响应参数 状态码：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：开机中

响应示例 状态码：200 成功响应。 { "id" : "222xx-xxxsdfsadf-xxx", "name" : "测试服务器", "machine_name" : "testy-xxxxx01-china.test.com", "description" : "测试服务器。", "server_group_id" : "11111xx-xxxsdfsadf-xxxxxxx", "flavor" : { "id" : "asdfjkl-2131f-xxx-123123", "links" : [ { "rel" : "", "hrel" : "" } ] }, "status" : "UNREGISTER", "create_time" : "2022-03-07T10:40:43.858Z", "update_time" : "2022-03-07T10:40:43.858Z", "image_id" : "xxx-xxx-xxx-xx", "availability_zone" : "", "domain" : "china.test.com", "ou_name" : "wksappusers", "sid" : "cc5279d6-xxxx-xx-xxx-b87a97cf02af", "instance_id" : "cc5279d6-xxxx-xx-xxx-b87a97cf02af", "os_version" : "", "os_type" : "Windows", "order_id" : "sdf2312-dfxxxx-sdfasdf-xxss", "maintain_status" : false, "scaling_auto_create" : false, "job_id" : "437415807337627690", "job_type" : "CREATE_SERVER", "job_status" : "WAITING", "job_time" : "2022-03-07T10:40:43.858Z", "resource_pool_id" : "cc5279d6-xxxx-xx-xxx-b87a97cf02af", "resource_pool_type" : "public", "host_id" : "cc5279d6-xxxx-xx-xxx-b87a97cf02af", "server_group_name" : "APS测试服务器组", "product_info" : { "product_id" : "workspace.appstream.general.2xlarge.4", "flavor_id" : "c3.large.4", "type" : "BASE", "architecture" : "x86", "cpu" : 2, "cpu_desc" : "云应用通用型|4核|8GB内存。", "memory" : 4096, "is_gpu" : false, "system_disk_type" : "SAS", "system_disk_size" : 80, "gpu_desc" : "GPU图形加速", "descriptions" : "GPU图形加速DG4型|32核128G内存32G显存|P02", "charge_mode" : 1, "contain_data_disk" : false, "resource_type" : "hws.resource.type.xxxx.vm", "cloud_service_type" : "hws.service.type.xxxxx", "volume_product_type" : "workspace", "sessions" : 2, "status" : "string", "cond_operation_az" : "cn-north-5a(normal),cn-north-5b(abandon),cn-north-5c(sellout)", "sub_product_list" : [ "xxx", "xxxx" ], "domain_ids" : [ "xxx", "xxxx" ], "package_type" : "general", "expire_time" : "2022-03-07T10:40:43Z", "support_gpu_type" : "A40" }, "metadata" : { "charging_mode" : 0 }, "session_count" : 10, "vm_status" : "BUILD", "task_status" : "scheduling", "freeze" : [ { "effect" : 1, "scene" : "ARREAR" } ], "host_address" : [ { "addr" : "127.*.*.1", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "C8-XX-XX-XX-XX-57", "OS-EXT-IPS:type" : "fixed", "OS-EXT-IPS:port_id" : "4b5fe243-2f5f-4c68-9eb2-8af3a5366666", "vpc_id" : "3bb2b656-0b79-4975-b870-a407f19038bb", "subnet_id" : "0785eeba-bfbb-4da3-94f9-d311c792e875", "tenant_type" : "tenant" } ], "enterprise_project_id" : "0", "tags" : [ { "key" : "demo01", "value" : "01" } ], "addresses" : { "additionalProp1" : [ { "addr" : "127.*.*.1", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "C8-XX-XX-XX-XX-57", "OS-EXT-IPS:type" : "fixed", "OS-EXT-IPS:port_id" : "4b5fe243-2f5f-4c68-9eb2-8af3a5366666" } ], "additionalProp2" : [ { "addr" : "127.*.*.1", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "C8-XX-XX-XX-XX-57", "OS-EXT-IPS:type" : "fixed", "OS-EXT-IPS:port_id" : "4b5fe243-2f5f-4c68-9eb2-8af3a5366666" } ], "additionalProp3" : [ { "addr" : "127.*.*.1", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "C8-XX-XX-XX-XX-57", "OS-EXT-IPS:type" : "fixed", "OS-EXT-IPS:port_id" : "4b5fe243-2f5f-4c68-9eb2-8af3a5366666" } ] }, "root_volume" : { "encrypt_flag" : 0, "kms_key" : "HJSADFHJKQWERVSADFSADF...", "key_alias" : "ADDJFKLJEWKLRJWKR4...", "type" : "SSD", "size" : 10, "kms_grant_id" : "adf123-123fgasdfxxxx-123sadasdf", "device" : "\tmp\test", "id" : "sdfasdf123-123asdfxxxxxxx-213adf", "volume_id" : "3213-df1234adsfxxxxxx-asdfsadf", "cluster_id" : "c950ee97-587c-4f24-8a74-3367e3da570f" }, "data_volumes" : [ { "encrypt_flag" : 0, "kms_key" : "HJSADFHJKQWERVSADFSADF...", "key_alias" : "ADDJFKLJEWKLRJWKR4...", "type" : "SSD", "size" : 10, "kms_grant_id" : "adf123-123fgasdfxxxx-123sadasdf", "device" : "\tmp\test", "id" : "sdfasdf123-123asdfxxxxxxx-213adf", "volume_id" : "3213-df1234adsfxxxxxx-asdfsadf", "cluster_id" : "c950ee97-587c-4f24-8a74-3367e3da570f" } ], "security_groups" : [ { "id" : "30789daf-e1c7-40ae-a3bc-11c84a8e5bb8", "name" : "" } ] }

