华为云用户手册

响应示例 { "volumeAttachments": [ { "device": "/dev/sdd", "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803" }, { "device": "/dev/sdc", "id": "a26887c6-c47b-4654-abb5-dfadf7d3f804", "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f804" } ] }

响应示例 { "server_group": { "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9", "name": "test", "policies": [ "anti-affinity" ], "members": [], "metadata": {} } }

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 server_group 是 Object 弹性云服务器组信息，参考表3。 表3 server_group参数信息 参数 是否必选 参数类型 描述 name 是 String 弹性云服务器组名称，长度大于0小于256字节。 policies 是 Array of strings 与云服务器组关联的策略名称列表。包括： anti-affinity：此组中的弹性云服务器必须安排到不同的主机。 说明： 推荐使用创建云服务器组。

SSH密钥管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 创建和导入SSH密钥（OpenStack原生）（废弃） POST /v2.1/{project_id}/os-keypairs ecs:serverKeypairs:create - √ × × × 查询SSH密钥详情（OpenStack原生）（废弃） GET /v2.1/{project_id}/os-keypairs/{keypair_name} ecs:serverKeypairs:get - √ × × × 查询SSH密钥列表（OpenStack原生）（废弃） GET /v2.1/{project_id}/os-keypairs ecs:serverKeypairs:list - √ × × × 删除SSH密钥（OpenStack原生）（废弃） DELETE /v2.1/{project_id}/os-keypairs/{keypair_name} ecs:serverKeypairs:delete - √ × × × 父主题： 权限和授权项

