huawei-cloud-api-definitions-APIExplorer 0.1.20240119

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"Api":{"properties":{"base_path":{"description":"yaml的basepath部分","maxLength":128,"minLength":1,"type":"string"},"components":{"description":"yaml中该接口需要的components部分+openapi3.0.1的parameters部分","properties":{},"type":"object"},"consumes":{"description":"yaml中该接口需要的consumes部分","properties":{},"type":"object"},"definitions":{"description":"yaml中该接口需要的definitions部分","properties":{},"type":"object"},"description":{"description":"接口的描述","maxLength":10000,"minLength":0,"type":"string"},"group_id":{"description":"apig的分组id","maxLength":64,"minLength":1,"type":"string"},"host":{"description":"yaml的host","maxLength":128,"minLength":1,"type":"string"},"id":{"description":"uuid","maxLength":32,"minLength":32,"type":"string"},"info_version":{"description":"info中的version字段","maxLength":32,"minLength":1,"type":"string"},"is_multiple_version":{"description":"是否多版本的标识","type":"boolean"},"name":{"description":"接口名","maxLength":512,"minLength":1,"type":"string"},"online_cli":{"description":"所属云服务的API是否已经在HWCloudCli上开放使用","type":"boolean"},"parameters":{"description":"yaml中该接口需要的parameters部分(openapi2.0)","properties":{},"type":"object"},"paths":{"description":"yaml中的path部分","properties":{},"type":"object"},"productshort":{"description":"产品的简称","maxLength":100,"minLength":1,"type":"string"},"region_id":{"description":"内部regionid","maxLength":256,"minLength":1,"type":"string"},"roma_info":{"$ref":"#/definitions/ApiRomaInfo","description":"api对应的roma配置信息"},"schemes":{"description":"yaml接口的协议","items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"summary":{"description":"中文名称","maxLength":512,"minLength":1,"type":"string"},"tags":{"description":"yaml中的tags","maxLength":512,"minLength":1,"type":"string"},"version":{"description":"openapi的版本号","maxLength":32,"minLength":1,"type":"string"}}},"ApiRomaInfo":{"properties":{"application_id":{"description":"应用id","example":"5661ab02-2dc0-4ba8-b9ff-dadb84169d7a","maxLength":64,"minLength":1,"type":"string"}}}},"description":null,"group_id":"eed1c825dbe54d0facd4d95f9de3e9d7","host":"apiexplorer.cn-north-4.myhuaweicloud.com","id":"a479a1bfd20247a993ff904163d1d72b","info_version":"v1","method":"get","name":"ShowApi","parameters":{},"paths":{"/v3/apis/detail":{"get":{"description":"根据产品短名、api名及regionId获取API的详情信息","operationId":"ShowApi","parameters":[{"description":"语言类型 中文:zh-cn 英文:en-us","in":"header","maxLength":16,"minLength":5,"name":"X-Language","required":false,"type":"string","x-example":"zh-cn"},{"description":"产品短名","in":"query","maxLength":100,"minLength":1,"name":"productshort","required":false,"type":"string"},{"description":"api英文名","in":"query","maxLength":63,"minLength":1,"name":"name","required":false,"type":"string"},{"description":"regionId","in":"query","maxLength":256,"minLength":1,"name":"region_id","required":false,"type":"string"},{"description":"罗马实例id(租户侧API调试场景场景下才使用)","in":"query","maxLength":64,"minLength":1,"name":"instance_id","required":false,"type":"string"},{"description":"api的id(租户侧API调试场景场景下才使用)","in":"query","maxLength":64,"minLength":1,"name":"id","required":false,"type":"string"},{"description":"分组的id(租户侧API调试场景场景下才使用)","in":"query","maxLength":64,"minLength":1,"name":"group_id","required":false,"type":"string"},{"description":"项目名称(租户侧Apic调试场景下才使用,字段不为空代表当前切换子项目,为空代表没有切换)","in":"query","maxLength":64,"minLength":1,"name":"project_name","required":false,"type":"string"},{"description":"yaml的版本信息,用来标记当前api对应的版本","in":"query","maxLength":100,"minLength":0,"name":"info_version","required":false,"type":"string"}],"responses":{"200":{"description":"OK","examples":{"application/json":{"base_path":"/APIExplorer","consumes":"[\"application/json;charset=UTF-8\"]","definitions":{},"group_id":"ce7d79b132d04b1c8b0d4fee649cbd46","host":"test.inhuawei.com","id":"043398e4b58f497ebb2beaf8b91c9f28","name":"NovaDeleteMetadataItem","online_cli":true,"parameters":{},"paths":{"/v2.1/{project_id}/servers/{server_id}/metadata/{key}":{"delete":{"consumes":[],"deprecated":false,"description":"删除云服务器指定元数据。","operationId":"NovaDeleteMetadataItem","parameters":[{"description":"待删除的云服务器metadata键值。","in":"path","name":"key","required":true,"type":"string","x-example":"key1","x-order":2},{"description":"项目ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx","x-order":3},{"description":"云服务器ID。","in":"path","name":"server_id","required":true,"type":"string","x-example":"e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67","x-order":4},{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX...","x-order":1}],"produces":[],"responses":{"204":{"description":"No Content"}},"summary":"删除云服务器指定元数据","tags":["元数据管理"],"x-api_level":"1","x-apiexplorer-hide":"false","x-apigateway-auth-type":"IAM","x-apigateway-match-mode":"NORMAL","x-apigateway-request-type":"public","x-call_frequency":"medium","x-constraint":"云服务器状态(云服务器的OS-EXT-STS:vm_state属性)必须是active,stopped,paused或者suspended。","x-ctc":"Y","x-first_open_time":"2018-3-30","x-flow_control_group":"ecs_DeleteMetaItem","x-hc":"Y","x-hk":"Y","x-hybridcloud":"true","x-in_cli":"nova meta","x-is_calling":"Y","x-is_registered":"Y","x-multi_tenant_flow_time":"1","x-multi_tenant_flow_value":"2000","x-name":"删除云服务器指定元数据","x-obc":"Y","x-order":56,"x-otc":"Y","x-registered_to":"apicom","x-request-examples-1":"DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata/{key}","x-request-examples-description-1":"","x-request-examples-text-1":"DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata/{key}","x-request-examples-url-1":"","x-scope":"Commercial","x-source":"Native","x-tenant_flow_time":"1","x-tenant_flow_value":"1000","x-timeout":"60s","x-tlf":"Y","x-un_cli":"openstack server unset --property","x-version":"v2.1"}}},"productshort":"ECS","region_id":"br-iaas-odin1","schemes":"[\"https\"]","summary":"删除云服务器指定元数据","tags":"元数据管理","version":"2.0"}},"schema":{"$ref":"#/definitions/Api"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"获取API详情","tags":["ApiServerV3"],"x-is-registered":"Y","x-request-examples-1":"/v2/api?productshort=ECS&apiname=NovaDeleteMetadataItem&region_id=br-iaas-odin1","x-request-examples-description-1":"","x-support-sdk":"Y"}}},"product_short":"APIExplorer","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取API详情","tags":"API","uri":null,"version":"2.0"}