云服务器内容精选

  • 请求示例 购买云手机服务器 POST https://{CPH Endpoint}/v2/{project_id}/cloud-phone/servers { "server_name" : "cph-kertus-1110", "server_model_name" : "physical.kg1.4xlarge.cp", "phone_model_name" : "kg1.cp.c20.d64SSD.e1v1", "image_id" : "20060220200717f201120a2300000e91", "count" : 1, "keypair_name" : "keypair", "ports" : [ { "name" : "myServer1", "listen_port" : 20000, "internet_accessible" : "false" }, { "name" : "myServer2", "listen_port" : 20001, "internet_accessible" : "true" } ], "extend_param" : { "charging_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : 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 } }
  • 响应示例 状态码: 200 OK { "request_id" : "1564567b8bab40f34711234cb80d8574", "order_id" : "CS1710111105S8IPB", "product_id" : "00301-25217-0--0", "server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ] }
  • 请求参数 表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 云手机服务器规格,不超过64个字节。 phone_model_name 是 String 云手机规格,不超过64个字节。 image_id 是 String 云手机镜像ID,不超过32个字节。 count 是 Integer 购买的云手机服务器个数,最多可购买10台。 keypair_name 否 String 密钥对名称,不超过64个字节,用于云手机ADB登录。 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 云手机使用的带宽信息。 availability_zone 否 String 待创建云服务器所在的可用区,需要指定可用区(AZ)的名称。如上海一可用区1为cn-east-3a。 表4 Port 参数 是否必选 参数类型 描述 name 是 String 应用端口名称,不超过16个字节,系统关键服务名称不能使用"adb"和"vnc"。 listen_port 是 Integer 端口号,大于等于10000,小于等于50000。 internet_accessible 是 String 为"true"则映射出公网访问(忽略大小写)。 为其他则不映射。 表5 extend_param 参数 是否必选 参数类型 描述 charging_mode 是 Integer 计费类型。 0:包周期 period_type 是 Integer 订购周期类型。 2:月 3:年 period_num 是 Integer 订购周期数。 当订购周期为月时,取值范围[1, 9]。 当订购周期为年时,取值范围[1,10]。 is_auto_pay 否 Integer 是否自动付款。默认不自动付款。 1:自动付款 0:不自动付款 is_auto_renew 否 Integer 是否自动续订。默认不自动续订。 1:自动续订 0:不自动续订 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 磁盘大小,单位GB,取值范围[10,32768]。 表11 server_share_data_volume 参数 是否必选 参数类型 描述 volume_type 是 String 磁盘类型,只支持如下类型: SSD GPSSD size 是 Integer 磁盘大小,单位GB,取值范围[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,共享带宽
  • 功能介绍 购买云手机服务器,支持您复用已有的VPC网络管理云手机服务器,支持云手机服务器复用您已购买的共享带宽等资源。 请确保您已具有虚拟私有云资源,创建服务器需要指定一个已有的虚拟私有云,否则无法创建服务器。同时请确保您的账号至少具有VPC ReadOnlyAccess权限,以便虚拟私有云资源可以被选取到。 请确保您的账号已成功创建密钥对,并具有查询密钥对列表的细粒度权限ecs:serverKeypairs:list。若需要创建密钥对,请确保账号具有创建密钥对的细粒度权限ecs:serverKeypairs:create。 请确保已正确创建委托(委托名称cph_admin_trust,委托服务CPH),委托未被删除, 确保委托包含VPC FullAccess权限,委托及权限校验失败将导致云服务器创建失败。创建委托时委托类型选择“云服务”,云服务选择“CPH”,即允许CPH调用云服务。 请确保您使用的账号具有Security Administrator权限。 请确保您有足够的服务器及网络配额,配额校验不通过将导致创建失败。
  • 请求示例 切换云手机服务器 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", "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登录。 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 云手机使用的带宽信息。 表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 磁盘大小,单位GB,取值范围[10,32768]。 表11 server_share_data_volume 参数 是否必选 参数类型 描述 volume_type 是 String 磁盘类型,只支持如下类型: SSD GPSSD size 是 Integer 磁盘大小,单位GB,取值范围[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,共享带宽
  • 响应示例 状态码: 200 OK { "server_name" : "cph-418540-1620-40-old-1", "availability_zone" : "br-iaas-odin1a", "addresses" : [ { "public_ip" : "10.246.xxx.xxx", "server_ip" : "172.31.22.245", "intranet_ip" : "172.31.22.245", "access_ip" : "10.246.xxx.xxx" } ], "metadata" : { "product_id" : "OFFI451249149551403012", "order_id" : "CS2007271727F9XJE" }, "create_time" : "2020-01-01T00:00:00Z", "vpc_id" : "12021c68-730f-41fa-9884-11c616f4c9ad", "phone_model_name" : "kg1.cg.c40.d30SSD.e1v1.old", "subnet_cidr" : "172.31.0.0/16", "keypair_name" : "KeyPair-1230", "resource_project_id" : "06a5b529fa80d28b2f53c014024bed44", "server_id" : "6edb89150bc742aa81fc8ac4ff047297", "server_model_name" : "physical.kg1.4xlarge.cg", "update_time" : "2020-01-01T00:00:00Z", "cidr" : "172.31.0.0/16", "vpc_cidr" : "172.31.0.0/16", "subnet_id" : "5784d2fe-fefd-42f0-a7f1-e88454d8bc0f", "request_id" : "91d5bf46a817466daa25fc5824ab9717", "status" : 5, "network_version" : "v1", "security_groups" : [ ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 server_name String 云手机服务器名称, 不超过65字符,只支持英文字母、数字、汉字、下划线和中划线。 availability_zone String 云手机服务器所在的可用区。 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。 resource_project_id String 云手机服务器的项目ID。 metadata metadata object 订单以及产品相关信息。 addresses Array of Address objects 云手机服务器的IP相关信息。 band_widths Array of Bandwidth objects 云手机服务器带宽信息的结构体数组。 volumes Array of Volume objects 云手机服务器卷信息的结构体数组。 share_volume_info share_volume_info object 云手机服务器的共享存储相关信息。 network_version String 是否为自定义网络的云手机服务器标识。"v1",非自定义网络的云手机服务器。"v2",自定义网络的云手机服务器。支持按照网络版本字段进行筛选。 enterprise_project_id String 云手机服务器所属企业项目ID。 security_groups Array of strings 服务器扩展网卡绑定的安全组信息。 系统定义网络的服务器,该字段返回为空列表。 create_time String 创建时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 update_time String 更新时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 表4 metadata 参数 参数类型 描述 product_id String 产品ID,不超过64个字节。 order_id String 订单ID,不超过64个字节。 表5 Address 参数 参数类型 描述 intranet_ip String 云手机服务器的内网IP,过期字段。 access_ip String 云手机服务器的公网IP,过期字段。 server_ip String 云手机服务器的内网IP,新增字段。 public_ip String 云手机服务器的公网IP,新增字段。 表6 Bandwidth 参数 参数类型 描述 band_width_name String 云手机服务器的带宽名称。 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,共享带宽 create_time String 带宽创建时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 update_time String 带宽更新时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 表7 Volume 参数 参数类型 描述 volume_name String 云手机服务器的硬盘名称。 volume_id String 云手机服务器的硬盘唯一标识。 volume_size Integer 云手机服务器的硬盘大小,单位G。 volume_type String 云手机服务器的硬盘类型。 create_time String 硬盘创建时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 update_time String 硬盘更新时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 表8 share_volume_info 参数 参数类型 描述 volume_type String 共享存储磁盘类型。 size Integer 共享存储大小,单位G。 version Integer 共享存储版本: 0:共享存储1.0 1:共享存储2.0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of PhoneJob objects 任务列表。 表5 PhoneJob 参数 参数类型 描述 phone_id String 云手机的唯一标识ID,云手机相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。
  • 响应示例 状态码: 200 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "job_id" : "1564567b8bab40f34711234cb80d5678" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 command 是 String 安装单apk场景填写install,多apk场景填写install-multiple。 content 是 String 指定OBS桶中的apk文件(需要提前上传到指定桶中)。 只支持大小写字母、数字、下划线(_)、点(.)、斜线(/)、冒号(:)、中划线(-)。推送的文件只支持apk文件类型。 单apk场景,只能传一个apk,最大长度为1024字节;多apk场景,最多传50个apk,中间用空格分开,最大长度8100字节。 phone_ids 否 Array of strings 云手机ID列表。 server_ids参数不存在时必选,同时存在只处理phone_ids。 server_ids 否 Array of strings 云手机服务器ID列表。 phone_ids参数不存在时必选,同时存在只处理phone_ids。
  • 请求示例 在云手机中安装apk POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/commands { "command" : "install", "content" : "-t -r obs://push-bucket/my_apps/test.apk", "phone_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ] } 在云手机中安装多apk POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/commands { "command" : "install-multiple", "content" : "-t -r obs://push-bucket/my_apps/test_part1.apk obs://push-bucket/my_apps/test_part_2.apk obs://push-bucket/my_apps/test_part3.apk", "phone_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ] }
  • 功能介绍 在云手机中安装apk。系统会将指定的apk文件下载后直接安装到云手机中。 支持安装单apk应用和多apk应用。可使用install命令安装单apk应用,一次只支持安装一个apk,如果一次传多个apk只有第一个安装成功;可使用install-multiple命令安装多apk应用(多apk应用为单个应用拆分成多个apk),一次只支持同一个应用的多个apk。该接口为异步接口。接口调用前请先确保已完成CPH服务操作OBS桶的委托授权。委托CPH操作OBS桶请参见委托CPH操作OBS桶。 管理面性能有限,对相同服务器批量执行的ADB命令,将会阻塞云手机其他任务执行。 建议通过开发应用市场的方式安装apk。允许安装的apk大小限制为2G(即不可将obs桶内大于2G的apk安装到手机中),超过限制将返回错误。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of Job objects 任务信息。 表5 Job 参数 参数类型 描述 phone_id String 云手机的唯一标识,云手机相关任务包含此字段。 server_id String 云手机服务器的唯一标识ID,云手机服务器相关任务包含此字段。 node_id String (已废弃)云手机服务器的唯一标识ID,云手机服务含此字段。 job_id String 任务的唯一标识。 begin_time String 任务处理开始时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 end_time String 任务处理结束时间, 时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。 status Integer 任务状态。 1 :运行中 2 : 成功 -1 :失败 error_code String 任务错误码。 error_msg String 任务错误码说明。 execute_msg String 任务执行返回内容,最长1024个字节。
  • 响应示例 状态码: 200 OK { "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "server_id" : "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01", "node_id" : "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01", "job_id" : "1564567b8bab40f34711234cb80d0123", "begin_time" : "2017-10-25T00:00:00Z", "end_time" : "2017-10-25T00:00:30Z", "status" : -1, "error_code" : "CPS0005", "error_msg" : "Phone not found." }, { "phone_id" : "abc4567b8bab40ffb711234cb80d0abc", "server_id" : "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01", "node_id" : "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01", "job_id" : "1564567b8bab40f34711234cb80d0456", "begin_time" : "2017-10-25T00:00:00Z", "end_time" : "2017-10-25T00:00:32Z", "status" : 2, "error_code" : "", "error_msg" : "" } ] }