华为云用户手册

响应消息 响应参数如表4所示。 表3 响应参数 参数 参数类型 描述 flavors Array of objects 云服务器规格列表，详情请参见表4。 flavors_links Array of objects 分页查询时，查询下一页数据链接 ,详情请参见表5 flavors_links字段数据结构说明。 表4 flavors数据结构说明 参数 参数类型 描述 id String 规格ID。 links Array of objects 规格相关快捷链接地址。 详情请参见表5。 name String 规格名称。 表5 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 href String 对应快捷链接。

响应示例 { "job_id": "ff80808288d41e1b018990260955686a"} 或 { "order_id": " CS 1711152257C60TL", "job_id": "ff80808288d41e1b018990260955686a"} 或 { "error": { "message": "XXXX", "code": "XXX" }}

请求示例 变更专属主机上的云服务器的规格为“s3.large.2”，自动支付且支持开机状态下变更规格。 POST https://{endpoint}/v1.1/{project_id}/cloudservers/{server_id}/resize{ "resize": { "flavorRef": "s3.large.2", "dedicated_host_id": "459a2b9d-804a-4745-ab19-a113bb1b4ddc", "extendparam":{ "isAutoPay": "true" }, "mode": "withStopServer" }}

请求消息 表2 参数说明 名称 是否必选 参数类型 描述 resize 是 Object 标记为云服务器变更规格操作，详情参见 表3。 dry_run 否 Boolean 是否只预检此次请求。 true：发送检查请求，不会变更云服务器规格。检查项包括是否填写了必需参数、请求格式等。 如果检查不通过，则返回对应错误。 如果检查通过，则返回202状态码。 false：发送正常请求，通过检查后并且执行变更云服务器规格请求。 表3 resize数据结构说明 名称 是否必选 参数类型 描述 flavorRef 是 String 变更后的云服务器规格ID。 可以通过 查询云服务器规格变更支持列表 接口查询允许变更的规格列表。 说明： 不支持变更至同一规格。 dedicated_host_id 否 String 新专属主机ID。 仅对于部署在专属主机上的弹性云服务器，该参数必选。 extendparam 否 Object 变更云服务器扩展信息，详情参见 表4。 mode 否 String 取值为withStopServer ，支持开机状态下变更规格。 mode取值为withStopServer时，对开机状态的云服务器执行变更规格操作，系统自动对云服务器先执行关机，再变更规格，变更成功后再执行开机。 cpu_options 否 Object 自定义CPU选项。 详情请参见表5。 表4 extendparam数据结构说明 名称 是否必选 参数类型 描述 isAutoPay 否 String 下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。 “true”：是（自动支付） “false”：否（需要客户手动支付） 说明： 当弹性云服务器是按包年包月计费时生效，该值为空时默认为客户手动支付。 表5 cpu_options数据结构说明 参数 是否必选 参数类型 描述 hw:cpu_threads 否 integer 用于控制CPU是否开启超线程。 取值范围：1，2。 1: 关闭超线程。 2: 打开超线程。 需要同时满足如下条件，才能设置为“关闭超线程”： 只能在实例创建或者resize时指定。 只有目标flavor的extra_specs参数： 存在“hw:cpu_policy”并取值为“dedicated”。 存在“hw:cpu_threads”并取值为“2”。

请求示例 将指定云服务器加入云服务器组。 POST https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action{ "add_member": { "instance_uuid":"34dac9a0-c4a7-457b-bab2-e2c696e0e401" }}

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

请求示例 批量启动ID为“616fb98f-46ca-475e-917e-2563e5a8cd19”和“726fb98f-46ca-475e-917e-2563e5a8cd20”的云服务器，请求参数必须以“os-start”字段下发。 POST https://{endpoint}/v1/{project_id}/cloudservers/action{ "os-start": { "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" }, { "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" } ] }}

