huawei-cloud-api-definitions-ROMA 0.1.20240626

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"EnvCreate":{"properties":{"name":{"description":"环境的名称,支持英文,数字,下划线,且只能以英文字母开头。","example":"DEV","maxLength":64,"minLength":3,"pattern":"^[a-zA-Z]{1,}([a-zA-Z0-9_])*$","type":"string"},"remark":{"description":"描述信息\n> 中文字符必须为UTF-8或者unicode编码。","example":"开发环境","maxLength":255,"type":"string"}},"required":["name"]},"EnvInfo":{"properties":{"create_time":{"description":"创建时间","format":"date-time","type":"string"},"id":{"description":"环境编号","type":"string"},"name":{"description":"环境名称","type":"string"},"remark":{"description":"描述信息","type":"string"}}},"ResponseModel":{"properties":{"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误描述","type":"string"}},"required":["error_code","error_msg"]}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"6615de9411344f6e94dc11489f0182b1","info_version":"v2","method":"post","name":"CreateEnvironmentV2","parameters":{"apic_instance_id":{"description":"实例ID","in":"path","name":"instance_id","required":true,"type":"string","x-example":"f0fa1789-3b76-433b-a787-9892951c620e"},"apic_project_id":{"description":"项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。","in":"path","name":"project_id","required":true,"type":"string","x-example":"73d69ae0cfcf460190522d06b60f05ad"},"apic_x_auth_token":{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."}},"paths":{"/v2/{project_id}/apic/instances/{instance_id}/envs":{"post":{"description":"在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。\n\n\n对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测试的版本,发布在测试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。\n\n\n为此,服务集成提供多环境管理功能,使租户能够最大化的模拟实际场景,低成本的接服务集成。","operationId":"CreateEnvironmentV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"创建环境的请求体","in":"body","name":"CreateEnvironmentV2RequestBody","required":true,"schema":{"$ref":"#/definitions/EnvCreate"}}],"responses":{"201":{"description":"Created","examples":{"application/json":{"create_time":"2020-07-31T06:41:43.511347628Z","id":"7a1ad0c350844ee69479b47df9a881cb","name":"DEV","remark":"Development environment"}},"schema":{"$ref":"#/definitions/EnvInfo"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2012","error_msg":"Invalid parameter value,parameterName:name. Please refer to the support documentation"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"401":{"description":"Unauthorized","examples":{"application/json":{"error_code":"APIG.1002","error_msg":"Incorrect token or token resolution failed"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"403":{"description":"Forbidden","examples":{"application/json":{"error_code":"APIG.1005","error_msg":"No permissions to request this method"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"404":{"description":"Not Found","examples":{"application/json":{"error_code":"APIG.3030","error_msg":"The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"500":{"description":"Internal Server Error","examples":{"application/json":{"error_code":"APIG.9999","error_msg":"System error"}},"schema":{"$ref":"#/definitions/ResponseModel"}}},"schemes":["https"],"summary":"创建环境","tags":["环境管理"],"x-api-version":"v2","x-apigateway-request-type":"public","x-hybridcloud":true,"x-is-registered":"Y","x-open-region-cloud":"hc,hcso","x-order":1,"x-request-examples-1":{"name":"DEV","remark":"Development environment"},"x-request-examples-description-1":"创建一个环境","x-romaconnect-mode":"huaweicloud,hybrid,on-premise","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建环境","tags":"环境管理","uri":null,"version":"2.0"}