响应说明 表5 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 serverId String 生成文件服务ID 全局唯一 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表6 5 returnDesc String 描述。

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200033 外呼数据不存在。 3 0200034 子状态与业务结果不匹配。 4 02000005 参数长度超过指定范围 5 02000001 参数值为空 6 02000002 参数包含非法字符 7 02000003 参数长度不能大于规定长度 8 02000004 参数长度不能小于规定长度 9 02000005 参数长度需要介于规定长度之间 10 02000006 参数值类型不正确 11 02000007 参数值大小不正确 12 02000008 参数转换异常，请检查请求参数 13 02000009 参数组合不正确，请检查请求参数 14 02000010 hour和minute必须同时存在

报文样例 该接口的请求消息体举例如下： { "userName":"zhangsan", "serverInfo":{ "ip":"1.2.3.4", "port":"22", "filePath":"/home/sftp" }, "serverPwd":"******" } 该接口的响应消息体举例如下： { "resultCode": "02000005", "description": " 参数长度需要介于8和80之间" }

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 serverInfo JsonObject True 文件服务器信息。 2 userName String True 用户名 3 serverPwd String True 服务密码，明文传递，后台密文保存 表4 serverInfo参数说明 序号 参数名 参数类型 是否必选 说明 1 ip String True 文件服务器IP。客户自备ip地址。 2 port String True port 3 filePath String True 文件服务器默认路径 示例：/home/sftp

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/addServer 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。

