华为云用户手册

响应消息 响应参数如表4所示。 表4 响应参数 参数 参数类型 描述 remote_console Object 弹性云服务器获取远程登录地址，参考表5。 表5 remote_console参数信息 参数 参数类型 描述 type String 远程登录的类型。 protocol String 远程登录的协议。 url String 远程登录的url。 该url有效时间10min，超过10min请重新获取。

请求示例 获取指定云服务器的VNC远程登录地址。 POST https://{endpoint}/v2.1/13c67a214ced4afb88d911ae4bd5721a/servers/47bc79ae-df61-4ade-9197-283a74e5d70e/remote-consoles { "remote_console" : { "type" : "novnc", "protocol": "vnc" } }

请求示例 删除云服务器的ID为“d32019d3-bc6e-4319-9c1d-6722fc136a23”的网卡。 POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics/delete { "nics": [ { "id": "d32019d3-bc6e-4319-9c1d-6722fc136a23" } ] }

标签类型介绍 标签管理接口包括两类：“一维标签管理接口”和“二维标签管理接口”，其中： 一维标签：指标签的格式是字符串。一维标签全部是OpenStack原生接口，详情请参见标签管理（OpenStack Nova API）。 二维标签：标签由Key和Value组成。二维标签全部是E CS 接口，具体使用请参见本节内容。 在执行增、删、改、查等操作时，建议使用同类标签管理接口进行操作，不要混用。 建议使用二维标签。 父主题： 标签管理

