功能介绍
分页查询 云手机 服务器，云手机服务器列表按照创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在云手机服务器，则返回空列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/cloud-phone/servers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量为一个大于0小于资源总个数的整数，表示查询该偏移量后面的所有的资源数，默认值为0。 |
|
limit |
否 |
Integer |
每页返回的资源个数。取值范围：1~100（默认值为100），一般设置为10、20、50。 |
|
server_name |
否 |
String |
云手机服务器名称，支持模糊查询。 |
|
server_id |
否 |
String |
云手机服务器的唯一标识。 |
|
network_version |
否 |
String |
云手机服务器是否为自定义网络标识。
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
count |
Integer |
实例总数。 |
|
servers |
云手机服务器信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
服务器状态。
|
|
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 |
云手机服务器的IP相关信息。 |
|
|
resource_project_id |
String |
云手机服务器的项目ID。 |
|
metadata |
订单以及产品相关信息。 |
|
|
network_version |
String |
是否为自定义网络的云手机服务器标识。"v1"，非自定义网络的云手机服务器。 "v2"，自定义网络的云手机服务器。支持按照网络版本字段进行筛选。 |
|
ent erp rise_project_id |
String |
云手机服务器所属企业项目ID。 |
|
create_time |
String |
创建时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 |
|
update_time |
String |
更新时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
intranet_ip |
String |
云手机服务器的内网IP，过期字段。 |
|
access_ip |
String |
云手机服务器的 公网IP ，过期字段。 |
|
server_ip |
String |
云手机服务器的内网IP，新增字段。 |
|
public_ip |
String |
云手机服务器的公网IP，新增字段。 |
请求示例
查询服务器列表
GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers
响应示例
状态码： 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" : "CS21111116336E8RX"
},
"availability_zone" : "br-iaas-odin1a",
"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"
},
"availability_zone" : "br-iaas-odin1a",
"network_version" : "v1",
"create_time" : "2021-08-30T07:17:40Z",
"update_time" : "2021-11-05T09:07:57Z"
} ],
"request_id" : "4336f6c61d2048c6b58b4368d9d95ecd",
"count" : 2
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
