华为云用户手册

响应示例 响应示例 { "absolute":{ "maxServerMeta":128, "maxPersonality":5, "maxImageMeta":128, "maxPersonalitySize":10240, "maxSecurityGroupRules":20, "maxTotalKeypairs":-1, "total RAM Used":75776, "totalInstancesUsed":21, "maxSecurityGroups":10, "totalFloatingIpsUsed":0, "maxTotalCores":20480, "totalSecurityGroupsUsed":1, "maxTotalFloatingIps":10, "maxTotalInstances":2048, "totalCoresUsed":40, "maxTotalRAMSize":25165824, "maxTotalSpotInstances":20, "maxTotalSpotCores":320, "maxTotalSpotRAMSize":655360, "totalSpotInstancesUsed":0, "totalSpotCoresUsed":0, "totalSpotRAMUsed":0, "limit_by_flavor":[], "maxServerGroups":10, "maxServerGroupMembers":16, "totalServerGroupsUsed":2 }}

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

请求示例 一键重置指定云服务器的管理员账号（root用户或Administrator用户）的密码，建议将密码在配置文件或者环境变量中密文存放，使用时解密，确保安全。 PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-reset-password{"reset-password": {"new_password": "$ADMIN_PASS",}}

请求示例 为云服务器切换VPC，添加网卡、安全组并指定IP地址。 POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/changevpc{ "vpc_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23", "nic": { "subnet_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23", "security_groups": [ { "id": "f0ac4394-7e4a-4409-9701-ba8be283dbc3" } ], "ip_address": "192.168.255.1" }}

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

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 vpc_id 是 String 虚拟机私有云ID ，UUID格式。 nic 是 Object 需要添加的网卡参数列表，详情请参见表3。 表3 nic字段数据结构说明 参数 是否必选 参数类型 描述 port_id 否 String 网卡ID，UUID格式。 当该字段不为空时，表示挂载指定的网卡。 说明： port_id和subnet_id不能同时为空。 网卡ID可以通过虚拟私有云的“查询端口列表”接口查询。 约束： 网卡必须带有安全组。 网卡状态必须为DOWN。 网卡的vpcid必须和传入的vpcid一致。 当port_id和subnet_id同时存在的时候，优先使用port_id。 当选择port_id不为空时，代表此时使用的是弹性网卡，此时security_groups和ip_address等参数不生效。 subnet_id 否 String 云服务器添加网卡的信息。 需要指定云服务器所属虚拟私有云下已创建的网络（network）的ID，UUID格式。 security_groups 否 Array of objects 添加网卡的安全组信息，详情请参见表4。 ip_address 否 String IP地址，无该参数表示自动分配IP地址。 表4 security_groups字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 安全组ID。

功能介绍 云服务器切换虚拟私有云。 本接口为异步接口，当前云服务器切换虚拟私有云请求下发成功后会返回job_id，此时云服务器切换虚拟私有云并没有立即完成，需要通过调用查询任务的执行状态查询job状态，当Job状态为 SUC CES S 时代表云服务器虚拟私有云切换成功。 切换虚拟私有云会卸载当前主网卡，用新指定的虚拟私有云创建主网卡。 若原主网卡绑定有弹性IP，则会将弹性IP绑定到新创建的主网卡上。 切换虚拟私有云会导致云服务器网络中断，同时更改云服务器子网、IP地址、MAC地址。 虚拟私有云切换完成后，与网络配置相关的应用软件需要重新配置。与网络相关的服务也需要重新配置，例如ELB、VPN、NAT、DNS等。 切换虚拟私有云过程中，请勿操作云服务器的弹性IP，或对云服务器做其他操作。

URI DELETE /v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}?delete_flag=0 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方法请参见获取项目ID。 server_id 是 云服务器ID。 volume_id 是 磁盘ID。 delete_flag 否 是否强制卸载数据盘。 是，值为“1”。 否，值为“0”。 默认值为0。

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