请求示例 变更服务器的规格 POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers/change-server-model { "server_id" : "a176d8625981453bbafbc0a321d8d6a1", "server_model_name" : "physical.rx1.xlarge.special", "phone_model_name" : "rx1.cp.sp.c105.d8.e5v5", "extend_param" : { "is_auto_pay" : 1 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_id 是 String 云手机服务器的唯一标识。只有特定的服务器才能操作变更规格。 server_model_name 是 String 目标云手机服务器规格，不超过64个字节。仅允许相同代系服务器之间的规格切换。 phone_model_name 是 String 目标云手机规格。要求与变更前云手机规格路数相同，与目标云手机服务器规格匹配。 extend_param 否 extend_param object 购买模式参数。 表4 extend_param 参数 是否必选 参数类型 描述 is_auto_pay 否 Integer 否自动付款。默认不自动付款。如果是规格升配的变更，则需要支付额外的费用，如果是降配的变更，则会自动退款。 1 ：自动付款 0 ：不自动付款

响应示例 状态码：200 OK { "request_id" : "1564567b8bab40f34711234cb80d8574", "order_id" : "CS1710111105S8IPB", "product_id" : "00301-25217-0--0", "server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ] }

请求示例 创建云手机裸服务器请求体 POST https://{CPH Endpoint}/v2.1/{project_id}/cloud-phone/servers { "server_name" : "cph-test-wy", "server_model_name" : "physical.rx2.32xlarge.4", "count" : 1, "order_param" : { "charging_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_renew" : 0, "is_auto_pay" : 1 }, "nics" : [ { "subnet_id" : "3c5e2638-b71f-4499-8d1e-355e89f21ae0", "vpc_id" : "6eb5019f-df01-4ded-9486-d54e7b282ced", "ipv6_enable" : true, "ipv6_band_width_id" : "fbe74c2f-e2ba-427a-b8aa-1c7c4f510ac1" } ], "public_ip" : { "type" : "5_bgp", "count" : 1, "band_width" : { "band_width_share_type" : 0, "band_width_size" : 300, "band_width_charge_mode" : 1 } }, "keypair_name" : "KeyPair-1d1d-wy", "enterprise_project_id" : "0" }

响应参数 状态码：200 表9 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 order_id String 订单ID，不超过64个字节。 product_id String 产品ID，不超过64个字节。 server_ids Array of strings 服务器ID列表。 error_msg String 任务错误码说明。 error_code String 任务错误码。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_name 是 String 云手机裸服务器名称，不超过60个字符，只支持英文字母、数字、汉字、下划线和中划线。批量购买会在云手机裸服务器名称后自动添加序号，比如设置此参数为server-1，那么创建的云手机裸服务器名称会自动按序增加数字后缀，比如为server-1-0001。 server_model_name 是 String 云手机裸服务器规格名称。 count 是 Integer 购买的云手机裸服务器个数，最多可购买10台。 order_param 是 order_param object 订单结构体。 nics 是 Array of NicForSingleServer objects 租户自定义的网卡的结构体，为待创建的云手机裸服务器的网卡信息。 public_ip 是 public_ip object 租户自定义的弹性公网IP结构体。 配置云手机裸服务器的弹性IP信息的方式， 自动分配，需要指定新创建弹性IP的信息； 使用已有，需要指定已经购买的EIP ID。 availability_zone 否 String 待创建云手机裸服务器所在的可用区（AZ）的名称。如上海一可用区1为cn-east-3a。 data_volume 否 data_volume object 数据盘结构体。 keypair_name 是 String 指定登录云手机裸服务器已有密钥的名称。 enterprise_project_id 否 String 企业项目ID。 该字段不传（或传为字符串“0”），则将资源绑定给默认企业项目。 image_id 否 String 云手机裸服务器镜像ID，不超过36个字节。未指定时使用默认云手机裸服务器镜像。 表4 order_param 参数 是否必选 参数类型 描述 charging_mode 是 Integer 计费类型。 0：包周期 period_type 是 Integer 订购周期类型。 2：月 3：年 period_num 是 Integer 订购周期数。 当订购周期为月时，取值范围[1, 9]。 当订购周期为年时，取值范围[1,10]。 is_auto_pay 否 Integer 是否自动付款。默认不自动付款。 0：不自动付款 1：自动付款 is_auto_renew 否 Integer 是否自动续订。默认不自动续订。 0：不自动续订 1：自动续订 表5 NicForSingleServer 参数 是否必选 参数类型 描述 subnet_id 是 String 租户自定义的子网 ID，为待创建的云手机裸服务器所属的子网。 需要指定vpc_id对应VPC下已创建的子网（subnet）的网络ID，UUID格式 ipv6_enable 否 Boolean 是否支持ipv6，默认不支持ipv6。 false：不支持ipv6 true：支持ipv6 ipv6_band_width_id 否 String ipv6绑定的共享带宽ID。 表6 public_ip 参数 是否必选 参数类型 描述 ids 否 Array of strings 指定已有的EIP进行云手机裸服务器创建，当前只支持传入一个已有的EIP ID。指定EIP后public_ip结构体中count字段和type字段不生效。 type 否 String 弹性公网IP的类型。 例如： 5_telcom：电信 5_union：联通 5_bgp：全动态BGP 5_sbgp：静态BGP count 否 Integer Eip数量。默认为0。取值范围为【0,1】 band_width 是 band_width object 云手机裸服务器使用的带宽信息。 表7 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，共享带宽 表8 data_volume 参数 是否必选 参数类型 描述 volume_type 是 String 数据盘类型，只支持如下类型： SSD GPSSD size 是 Integer 数据盘大小，单位GiB，取值范围[1，32768] count 否 Integer 数据盘数量，默认值为1