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":{"ApiBatchPublish":{"properties":{"apis":{"description":"需要发布或下线的API ID列表","items":{"type":"string"},"type":"array"},"env_id":{"description":"环境ID","type":"string"},"remark":{"description":"对本次发布的描述信息\n\n字符长度不超过255\n> 中文字符必须为UTF-8或者unicode编码。","type":"string"}},"required":["env_id"]},"BatchFailure":{"description":"批量操作失败的返回结果","properties":{"api_id":{"description":"操作失败的API ID","type":"string"},"api_name":{"description":"操作失败的APi名称","type":"string"},"error_code":{"description":"操作失败的错误码","type":"string"},"error_msg":{"description":"操作失败的错误信息","type":"string"}}},"BatchPublishResult":{"properties":{"failure":{"description":"发布或下线失败的API及错误信息","items":{"$ref":"#/definitions/BatchFailure"},"type":"array"},"success":{"description":"发布或下线成功的信息","items":{"$ref":"#/definitions/PublishResp"},"type":"array"}}},"PublishResp":{"properties":{"api_id":{"description":"API编号","example":"7addcd00cfab433984b1d8bf2fe08aaa","type":"string"},"api_name":{"description":"API名称","example":"api_name","type":"string"},"env_id":{"description":"发布的环境编号","example":"DEFAULT_ENVIRONMENT_RELEASE_ID","type":"string"},"publish_id":{"description":"发布记录的ID","example":"5b729aa252764739be2c37ef0d66dc63","type":"string"},"publish_time":{"description":"发布时间","example":"2018-07-26T13:18:04.1079916Z","format":"date-time","type":"string"},"remark":{"description":"发布描述","example":"string","type":"string"},"version_id":{"description":"在线的版本号","example":"3d9dcb733ba34352b0d02f85fd16b026","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":"6414f16ae87c4e82bd5462390098fb30","info_version":"v2","method":"post","name":"BatchPublishOrOfflineApiV2","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}/apis/publish":{"post":{"description":"将多个API发布到一个指定的环境,或将多个API从指定的环境下线。\n\n注意:当action = online时,接口返回的响应中publish_id,version_id, publish_time字段才有含义。","operationId":"BatchPublishOrOfflineApiV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"- online:发布\n- offline:下线","in":"query","name":"action","required":true,"type":"string"},{"description":"批量发布或下线API的请求体","in":"body","name":"BatchPublishOrOfflineApiV2RequestBody","required":true,"schema":{"$ref":"#/definitions/ApiBatchPublish"}}],"responses":{"200":{"description":"OK","examples":{"application/json":{"failure":[{"api_id":"abd9c4b2ff974888b0ba79be7e6b2762","error_code":"APIG.3002","error_msg":"Api abd9c4b2ff974888b0ba79be7e6b2762 not found"}],"success":[{"api_id":"3a955b791bd24b1c9cd94c745f8d1aad","api_name":"Api_mock","env_id":"DEFAULT_ENVIRONMENT_RELEASE_ID","publish_id":"9f27d1dc4f4242a9abf88e563dbfc33d","publish_time":"2020-08-03T03:01:31.26522821Z","remark":"Publish to the production environment","version_id":"632b2c9e022941969af9a1d45735ae2c"}]}},"schema":{"$ref":"#/definitions/BatchPublishResult"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2011","error_msg":"Invalid parameter value: parameter action should be \\\"online\\\" or \\\"offline\\\""}},"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"}}},"summary":"批量发布或下线API","tags":["API管理"],"x-api-version":"v2","x-apigateway-request-type":"public","x-hybridcloud":true,"x-is-registered":"Y","x-open-region-cloud":"hc,hcso","x-order":7,"x-request-examples-1":{"apis":["3a955b791bd24b1c9cd94c745f8d1aad","abd9c4b2ff974888b0ba79be7e6b2762"],"env_id":"DEFAULT_ENVIRONMENT_RELEASE_ID","remark":"Publish to the production environment"},"x-request-examples-description-1":"根据列表批量发布API到指定环境上","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":"批量发布或下线API","tags":"API管理","uri":null,"version":"2.0"}