huawei-cloud-api-definitions-APIExplorer 0.1.20240203

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"}}},"ApiList":{"properties":{"apis":{"description":"api数组","items":{"$ref":"#/definitions/Api"},"maxItems":100,"minItems":0,"type":"array"},"count":{"description":"总数","maximum":1000100,"minimum":0,"type":"integer"},"roma_info":{"$ref":"#/definitions/RomaInfo","description":"Roma Exchange传递的信息"}}},"ApiRomaInfo":{"properties":{"application_id":{"description":"应用id","example":"5661ab02-2dc0-4ba8-b9ff-dadb84169d7a","maxLength":64,"minLength":1,"type":"string"}}},"RomaInfo":{"properties":{"instance_id":{"description":"罗马实例id","example":"42d6d768-8eb0-4da0-854d-1fff25069f93","maxLength":64,"minLength":1,"type":"string"},"region_id":{"description":"region的id","example":"cn-north-9","maxLength":256,"minLength":1,"type":"string"}}}},"description":null,"group_id":"eed1c825dbe54d0facd4d95f9de3e9d7","host":"apiexplorer.cn-north-4.myhuaweicloud.com","id":"e4ea9714ce0b4490aac6787482e922d5","info_version":"v1","method":"get","name":"ListApis","parameters":{},"paths":{"/v2/apis":{"get":{"description":"获取指定产品的API列表,或者根据api中英文名模糊匹配API列表,支持分页","operationId":"ListApis","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的中英文名模糊匹配,中文名来自summary字段","in":"query","maxLength":63,"minLength":1,"name":"name","required":false,"type":"string"},{"default":10,"description":"每页显示的条目数量","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"},{"default":0,"description":"偏移量,表示从此偏移量开始查询","in":"query","maximum":1000000,"minimum":0,"name":"offset","required":false,"type":"integer"},{"description":"罗马实例id(租户侧APIC调试场景下才使用)","in":"query","maxLength":64,"minLength":1,"name":"instance_id","required":false,"type":"string"},{"description":"应用id(租户侧APIC调试场景下才使用)","in":"query","maxLength":64,"minLength":1,"name":"application_id","required":false,"type":"string"},{"description":"region的id(租户侧APIC调试场景下才使用)","in":"query","maxLength":64,"minLength":1,"name":"region_id","required":false,"type":"string"},{"description":"版本(租户侧ROMA Exchange API调试场景场景下才使用)","in":"query","maxLength":64,"minLength":1,"name":"version","required":false,"type":"string"},{"description":"资产id(租户侧ROMA Exchange API调试场景场景下才使用)","in":"query","maxLength":64,"minLength":1,"name":"asset_id","required":false,"type":"string"},{"description":"请求类型(租户侧ROMA Exchange API调试场景场景下才使用,允许值:myasset,market,mysubscription)","in":"query","maxLength":64,"minLength":1,"name":"type","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"},{"default":false,"description":"是否CLI调用api列表接口","in":"query","name":"is_cli_used","required":false,"type":"boolean"},{"default":false,"description":"查询是否推荐的api列表。推荐的API是指使用次数前五的API","in":"query","name":"is_recommend","required":false,"type":"boolean"},{"default":5,"description":"api使用次数排名:如果有值,表示返回使用次数排名前几的api列表","in":"query","maximum":100,"minimum":1,"name":"top_number","required":false,"type":"integer"}],"responses":{"200":{"description":"OK","examples":{"application/json":{"apis":[{"description":"把磁盘挂载到弹性云服务器上。","group_id":"ce7d79b132d04b1c8b0d4fee649cbd46","id":"89330f459437462a85895b7d41c10971","info_version":"v1","is_multiple_version":false,"name":"AttachServerVolume","productshort":"ECS","region_id":"cn-north-7","roma_info":{"application_id":"5661ab02-2dc0-4ba8-b9ff-dadb84169d7a"},"summary":"弹性云服务器挂载磁盘","tags":"磁盘管理"},{"description":"批量重置弹性云服务器管理帐号(root用户或Administrator用户)的密码。","group_id":"ce7d79b132d04b1c8b0d4fee649cbd46","id":"4f6537349ab94f6da8e747af4cd0fe39","info_version":"v1","is_multiple_version":false,"name":"BatchResetServersPassword","productshort":"ECS","region_id":"cn-north-7","roma_info":{"application_id":"5661ab02-2dc0-4ba8-b9ff-dadb84169d7a"},"summary":"批量重置弹性云服务器密码","tags":"批量操作"}],"count":2,"roma_info":{"instance_id":"42d6d768-8eb0-4da0-854d-1fff25069f93","region_id":"cn-north-9"}}},"headers":{"Search-History-Id":{"description":"搜索历史ID","type":"string"}},"schema":{"$ref":"#/definitions/ApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"获取API列表","tags":["ApiServerV2"],"x-is-registered":"Y","x-methodAnnotations":["@CrossOrigin"],"x-request-examples-1":"/v2/apis?productshort=ECS&apiname=Server&offset=1&limit=1","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"}