华为云用户手册

请求示例 批量挂载共享数据盘到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" } ] }

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 serverinfo 是 Array of objects 共享磁盘需要挂载的弹性云服务器列表。详细请参见表3。 表3 serverinfo 列表数据结构说明 参数 是否必选 参数类型 描述 server_id 是 String 共享磁盘需要挂载的弹性云服务器ID。 device 否 String 磁盘挂载点。 说明： 新增加的磁盘挂载点不能和已有的磁盘挂载点相同。 对于采用XEN虚拟化类型的弹性云服务器，device为必选参数；系统盘挂载点请指定/dev/sda；数据盘挂载点请按英文字母顺序依次指定，如/dev/sdb，/dev/sdc，如果指定了以“/dev/vd”开头的挂载点，系统默认改为“/dev/sd”。 对于采用KVM虚拟化类型的弹性云服务器，系统盘挂载点请指定/dev/vda；数据盘挂载点可不用指定，也可按英文字母顺序依次指定，如/dev/vdb，/dev/vdc，如果指定了以“/dev/sd”开头的挂载点，系统默认改为“/dev/vd”。 对于仅支持S CS I类型磁盘的弹性云服务器，数据盘的挂载点请按英文字母顺序依次指定，如/dev/sdb，/dev/sdc，系统不会修改默认挂载点。

响应消息 响应参数如表3所示。 表3 响应参数 参数 参数类型 描述 flavors Array of objects 云服务器规格列表，详情请参见表4。 flavors_links Array of objects 分页查询时，查询下一页数据链接 , 详情请参见表5 flavors_links字段数据结构说明。 表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 扩展属性，该云服务器规格是否禁用。 当前未使用该参数，缺省值为false。 rxtx_factor Float 云服务器可使用网络带宽与网络硬件带宽的比例。 当前未使用该参数，缺省值为1.0。 os-flavor-access:is_public Boolean 扩展属性，flavor是否给所有租户使用。 true：表示给所有租户使用。 false：表示给指定租户使用。 缺省值为true。 links Array of objects 规格相关快捷链接地址，详情请参见表5。 表5 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 href String 对应快捷链接。

