华为云用户手册

请求示例 批量挂载共享数据盘到ID为“a26887c6-c47b-4654-abb5-dfadf7d3f803”和“a26887c6-c47b-4654-abb5-dfadf7d3fa05”的云服务器。 POST https://{endpoint}/v1/{project_id}/batchaction/attachvolumes/{volume_id} { "serverinfo": [ { "server_id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", "device": "/dev/sdb" }, { "server_id": "a26887c6-c47b-4654-abb5-dfadf7d3fa05", "device": "/dev/sda" } ] }

请求示例 导入SSH密钥。 POST https://{endpoint}/v2.1/{project_id}/os-keypairs { "keypair": { "public_key": "ssh-rsaAAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpW*************************************************************************************************************************************************************************************************************************** Generated-by-Nova\\n\n", "type": "ssh", "name": "demo1", "user_id": "fake" } } 创建SSH密钥。 POST https://{endpoint}/v2.1/{project_id}/os-keypairs { "keypair": { "name": "demo" } }

响应消息 响应参数如表4所示。 表4 响应参数 参数 参数类型 描述 keypair Object SSH密钥信息，详情请参见表5。 表5 keypair字段数据结构说明 参数 参数类型 描述 fingerprint String 密钥对应指纹信息。 name String 密钥名称。 public_key String 密钥对应publicKey信息。 private_key String 密钥对应privateKey信息。 创建SSH密钥时，响应中包括private_key的信息。 导入SSH密钥时，响应中不包括private_key的信息。 user_id String 密钥所属用户ID。 type String 密钥类型，值为“ssh”或“x509”。 微版本2.2及以上版本支持。