响应示例 { "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ] }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 id String 卷ID，UUID格式 displayName String 卷名称 status String 卷状态 attachments Array of objects 挂卷信息 availabilityZone String 卷所属AZ createdAt String 创建卷的时间 displayDescription String 卷描述 volumeType String 卷类型 snapshotId String 快照ID metadata Object 元数据 size Integer 卷大小

响应示例 { "volumes": [ { "status": "available", "attachments": [{}], "availabilityZone": "nova", "createdAt": "2016-05-20T07:57:56.299000", "displayDescription": null, "volumeType": null, "dispalyName": "test", "snapshotId": null, "metadata": {}, "id": "70b14513-faad-4646-b7ab-a065cef282b4", "size": 1 } ] }

响应示例 { "addresses": { "云服务器所在网络名称": [ { "version": 4, "addr": "10.176.42.16" }, { "version": 6, "addr": "::babe:10.176.42.16" } ] } }

响应消息 响应参数如表2所示。 表2 响应参数 参数 是否必选 参数类型 描述 addresses 是 Object 云服务器网络信息，参考表3。 表3 addresses参数结构说明 参数 是否必选 参数类型 描述 云服务器所在网络名称 是 Array of objects 云服务器所在网络，内嵌云服务器网络详细信息，格式参见表4。 表4 云服务器网络参数结构说明 属性 类型 CRUD 默认值 约束 备注 version Integer R 不涉及 4 or 6 IP地址版本，IPv4或者IPv6 addr String R 不涉及 IP地址格式 IP地址

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 volumeAttachment Object 云服务器挂载信息，更多信息请参见表3。 表3 volumeAttachment参数 参数 参数类型 描述 serverId String 弹性云服务器ID，UUID格式。 volumeId String 云硬盘ID，UUID格式。 id String 挂载ID，与云硬盘ID相同。 UUID格式。 size Integer 云硬盘大小，单位GB。 device String 云硬盘挂载盘符，即磁盘挂载点。 pciAddress String pci地址。 bootIndex Boolean 云硬盘启动顺序。 0为系统盘。 非0为数据盘 bus String 磁盘总线类型 。 取值范围：virtio、scsi

响应示例 { "volumeAttachment": { "pciAddress": "0000:02:01.0", "volumeId": "a26887c6-c47b-4654-abb5-asdf234r234r", "device": "/dev/vda", "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", "id": "a26887c6-c47b-4654-abb5-asdf234r234r", "size": "40", "bootIndex": 0, "bus":"virtio" } }

响应示例 { "volume": { "status": "available", "attachments": [{}], "availabilityZone": "nova", "createdAt": "2016-05-20T07:57:56.299000", "displayDescription": null, "volumeType": null, "dispalyName": "test", "snapshotId": null, "metadata": {}, "id": "70b14513-faad-4646-b7ab-a065cef282b4", "size": 1 } }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 id String 卷ID，UUID格式 displayName String 卷名称 status String 卷状态 attachments Array of objects 挂卷信息 availabilityZone String 卷所属AZ createdAt String 创建卷的时间 displayDescription String 卷描述 volumeType String 卷类型 snapshotId String 快照ID metadata Object 元数据 size Integer 卷大小

网卡管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 云服务器网卡配置私有IP PUT /v1/{project_id}/cloudservers/nics/{nic_id} ecs:cloudServerNics:update - √ × × × 批量删除云服务器网卡 POST /v1/{project_id}/cloudservers/{server_id}/nics/delete ecs:cloudServerNics:delete - √ √ √ √ 批量添加云服务器网卡 POST /v1/{project_id}/cloudservers/{server_id}/nics ecs:cloudServers:addNics - √ √ √ √ 查询云服务器网卡信息 GET /v1/{project_id}/cloudservers/{server_id}/os-interface ecs:cloudServers:listServerInterfaces - √ √ √ √ 云服务器切换虚拟私有网络 POST /v1/{project_id}/cloudservers/{server_id}/changevpc ecs:cloudServers:changeVpc - √ √ √ √ 更新云服务器指定网卡属性 POST /v1/{project_id}/cloudservers/{server_id}/os-interface/{port_id}/change-network-interface ecs:cloudServers:changeNetworkInterface - √ √ √ √ 添加云服务器网卡（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers/{server_id}/os-interface ecs:serverInterfaces:use ecs:servers:get ecs:serverInterfaces:get vpc:networks:get vpc:networks:update vpc:subnets:get vpc:subnets:update vpc:ports:create vpc:ports:update vpc:ports:get vpc:networks:create vpc:subnets:create vpc:routers:get vpc:routers:update √ × × × 删除云服务器网卡（OpenStack原生）（废弃） DELETE /v2.1/{project_id}/servers/{server_id}/os-interface/{id} ecs:serverInterfaces:use ecs:serverInterfaces:get ecs:servers:get vpc:networks:create vpc:subnets:create vpc:networks:get vpc:networks:update vpc:subnets:get vpc:subnets:update vpc:ports:delete vpc:ports:update vpc:ports:get vpc:routers:get vpc:routers:update √ × × × 查询云服务器网卡信息（OpenStack原生）（废弃） GET /v2.1/{project_id}/servers/{server_id}/os-interface ecs:serverInterfaces:get vpc:ports:get √ × × × 查询指定云服务器网卡信息（OpenStack原生）（废弃） GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id} ecs:serverInterfaces:get vpc:ports:get √ × × × 父主题： 权限和授权项

