请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于管理员创建 IAM 用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 1 2 3 4 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint，比如“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求示例 批量删除标签 Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/{resource_id}/tags { "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。 delete：刪除 tags 是 Array of Tag objects 标签列表。 表4 Tag 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，不能以_sys_开头。 value 是 String 值列表。 每个值最大长度255个unicode字符。 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，但首尾不能含有空格。

请求示例 切换云手机服务器 POST https://{CPH Endpoint}/v2/{project_id}/cloud-phone/servers/{server_id}/change { "phone_model_name" : "kg1.cp.c20.d64SSD.e1v1", "image_id" : "20060220200717f201120a2300000e91", "keypair_name" : "keypair", "property" : "{\"sys.prop.writephonenum\":\"13666666666\",\"sys.prop.writeimsi\":\"460021624617113\",\"sys.prop.writewifissid\":\"test_wifi\"}", "ports" : [ { "name" : "myServer1", "listen_port" : 20000, "internet_accessible" : "false" }, { "name" : "myServer2", "listen_port" : 20001, "internet_accessible" : "true" } ], "extend_param" : { "enterprise_project_id" : "0" }, "tenant_vpc_id" : "fca063f6-b942-42a8-9004-e5545f58d6a2", "nics" : [ { "subnet_id" : "f1cbfc37-eb42-4357-a0ec-9e4f11950908" } ], "public_ip" : { "eip" : { "type" : "5_bgp" } }, "band_width" : { "band_width_share_type" : 0, "band_width_size" : 300, "band_width_charge_mode" : 1 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 phone_model_name 是 String 云手机规格，不超过64个字节。 image_id 是 String 云手机镜像ID，不超过32个字节。 keypair_name 否 String 密钥对名称，不超过64个字节，用于云手机ADB登录。 availability_zone 否 String 云手机服务器所在的可用区，不填则维持原可用区不变。如上海一可用区1为cn-east-3a。 ports 否 Array of Port objects 云手机启用的应用端口，云手机服务会做端口转发。 extend_param 否 extend_param object 扩展字段。 tenant_vpc_id 是 String 租户自定义的VPC ID，为待创建的云服务器所属的虚拟私有云（简称VPC），需要指定已创建VPC的ID，UUID格式。 nics 是 Array of Nic objects 租户自定义的网卡的结构体，为待创建的云服务器的网卡信息。 public_ip 是 public_ip object 租户自定义的弹性公网IP结构体。 配置云服务器的弹性IP信息的方式， 自动分配，需要指定新创建弹性IP的信息； 使用已有，需要指定已经购买的EIP ID。 phone_count_per_ip 否 Integer 多少个手机共用一个vip。默认为手机开数，表示所有手机共享1个vip。取值范围：1到手机规格开数。 phone_data_volume 否 phone_data_volume object 手机磁盘结构体，2.0规格必选。 server_share_data_volume 否 server_share_data_volume object 共享存储磁盘结构体，2.0规格可选。 band_width 是 band_width object 云手机使用的带宽信息。 property 否 String 云手机属性列表，为Json格式字符串。只可以预置有权限修改的属性。字符串长度[1,8192]。 表4 Port 参数 是否必选 参数类型 描述 name 是 String 应用端口名称，不超过16个字节，系统关键服务名称不能使用"adb"和"vnc"。 listen_port 是 Integer 端口号，大于等于10000，小于等于50000。 internet_accessible 是 String 为"true"则映射出公网访问（忽略大小写）。 为其他则不映射。 表5 extend_param 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID。 该字段不传（或传为字符串“0”），则将资源绑定给默认企业项目。 表6 Nic 参数 是否必选 参数类型 描述 subnet_id 是 String 租户自定义的子网 ID，为待创建的云服务器所属的子网。 需要指定tenant_vpc_id对应VPC下已创建的子网（subnet）的网络ID，UUID格式。 ipv6_enable 否 Boolean 是否支持ipv6。 取值为true时，标识此网卡支持ipv6。 ipv6_bandwidth 否 ipv6_bandwidth object 绑定的共享带宽信息，详情请参见 ipv6_bandwidth数据结构说明。 表7 ipv6_bandwidth 参数 是否必选 参数类型 描述 band_width_id 是 String ipv6绑定的共享带宽ID。 表8 public_ip 参数 是否必选 参数类型 描述 ids 否 Array of strings 指定已有的EIP进行服务器创建，当前只支持传入一个已有的EIP ID。 eip 否 eip object 配置服务器自动分配弹性IP时，创建弹性IP的配置参数，详情见 eip 结构体。 count 否 Integer Eip数量。默认为1，不需要Eip可设置为0，取值范围为0到手机IP数。 表9 eip 参数 是否必选 参数类型 描述 type 是 String 弹性公网IP的类型。 5_telcom：电信 5_union：联通 5_bgp：全动态BGP 5_sbgp：静态BGP 表10 phone_data_volume 参数 是否必选 参数类型 描述 volume_type 是 String 磁盘类型，只支持如下类型： SSD GPSSD size 是 Integer 手机磁盘大小，单位GiB，取值范围[10，32768]。 表11 server_share_data_volume 参数 是否必选 参数类型 描述 volume_type 是 String 磁盘类型，只支持如下类型： SSD GPSSD size 是 Integer 共享磁盘大小，单位GiB，取值范围[10，32768]。 表12 band_width 参数 是否必选 参数类型 描述 band_width_id 否 String 云手机服务器的带宽唯一标识，选共享带宽时必选。 band_width_size 否 Integer 云手机服务器的带宽大小，选独享带宽时必选。 band_width_charge_mode 是 Integer 云手机服务器带宽的计费方式。 0：bandwidth, 按带宽计费 1：traffic, 按流量计费 band_width_share_type 是 Integer 云手机服务器的带宽类型。 0：per，独享带宽 1：whole，共享带宽

服务器规格列表 规格名称 规格说明 physical.rx1.xlarge CPU 64U，Memory 256G，Disk 2*1.2T SAS + 800G SSD，网卡2 x 2*10GE physical.rx1.xlarge.cg CPU 64U，Memory 256G，Disk 2*1.2T SAS + 800G SAS SSD，网卡2 x 2*10GE，云手游接入软件 physical.rx2.32xlarge.4 CPU 128U，Memory 512G，无本地盘，网卡2 x 2*10GE physical.rx3.32xlarge.4 CPU 128U，Memory 512G，无本地盘，网卡2 x 2*10GE 父主题： 附录

云手机规格列表 规格名称 规格说明 rc1.se 手机开数 60，CPU 4U，Memory 8GB，720P 30fps rc1.plus 手机开数 30，CPU 6U，Memory 12GB，720P 60fps rc2.se 手机开数 100，CPU 5U，Memory 10GB，720P 30fps rc2.plus 手机开数 80，CPU 6U，Memory 12GB，720P 30fps rc2.pro 手机开数 60，CPU 8U，Memory 16GB，720P 60fps rc2.max 手机开数 40，CPU 16U，Memory 24GB，1080P 30fps rc2.pro_max 手机开数 20，CPU 20U，Memory 32GB，1080P 30fps rc3.se 手机开数 100，CPU 5U，Memory 10GB，720P 30fps rc3.plus 手机开数 90，CPU 6U，Memory 12GB，720P 60fps rc3.pro 手机开数 60，CPU 8U，Memory 16GB，1080P 60fps rc3.max 手机开数 40，CPU 16U，Memory 24GB，1080P 60fps rc3.pro_max 手机开数 20，CPU 20U，Memory 32GB，1080P 60fps 父主题： 附录

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 count Integer 实例总数。 servers Array of Server objects 云手机服务器信息。 表5 Server 参数 参数类型 描述 server_name String 云手机服务器名称，不超过65字符，只支持英文字母、数字、汉字、下划线和中划线。 availability_zone String 云手机服务器所在的可用区。如上海一可用区1为cn-east-3a。 server_id String 云手机服务器的唯一标识，不超过32个字节。 server_model_name String 云手机服务器规格名称，不超过64个字节。 phone_model_name String 云手机规格名称，不超过64个字节。 keypair_name String 连接云手机所使用的密钥对的名称，不超过64个字节。 status Integer 服务器状态。 0、1、3、4：创建中 2：异常 5：正常 8：冻结 10：关机 11：关机中 12：关机失败 13：开机中 vpc_id String 云手机服务器所属虚拟私有云（简称VPC）的ID。 网络版本network_version取值为“v1”时，表示云手机服务器所属资源租户的VPC ID；取值为“v2”时，表示租户创建服务器时指定VPC的 VPC ID。 cidr String 云手机服务器所属虚拟私有云（简称VPC）的网段。网络版本 network_version 取值为“v1”时，表示云手机服务器所属资源租户的VPC CIDR；取值为“v2”时，表示租户创建服务器时指定 VPC 的 VPC CIDR。 vpc_cidr String 云手机服务器所属虚拟私有云（简称VPC 网络版本 network_version 取值为“v1”时，表示云手机服务器所属资源租户的VPC CIDR；取值为“v2”时，表示租户创建服务器时指定 VPC 的 VPC CIDR subnet_id String 云手机服务器所属子网的ID。仅在网络版本 network_version 取值为“v2”时，该取值表示租户创建服务器时指定子网的 ID，网络版本取值为“v1”时，该字段表示云手机服务器所属资源租户的子网ID。 subnet_cidr String 云手机服务器所属子网网段。网络版本 network_version 取值为“v2”时，表示租户创建服务器时指定子网的 CIDR; 取值为“v1”时，表示云手机服务器所属资源租户的子网CIDR。 addresses Array of Address objects 云手机服务器的IP相关信息。 resource_project_id String 云手机服务器的项目ID。用于对使用系统定义网络的服务器创建对等连接，并非租户的项目ID。 metadata metadata object 订单以及产品相关信息。 network_version String 是否为自定义网络的云手机服务器标识。"v1"，非自定义网络的云手机服务器。 "v2"，自定义网络的云手机服务器。支持按照网络版本字段进行筛选。 enterprise_project_id String 云手机服务器所属企业项目ID。 create_time String 创建时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 update_time String 更新时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 表6 Address 参数 参数类型 描述 intranet_ip String 云手机服务器的内网IP，过期字段。 access_ip String 云手机服务器的公网IP，过期字段。 server_ip String 云手机服务器的内网IP，新增字段。 public_ip String 云手机服务器的公网IP，新增字段。 表7 metadata 参数 参数类型 描述 product_id String 产品ID，不超过64个字节。 order_id String 订单ID，不超过64个字节。 charging_mode Integer 计费类型。 0：包周期

响应示例 状态码：200 OK { "servers" : [ { "server_name" : "cph-edgr-1", "server_id" : "4aff349ab539452a85ac5d7442b39377", "server_model_name" : "physical.rx1.xlarge", "phone_model_name" : "rx1.cp.c105.d6.e5v5", "keypair_name" : "keypair01", "status" : 2, "vpc_id" : "9a11e291-967f-4dd6-99bd-9be54f10583c", "cidr" : "192.168.0.0/16", "vpc_cidr" : "192.168.0.0/16", "subnet_id" : "c7f9983d-03ca-4a2e-a0e1-d6bd97174669", "subnet_cidr" : "192.168.0.0/24", "addresses" : [ { "intranet_ip" : "192.168.0.62", "server_ip" : "192.168.0.62", "access_ip" : "10.246.175.190", "public_ip" : "10.246.175.190" }, { "intranet_ip" : "192.168.0.169", "server_ip" : "192.168.0.169", "access_ip" : "10.246.171.245", "public_ip" : "10.246.171.245" } ], "resource_project_id" : "06a5b529fa80d28b2f53c014024bed44", "metadata" : { "product_id" : "00301-221014-0--0", "order_id" : " CS 21111116336E8RX", "charging_mode" : 0 }, "availability_zone" : "xxxxxx", "network_version" : "v2", "create_time" : "2021-11-11T08:33:40Z", "update_time" : "2021-11-11T09:28:30Z" }, { "server_name" : "cph-igfp-2", "server_id" : "6d74b672216d40f39377a99e7f95aa95", "server_model_name" : "physical.kg1m.4xlarge.cg", "phone_model_name" : "kg1m.cg.c60.d20SSD.e1v1", "keypair_name" : "KeyPair-2", "status" : 2, "vpc_id" : "12021c68-730f-41fa-9884-11c616f4c9ad", "cidr" : "172.31.0.0/16", "vpc_cidr" : "172.31.0.0/16", "subnet_id" : "92cf2447-163c-4fe8-897b-fd262ab6b134", "subnet_cidr" : "172.31.0.0/16", "addresses" : [ { "intranet_ip" : "172.31.185.82", "access_ip" : "88.88.48.151", "server_ip" : "172.31.185.82", "public_ip" : "88.88.48.151" } ], "resource_project_id" : "06a5b529fa80d28b2f53c014024bed44", "metadata" : { "product_id" : "OFFI635412973496623104", "order_id" : "CS21083015171L1CA", "charging_mode" : 0 }, "availability_zone" : "xxxxxx", "network_version" : "v1", "create_time" : "2021-08-30T07:17:40Z", "update_time" : "2021-11-05T09:07:57Z" } ], "request_id" : "4336f6c61d2048c6b58b4368d9d95ecd", "count" : 2 }

URI GET /v1/{project_id}/cloud-phone/servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量为一个大于等于0整数，表示查询该偏移量后面的所有的资源数，默认值为0。 limit 否 Integer 每页返回的资源个数。取值范围：1~100（默认值为100），一般设置为10、20、50。 server_name 否 String 云手机服务器名称，支持模糊查询。 server_id 否 String 云手机服务器的唯一标识。 network_version 否 String 云手机服务器是否为自定义网络标识。 v1：系统定义网络的云手机服务器 v2：自定义网络的云手机服务器 phone_model_name 否 String 手机规格名称。 create_since 否 Long 查询的起始时间戳。 create_until 否 Long 查询的结束时间戳。 status 否 Integer 服务器状态。 0、1、3、4：创建中 2：异常 5：正常 8：冻结 10：关机 11：关机中 12：关机失败 13：开机中

请求示例 批量添加标签 Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/{resource_id}/tags/action { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。 create：创建 tags 是 Array of Tag objects 标签列表。 表4 Tag 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，不能以_sys_开头。 value 是 String 值列表。 每个值最大长度255个unicode字符。 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，但首尾不能含有空格。