huawei-cloud-api-definitions-AS 0.1.20260109

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"BandwidthResult":{"description":"带宽信息","properties":{"charging_mode":{"description":"带宽的计费类型。字段值为“bandwidth”,表示按带宽计费。字段值为“traffic”,表示按流量计费。","enum":["bandwidth","traffic"],"type":"string"},"id":{"description":"带宽ID,创建WHOLE类型带宽的弹性IP时指定的共享带宽。","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"},"share_type":{"description":"带宽的共享类型。共享类型枚举:PER,表示独享。目前只支持独享。","enum":["PER","WHOLE"],"type":"string"},"size":{"description":"带宽(Mbit/s)。","maximum":300,"minimum":1,"type":"integer"}}},"CpuOptions":{"properties":{"hw_cpu_threads":{"description":"是否关闭实例超线程,1是关闭,2是开启","format":"int32","type":"integer"}},"type":"object"},"DiskResult":{"description":"磁盘信息","properties":{"data_disk_image_id":{"description":"导入数据盘的数据盘镜像ID。","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"},"dedicated_storage_id":{"description":"磁盘所属的专属存储ID。","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"},"disk_type":{"description":"系统盘还是数据盘,DATA表示为数据盘,SYS表示为系统盘。","enum":["SYS","DATA"],"type":"string"},"iops":{"description":"云硬盘iops","format":"int32","type":"integer"},"metadata":{"$ref":"#/definitions/MetaData","description":"创建磁盘的元数据"},"size":{"description":"磁盘大小,容量单位为GB。","type":"integer"},"snapshot_id":{"description":"磁盘备份的快照ID。","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"},"throughput":{"description":"云硬盘吞吐量","format":"int32","type":"integer"},"volume_type":{"description":"磁盘类型。","enum":["SATA","SAS","SSD","co-pl","uh-11","GPSSD2","ESSD2"],"type":"string"}},"type":"object"},"EipResult":{"description":"eip信息","properties":{"bandwidth":{"$ref":"#/definitions/BandwidthResult","description":"IP地址带宽参数。"},"ip_type":{"description":"IP地址类型。","enum":["5_bgp","5_sbgp","5_telcom","5_union"],"type":"string"}}},"InstanceConfigResult":{"description":"实例配置信息","properties":{"adminPass":{"description":"登录云服务器的密码,非明文回显。","type":"string"},"cpu_options":{"$ref":"#/definitions/CpuOptions","description":"是否关闭超线程,1是关闭,2是开启(默认)"},"dedicated_host_id":{"description":"专属主机的ID。","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"},"disk":{"description":"磁盘组信息。","items":{"$ref":"#/definitions/DiskResult"},"type":"array"},"flavorRef":{"description":"云服务器的规格ID。","type":"string"},"imageRef":{"description":"镜像ID,同image_id。","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"},"instance_id":{"description":"该参数为预留字段。","type":"string"},"instance_name":{"description":"该参数为预留字段。","type":"string"},"key_fingerprint":{"description":"登录云服务器的SSH密钥指纹。","type":"string"},"key_name":{"description":"登录云服务器的SSH密钥名称。","maxLength":32,"minLength":1,"type":"string"},"market_type":{"description":"云服务器的计费模式,可以选择竞价计费或按需计费。","type":"string"},"metadata":{"$ref":"#/definitions/VmMetaData"},"multi_flavor_priority_policy":{"description":"使用伸缩配置创建云主机的时候,多规格使用的优先级策略。\n\nPICK_FIRST(默认):选择优先,虚拟机扩容时规格的选择按照flavorRef列表的顺序进行优先级排序。\nCOST_FIRST:成本优化,虚拟机扩容时规格的选择按照价格最优原则进行优先级排序。","type":"string"},"personality":{"description":"个人信息","items":{"$ref":"#/definitions/PersonalityResult"},"type":"array"},"public_ip":{"$ref":"#/definitions/PublicipResult"},"security_groups":{"description":"安全组信息。","items":{"$ref":"#/definitions/SecurityGroups"},"type":"array"},"server_group_id":{"description":"云服务器组ID。","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"},"tenancy":{"description":"在专属主机上创建弹性云服务器。","type":"string"},"user_data":{"description":"cloud-init用户数据,base64格式编码。","type":"string"}}},"MetaData":{"description":"创建磁盘的元数据","properties":{"__system__cmkid":{"description":"用户主密钥ID,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。说明:- 系统盘不支持加密。- 请参考[查询密钥列表](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=KMS&api=ListKeys&version=v2),通过HTTPS请求获取密钥ID。","type":"string"},"__system__encrypted":{"description":"metadata中的表示加密功能的字段,0代表不加密,1代表加密。  该字段不存在时,云硬盘默认为不加密。\n说明:\n系统盘不支持加密。","type":"string"}}},"PersonalityResult":{"description":"个人信息","properties":{"content":{"description":"注入文件内容,base64格式编码。","type":"string"},"path":{"description":"注入文件路径信息。","type":"string"}}},"PublicipResult":{"description":"弹性IP信息","properties":{"eip":{"$ref":"#/definitions/EipResult","description":"云服务器自动分配弹性IP时,创建弹性IP的配置参数。"}}},"ScalingConfigListResult":{"description":"伸缩配置列表信息","properties":{"limit":{"description":"查询记录数。","maximum":100,"minimum":0,"type":"integer"},"scaling_configurations":{"description":"伸缩配置列表","items":{"$ref":"#/definitions/ScalingConfiguration"},"type":"array"},"start_number":{"description":"查询的起始行号。","type":"integer"},"total_number":{"description":"总记录数。","maximum":100,"minimum":0,"type":"integer"}}},"ScalingConfiguration":{"description":"伸缩配置详情","properties":{"create_time":{"description":"创建伸缩配置的时间,遵循UTC时间。","format":"date-time","type":"string"},"instance_config":{"$ref":"#/definitions/InstanceConfigResult"},"scaling_configuration_id":{"description":"伸缩配置ID,全局唯一。","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"},"scaling_configuration_name":{"description":"伸缩配置名称。","example":"config_name_1","type":"string"},"scaling_group_id":{"description":"绑定该伸缩配置的伸缩组ID","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"},"tenant":{"description":"租户ID。","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"}}},"SecurityGroups":{"description":"安全组信息","properties":{"id":{"description":"安全组ID","example":"6c22a6c0-b5d2-4a84-ac56-51090dcc33be","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string"}},"required":["id"]},"VmMetaData":{"description":"云服务器元数据","properties":{"admin_pass":{"description":"如果需要使用密码方式登录云服务器,可使用adminPass字段指定云服务器管理员帐户初始登录密码。其中,Linux管理员帐户为root,Windows管理员帐户为Administrator。密码复杂度要求:- 长度为8-26位。- 密码至少必须包含大写字母、小写字母、数字和特殊字符(!@$%^-_=+[{}]:,./?)中的三种。- 密码不能包含用户名或用户名的逆序。- Windows系统密码不能包含用户名或用户名的逆序,不能包含用户名中超过两个连续字符的部分。","type":"string"}}}},"description":null,"group_id":"c14e7adea4354f78bb333ea8451df077","host":"as.cn-north-4.myhuaweicloud.com","id":"1ef8ef74927a487e8965f4209de2f126","info_version":"v1","method":"get","name":"ListScalingConfigs","parameters":{},"paths":{"/autoscaling-api/v1/{project_id}/scaling_configuration":{"get":{"description":"根据输入条件过滤查询弹性伸缩配置。查询结果分页显示。可以根据伸缩配置名称,镜像ID,起始行号,记录条数进行条件过滤查询。若不加过滤条件默认最多查询租户下20条伸缩配置信息。","operationId":"ListScalingConfigs","parameters":[{"description":"项目ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"0513757xxxxxd5eb2f08xxxb93ef4f0f","x-order":1},{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX...","x-order":2},{"description":"伸缩配置名称。","in":"query","name":"scaling_configuration_name","required":false,"type":"string","x-example":"test","x-order":3},{"description":"镜像ID,同imageRef。","in":"query","name":"image_id","required":false,"type":"string","x-example":"66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f","x-order":4},{"description":"查询的起始行号,默认为0。","in":"query","name":"start_number","required":false,"type":"integer","x-example":0,"x-order":5},{"description":"查询的记录条数,默认为20。","in":"query","name":"limit","required":false,"type":"integer","x-example":5,"x-order":6}],"responses":{"200":{"description":"请求正常","examples":{"application/json":{"limit":10,"scaling_configurations":[{"create_time":"2021-04-17T07:44:24Z","instance_config":{"adminPass":"***","disk":[{"disk_type":"SYS","size":40,"volume_type":"SATA"}],"flavorRef":"s2.medium.2","imageRef":"4ffe0dc8-ac16-4d3a-a1e9-5640e4930cea","key_fingerprint":"SHA256:eX6af8hJmcx0FPZu36+E7w8snfp1JwyLb7Qc7qADeIs","key_name":"KeyPair-4671-test","metadata":{},"multi_flavor_priority_policy":"PICK_FIRST","security_groups":[{"id":"c7033a8e-77bd-41db-a6f4-5788c0bb7fa9"}]},"scaling_configuration_id":"8249ba60-321c-4a02-a0ca-c38fdd54ab0f","scaling_configuration_name":"as-config-9818","scaling_group_id":"5294b80e-ee63-4116-bb71-4ea4cadba995","tenant":"06057680f980d5762f0cc01cc6a3a509"},{"create_time":"2021-04-10T03:25:24Z","instance_config":{"adminPass":"***","disk":[{"disk_type":"SYS","size":40,"volume_type":"SATA"}],"flavorRef":"s2.medium.2,s2.medium.4,s6.small.1","imageRef":"4ffe0dc8-ac16-4d3a-a1e9-5640e4930cea","key_fingerprint":"SHA256:eX6af8hJmcx0FPZu36+E7w8snfp1JwyLb7Qc7qADeIs","key_name":"KeyPair-4671-test","metadata":{},"multi_flavor_priority_policy":"PICK_FIRST","security_groups":[{"id":"c7033a8e-77bd-41db-a6f4-5788c0bb7fa9"}]},"scaling_configuration_id":"ad8ff7b8-eac8-4b91-8ca6-b0fa5391aceb","scaling_configuration_name":"as-config-01","scaling_group_id":"4201a1cd-461c-447e-aa7a-a85aeabea5a3","tenant":"06057680f980d5762f0cc01cc6a3a509"}],"start_number":0,"total_number":2}},"schema":{"$ref":"#/definitions/ScalingConfigListResult"}},"400":{"description":"Bad Request 服务器未能处理请求。"},"401":{"description":"Unauthorized 被请求的页面需要用户名和密码。"},"403":{"description":"Forbidden 对被请求的页面访问禁止。"},"404":{"description":"Not Found 服务器无法找到被请求的页面。"},"405":{"description":"Method Not Allowed 请求中指定的方法不被允许。"},"406":{"description":"Not Acceptable 服务器生成的响应无法被客户端所接受。"},"407":{"description":"Proxy Authentication 用户必须首先使用代理服务器进行验证,这样请求才会被处理"},"408":{"description":"Request Timeout 请求超出了服务器的等待时间。"},"409":{"description":"Conflict 由于冲突,请求无法被完成。"},"500":{"description":"Internal Server Error 请求未完成。服务异常。"},"501":{"description":"Not Implemented 请求未完成。服务器不支持所请求的功能。"},"502":{"description":"Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。"},"503":{"description":"Service Unavailable 请求未完成。系统暂时异常。"},"504":{"description":"Gateway Timeout 网关超时。"}},"summary":"查询弹性伸缩配置列表","tags":["弹性伸缩配置"],"x-apiErrorCodes":"","x-apigateway-auth-type":"","x-apigateway-match-mode":"","x-apigateway-request-type":"","x-call_frequency":"","x-constraint":"","x-ctc":"Y","x-first_open_time":"2016-06-30","x-flow_control_group":"as","x-hc":"Y","x-hk":"Y","x-hybridcloud":"true","x-iftype":"公开接口","x-in_cli":"","x-is-registered":"Y","x-is_calling":"Y","x-multi_tenant_flow_time":"1","x-multi_tenant_flow_value":"780","x-name":"查询弹性伸缩配置列表","x-obc":"Y","x-order":2,"x-otc":"Y","x-request-examples-description-1":"本示例展示了查询使用了ID为37ca2b35-6fc7-47ab-93c7-900324809c5c的镜像的伸缩配置。","x-request-examples-url-1":"GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration?image_id=37ca2b35-6fc7-47ab-93c7-900324809c5c","x-scope":"Commercial","x-source":"SelfDeveloped","x-source_url":"","x-support-sdk":"Y","x-tenant_flow_time":"1","x-tenant_flow_value":"78","x-timeout":"10s","x-tlf":"Y","x-un_cli":"","x-version":"v1"}}},"product_short":"AS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询弹性伸缩配置列表","tags":"弹性伸缩配置","uri":null,"version":"2.0"}