请求示例 批量挂载共享数据盘到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”。 对于仅支持SCSI类型磁盘的弹性云服务器，数据盘的挂载点请按英文字母顺序依次指定，如/dev/sdb，/dev/sdc，系统不会修改默认挂载点。

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 os-start 是 Object 标记为启动云服务器操作，详情请参见表3。 表3 os-start字段数据结构说明 参数 是否必选 参数类型 描述 servers 是 Array of objects 云服务器ID列表，详情请参见表4。 表4 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云服务器ID。

请求示例 设置云服务器的定时删除时间为“2020-09-25T12:05:00Z”。 POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/actions/update-auto-terminate-time{ "auto_terminate_time": "2020-09-25T12:05:00Z",} 取消云服务器的定时删除。 POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/actions/update-auto-terminate-time{ "auto_terminate_time": "",}

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 auto_terminate_time 是 String 按需云服务器定时删除时间。 按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 如果秒（ss）取值不是 00，则自动取为当前分钟（mm）开始时。 最短定时删除时间为当前时间半小时之后。 最长定时删除时间不能超过当前时间三年。 如果参数auto_terminate_time为空字符串，表示不设置定时删除或取消定时删除。 示例：2020-09-25T12:05:00Z

响应消息 响应参数 响应参数如表5所示。 表5 响应参数 参数 参数类型 描述 resources Array of objects 返回的云服务器列表，详情参见表6。 total_count Integer 总记录数 表6 resource字段数据结构说明 参数 参数类型 描述 resource_id String 云服务器ID resouce_detail String 预留字段。 tags Array of objects 标签列表。 resource_name String 资源名称，即弹性云服务器名称。 表7 resource_tag字段数据结构说明 参数 参数类型 描述 key String 键。 最大长度127个unicode字符。 key不能为空。 只能包含字母、数字、下划线“_”、中划线“-”。 value String 值。 每个值最大长度255个unicode字符。 可以为空字符串。 只能包含字母、数字、下划线“_”、中划线“-”。

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 action 是 String 值为filter：表示按标签过滤弹性云服务器，返回符合条件的云服务器列表。 limit 否 String 查询返回的云服务器数量限制，最多为1000，不能为负数。 如果action的值为count时，此参数无效。 如果action的值为filter时，limit必填，取值范围[0-1000]，如果不传值，系统默认limit值为1000。 offset 否 String 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0。 查询第一页数据时，可以不传入此参数。 如果action的值为count时，此参数无效。 如果action的值为filter时，必填，如果用户不传值，系统默认offset值为0。 tags 否 Array of objects 查询包含所有指定标签的弹性云服务器，详情请参见表3。 结构体不能缺失。 key不能为空或者空字符串。 key不能重复。 同一个key中values不能重复。 not_tags 否 Array of strings 查询不包含所有指定标签的弹性云服务器。 结构体不能缺失。 key不能为空或者空字符串。 Key不能重复。 同一个key中values不能重复。 matches 否 Array of objects 搜索字段，用于按条件搜索弹性云服务器。 当前仅支持按resource_name进行搜索。更多信息，请参见表4。 表3 tag字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 key不能为空。 values 是 Array of strings 值列表。 value不允许重复。 每个值最大长度255 个unicode字符。 如果values为空则表示any_value。 value之间为或的关系。 表4 match字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键，表示要匹配的字段。 当前key的参数值只能取“resource_name”，此时value的参数值为云服务器名称。 key不能重复，value为匹配的值。 此字段为固定字典值。 不允许为空字符串。 value 是 String 值。 当前key的参数值只能取“resource_name”，此时value的参数值为云服务器名称。 每个值最大长度255个unicode字符。 不可以为空 。

示例 请求示例 POST https://{endpoint}/v1/{project_id}/cloudservers/resource_instances/action { "offset": "100", "limit": "1", "action": "filter", "matches":[ { "key": "resource_name", "value": "ecs_test" }], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }]} 响应示例 { "resources": [ { "resource_detail": null, "resource_id": "31760ffa-6711-406d-bc94-bce4ae925a8a", "resource_name": "ecs_test", "tags": [ { "key": "key1"， "value": "value1" } ] } ], "total_count": 1000}