响应示例 导入SSH密钥： { "keypair": { "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnE********************************************************************************************************************************************************************************************************************************************* Generated-by-Nova\\n\n", "user_id": "6fc0d2cbbfab40b199874b97097e913d", "name": "demo1", "fingerprint": "fc:47:b5:c3:7d:25:32:**:**:**:**:**:**:**:**:**" } } 创建SSH密钥： { "keypair": { "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnE********************************************************************************************************************************************************************************************************************************************* Generated-by-Nova\n", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEA1jYE8UGHgcyvS2MuCGpF+yLCJeY+c6kegVNhiWhIN0SunZUu\n6yhUIb8v1f9Xpivhk/+z/LqfVbDGfQ8ejwTi6MOaftv8BrDJcAyaVokPMzZxDIPr\nvwK/2YWBwDMihADjicSHJz6FIMXzXY/3ol1ffAGm7AXVAO0A99DoPBeAZp9pYov1\ng/Sm0EFY2+5Gwd4DSCaRk1HKF+92q6K6pKv6aWi0ZpsDCe20yBpfP9DFlNg8vnkw\ncjmgzG9obWwfo/GV8hLuzqKMtDWknfjzR79z2fTiFTu4HdZcqE0bwjCvxd+Ovs5m\nbZORAEkjseUYn50sJNzbboFY17PRjCXxSwUYmwIDAQABAoIBADNKQ+ywUA3YQLDA\nUqlZKOB09h+0/YccG13D5TrNaV0yaMz6h31u7pYV/RI0TXxQTXbuZt5AoR4Xca9I\nC30bImmxTDDL45CGi/T0T5AgyS7t/iuM+smFkwI2YVbv53fL7q9yCxpucdnjC95/\nNj/+M3qxupIQ42uRVAYCU1jwF6J6YLy/9UamrmVd4bWFRtT19O7uszUhHLqJOZXq\n3ItqnMyD5bSMkzMN+RxmZVXAPkBOonGVeBBInCjvHv23REkngX38zcUSc543H3Di\n4673helqSdMnI0/TgyfLQcNuOsfQcD02A**********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************\n-----END RSA PRIVATE KEY-----\n", "user_id": "6fc0d2cbbfab40b199874b97097e913d", "type": "ssh", "name": "demo", "fingerprint": "fc:47:b5:c3:7d:25:32:**:**:**:**:**:**:**:**:**" } }

请求消息 请求参数如表2所示。 创建SSH密钥时，只需要提交SSH密钥的name属性。导入SSH密钥时，才需要提交public_key属性。 表2 请求参数 参数 是否必选 参数类型 描述 keypair 是 Object 创建或导入的SSH密钥信息，详情请参见表3。 表3 keypair字段数据结构说明 参数 是否必选 参数类型 描述 public_key 否 String 导入的公钥信息。 建议导入的公钥长度不大于1024字节。 说明： 长度超过1024字节会导致云服务器注入该密钥失败。 type 否 String 密钥类型，值为“ssh”或“x509”。 微版本2.2及以上版本支持。 name 是 String 密钥名称。 新创建的密钥名称不能和已有密钥名称相同。 user_id 否 String 密钥的用户ID。 微版本2.10及以上版本支持。

租户配额管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 查询租户配额 GET /v1/{project_id}/cloudservers/limits ecs:cloudServerQuotas:get - √ √ × × 查询租户配额（OpenStack原生）（废弃） GET /v2.1/{project_id}/os-quota-sets/{project_id}?user_id={user_id} ecs:quotas:get - √ × × × 查询默认配额（OpenStack原生）（废弃） GET /v2.1/{project_id}/os-quota-sets/{project_id}/defaults ecs:quotas:get - √ × × × 父主题： 权限和授权项

响应示例 { "remote_console": { "url": "https://nova-novncproxy.az21.dc1.domainname.com:8002/vnc.auto.html?token=80fa7c8d-37fe-451e-8b08-bfbd9fb6a4df&lang=EN", "type": "novnc", "protocol": "vnc" } }

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

接口约束 使用此接口时，请指定微版本不低于2.6。 "微版本号": 通过Http请求头X-OpenStack-Nova-API-Version来或者OpenStack-API-Version添加。 示例：X-OpenStack-Nova-API-Version：2.6 或者OpenStack-API-Version：compute 2.6 获取的登录地址有效时间10min，超过10min请重新获取。

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

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

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

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

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

响应消息 响应参数如表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 卷大小

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

网卡管理 权限 对应的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 √ × × × 父主题： 权限和授权项

返回值 正常 返回值 说明 200 任务提交成功。 202 任务提交成功，当前系统繁忙，下发的任务会延迟处理。 204 任务提交成功。 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 提交任务类请求结果

操作步骤 查询弹性云服务器详情 接口相关信息 URI格式： GET /v1/{project_id}/cloudservers/{server_id} 详情请参见“查询云服务器详情”。 请求示例 GET https://{endpoint}/v1/743b4c0428d945316666666666666666/cloudservers/893c7791-f1df-4c3d-8383-3caae9656c62 {endpoint}信息请从地区和终端节点获取。 响应示例 { "server": { "fault": null, "id": "893c7791-f1df-4c3d-8383-3caae9656c62", "name": "ecs-test", "addresses": { "24bbb54c-659f-4141-8db9-a957e12b6ee8": [{ "version": "4", "addr": "192.168.0.16", "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:37:de:ee", "OS-EXT-IPS:type": "fixed", "OS-EXT-IPS:port_id": "390b39b0-9a77-4ec2-ae1e-3af358f78999" }, { "version": "4", "addr": "121.xx.xx.64", "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:37:de:ee", "OS-EXT-IPS:type": "floating", "OS-EXT-IPS:port_id": "390b39b0-9a77-4ec2-ae1e-3af358f78999" }] }, "flavor": { "disk": "0", "vcpus": "2", "ram": "4096", "id": "c6s.large.2", "name": "c6s.large.2" }, "accessIPv4": "", "accessIPv6": "", "status": "SHUTOFF", "progress": null, "hostId": "604599c4eeeaa05d8865749e4c97979e14d74c6639a08460051b3a97", "updated": "2021-02-18T12:38:39Z", "created": "2021-02-18T12:37:42Z", "metadata": { "metering.image_id": "6674d782-54ba-4f04-896d-95edd50f2eb9", "metering.imagetype": "gold", "metering.resourcespeccode": "c6s.large.2.linux", "image_name": "CentOS 8.2 64bit", "os_bit": "64", "cascaded.instance_extrainfo": "stopped_release_resource:True,pcibridge:1", "metering.resourcetype": "1", "vpc_id": "24bbb54c-659f-4141-8db9-a957e12b6ee8", "os_type": "Linux", "charging_mode": "0", "__support_agent_list": "ces" }, "tags": [], "description": "", "locked": false, "config_drive": "", "tenant_id": "0b3ade290700f3612f29c005b9d16666", "user_id": "0b3ade2a03800fec1f20c005d6116666", "key_name": null, "os-extended-volumes:volumes_attached": [{ "device": "/dev/vda", "bootIndex": "0", "id": "0dc13ef4-dcf6-49d2-8d34-395d94767917", "delete_on_termination": "true" }], "OS-EXT-STS:task_state": null, "OS-EXT-STS:power_state": 4, "OS-EXT-STS:vm_state": "stopped", "OS-EXT-SRV-ATTR:host": "604599c4eeeaa05d8865749e4c97979e14d74c6639a08460051b3a97", "OS-EXT-SRV-ATTR:instance_name": "instance-003ef12a", "OS-EXT-SRV-ATTR:hypervisor_hostname": "5edb1b44af14ebaaa784cfba010f78f113b1fd0865fef854c264a925", "OS-DCF:diskConfig": "MANUAL", "OS-EXT-AZ:availability_zone": "cn-east-3c", "os:scheduler_hints": { }, "OS-EXT-SRV-ATTR:root_device_name": "/dev/vda", "OS-EXT-SRV-ATTR:ramdisk_id": "", "enterprise_project_id": "0", "OS-EXT-SRV-ATTR:user_data": null, "OS-SRV-USG:launched_at": "2021-02-18T12:37:57.000000", "OS-EXT-SRV-ATTR:kernel_id": "", "OS-EXT-SRV-ATTR:launch_index": 0, "host_status": "UP", "OS-EXT-SRV-ATTR:reservation_id": "r-q8xjhqzk", "OS-EXT-SRV-ATTR:hostname": "ecs-test", "OS-SRV-USG:terminated_at": null, "sys_tags": [{ "key": "_sys_enterprise_project_id", "value": "0" }], "security_groups": [{ "id": "d0d30ee2-5b34-44d4-b5a3-68b9d64e7286", "name": "Sys-WebServer" }], "image": { "id": "6674d782-54ba-4f04-896d-95edd50f2eb9" }, "hypervisor": null, "auto_terminate_time": "" } } 根据公网IP查询公网IP详情 接口相关信息 URI格式： GET /v1/{project_id}/publicips 详情请参见“查询弹性公网IP列表”。 请求示例 GET https://{endpoint}/v1/743b4c0428d945316666666666666666/publicips?public_ip_address=121.xx.xx.64 {endpoint}信息请从地区和终端节点获取。 public_ip_address参数传入的公网IP地址从1的返回信息中获取，从返回body体中的"server"下的"address"信息中找到"OS-EXT-IPS:type"为"floating"的"addr"字段，即为公网IP地址。 响应示例 { "publicips": [{ "id": "92597d39-b81d-42b0-8d02-fe8afe7ef076", "type": "5_bgp", "port_id": "390b39b0-9a77-4ec2-ae1e-3af358f78999", "public_ip_address": "121.xx.xx.64", "private_ip_address": "192.168.0.16", "status": "ACTIVE", "tenant_id": "0b3ade290700f3612f29c005b9d16666", "create_time": "2021-02-18 12:38:08", "bandwidth_id": "3a087bbd-0bcf-4401-9e2b-6a96fa2e3471", "bandwidth_name": "ecs-test-bandwidth-891e", "bandwidth_share_type": "PER", "bandwidth_size": 5, "profile": {}, "enterprise_project_id": "0", "ip_version": 4 }] }

请求示例 PUT https://{endpoint}/v1/{project_id}/cloudservers/nics/{nic_id} { "nic": { "subnet_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23", "ip_address": "192.168.0.7", "reverse_binding": true } }

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 nic 是 Object 需要配置虚拟IP的网卡参数列表。更多信息请参见表3。 表3 nic字段数据结构说明 参数 是否必选 参数类型 描述 subnet_id 是 String 云服务器添加网卡的信息。 需要指定云服务器所属虚拟私有云下已创建的网络（network）的ID，UUID格式。 ip_address 是 String 网卡即将配置的虚拟IP的地址。 reverse_binding 否 Boolean 虚拟IP的allowed_address_pairs属性是否添加网卡的IP/Mac对。 说明： 添加IP/Mac对后才能在网卡详情页面正常展示虚拟IP的地址。

功能介绍 虚拟IP地址用于为网卡提供第二个IP地址，同时支持与多个弹性云服务器的网卡绑定，从而实现多个弹性云服务器之间的高可用性。 该接口用于给云服务器网卡配置虚拟IP地址： 当指定的IP地址是一个不存在的虚拟IP地址时，系统会创建该虚拟IP，并绑定至对应网卡。 当指定的IP地址是一个已经创建好的虚拟IP时，系统会将指定的网卡和虚拟IP绑定。如果该IP的device_owner为空，则仅支持VPC内二三层通信；如果该IP的device_owner为neutron:VIP_PORT，则支持VPC内二三层通信、VPC之间对等连接访问，以及弹性公网IP、VPN、云专线等Internet接入。 了解更多请参考虚拟IP简介。

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

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

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

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

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

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