功能介绍 当您创建的弹性云服务器规格无法满足业务需要时，可以变更云服务器规格，升级vCPU、内存。具体接口的使用，请参见本节内容。 本接口为异步接口，当前变更弹性云服务器规格请求下发成功后会返回job_id，此时变更弹性云服务器规格并没有立即完成，需要通过调用查询任务的执行状态查询job状态，当Job状态为 SUCCESS 时代表云服务器规格变更成功。 变更规格时，部分规格的之间不能互相变更。您可以参见查询云服务器规格变更支持列表查询支持列表。

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 resize 是 Object 标记为云服务器变更规格操作，详情请参见表3。 dry_run 否 Boolean 是否只预检此次请求。 true：发送检查请求，不会变更云服务器规格。检查项包括是否填写了必需参数、请求格式等。 如果检查不通过，则返回对应错误。 如果检查通过，则返回202状态码。 false：发送正常请求，通过检查后并且执行变更云服务器规格请求。 表3 resize数据结构说明 参数 是否必选 参数类型 描述 flavorRef 是 String 变更后的云服务器规格ID。 可能通过 查询云服务器规格变更支持列表 接口查询允许变更的规格列表。 mode 否 String 取值为withStopServer ，支持开机状态下变更规格。 mode取值为withStopServer时，对开机状态的云服务器执行变更规格操作，系统自动对云服务器先执行关机，再变更规格，变更成功后再执行开机。 cpu_options 否 Object 自定义CPU选项。 详情请参见表4。 表4 cpu_options数据结构说明 参数 是否必选 参数类型 描述 hw:cpu_threads 否 integer 用于控制CPU是否开启超线程。 取值范围：1，2。 1: 关闭超线程。 2: 打开超线程。 需要同时满足如下条件，才能设置为“关闭超线程”： 只能在实例创建或者resize时指定。 只有目标flavor的extra_specs参数： 存在“hw:cpu_policy”并取值为“dedicated”。 存在“hw:cpu_threads”并取值为“2”。

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

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

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

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 quota_set Object quota_set对象，详情请参见表3。 表3 quota_set参数信息 参数 参数类型 描述 cores Integer vcpu数量配额 fixed_ips Integer 固定IP数量配额，目前不支持此参数 floating_ips Integer 浮动IP数量配额，目前不支持此参数 id String project的UUID injected_file_content_bytes Integer 注入文件的文件大小配额，单位字节 injected_file_path_bytes Integer 注入文件的路径大小配额，单位字节，目前不支持此参数 injected_files Integer 注入文件数量配额 instances Integer 云服务器数量配额 key_pairs Integer 密钥对数量配额，目前不支持此参数 metadata_items Integer 元数据数量配额 ram Integer 内存配额，单位MB security_group_rules Integer 每个安全组规则的配额，目前不支持此参数 security_groups Integer 安全组数量配额，目前不支持此参数 server_groups Integer 云服务器组数量配额。 server_group_members Integer 云服务器组中云服务器个数配额。

响应示例 { "quota_set": { "cores": 20, "fixed_ips": 40, "floating_ips": 10, "id": "d9ebe43510414ef590a4aa158605329e", "injected_file_content_bytes": 10240, "injected_file_path_bytes": 255, "injected_files": 5, "instances": 20, "key_pairs": 100, "metadata_items": 128, "ram": 51200, "security_group_rules": 20, "security_groups": 50, "server_group_members": 10, "server_groups": 10 }}

响应示例 { "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：此组中的弹性云服务器必须安排到不同的主机。 说明： 推荐使用创建云服务器组。

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

状态码 正常状态码 描述 200 OK 201 Created 202 Accepted 204 No Content 错误状态码 描述 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 409 Conflict 413 Request Entity Too Large 415 Unsupported Media Type 429 Too Many Requests 500 Internal Server Error 501 Not Implemented 503 Service Unavailable 父主题： 附录

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 server_group Object 弹性云服务器组信息，参考表3。 表3 server_group参数信息 参数 参数类型 描述 id String 弹性云服务器组UUID。 name String 弹性云服务器组名称。 policies Array of strings 弹性云服务器组类型。包括： anti-affinity：此组中的云服务器必须安排到不同的主机。 members Array of strings 弹性云服务器组中包含的弹性云服务器列表。 metadata Object 弹性云服务器组元数据。 project_id String 弹性云服务器组所属租户ID，UUID格式。 微版本2.13及以上版本支持。 user_id String 弹性云服务器组所属用户ID，UUID格式。 微版本2.13及以上版本支持。

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

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

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

响应示例 { "floating_ips": [ { "id": "05f71f43-f3c9-47ef-ac8d-9f02aef66418", "pool": "external", "ip": "10.154.51.235", "fixed_ip": "192.168.1.2", "instance_id": "8b380f68-5057-4aa2-a33a-170b37218fa8" }, { "id": "a25236cf-dd76-4adc-916a-f0b4a24048d3", "pool": "external", "ip": "10.154.51.237", "fixed_ip": null, "instance_id": null } ]}

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 display_description 否 String 快照的描述。 volume_id 是 String 卷ID。 display_name 否 String 云硬盘快照名称。 最大支持255个字节。 说明： 通过VBS对云硬盘创建备份时，同时会创建以autobk_snapshot_为名称前缀的快照，云硬盘控制台对此类快照会有操作限制。因此，建议您不要创建以autobk_snapshot_为名称前缀的快照，避免影响快照的正常使用。 force 否 Boolean 是否执行强制创建。force为true时，支持卷在in-use状态时创建快照。

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

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