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":{"EnvVariableBase":{"properties":{"variable_value":{"description":"变量值支持英文字母、数字、英文格式的下划线、中划线,斜线(/)、点、冒号,1 ~ 255个字符。","example":"192.168.1.5","type":"string"}},"required":["variable_value"]},"EnvVariableCreate":{"allOf":[{"$ref":"#/definitions/EnvVariableBase"},{"properties":{"env_id":{"description":"环境编号","example":"7a1ad0c350844ee69479b47df9a881cb","maxLength":65,"minLength":1,"pattern":"^[a-zA-Z0-9-_]{0,64}$","type":"string"},"group_id":{"description":"API分组编号","example":"73c58022f20d495aa18885d718647f09","maxLength":65,"minLength":1,"pattern":"^[a-zA-Z0-9-_]{0,64}$","type":"string"},"variable_name":{"description":"变量名,支持英文字母、数字、英文格式的下划线、中划线,必须以英文字母开头,3~32个字符。在API定义中等于#Name的值#部分(区分大小写),发布到环境里的API被变量值换。\n> 中文字符必须为UTF-8或者unicode编码。","example":"address","type":"string"}},"type":"object"}],"required":["env_id","group_id","variable_name"]},"EnvVariableInfo":{"allOf":[{"$ref":"#/definitions/EnvVariableCreate"},{"properties":{"id":{"description":"环境变量编号","type":"string"}},"type":"object"}]},"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":"8f39e5fb0f3548168de572de045d24a3","info_version":"v2","method":"post","name":"CreateEnvironmentVariableV2","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}/env-variables":{"post":{"description":"将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。\n\n\n用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,服务集成会将这些变量替换成真实的变量值,以达到不同环境的区分效果。\n\n\n环境变量定义在API分组上,该分组下的所有API都可以使用这些变量。\n\n> 1.环境变量的变量名称必须保持唯一,即一个分组在同一个环境上不能有两个同名的变量\n  2.环境变量区分大小写,即变量ABC与变量abc是两个不同的变量\n  3.设置了环境变量后,使用到该变量的API的调试功能将不可使用。\n  4.定义了环境变量后,使用到环境变量的地方应该以对称的#标识环境变量,当API发布到相应的环境后,会对环境变量的值进行替换,如:定义的API的URL为:https://#address#:8080,环境变量address在RELEASE环境上的值为:192.168.1.5,则API发布到RELEASE环境后的真实的URL为:https://192.168.1.5:8080。","operationId":"CreateEnvironmentVariableV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"创建环境变量的请求体","in":"body","name":"CreateEnvironmentVariableV2RequestBody","required":true,"schema":{"$ref":"#/definitions/EnvVariableCreate"}}],"responses":{"201":{"description":"Created","examples":{"application/json":{"env_id":"7a1ad0c350844ee69479b47df9a881cb","group_id":"c77f5e81d9cb4424bf704ef2b0ac7600","id":"25054838a624400bbf2267cf5b3a3f70","variable_name":"address","variable_value":"192.168.1.5"}},"schema":{"$ref":"#/definitions/EnvVariableInfo"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2012","error_msg":"Invalid parameter value,parameterName:variable_name"}},"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.3003","error_msg":"Environment 7a1ad0c350844ee69479b47df9a881cb does not exist"}},"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":{"env_id":"7a1ad0c350844ee69479b47df9a881cb","group_id":"c77f5e81d9cb4424bf704ef2b0ac7600","variable_name":"address","variable_value":"192.168.1.5"},"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"}