状态管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 切换弹性云服务器操作系统 POST /v2/{project_id}/cloudservers/{server_id}/changeos ecs:cloudServers:changeOS - √ √ √ √ 切换弹性云服务器操作系统 POST /v1/{project_id}/cloudservers/{server_id}/changeos ecs:cloudServers:changeOS - √ √ √ √ 重装弹性云服务器操作系统 POST /v2/{project_id}/cloudservers/{server_id}/reinstallos ecs:cloudServers:rebuild - √ √ √ √ 重装弹性云服务器操作系统 POST /v1/{project_id}/cloudservers/{server_id}/reinstallos ecs:cloudServers:rebuild - √ √ √ √ 变更云服务器规格（V1.1） POST /v1.1/{project_id}/cloudservers/{server_id}/resize ecs:cloudServers:resize - √ √ √ √ 变更云服务器规格（按需） POST /v1/{project_id}/cloudservers/{server_id}/resize ecs:cloudServers:resize - √ √ √ √ 冷迁移云服务器 POST /v1/{project_id}/cloudservers/{server_id}/migrate ecs:cloudServers:migrate - √ √ √ √ 启动云服务器（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers/{server_id}/action ecs:servers:start ecs:servers:list √ × × × 关闭云服务器（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers/{server_id}/action ecs:servers:stop ecs:servers:list √ × × × 重启云服务器（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers/{server_id}/action ecs:servers:reboot ecs:servers:list √ × × × 变更云服务器规格（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers/{server_id}/action ecs:servers:resize ecs:servers:list ecs:flavors:get ims:images:get evs:volumes:list evs:volumes:create evs:volumes:get evs:volumes:attach evs:volumes:detach evs:volumes:manage vpc:ports:get vpc:ports:update vpc:ports:create vpc:ports:delete √ × × × 锁定云服务器（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers/{server_id}/action ecs:servers:lock ecs:servers:list √ × × × 解锁云服务器（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers/{server_id}/action ecs:servers:unlock ecs:servers:list √ × × × 父主题： 权限和授权项

响应消息 响应参数如表4所示。 表4 响应参数 参数 是否必选 参数类型 描述 security_group 是 Object security_group对象，请参见表5。 表5 响应参数security_group对象 参数 是否必选 参数类型 描述 description 是 String 安全组描述信息。 长度不超过255个字符。 id 是 String 安全组ID，UUID格式。 name 是 String 安全组名称。 长度不超过255个字符。 rules 是 Array of objects 安全组规则列表，请参见表6。 tenant_id 是 String 租户ID或项目ID。 长度不超过255个字符。 表6 security_group_rule对象 参数 是否必选 参数类型 描述 parent_group_id 是 String 相关联的安全组ID，UUID格式。 ip_protocol 是 String 协议类型或直接指定IP协议号，取值可为icmp，tcp，udp或IP协议号。 from_port 是 Integer 起始端口，范围1-65535，且不大于to_port(icmp时，表示type，范围是0-255)。 to_port 是 Integer 终止端口，范围1-65535，且不小于from_port(icmp时，表示code，范围是0-255，且如果from_port为-1，to_port为-1表示任意ICMP报文)。 ip_range 是 Object 包含对端ip网段，cidr格式，参见表7。ip_range或者group参数的值为空。 group 是 Object 包括对端安全组的名称和对端安全组所属租户的租户ID，参见表8，ip_range或者group参数的值为空。 id 是 String 安全组规则ID，UUID格式。 表7 ip_range对象 参数 是否必选 参数类型 描述 cidr 是 String 对端IP网段，cidr格式。 长度不超过255个字符。 表8 group对象 参数 是否必选 参数类型 描述 tenant_id 是 String 对端安全组所属租户的租户ID。 name 是 String 对端安全组的名称。

响应示例 { "security_group": { "rules": [ { "from_port": null, "group": { "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "name": "test" }, "ip_protocol": null, "to_port": null, "parent_group_id": "3d02312d-0764-49c9-8244-2368ddce0045", "ip_range": {}, "id": "00dec0b6-8e96-4906-aadf-46cfe54cf5ef" } ], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "id": "3d02312d-0764-49c9-8244-2368ddce0045", "name": "test", "description": "description" } }

请求示例 PUT https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/3d02312d-0764-49c9-8244-2368ddce0045 { "security_group": { "name": "test", "description": "description" } }

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

响应消息 响应参数 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 volumeAttachments Array of objects 云服务器挂载信息列表，详情请参见表3。 表3 volumeAttachments字段数据结构说明 参数 参数类型 描述 device String 挂载目录。 id String 挂载资源ID。 serverId String 所属云服务器ID。 volumeId String 挂载云磁盘ID。

响应示例 { "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 可用区状态

响应示例 { "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" } } ] }

响应消息 响应参数如表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信息。