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":{"ErrorResp":{"example":{"error_code":"ROMA.00000101","error_details":"some error details here","error_msg":"error summary","request_id":"13760c1fe8655e61209b75665e9bef43"},"properties":{"error_code":{"description":"错误码","maxLength":128,"minLength":1,"type":"string"},"error_details":{"description":"具体错误消息","maxLength":128,"minLength":1,"type":"string"},"error_msg":{"description":"错误消息","maxLength":128,"minLength":1,"type":"string"},"request_id":{"description":"请求处理ID","maxLength":128,"minLength":1,"type":"string"}},"type":"object"},"RomaInstanceCheckListResp":{"properties":{"instances":{"description":"实例列表","items":{"properties":{"available_zone_ids":{"description":"创实例使用的可用区列表","example":["9f1c5806706d4c1fb0eb72f0a9b18c77"],"items":{"type":"string"},"maxItems":9,"minItems":1,"type":"array"},"charge_type":{"description":"实例计费模式","enum":["prePaid","postPaid"],"example":"prePaid","type":"string"},"cpu_arch":{"default":"x86_64","description":"CPU架构类型,取值如下: - x86_64: x86架构 - aarch64: arm架构","enum":["x86_64","aarch64"],"example":"x86_64","type":"string"},"create_time":{"description":"创建时间","example":"2019-12-06T06:49:04Z","type":"string"},"description":{"description":"实例描述","example":"","type":"string"},"enterprise_project_id":{"description":"实例所属企业项目ID","example":"0","type":"string"},"error_code":{"description":"错误码","maxLength":128,"minLength":1,"type":"string"},"error_msg":{"description":"错误消息","maxLength":512,"minLength":1,"type":"string"},"flavor_id":{"description":"实例规格ID","example":"00400-30101-0--0","type":"string"},"flavor_type":{"description":"实例规格类型","example":"basic","type":"string"},"id":{"description":"实例ID","example":"e34610ca-0a37-4f04-8856-4101b08cc5e2","type":"string"},"maintain_begin":{"description":"运维开始时间","example":"22:00:00","type":"string"},"maintain_end":{"description":"运维结束时间","example":"02:00:00","type":"string"},"name":{"description":"实例名称","example":"roma-test","type":"string"},"project_id":{"description":"租户项目ID","example":"106506b9a92342df9a5025fc12351cfc","type":"string"},"publicip_address":{"description":"实例绑定的弹性公网地址","example":"139.9.140.164","type":"string"},"publicip_enable":{"description":"是否开启公网访问,开启时publicip_id字段必填。","example":true,"type":"boolean"},"publicip_id":{"description":"实例绑定的弹性公网地址ID","example":"55a6ef1b-498d-42fb-bbc7-d01ba1652bfc","type":"string"},"security_group_id":{"description":"实例指定安全组ID","example":"56275464-d5f1-417d-a73b-92ee479e91e2","type":"string"},"status":{"description":"实例运行状态","enum":["CREATING","CREATE_FAILED","ERROR","RUNNING","FREEZING","FROZEN","DELETING","DELETE_FALIED"],"example":"RUNNING","type":"string"},"subnet_id":{"description":"实例指定虚拟私有云子网ID","example":"8e2ee0d5-0f1d-4067-965f-caf00dd65529","type":"string"},"update_time":{"description":"更新时间","example":"2019-12-06T06:49:04Z","type":"string"},"vpc_id":{"description":"实例指定虚拟私有云ID","example":"000c3783-a9c0-4ee4-ac44-93bfdfbf3340","type":"string"}},"type":"object"},"maxItems":100,"minItems":0,"type":"array"},"size":{"description":"本页数量","example":1,"maximum":100,"minimum":0,"type":"integer"},"total":{"description":"列表总数","example":1,"maximum":100,"minimum":0,"type":"integer"}},"type":"object"}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"a1f8cc05cc674cd5a6e15ac58bf24c3c","info_version":"v2","method":"get","name":"CheckRomaInstanceListV2","parameters":{},"paths":{"/v2/{project_id}/instances":{"get":{"description":"获取符合条件的服务实例列表。","operationId":"CheckRomaInstanceListV2","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)","in":"header","maxLength":65536,"minLength":1000,"name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"租户项目编号","in":"path","maxLength":128,"minLength":16,"name":"project_id","required":true,"type":"string","x-example":"96524074748c48e6887d0cca5463c78d"},{"description":"实例状态","in":"query","maxLength":128,"minLength":3,"name":"status","required":false,"type":"string","x-example":"RUNNING"},{"default":0,"description":"偏移量,大于等于0","format":"int32","in":"query","maximum":100,"minimum":0,"name":"offset","type":"integer"},{"default":10,"description":"每页显示的条目数量","format":"int32","in":"query","maximum":100,"minimum":0,"name":"limit","type":"integer"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RomaInstanceCheckListResp"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"ROMA.00013000","error_details":"some error details here","error_msg":"Invalid parameter value,parameterName:name. Please refer to the support documentation","request_id":"13760c1fe8655e61209b75665e9bef43"}},"schema":{"$ref":"#/definitions/ErrorResp"}},"401":{"description":"Unauthorized","examples":{"application/json":{"error_code":"ROMA.00012000","error_details":"some error details here","error_msg":"Incorrect token or token resolution failed","request_id":"13760c1fe8655e61209b75665e9bef43"}},"schema":{"$ref":"#/definitions/ErrorResp"}},"403":{"description":"Forbidden","examples":{"application/json":{"error_code":"ROMA.00012000","error_details":"some error details here","error_msg":"No permissions to request this method","request_id":"13760c1fe8655e61209b75665e9bef43"}},"schema":{"$ref":"#/definitions/ErrorResp"}},"500":{"description":"Internal Server Error","examples":{"application/json":{"error_code":"ROMA.00011000","error_details":"some error details here","error_msg":"System error","request_id":"13760c1fe8655e61209b75665e9bef43"}},"schema":{"$ref":"#/definitions/ErrorResp"}}},"security":[{"apig-auth-iam":[]}],"summary":"查询实例列表","tags":["INSTANCE_MANAGEMENT"],"x-apigateway-backend":{"httpEndpoints":{"address":"#roma-address#","description":"","method":"GET","path":"/v2/{project_id}/instances","scheme":"https","timeout":30000},"parameters":[{"description":"","in":"PATH","name":"project_id","origin":"REQUEST","value":"project_id"}],"type":"HTTP"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-request-type":"public","x-is-registered":"Y","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询实例列表","tags":"INSTANCE_MANAGEMENT","uri":null,"version":"2.0"}