请求示例 批量删除指定云服务器的2组标签。 POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags/action { "action": "delete", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value3" } ] }

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 tags 是 Array of objects 标签列表，详情参见表3 action 是 String 操作标识（仅支持小写）：delete（删除） 表3 tags 字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 不能为空。 同一资源的key值不能重复。 value 否 String 值。 可以为空字符串。

响应示例 { "availabilityZoneInfo": [{ "zoneState": { "available": true }, "hosts": null, "zoneName": "cn-east-2a" //请以实际返回的可用区名称为准 }, { "zoneState": { "available": true }, "hosts": null, "zoneName": "cn-east-2b" //请以实际返回的可用区名称为准 }] }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 availabilityZoneInfo Array of objects 可用区信息，参考表3。 表3 availabilityZoneInfo参数信息 参数 参数类型 描述 zoneState Object 可用区的状态，参考表4。 hosts List 该字段的值为null zoneName String 可用区的名称 表4 zoneState参数信息 参数 参数类型 描述 available Boolean 可用区状态

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 keypairs Array of objects 密钥信息列表，详情请参见表3。 表3 keypairs字段数据结构说明 参数 参数类型 描述 keypair Object 密钥信息详情，详情请参见表4。 表4 keypair字段数据结构说明 参数 参数类型 描述 fingerprint String 密钥对应指纹信息。 name String 密钥名称。 type String 密钥类型，默认“ssh” 微版本2.2及以上版本支持。 public_key String 密钥对应publicKey信息。

响应示例 { "keypairs": [ { "keypair": { "fingerprint": "15:b0:f8:b3:f9:48:63:**:**:**:**:**:**:**:**:**", "name": "keypair-601a2305-4f25-41ed-89c6-2a966fc8027a", "type": "ssh", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79Kkl****************************************************************************************************************************************************** Generated-by-Nova\n" } } ] }

云服务器组管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 删除云服务器组 DELETE /v1/{project_id}/cloudservers/os-server-groups/{server_group_id} ecs:cloudServers:deleteServerGroup - √ √ × × 创建云服务器组 POST /v1{project_id}/cloudservers/os-server-groups ecs:cloudServers:createServerGroup - √ √ × × 添加云服务器云主机组成员 POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action ecs:cloudServers:addServerGroupMember - √ √ × × 删除云服务器云主机组成员 POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action ecs:cloudServers:deleteServerGroupMember - √ √ × × 查询云服务器组列表 GET /v1/{project_id}/cloudservers/os-server-groups ecs:cloudServers:list - √ √ × × 查询云服务器组详情 GET /v1/{project_id}/cloudservers/os-server-groups/{server_group_id} ecs:cloudServers:get ecs:cloudServers:showServerGroup - √ √ × × 创建云服务器组（OpenStack原生）（废弃） POST /v2.1/{project_id}/os-server-groups ecs:serverGroups:manage - √ × × × 查询云服务器组列表（OpenStack原生）（废弃） GET /v2.1/{project_id}/os-server-groups ecs:serverGroups:manage - √ × × × 查询云服务器组详情（OpenStack原生）（废弃） GET /v2.1/{project_id}/os-server-groups/{server_group_id} ecs:serverGroups:manage - √ × × × 删除云服务器组（OpenStack原生）（废弃） DELETE /v2.1/{project_id}/os-server-groups/{server_group_id} ecs:serverGroups:manage - √ × × × 父主题： 权限和授权项

请求示例 POST https://{endpoint}/v1/{project_id}/servers/{server_id}/tags/action { "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value3" } ] }

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 tags 是 Array of objects 标签列表 action 是 String 操作标识（仅支持小写）：create（创建） 表3 resource_tag 字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 不能为空。 对于同一资源键值唯一。 长度不超过36个字符。 标签的键必须唯一且输入不能为空。 value 是 String 值。 长度不超过43个字符。

生命周期管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 创建云服务器 POST /v1.1/{project_id}/cloudservers 创建云服务器时新创建弹性公网IP ecs:cloudServers:createServers 创建云服务器时绑定已有的弹性公网IP ecs:cloudServers:createServers 创建云服务器时新创建弹性公网IP vpc:publicIps:create 创建云服务器时绑定已有的弹性公网IP vpc:publicIps:update √ √ × √ 创建云服务器（按需） POST /v1/{project_id}/cloudservers 创建云服务器时新创建弹性公网IP ecs:cloudServers:createServers 创建云服务器时绑定已有的弹性公网IP ecs:cloudServers:createServers 创建云服务器时新创建弹性公网IP vpc:publicIps:create 创建云服务器时绑定已有的弹性公网IP vpc:publicIps:update √ √ × √ 删除云服务器 POST /v1/{project_id}/cloudservers/delete ecs:cloudServers:deleteServers - √ √ √ √ 查询云服务器详情列表 GET /v1/{project_id}/cloudservers/detail ecs:cloudServers:list - √ √ × × 查询云服务器详情 GET /v1/{project_id}/cloudservers/{server_id} ecs:cloudServers:showServer - √ √ × × 修改弹性云服务器 PUT /v1/{project_id}/cloudservers/{server_id} ecs:cloudServers:updateServer - √ √ √ √ 查询云服务器详情列表（OpenStack原生）（废弃） GET /v2.1/{project_id}/servers/detail ecs:servers:list ecs:servers:get ecs:serverVolumes:use ecs:diskConfigs:use ecs:securityGroups:use ecs:serverKeypairs:get vpc:securityGroups:get vpc:securityGroupRules:get vpc:networks:get vpc:subnets:get vpc:ports:get vpc:routers:get √ × × × 查询云服务器列表（OpenStack原生）（废弃） GET /v2.1/{project_id}/servers ecs:servers:list - √ × × × 查询云服务器详情（OpenStack原生）（废弃） GET /v2.1/{project_id}/servers/{server_id} ecs:servers:get ecs:serverVolumes:use ecs:diskConfigs:use ecs:securityGroups:use ecs:serverKeypairs:get vpc:securityGroups:get vpc:securityGroupRules:get vpc:networks:get vpc:subnets:get vpc:ports:get vpc:routers:get √ × × × 创建云服务器（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers POST /v2.1/{project_id}/os-volumes_boot ecs:servers:create ecs:servers:get ecs:serverInterfaces:use ecs:serverInterfaces:get ecs:flavors:get ecs:securityGroups:use evs:volumes:list evs:volumes:get evs:volumes:create evs:volumes:attach evs:volumes:manage vpc:securityGroups:get vpc:networks:get vpc:networks:update vpc:subnets:get vpc:subnets:update vpc:ports:create vpc:ports:update vpc:ports:get vpc:ports:delete vpc:networks:create vpc:subnets:create vpc:routers:get vpc:routers:update ims:images:list ims:images:get √ × × × 删除云服务器（OpenStack原生）（废弃） DELETE /v2.1/{project_id}/servers/{server_id} ecs:servers:delete - √ × × × 修改云服务器（OpenStack原生）（废弃） PUT /v2.1/{project_id}/servers/{server_id} ecs:servers:update ecs:servers:get √ × × × 父主题： 权限和授权项

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 migrate 是 Object 迁移云服务器，详情请参见表3。 将弹性云服务器从专属 主机迁移 至公共资源池时，migrate字段值为null。 表3 migrate数据结构说明 参数 是否必选 参数类型 描述 dedicated_host_id 否 String 专属主机ID。 当弹性云服务器从公共资源池迁移至专属主机上，或者弹性云服务器在专属主机之间迁移时，该字段生效。

请求示例 迁移公共资源池的云服务器迁移至ID为“459a2b9d-804a-4745-ab19-a113bb1b4ddc”的专属主机。 POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/migrate { "migrate": { "dedicated_host_id": "459a2b9d-804a-4745-ab19-a113bb1b4ddc" } }

功能介绍 将部署在专属主机上的弹性云服务器迁移至其他专属主机。 将部署在专属主机上的弹性云服务器迁移至公共资源池，即不再部署在专属主机上。 将公共资源池的弹性云服务器迁移至专属主机上，成为专属主机上部署的弹性云服务器。 本接口为异步接口，当前冷迁移弹性云服务器请求下发成功后会返回job_id，此时冷迁移弹性云服务器并没有立即完成，需要通过调用查询任务的执行状态查询job状态，当Job状态为 SUC CES S 时代表云服务器冷迁移成功。 在云服务器不跨NUMA情况下，可能由于单NUMA资源不足，导致迁移失败。

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 block_device 是 Object 更新云服务器挂载的单个磁盘信息，参考表3。 表3 block_device数据结构说明 参数 是否必选 参数类型 描述 delete_on_termination 是 Boolean 弹性云服务器释放时，磁盘随实例释放策略。 true：磁盘随实例释放。 false：磁盘不随实例释放。 说明： 不支持修改包年/包月计费模式的磁盘。 不支持修改共享盘。 不支持修改系统盘。

响应消息 响应参数如表4所示。 表4 响应参数 参数 参数类型 描述 security_group Object security_group对象，参见表5。 表5 响应参数security_group的对象 参数 参数类型 描述 description String 安全组描述信息 id String 安全组ID，UUID格式 name String 安全组名字 rules Array of objects 安全组规则列表，当前该列表为空列表 tenant_id String 租户ID或项目ID

响应示例 { "security_group": { "rules": [], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "description": "desc-sg", "id": "81f1d23b-b1e2-42cd-bdee-359b4a065a42", "name": "test-sg" } }

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 security_group 是 Object security_group对象，在消息体中指定，请参见表3。 表3 请求参数security_group的对象 参数 是否必选 参数类型 描述 name 否 String 安全组名称，长度0-255。 description 否 String 安全组描述，长度0-255。

响应示例 { "attachableQuantity": { "free_scsi": 23, "free_blk": 15, "free_disk": 23 }, "volumeAttachments": [ { "pciAddress": "0000:02:01.0", "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803", "device": "/dev/vda", "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", "size": 40, "bootIndex": 0, "bus":"virtio" }, { "pciAddress": "0000:02:02.0", "volumeId": "a26887c6-c47b-4654-abb5-asdf234r234r", "device": "/dev/vdb", "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", "id": "a26887c6-c47b-4654-abb5-asdf234r234r", "size": 10, "bootIndex": 1, "bus":"virtio" } ] }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 volumeAttachments Array of objects 云服务器挂载信息列表，更多信息请参见表3。 attachableQuantity Object 云服务器可挂载磁盘数量，更多信息请参见表4。 表3 volumeAttachments参数 参数 参数类型 描述 serverId String 弹性云服务器ID，UUID格式。 volumeId String 云硬盘ID，UUID格式。 id String 挂载ID，与云硬盘ID相同。 UUID格式。 size Integer 云磁盘大小，单位GB。 device String 云硬盘挂载盘符，即控制台显示的磁盘挂载点。 如需查询云服务器内部的磁盘挂载点，请参见控制台与弹性云服务器内部之间磁盘挂载点的对应关系。 pciAddress String pci地址。 bootIndex Integer 云硬盘启动顺序。 0为系统盘 非0为数据盘 bus String 磁盘总线类型 。 取值范围：virtio、scsi 表4 attachableQuantity参数 参数 参数类型 描述 free_scsi Integer 云服务器可挂载scsi类型磁盘数量。 free_blk Integer 云服务器可挂载virtio_blk类型磁盘数量。 free_disk Integer 云服务器可挂载磁盘总数。

响应示例 { "interfaceAttachment": { "port_state": "ACTIVE", "fixed_ips": [ { "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", "ip_address": "192.168.1.3" } ], "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", "port_id": "ce531f90-199f-48c0-816c-13e38010b442", "mac_addr": "fa:16:3e:4c:2c:30" } }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 interfaceAttachment Object 云服务器网卡信息列表，详情请参见表3。 表3 interfaceAttachment字段数据结构说明 参数 参数类型 描述 port_state String 网卡端口状态。 fixed_ips Array of objects 网卡IP信息列表，详情请参见表4。 net_id String 网卡端口所属网络ID。 port_id String 网卡端口ID。 mac_addr String 网卡Mac地址信息。 表4 fixed_ips字段数据结构说明 参数 参数类型 描述 subnet_id String 网卡所属子网ID。 ip_address String 网卡IP地址。

响应示例 { "snapshot": { "createdAt": "2016-05-20T16:54:14.981520", "displayDescription": null, "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583", "displayName": "test", "size": 1, "status": "creating", "volumeId": "ba5730ea-8621-4ae8-b702-ff0ffc12c209" } }

响应消息 响应参数 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 id String 卷快照ID，UUID格式 status String 卷快照的状态 displayName String 卷快照名称 displayDescription String 卷快照描述信息 createdAt String 卷快照创建时间 volumeId String 快照所属的卷ID，UUID格式。 size Integer 卷快照大小

响应消息 响应参数如表3所示。 表3 响应参数 参数 是否必选 参数类型 描述 floating_ip 是 Object floating_ip对象，参见表4。 表4 floating_ip对象 参数 是否必选 参数类型 描述 fixed_ip 是 String 私有IP地址 id 是 String 浮动IP的ID，UUID格式 instance_id 是 String 被绑定主机的ID，UUID格式 ip 是 String 浮动IP的ip地址 pool 是 String 网络资源池名称，用于分配浮动IP

响应示例 { "flavors": [ { "id": "c3.15xlarge.2", "name": "c3.15xlarge.2", "vcpus": "60", "ram": 131072, "disk": "0", "swap": "", "links": [ { "rel": "self", "href": "https://compute-ext.region.example.com/v1.0/743b4c0428d94531b9f2add666642e6b/flavors/c3.15xlarge.2", "type": null }, { "rel": "bookmark", "href": "https://compute-ext.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.15xlarge.2", "type": null } ], "OS-FLV-EXT-DATA:ephemeral": 0, "rxtx_factor": 1, "OS-FLV-DISABLED:disabled": false, "rxtx_quota": null, "rxtx_cap": null, "os-flavor-access:is_public": true, "extra_specs": { "ecs:virtualization_env_types": "CloudCompute", "ecs:generation": "c3", "ecs:performancetype": "computingv3", "resource_type": "IOoptimizedC3_2" } } ] }

响应消息 响应参数如表3所示。 表3 响应参数 参数 是否必选 参数类型 描述 flavors 是 Array of objects 云服务器规格列表。 详情请参见表4。 表4 flavors数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云服务器规格ID。 name 是 String 云服务器规格名称。 vcpus 是 Integer 云服务器规格对应要求的CPU核数。 ram 是 Integer 云服务器规格对应要求的内存大小，单位为MB。 disk 是 Integer 云服务器规格对应要求的系统盘大小。 当前未使用该参数，缺省值为0。 swap 否 String 云服务器规格对应要求的交换分区大小。 当前未使用该参数，缺省值为""。 OS-FLV-EXT-DATA:ephemeral 是 Integer 扩展属性，临时盘大小。 当前未使用该参数，缺省值为0。 OS-FLV-DISABLED:disabled 是 Boolean 扩展属性，指定规格是否可用。 true：不可用 false：可用 说明： 当前未使用该参数。 rxtx_factor 是 Float 扩展属性。 说明： 当前未使用该参数。 rxtx_quota 是 String 云服务器可使用网络带宽的软限制。 当前未使用该参数，缺省值为null。 rxtx_cap 是 String 云服务器可使用网络带宽的硬限制。 当前未使用该参数，缺省值为null。 os-flavor-access:is_public 是 Boolean 扩展属性，flavor是否给所有租户使用。 true：表示给所有租户使用。 false：表示给指定租户使用。 缺省值为“true”。 links 是 Array of objects 规格相关快捷链接地址。 详情请参见表5。 extra_specs 是 Array of objects 云服务器规格的扩展字段。 详情请参见表6。 表5 links字段数据结构说明 参数 是否必选 参数类型 描述 rel 是 String 快捷链接标记名称。 href 是 String 对应快捷链接。 type 是 String 快捷链接类型，当前接口未使用，缺省值为null。