huawei-cloud-api-definitions-ECS 0.1.20250919

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ASICAcceleratorInfo":{"properties":{"count":{"description":"ASIC设备数量。","type":"integer"},"memory_mb":{"description":"ASIC设备的内存,单位为MB。","type":"integer"},"name":{"description":"ASIC设备名称。","type":"string"}},"type":"object"},"CpuOptions":{"description":"自定义CPU选项。","properties":{"hw:cpu_threads":{"description":"CPU超线程数, 决定CPU是否开启超线程。取值范围:1,2。\n\n- 1: 关闭超线程。\n- 2: 打开超线程。\n\n取值不能大于flavor中的   hw:cpu_threads,并且目标flavor配置需满足 \"hw:cpu_policy\": \"dedicated\",\"hw:cpu_threads\": \"2\"需要同时满足如下条件,才能设置为“关闭超线程”\n\n- 只能在实例创建或者resize时指定。\n- 只有目标flavor的extra_specs参数:\n- 存在“hw:cpu_policy”并取值为“dedicated”。\n- 存在“hw:cpu_threads”并取值为“2”。","enum":[1,2],"format":"int32","type":"integer"}}},"GpuInfo":{"properties":{"count":{"description":"GPU设备数量。","type":"integer"},"memory_mb":{"description":"GPU设备的内存,单位为MB。","type":"integer"},"name":{"description":"GPU设备名称。","type":"string"}},"type":"object"},"Hypervisor":{"description":"hypervisor信息。","properties":{"csd_hypervisor":{"description":"hypervisor csd信息","type":"string"},"hypervisor_type":{"description":"hypervisor类型","type":"string"}}},"SecurityOptions":{"properties":{"secure_boot_enabled":{"description":"是否支持安全启动 true:支持安全启动 false:不支持安全启动 默认值:false","type":"boolean","x-huawei-extraAnnotation":""},"tpm_enabled":{"description":"是否支持vtpm启动 true:支持vtpm启动 false:不支持vtpm启动 默认值:false","type":"boolean","x-huawei-extraAnnotation":""}}},"ServerAddress":{"description":"弹性云服务器的网络属性。","properties":{"OS-EXT-IPS-MAC:mac_addr":{"description":"MAC地址。","example":"fa:16:3e:09:31:dc","type":"string"},"OS-EXT-IPS:port_id":{"description":"IP地址对应的端口ID。","example":"4b5fe243-2f5f-4c68-9eb2-8af3a5366666","type":"string"},"OS-EXT-IPS:type":{"description":"IP地址类型。\n\n- fixed:代表私有IP地址。\n- floating:代表浮动IP地址。","enum":["fixed","floating"],"type":"string"},"addr":{"description":"IP地址。","type":"string"},"primary":{"description":"是否主网卡。\n\n- true:是主网卡\n- false:辅助网卡","example":false,"type":"boolean"},"version":{"description":"IP地址版本。\n\n- “4”:代表IPv4。\n- “6”:代表IPv6。","type":"string"}},"required":["addr","version"]},"ServerDetail":{"description":"云服务器详情。","properties":{"OS-DCF:diskConfig":{"description":"扩展属性, diskConfig的类型。\n\n- MANUAL,镜像空间不会扩展。\n- AUTO,系统盘镜像空间会自动扩展为与flavor大小一致。","example":"AUTO","type":"string"},"OS-EXT-AZ:availability_zone":{"description":"扩展属性,弹性云服务器所在可用区名称。","example":"cn-north-1c","type":"string"},"OS-EXT-SRV-ATTR:host":{"description":"弹性云服务器所在主机的主机名称。","example":"pod01.cn-north-1c","type":"string"},"OS-EXT-SRV-ATTR:hostname":{"description":"弹性云服务器的主机名。","type":"string"},"OS-EXT-SRV-ATTR:hypervisor_hostname":{"description":"扩展属性,弹性云服务器所在虚拟化主机名。","example":"nova022@36","type":"string"},"OS-EXT-SRV-ATTR:instance_name":{"description":"扩展属性,弹性云服务器别名。","example":"instance-0048a91b","type":"string"},"OS-EXT-SRV-ATTR:kernel_id":{"description":"若使用AMI格式的镜像,则表示kernel image的UUID;否则,留空。","type":"string"},"OS-EXT-SRV-ATTR:launch_index":{"description":"批量创建场景,弹性云服务器的启动顺序。","example":0,"format":"int32","type":"integer"},"OS-EXT-SRV-ATTR:ramdisk_id":{"description":"若使用AMI格式镜像,则表示ramdisk image的UUID;否则,留空。","type":"string"},"OS-EXT-SRV-ATTR:reservation_id":{"description":"批量创建场景,弹性云服务器的预留ID。","example":"r-f06p3js8","type":"string"},"OS-EXT-SRV-ATTR:root_device_name":{"description":"弹性云服务器系统盘的设备名称。","example":"/dev/vda","type":"string"},"OS-EXT-SRV-ATTR:user_data":{"description":"创建弹性云服务器时指定的user_data。","example":"IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRjcGRkSjckWm5WZHNiR253Z0l0SGlxUjZxbWtLTlJaeU9lZUtKd3dPbG9XSFdUeGFzWjA1STYwdnJYRTdTUTZGbEpFbWlXZ21WNGNmZ1pac1laN1BkMTBLRndyeC8nIHwgY2hwYXNzd2Q6666","type":"string"},"OS-EXT-STS:power_state":{"description":"扩展属性,弹性云服务器电源状态。","example":4,"format":"int32","type":"integer"},"OS-EXT-STS:task_state":{"description":"扩展属性,弹性云服务器当前任务的状态。\n\n取值范围请参考[云服务器状态](https://support.huaweicloud.com/api-ecs/ecs_08_0002.html)表3。","example":"rebooting","type":"string"},"OS-EXT-STS:vm_state":{"description":"扩展属性,弹性云服务器当前状态。\n\n云服务器状态说明请参考[云服务器状态](https://support.huaweicloud.com/api-ecs/ecs_08_0002.html)。","example":"active","type":"string"},"OS-SRV-USG:launched_at":{"description":"弹性云服务器启动时间。时间格式例如:2019-05-22T03:23:59.000000","example":"2018-08-15T14:21:22.000000","type":"string"},"OS-SRV-USG:terminated_at":{"description":"弹性云服务器删除时间。\n\n时间格式例如:2019-05-22T03:23:59.000000","example":"2019-05-22T03:23:59.000000","type":"string"},"accessIPv4":{"description":"预留属性。","type":"string"},"accessIPv6":{"description":"预留属性。","type":"string"},"addresses":{"additionalProperties":{"items":{"$ref":"#/definitions/ServerAddress"},"type":"array"},"description":"弹性云服务器的网络属性。","type":"object"},"auto_terminate_time":{"description":"弹性云服务器定时删除时间。\n\n时间格式例如:2020-01-19T03:30:52Z","example":"2020-01-19T03:30:52Z","type":"string"},"config_drive":{"description":"config drive信息。","type":"string"},"cpu_options":{"$ref":"#/definitions/CpuOptions","description":"自定义CPU选项。"},"created":{"description":"弹性云服务器创建时间。\n\n时间格式例如:2019-05-22T03:19:19Z","example":"2017-07-15T11:30:52Z","type":"string"},"description":{"description":"弹性云服务器的描述信息。","example":"ecs description","type":"string"},"enterprise_project_id":{"description":"弹性云服务器所属的企业项目ID。","example":"0","type":"string","x-open-region-cloud":"hc"},"fault":{"description":"弹性云服务器故障信息。\n\n可选参数,在弹性云服务器状态为ERROR且存在异常的情况下返回。","type":"object"},"flavor":{"$ref":"#/definitions/ServerFlavor","description":"弹性云服务器规格信息。"},"hostId":{"description":"弹性云服务器所在主机的主机ID。","example":"c7145889b2e3202cd295ceddb1742ff8941b827b586861fd0acedf64","type":"string"},"host_status":{"description":"nova-compute状态。\n\n- UP:服务正常\n- UNKNOWN:状态未知\n- DOWN:服务异常\n- MAINTENANCE:维护状态\n- 空字符串:弹性云服务器无主机信息","example":"UP","type":"string"},"hypervisor":{"$ref":"#/definitions/Hypervisor","description":"hypervisor信息。"},"id":{"description":"弹性云服务器ID,格式为UUID。","example":"4f4b3dfa-eb70-47cf-a60a-998a53bd6666","type":"string"},"image":{"$ref":"#/definitions/ServerImage","description":"弹性云服务器镜像信息。"},"key_name":{"description":"弹性云服务器使用的密钥对名称。","example":"KeyPair-test","type":"string"},"locked":{"description":"弹性云服务器是否为锁定状态。\n\n- true:锁定\n- false:未锁定","example":false,"type":"boolean"},"metadata":{"additionalProperties":{"type":"string"},"description":"弹性云服务器元数据。\n\n> 说明:\n> \n> 元数据包含系统默认添加字段和用户设置的字段。\n\n系统默认添加字段\n\n1. charging_mode\n云服务器的计费类型。\n\n- “0”:按需计费(即postPaid-后付费方式)。\n- “1”:按包年包月计费(即prePaid-预付费方式)。\"2\":竞价实例计费\n\n2. metering.order_id\n按“包年/包月”计费的云服务器对应的订单ID。\n\n3. metering.product_id\n按“包年/包月”计费的云服务器对应的产品ID。\n\n4. vpc_id\n云服务器所属的虚拟私有云ID。\n\n5. EcmResStatus\n云服务器的冻结状态。\n\n- normal:云服务器正常状态(未被冻结)。\n- freeze:云服务器被冻结。\n\n> 当云服务器被冻结或者解冻后,系统默认添加该字段,且该字段必选。\n\n6. metering.image_id\n云服务器操作系统对应的镜像ID\n\n7.  metering.imagetype\n镜像类型,目前支持:\n\n- 公共镜像(gold)\n- 私有镜像(private)\n- 共享镜像(shared)\n\n8. metering.resourcespeccode\n云服务器对应的资源规格。\n\n9. image_name\n云服务器操作系统对应的镜像名称。\n\n10. os_bit\n操作系统位数,一般取值为“32”或者“64”。\n\n11. lockCheckEndpoint\n回调URL,用于检查弹性云服务器的加锁是否有效。\n\n- 如果有效,则云服务器保持锁定状态。\n- 如果无效,解除锁定状态,删除失效的锁。\n\n12. lockSource\n弹性云服务器来自哪个服务。订单加锁(ORDER)\n\n13. lockSourceId\n弹性云服务器的加锁来自哪个ID。lockSource为“ORDER”时,lockSourceId为订单ID。\n\n14. lockScene\n弹性云服务器的加锁类型。\n\n- 按需转包周期(TO_PERIOD_LOCK)\n\n15. virtual_env_type\n\n- IOS镜像创建虚拟机,\"virtual_env_type\": \"IsoImage\" 属性;\n- 非IOS镜像创建虚拟机,在19.5.0版本以后创建的虚拟机将不会添加virtual_env_type 属性,而在此之前的版本创建的虚拟机可能会返回\"virtual_env_type\": \"FusionCompute\"属性 。\n\n> virtual_env_type属性不允许用户增加、删除和修改。\n\n16. metering.resourcetype\n云服务器对应的资源类型。\n\n17. os_type\n操作系统类型,取值为:Linux、Windows。\n\n18. cascaded.instance_extrainfo\n系统内部虚拟机扩展信息。\n\n19. __support_agent_list\n云服务器是否支持企业主机安全、主机监控。\n\n- “hss”:企业主机安全\n-  “ces”:主机监控\n\n20. agency_name\n委托的名称。\n\n委托是由租户管理员在统一身份认证服务(Identity and Access Management,IAM)上创建的,可以为弹性云服务器提供访问云服务的临时凭证。","type":"object","x-huawei-extraAnnotation":""},"name":{"description":"弹性云服务器名称。","example":"ecs-test-server","type":"string"},"os-extended-volumes:volumes_attached":{"description":"挂载到弹性云服务器上的磁盘。","items":{"$ref":"#/definitions/ServerExtendVolumeAttachment"},"type":"array"},"os:scheduler_hints":{"$ref":"#/definitions/ServerSchedulerHints","description":"弹性云服务器调度信息"},"progress":{"description":"弹性云服务器进度。","example":0,"format":"int32","type":"integer"},"security_groups":{"description":"弹性云服务器所属安全组列表。","items":{"$ref":"#/definitions/ServerSecurityGroup"},"type":"array"},"security_options":{"$ref":"#/definitions/SecurityOptions","description":"安全启动信息。"},"status":{"description":"弹性云服务器状态。\n\n取值范围:\n\nACTIVE、BUILD、DELETED、ERROR、HARD_REBOOT、MIGRATING、PAUSED、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、SHELVED、SHELVED_OFFLOADED、SOFT_DELETED、SUSPENDED、VERIFY_RESIZE\n\n弹性云服务器状态说明请参考[云服务器状态](https://support.huaweicloud.com/api-ecs/ecs_08_0002.html)","example":"ACTIVE","type":"string"},"sys_tags":{"description":"弹性云服务器系统标签。","items":{"$ref":"#/definitions/ServerSystemTag"},"type":"array"},"tags":{"description":"弹性云服务器标签。","items":{"type":"string"},"type":"array"},"tenant_id":{"description":"弹性云服务器所属租户ID,即项目id,和project_id表示相同的概念,格式为UUID。","example":"743b4c0428d94531b9f2add666646666","type":"string"},"updated":{"description":"弹性云服务器更新时间。\n\n时间格式例如:2019-05-22T03:30:52Z","example":"2019-05-22T03:30:52Z","type":"string"},"user_id":{"description":"创建弹性云服务器的用户ID,格式为UUID。","example":"05498fe56b8010d41f7fc01e280b6666","type":"string"}},"required":["OS-EXT-AZ:availability_zone","OS-EXT-SRV-ATTR:host","OS-EXT-SRV-ATTR:hostname","OS-EXT-SRV-ATTR:hypervisor_hostname","OS-EXT-SRV-ATTR:instance_name","OS-EXT-SRV-ATTR:kernel_id","OS-EXT-SRV-ATTR:launch_index","OS-EXT-SRV-ATTR:ramdisk_id","OS-EXT-SRV-ATTR:root_device_name","OS-EXT-STS:power_state","OS-EXT-STS:task_state","OS-EXT-STS:vm_state","OS-SRV-USG:launched_at","OS-SRV-USG:terminated_at","accessIPv4","accessIPv6","addresses","config_drive","created","flavor","hostId","host_status","id","image","key_name","locked","metadata","name","os-extended-volumes:volumes_attached","security_groups","status","tenant_id","updated","user_id","auto_terminate_time"]},"ServerExtendVolumeAttachment":{"description":"挂载到弹性云服务器上的磁盘。","properties":{"bootIndex":{"description":"启动标识,“0”代表启动盘,“-1“代表非启动盘。","example":"0","type":"string"},"delete_on_termination":{"description":"删弹性云服务器时是否一并删除该磁盘。\n\n- true:是\n- false:否\n微版本2.3及以上版本支持。","example":"false","type":"string"},"device":{"description":"云硬盘挂载盘符,即磁盘挂载点。","example":"/dev/vda","type":"string"},"id":{"description":"磁盘ID,格式为UUID。","example":"9aaa13b6-e739-41cc-9b53-0577a8a76666","type":"string"}},"required":["delete_on_termination","device","id"]},"ServerFlavor":{"description":"弹性云服务器规格信息。","properties":{"asic_accelerators":{"description":"该云服务器规格对应的ASIC设备。","items":{"$ref":"#/definitions/ASICAcceleratorInfo"},"type":"array"},"disk":{"description":"该云服务器规格对应要求系统盘大小,0为不限制。此字段在本系统中无效。","example":"0","type":"string"},"gpus":{"description":"该云服务器规格对应的GPU设备。","items":{"$ref":"#/definitions/GpuInfo"},"type":"array"},"id":{"description":"弹性云服务器规格ID。","example":"s3.xlarge.4","type":"string"},"name":{"description":"弹性云服务器规格名称。","example":"s3.xlarge.4","type":"string"},"ram":{"description":"该云服务器规格对应的内存大小,单位为MB。","example":"16384","type":"string"},"vcpus":{"description":"该云服务器规格对应的CPU核数。","example":"4","type":"string"}},"required":["disk","id","name","ram","vcpus","gpus","asic_accelerators"]},"ServerImage":{"description":"弹性云服务器镜像信息。","properties":{"id":{"description":"镜像id","example":"04c6329c-ad97-4b0e-be4d-2d8e2dce6666","type":"string"}},"required":["id"]},"ServerSchedulerHints":{"description":"弹性云服务器调度信息。","properties":{"dedicated_host_id":{"description":"专属主机ID。\n\n此属性仅在tenancy值为dedicated时有效。\n\n不指定此属性,系统将自动分配租户可自动放置弹性云服务器的专属主机。\n\n创建与查询此值均有效。","items":{"description":"","type":"string"},"type":"array","x-admin":"False","x-internal":"False"},"group":{"description":"反亲和性组信息。\n\nUUID格式。","items":{"type":"string"},"type":"array","x-huawei-extraAnnotation":""},"tenancy":{"description":"在专属主机或共享池中创建弹性云服务器。默认为在共享池创建。值为: shared或dedicated。\n\n- shared:表示共享池。\n- dedicated:表示专属主机。\n\n创建与查询此值均有效。","items":{"description":"","type":"string"},"type":"array","x-admin":"False","x-internal":"False"}}},"ServerSecurityGroup":{"description":"弹性云服务器所属安全组列表。","properties":{"id":{"description":"安全组ID。","type":"string","x-huawei-extraAnnotation":""},"name":{"description":"安全组名称或者UUID。","example":"sg-666","type":"string"}},"required":["id","name"]},"ServerSystemTag":{"description":"弹性云服务器系统标签。","properties":{"key":{"description":"系统标签的Key值。","type":"string"},"value":{"description":"系统标签的value值。","type":"string"}}},"ShowServerResponseBody":{"description":"This is a auto create Response Object","properties":{"server":{"$ref":"#/definitions/ServerDetail","description":"弹性云服务器详细信息"}},"required":["server"]}},"description":null,"group_id":"395cf9dd07ff44ddb50f92797b2a85de","host":"ecs.cn-north-4.myhuaweicloud.com","id":"55d2abdfe3764bf7aeb21344eab78f62","info_version":"v2","method":"get","name":"ShowServer","parameters":{"X-Auth-Token":{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},"project_id":{"description":"项目ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},"server_id":{"description":"云服务器ID。","in":"path","name":"server_id","required":true,"type":"string","x-example":"e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67"}},"paths":{"/v1/{project_id}/cloudservers/{server_id}":{"get":{"consumes":[],"deprecated":false,"description":"查询弹性云服务器的详细信息。\n\n该接口支持查询弹性云服务器的计费方式,以及是否被冻结。","operationId":"ShowServer","parameters":[{"$ref":"#/parameters/project_id"},{"$ref":"#/parameters/server_id"},{"$ref":"#/parameters/X-Auth-Token"}],"produces":[],"responses":{"200":{"description":"OK","examples":{"application/json":{"server":{"OS-DCF:diskConfig":"AUTO","OS-EXT-AZ:availability_zone":"cn-north-1c","OS-EXT-SRV-ATTR:host":"pod01.cn-north-1c","OS-EXT-SRV-ATTR:hostname":"ecs-test","OS-EXT-SRV-ATTR:hypervisor_hostname":"nova022@36","OS-EXT-SRV-ATTR:instance_name":"instance-0048a91b","OS-EXT-SRV-ATTR:kernel_id":"","OS-EXT-SRV-ATTR:launch_index":0,"OS-EXT-SRV-ATTR:ramdisk_id":"","OS-EXT-SRV-ATTR:reservation_id":"r-3zhpg60n","OS-EXT-SRV-ATTR:root_device_name":"/dev/vda","OS-EXT-SRV-ATTR:user_data":"IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRMRDdOT2IkdjdxQTRseTEzMWREMlBVYkYzbE5VOWNJNy5sYmpqcUI0LnUzNk9BWmM3N1dqSFRuOXdTVU1qZXoxWXdtQXBvUHVSSFhWcTluR3BsdkVlcEtnNmY3ODEnIHwgY2hwYXNzd2QgLWU7","OS-EXT-STS:power_state":4,"OS-EXT-STS:task_state":null,"OS-EXT-STS:vm_state":"stopped","OS-SRV-USG:launched_at":"2019-07-15T11:31:09.000000","OS-SRV-USG:terminated_at":null,"accessIPv4":"","accessIPv6":"","addresses":{"140fd038-c4ae-4c32-ac07-34b525eb6b95":[{"OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:09:31:dc","OS-EXT-IPS:port_id":"4b5fe243-2f5f-4c68-9eb2-8af3a5368bea","OS-EXT-IPS:type":"fixed","addr":"192.168.0.219","version":"4"}]},"auto_terminate_time":"2021-01-12T23:34:02Z","config_drive":"","created":"2019-07-15T11:30:52Z","description":"zbo-test","enterprise_project_id":"0","fault":null,"flavor":{"asic_accelerators":[],"disk":"0","gpus":[],"id":"s3.xlarge.4","name":"s3.xlarge.4","ram":"16384","vcpus":"4"},"hostId":"31397656d6b318d01431f60c481d8425dc58eb421d237a385ceb80ee","host_status":"UP","id":"0f58c8dc-4a78-42e6-9811-565679de8e9e","image":{"id":"04c6329c-ad97-4b0e-be4d-2d8e2dce8427"},"key_name":null,"locked":false,"metadata":{"agency_name":"zbo-test-ecs","cascaded.instance_extrainfo":"pcibridge:1","charging_mode":"0","image_name":"CentOS 7.5 64bit","metering.image_id":"04c6329c-ad97-4b0e-be4d-2d8e2dce8427","metering.imagetype":"gold","metering.resourcespeccode":"s3.xlarge.4.linux","metering.resourcetype":"1","os_bit":"64","os_type":"Linux","vpc_id":"140fd038-c4ae-4c32-ac07-34b525eb6b95","zbo":"test"},"name":"ecs-test","os-extended-volumes:volumes_attached":[{"bootIndex":"0","delete_on_termination":"true","device":"/dev/vda","id":"2f5b14ed-2889-4d92-aeab-f03771f827a5"}],"os:scheduler_hints":{"group":["be4204e7-0b04-4e14-9782-c5f574917fdf"]},"progress":null,"security_groups":[{"name":"sg-1e22"}],"status":"SHUTOFF","sys_tags":[{"key":"_sys_enterprise_project_id","value":"0"}],"tags":["test"],"tenant_id":"743b4c0428d94531b9f2add666646666","updated":"2019-08-13T01:21:02Z","user_id":"05498fe56b8010d41f7fc01e280b6666"}}},"schema":{"$ref":"#/definitions/ShowServerResponseBody"}}},"summary":"查询云服务器详情","tags":["生命周期管理"],"x-apiexplorer-hide":"false","x-constraint":"无","x-first-open-time":"2018-3-30","x-hybridcloud":"true","x-is-registered":"Y","x-name":"查询云服务器详情","x-open-region-cloud":"hc,hk","x-order":4,"x-publishpath":"","x-registered_to":"apicom","x-request-examples-1":"GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}","x-request-examples-description-1":"","x-request-examples-text-1":"GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}","x-request-examples-url-1":"","x-scope":"Commercial","x-source":"SelfDeveloped","x-support-sdk":"Y","x-version":"v1"}}},"product_short":"ECS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询云服务器详情","tags":"生命周期管理","uri":null,"version":"2.0"}