响应示例 { "flavors": [ { "name": "c3.2xlarge.2", "links": [ { "href": "https://compute.region.example.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "self" }, { "href": "https://compute.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "bookmark" } ], "ram": 16384, "OS-FLV-DISABLED:disabled": false, "vcpus": 8, "swap": "", "os-flavor-access:is_public": true, "rxtx_factor": 1, "OS-FLV-EXT-DATA:ephemeral": 0, "disk": 0, "id": "c3.2xlarge.2" }, { "name": "c3.2xlarge.4", "links": [ { "href": "https://compute.region.example.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.4", "rel": "self" }, { "href": "https://compute.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.4", "rel": "bookmark" } ], "ram": 32768, "OS-FLV-DISABLED:disabled": false, "vcpus": 8, "swap": "", "os-flavor-access:is_public": true, "rxtx_factor": 1, "OS-FLV-EXT-DATA:ephemeral": 0, "disk": 0, "id": "c3.2xlarge.4" } ] }

可用区管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 查询可用区列表（OpenStack原生）（废弃） GET /v2.1/{project_id}/os-availability-zone ecs:availabilityZones:list - √ × × × 父主题： 权限和授权项

涉及接口 创建云服务器时，需要进行规格查询、可用区查询、云硬盘创建等操作，涉及的接口如下： 查询可用区列表：确定待创建云服务器所在的可用区。 查询云服务器规格详情列表：确定待创建云服务器的规格。 查询镜像列表详情：确定待创建云服务器使用的镜像。 查询网络列表：确定云服务器的网络信息。 创建和导入SSH密钥：设置密钥对登录方式。 创建云服务器：创建密钥对登录鉴权的云服务器。 查询云服务器详情：确认云服务器创建成功。

操作步骤 确定待创建云服务器所在的可用区。 查询可用区。 接口相关信息 URI格式：GET /v2.1/{project_id}/os-availability-zone 详情请参见查询可用区列表。 请求示例 GET https://{endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/os-availability-zone {endpoint}信息请从地区和终端节点获取。 响应示例 { "availabilityZoneInfo": [ { "hosts": null, "zoneState": { "available": true }, "zoneName":"zone_01" }, { "hosts": null, "zoneState": { "available": true }, "zoneName": "zone_01" } ] } 根据实际需要选择可用区，并记录可用区的zoneName。 确定待创建云服务器的规格。 查询云服务器规格信息。 接口相关信息 URI格式：GET /v1/{project_id}/cloudservers/flavors?availability_zone={availability_zone} 其中，“?”后的字段为查询规格时可选的查询检索参数，详情请参见查询规格详情和规格扩展信息列表。 请求示例 GET https://{endpoint}/v1/74610f3a5ad941998e91f076297ecf27/cloudservers/flavors?availability_zone=zone_01 {endpoint}信息请从地区和终端节点获取。 availability_zone的值“zone_01”通过步骤1获取。 响应示例 { "flavors": [ { "attachableQuantity": { "free_scsi": 60, "free_blk": 24, "free_disk": 60, "free_nic": 12 }, "id": "c3.2xlarge.2", "name": "c3.2xlarge.2", "vcpus": "8", "ram": 8192, "disk": "0", "swap": "", "links": [ { "rel": "self", "href": "https://xxx/v1.0/74610f3a5ad941998e91f076297ecf27/flavors/c3.2xlarge.2", "type": null }, { "rel": "bookmark", "href": "https://xxx/74610f3a5ad941998e91f076297ecf27/flavors/c3.2xlarge.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, "os_extra_specs": { "ecs:virtualization_env_types": "CloudCompute", "ecs:generation": "c3", "ecs:instance_architecture":"arm64" , "ecs:performancetype": "computingv3", "resource_type": "IOoptimizedC3_2" } } ] } 根据实际需要选择规格，并记录规格的ID。 确定待创建云服务器使用的镜像。 查询镜像。 接口相关信息 URI格式：GET /v2.1/{project_id}/images/detail 详情请参见查询镜像列表详情。 请求示例 GET https://{endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/images/detail {endpoint}信息请从地区和终端节点获取。 响应示例 { "images": [ { "OS-EXT-IMG-SIZE:size": 0, "metadata": { "__os_type": "Linux", "hw_vif_multiqueue_enabled": "true", "__imagetype": "gold", "__quick_start": "true", "virtual_env_type": "FusionCompute", "__support_xen": "true", "__support_kvm": "true", "__image_source_type": "uds", "__platform": "EulerOS", "__os_version": "EulerOS 2.2 64bit", "__os_bit": "64", "__isregistered": "false" }, "created": "2018-05-14T06:13:50Z", "minRam": 0, "name": "DBS-MySQL-Image_2.1.3.3", "progress": 100, "links": [ { "rel": "self", "href": "https://None/v2.1/74610f3a5ad941998e91f076297ecf27/images/11e8f727-d439-4ed1-b3b8-33f46c0379c4" }, { "rel": "bookmark", "href": "https://None/74610f3a5ad941998e91f076297ecf27/images/11e8f727-d439-4ed1-b3b8-33f46c0379c4" }, { "rel": "alternate", "href": "https://None/images/11e8f727-d439-4ed1-b3b8-33f46c0379c4", "type": "application/vnd.openstack.image" } ], "id": "11e8f727-d439-4ed1-b3b8-33f46c0379c4", "updated": "2018-05-14T06:13:52Z", "minDisk": 40, "status": "ACTIVE" } ] } 根据需要选择镜像，并记录镜像ID。 确定云服务器的网络信息。 查询网络。 接口相关信息 URI格式：GET /v2.1/{project_id}/os-networks 详情请参见查询网络列表（废弃）。 请求示例 GET https://{endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/os-networks {endpoint}信息请从地区和终端节点获取。 响应示例 { "networks": [ { "id": "07a9557d-4256-48ae-847c-415a9c8f7ff6", "label": "b_tt3_td1b", "broadcast": null, "cidr": null, "dns1": null, "dns2": null, "gateway": null, "netmask": null, "cidr_v6": null, "gateway_v6": null, "netmask_v6": null } ] } 根据需要选择网络，并记录网络ID。 设置密钥对登录方式。 如需设置为密码登录方式，请直接跳转至7。 创建密钥对。 接口相关信息 URI格式：POST /v2.1/{project_id}/os-keypairs 详情请参见创建和导入SSH密钥（废弃）。 请求示例 POST https://{endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/os-keypairs {endpoint}信息请从地区和终端节点获取。 Body： { "keypair": { "type": "ssh", "name": "demo1", "user_id": "fake" } } 响应示例 { "keypair": { "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCrR5Gcwlh5ih7JOvzIUuQxS5qzWWPMYHeDXkDKSQ9W5pumOV05SiO3WCswnaQ5xMdOl31mNiHtwlwq9dJi7X6jJBB2shT******************************************************************************************************************************************************************************************************************************************************************************************************* Generated-by-Nova\n", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAq0eRnMJYeYoeyTr8yFLkMUuas1ljzGB3g15AykkPVuabpjld\nOUojt1grMJ2kOcTHTpd9ZjYh7cJcKvXSYu1+oyQQdrIUw/tNBuVrsJAWxVOAi77d\nQeOLtDVImkyd+TQL1tv+F76V5vTsIkNweYHumWOxLIt/FJ4fqZG4T5GMTQQivMqD\npaI0IVrO+Wm3cWQYvNdf/EcC3DYhYqHANkRsbUYwXaREnI/tU1PjnH2XUJ69ABWz\ntdc+8sXyMoMMM1U4FLiTWzGyh0rUKkW5JXzJR2OEQT0IG+0Tf2Glyk0El0/OJPg/\ncZQzaO1o+H8DiUzs/7Pz72yDqo0R7fQ+mOCCn***********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************\n-----END RSA PRIVATE KEY-----\n", "user_id": "f79791beca3c48159ac2553fff22e166", "name": "demo1", "fingerprint": "57:a7:a2:ed:5f:aa:e7:**:**:**:**:**:**:**:**:**" } } 导入密钥。 接口相关信息 URI格式：POST /v2.1/{project_id}/os-keypairs 详情请参见创建和导入SSH密钥（废弃）。 请求示例 POST https://{endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/os-keypairs {endpoint}信息请从地区和终端节点获取。 Body： { "keypair": { "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDY8wMTdBYiJgi62o6eShoOlSKx3CZ3cE6PHisDblfK3Y0Bg7EHV7iV9c74pqsrIhK0xuGUuO1NxDQWbkwLTPN4F9Iy5CI********************************************************************************************************************************************************************************************************************************************************* Generated-by-Nova\n", "type": "ssh", "name": "demo2", "user_id": "fake" } } 响应示例 { "keypair": { "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDY8wMTdBYiJgi62o6eShoOlSKx3CZ3cE6PHisDblfK3Y0Bg7EHV7iV9c74pqsrIhK0xuGUuO1NxDQWbkwLTPN4F9Iy5CI********************************************************************************************************************************************************************************************************************************************************* Generated-by-Nova\n", "user_id": "f79791beca3c48159ac2553fff22e166", "name": "demo2", "fingerprint": "dd:44:45:49:d9:f6:4f:**:**:**:**:**:**:**:**:**" } } 记录响应消息体中的name信息。如本例中为“demo2”。 创建密钥对登录鉴权的云服务器。 接口相关信息 URI格式：POST /v1/{project_id}/cloudservers 接口约束及请求参数说明详情，请参见创建云服务器（按需）。 请求示例 POST https://{endpoint}/v1/74610f3a5ad941998e91f076297ecf27/cloudservers {endpoint}信息请从地区和终端节点获取。 Body： { "server": { "availability_zone":"zone_01", "name": "newserver", "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", "root_volume": { "volumetype": "SSD" }, "data_volumes": [ { "volumetype": "SSD", "size": 100, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s3.xlarge.2", "vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171", "security_groups": [ { "id": "507ca48f-814c-4293-8706-300564d54620" } ], "nics": [ { "subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83" } ], "publicip": { "eip": { "iptype": "5_bgp", "bandwidth": { "size": 10, "sharetype": "PER" } } }, "key_name": "sshkey-123", "count": 1, "extendparam": { "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb" }, "server_tags": [ { "key": "key1", "value": "value1" } ], "metadata": { "op_svc_userid": "8ea65f4099ba412883e2a0da72b96873", "agency_name": "test" } } } 响应示例 { "job_id": "ff808082739334d80173941567f21d4f", "serverIds": [ "6d311127-bce1-48db-bf0f-cac9f8f7f077" ] } 创建密码方式登录鉴权的弹性云服务器。 创建非cloud-init镜像、密码方式登录鉴权的弹性云服务器。 接口相关信息 URI格式：POST /v1/{project_id}/cloudservers 接口约束及请求参数说明详情，请参见创建云服务器（按需）。 请求示例 POST https://{endpoint}/v1/74610f3a5ad941998e91f076297ecf27/cloudservers {endpoint}信息请从地区和终端节点获取。 Body： { "server": { "adminPass": "$ADMIN_PASS", //建议在配置文件或者环境变量中密文存放，使用时解密，确保安全 "availability_zone":"zone_01", "name": "newserver", "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", "root_volume": { "volumetype": "SSD" }, "data_volumes": [ { "volumetype": "SSD", "size": 100, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s3.xlarge.2", "vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171", "security_groups": [ { "id": "507ca48f-814c-4293-8706-300564d54620" } ], "nics": [ { "subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83" } ], "publicip": { "eip": { "iptype": "5_bgp", "bandwidth": { "size": 10, "sharetype": "PER" } } }, "count": 1, "extendparam": { "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb" }, "server_tags": [ { "key": "key1", "value": "value1" } ], "metadata": { "op_svc_userid": "8ea65f4099ba412883e2a0da72b96873", "agency_name": "test" } } } 响应示例 { "job_id": "ff808082739334d80173941567f21d4f", "serverIds": [ "6d311127-bce1-48db-bf0f-cac9f8f7f077" ] } 创建cloud-init镜像（以Linux为例）、密码方式登录鉴权的弹性云服务器。 接口相关信息 URI格式：POST /v1/{project_id}/cloudservers 接口约束及请求参数说明详情，请参见创建云服务器（按需）。 请求示例 POST https://{endpoint}/v1/74610f3a5ad941998e91f076297ecf27/cloudservers {endpoint}信息请从地区和终端节点获取。 Body： { "server": { "availability_zone":"zone_01", "name": "newserver", "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", "root_volume": { "volumetype": "SSD" }, "data_volumes": [ { "volumetype": "SSD", "size": 100, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s3.xlarge.2", "vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171", "security_groups": [ { "id": "507ca48f-814c-4293-8706-300564d54620" } ], "nics": [ { "subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83" } ], "publicip": { "eip": { "iptype": "5_bgp", "bandwidth": { "size": 10, "sharetype": "PER" } } }, "count": 1, "extendparam": { "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb" }, "server_tags": [ { "key": "key1", "value": "value1" } ], "user_data":"IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRuaERlcUIkajBkelVMbkFrbWo4bWlFREFzT0VONkVPdGg1RmdqWnQybUVWZVRocC5OVDJXelZVdzFuNzhnL3dNdDE0dVpSQ1V3LzhHS3VGdEViQ0lPQS5vN1BZQzEnIHwgY2hwYXNzd2QgLWU7", "metadata": { "op_svc_userid": "8ea65f4099ba412883e2a0da72b96873", "agency_name": "test" } } } 响应示例 { "job_id": "ff808082739334d80173941567f21d4f", "serverIds": [ "6d311127-bce1-48db-bf0f-cac9f8f7f077" ] } 确认云服务器创建成功。 接口相关信息 URI格式：GET /v1/{project_id}/cloudservers/{server_id} 详情请参见查询云服务器详情。 请求示例 GET https://{endpoint}/v1/74610f3a5ad941998e91f076297ecf27/cloudservers/0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6 其中： 0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6为创建的云服务器UUID。 {endpoint}信息请从地区和终端节点获取。 响应示例 { "server":{ "id":"0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6", "name":"ecs-2ecf", "addresses":{ "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68":[ { "version":"4", "addr":"192.168.1.99", "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:df:18:6d", "OS-EXT-IPS:port_id":"23037c18-027a-44e5-b6b9-f8d8f113fe02", "OS-EXT-IPS:type":"fixed" } ] }, "flavor":{ "disk":"0", "vcpus":"2", "ram":"1024", "id":"s3.large.1", "name":"s3.large.1", "gpus": [], "asic_accelerators": [] }, "accessIPv4":"", "accessIPv6":"", "status":"ACTIVE", "progress":0, "hostId":"c7145889b2e3202cd295ceddb1742ff8941b827b586861fd0acedf64", "updated":"2018-09-13T07:06:51Z", "created":"2018-09-13T07:03:44Z", "image":{ "id":"1ce5800a-e487-4c1b-b264-3353a39e2b4b" }, "metadata":{ "metering.order_id":"CS1809131459IGC24", "metering.image_id":"c71b64e7-4767-4406-afde-2c7c7ac2242c", "metering.imagetype":"gold", "metering.resourcespeccode":"s3.small.1.linux", "image_name":"HEC_Public_Cloudinit_Oracle_Linux_7.4_64bit_40G", "metering.resourcetype":"1", "metering.product_id":"00301-117024-0--0", "cascaded.instance_extrainfo":"pcibridge:2", "os_bit":"64", "vpc_id":"0431c5e5-bc94-4a44-8263-15da2a642435", "os_type":"Linux", "charging_mode":"1" }, "tags":[ ], "description":"", "locked":false, "config_drive":"", "tenant_id":"74610f3a5ad941998e91f076297ecf27", "user_id":"f79791beca3c48159ac2553fff22e166", "key_name":"KeyPair-d750", "os-extended-volumes:volumes_attached":[ { "device":"/dev/vda", "bootIndex":"0", "id":"80c15cff-2473-4982-a816-d760cad6c42c", "delete_on_termination":"false" } ], "OS-EXT-STS:task_state":null, "OS-EXT-STS:power_state":1, "OS-EXT-STS:vm_state":"active", "OS-EXT-SRV-ATTR:host":"az21.dc1", "OS-EXT-SRV-ATTR:instance_name":"instance-0015147f", "OS-EXT-SRV-ATTR:hypervisor_hostname":"nova003@74", "OS-EXT-SRV-ATTR:user_data":null, "OS-DCF:diskConfig":"MANUAL", "OS-EXT-AZ:availability_zone":"zone_01", "os:scheduler_hints":{ }, "OS-EXT-SRV-ATTR:root_device_name":"/dev/vda", "OS-EXT-SRV-ATTR:ramdisk_id":"", "enterprise_project_id":"0", "OS-SRV-USG:launched_at":"2018-09-13T07:04:09.197749", "OS-EXT-SRV-ATTR:kernel_id":"", "OS-EXT-SRV-ATTR:launch_index":0, "host_status":"UP", "OS-EXT-SRV-ATTR:reservation_id":"r-nrd8b5c4", "OS-EXT-SRV-ATTR:hostname":"ecs-2ecf", "sys_tags":[ { "key":"_sys_enterprise_project_id", "value":"0" } ], "security_groups":[ { "name":"sg-95ec", "id":"6505b5d1-7837-41eb-8a1c-869d4355baa3" } ] } }

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

接口约束 使用此接口时，请指定微版本不低于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请重新获取。

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

请求示例 删除云服务器的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组成。二维标签全部是ECS接口，具体使用请参见本节内容。 在执行增、删、改、查等操作时，建议使用同类标签管理接口进行操作，不要混用。 建议使用二维标签。 父主题： 标签管理

响应示例 { "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 √ × × × 父主题： 权限和授权项

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

响应消息 响应参数如表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 对端安全组的名称。

请求示例 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。