响应示例 { "flavors": [ { "id": "c3.15xlarge.2", "name": "c3.15xlarge.2", "vcpus": "60", "ram": 131072, "disk": "0", "swap": "", "links": [ { "rel": "self", "href": "https://ecs.region.example.com/v1.0/743b4c0428d94531b9f2add666642e6b/flavors/c3.15xlarge.2", "type": null }, { "rel": "bookmark", "href": "https://ecs.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" } } ]}

URI GET /v1/{project_id}/cloudservers/resize_flavors?instance_uuid={instance_uuid}&source_flavor_id={source_flavor_id}&source_flavor_name={source_flavor_name} 参数说明请参见表1。 表1 路径参数 参数 是否必选 描述 project_id 是 项目ID。 获取方法请参见获取项目ID。

响应消息 响应参数如表3所示。 表3 响应参数 参数 参数类型 描述 flavors Array of objects 云服务器规格列表。 详情请参见表4。 表4 flavors数据结构说明 参数 参数类型 描述 id String 云服务器规格ID。 name String 云服务器规格名称。 vcpus String 云服务器规格对应的CPU核数。 ram Integer 云服务器规格对应的内存大小，单位为MB。 disk String 云服务器规格对应的系统盘大小。 当前未使用该参数，缺省值为0。 swap String 云服务器规格对应要求的交换分区大小。 当前未使用该参数，缺省值为""。 OS-FLV-EXT-DATA:ephemeral Integer 扩展属性，临时盘大小。 当前未使用该参数，缺省值为0。 OS-FLV-DISABLED:disabled Boolean 扩展属性，该云服务器规格是否禁用。 当前未使用该参数，缺省值为false。 rxtx_factor Float 云服务器可使用网络带宽与网络硬件带宽的比例。 当前未使用该参数，缺省值为1。 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 Object 云服务器规格的扩展字段。 详情请参见表6。 instance_quota Object 预留属性。 表5 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 href String 对应快捷链接。 type String 快捷链接类型，当前接口未使用，缺省值为null。

请求示例 批量重置ID为“1bd0eb17-4466-4c15-a9ce-87727ad311b5”和“fd6b6e9d-64a1-40fa-b7dc-f491be42fdd2”的云服务器的密码，建议将密码在配置文件或者环境变量中密文存放，使用时解密，确保安全。 PUT https://{endpoint}/v1/{project_id}/cloudservers/os-reset-passwords{ "new_password": "$ADMIN_PASS", "dry_run": true, "servers": [ { "id":"1bd0eb17-4466-4c15-a9ce-87727ad311b5" }, { "id":"fd6b6e9d-64a1-40fa-b7dc-f491be42fdd2" } ]}

响应示例 响应示例请参见响应（批量操作类）所示。 { "response": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" }, { "id": "516fb98f-46ca-475e-917e-2563e5a8cd12" } ] }

请求消息 请求参数如表2所示。 表2 请求参数 参数 参数类型 是否必选 描述 new_password String 是 新密码。 当dry_run字段为true时，该字段为非必填字段，否则为必填字段。 新密码的校验规则： 长度为8-26位。 密码至少必须包含大写字母（A-Z）、小写字母（a-z）、数字（0-9）和特殊字符（!@%-_=+[]:./?）中的三种。 密码不能包含用户名或用户名的逆序。 Windows系统密码不能包含用户名或用户名的逆序，不能包含用户名中超过两个连续字符的部分。 dry_run Boolean 否 是否只预检此次请求。 true：发送检查请求，不会重置密码。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回响应结果。 false：发送正常请求，通过检查后并且进行重置密码请求。 默认值：false servers Array of objects 是 待批量重置密码的弹性云服务器ID信息，详情参见 表3。 表3 servers字段数据结构说明 参数 参数类型 是否必选 描述 id String 是 弹性云服务器ID。

响应示例 { "server_groups": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19", "name": "test", "policies": ["anti-affinity"], "members": [], "metadata": {}, "project_id": "9c53a566cb3443ab910cf0daebca90c4" } ]}

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

请求示例 POST https://{endpoint}/v2.1/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes { "volume": { "availability_zone": "az1-dc1", "display_description": "test1", "snapshot_id": null, "size": 1, "display_name": "test", "volume_type": "SSD", "metadata": { "testkey": "testvalue" } }}

响应示例 { "volume": { "displayDescription": "test1", "volumeType": "SATA", "createdAt": "2018-05-18T01:17:03.871808", "metadata": { "testkey": "testvalue", "resourceSpecCode": "SATA" }, "attachments": [ {} ], "snapshotId": null, "size": 1, "displayName": "test", "id": "b4fb891c-c665-4478-92b0-8a7fa65a57cd", "availabilityZone": "az1.dc1", "status": "creating" }}

响应消息 响应参数如表3所示。 表3 响应参数 参数 参数类型 描述 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 卷大小

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 availability_zone 否 String 指定要创建卷的AZ，若指定的AZ不存在，则创卷失败，卷状态为error。当前云服务需要指定AZ创建卷。 display_description 否 String 卷的描述。 snapshot_id 否 String 快照ID，指定该参数表示创卷方式为从快照创建卷。 size 是（如果卷快照创卷，size为可选。） Integer 卷大小。 单位为GB。 display_name 否 String 卷名称。 volume_type 否 String 卷类型。 metadata 否 Object 卷的metadata数据。

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

响应示例 { "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 请求参数 参数 是否必选 参数类型 描述 os-change 是 Object 切换弹性云服务器操作系统，详情参见 表3。 表3 os-change字段数据结构说明 参数 是否必选 参数类型 描述 adminpass 否 String 云服务器管理员账户的初始登录密码。 其中，Windows管理员账户的用户名为Administrator，Linux管理员账户的用户名为root。 建议密码复杂度如下： 长度为8-26位。 密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?~#*）中的三种。 说明： Windows云服务器仅支持密码方式，且密码不能包含用户名或用户名的逆序，不能包含用户名中超过两个连续字符的部分。 adminpass和keyname不能同时为空。 adminpass和keyname不能同时有值。 keyname 否 String 密钥名称。 密钥可以通过密钥创建接口进行创建（请参见创建和导入SSH密钥对），或使用SSH密钥查询接口查询已有的密钥（请参见查询SSH密钥对列表 ）。 userid 否 String 用户ID。当传入keyname参数时，优先使用本参数设置的userid，若userid为空，默认使用当前token中的userid。 查看用户ID方法： 登录管理控制台。 单击用户名，在下拉列表中单击“我的凭证”。在该页面查看 IAM 用户ID。 imageid 是 String 切换系统所使用的新镜像的ID，格式为UUID。 镜像的ID可以从控制台或者参考《 镜像服务 API参考》的“查询镜像列表”的章节获取。 isAutoPay 否 String 下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。 “true”：是（自动支付） “false”：否（需要客户手动支付） 说明： 适用于包年/包月虚拟机费用发生变化时，不传该字段时默认为客户手动支付。 metadata 否 Object 切换云服务器的元数据。 更多信息，请参见表4。 mode 否 String 取值为withStopServer ，支持开机状态下切换弹性云服务器操作系统。 mode取值为withStopServer时，对开机状态的 弹性云服务器执行切换操作系统操作，系统自动对云服务器先执行关机，再切换操作系统。 表4 metadata字段数据结构说明 参数 是否必选 参数类型 描述 __system__encrypted 否 String metadata中的表示加密功能的字段，0代表不加密，1代表加密。 该字段不存在时，系统盘默认为不加密。 __system__cmkid 否 String 用户主密钥ID，是metadata中的表示加密功能的字段，与__system__encrypted配合使用。 说明： 请参考查询密钥列表，通过HTTPS请求获取密钥ID。