更新时间:2022-03-31 GMT+08:00
分享

查询云手机服务器详情

功能介绍

  • 接口名称

    GetCloudPhoneServerDetail

  • 功能描述

    根据server_id查询云手机服务器的详细信息。

URI

GET /v1/{project_id}/cloud-phone/servers/{server_id}

参数说明请参见表1
表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID

获取方式请参见获取项目ID

server_id

String

云手机服务器的唯一标识

请求消息

  • 请求参数

  • 请求样例
    1
    GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers/88b8449b896f3a4f0ad57222dd91909
    

响应消息

  • 响应参数

    参数

    参数类型

    描述

    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 字段取值一致,后续将废弃该字段。

    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

    Object

    订单以及产品相关信息,详情请参见表2

    addresses

    Array of objects

    云手机服务器的IP相关信息,详情请参见表3

    band_widths

    Array of objects

    云手机服务器带宽信息的结构体数组,详情请参见 band_widths 数据结构说明。

    volumes

    Array of objects

    云手机服务器卷信息的结构体数组,详情请参见 volumes 数据结构说明。

    network_version

    String

    云手机服务器是否为自定义网络标识。

    取值范围:

    • "v1",系统定义网络的云手机服务器。
    • "v2",自定义网络的云手机服务器。

    security_groups

    String数组

    服务器扩展网卡绑定的安全组信息

    系统定义网络的服务器,该字段返回为空列表

    create_time

    String

    创建时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。

    update_time

    String

    更新时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。

    表2 metadata数据结构说明

    参数

    参数类型

    描述

    order_id

    String

    订单ID,不超过64个字节。

    product_id

    String

    产品ID,不超过64个字节。

    probation_begin_time

    String

    云手机试玩开始时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。

    probation_end_time

    String

    云手机试玩结束时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。

    表3 address数据结构说明

    参数

    参数类型

    描述

    intranet_ip(过期)

    String

    云手机服务器的内网IP

    access_ip(过期)

    String

    云手机服务器的公网IP

    server_ip(新增)

    String

    云手机服务器的内网IP

    public_ip(新增)

    String

    云手机服务器的公网IP

    表4 band_widths 数据结构说明

    参数

    参数类型

    描述

    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

    表5 volumes 数据结构说明

    参数

    参数类型

    描述

    volume_name

    String

    云手机服务器的硬盘名称

    volume_id

    String

    云手机服务器的硬盘唯一标识

    volume_size

    Integer

    云手机服务器的硬盘大小,单位G

    volume_type

    Integer

    云手机服务器的硬盘类型

    create_time

    String

    硬盘创建时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ

    update_time

    String

    硬盘更新时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ

  • 响应样例
    { 
        "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",
        "subnet_cidr": "172.31.0.0/16",
        "request_id": "91d5bf46a817466daa25fc5824ab9717",
        "status": 5,
        "network_version": "v1",
        "security_groups": []
    }
  • 响应样例 - 自定义网络的云手机服务器
    {
        "server_name": "cph-2ykg-asdv-2",
        "server_id": "95bf815ae612435d9ab2af7ad91dcaab",
        "server_model_name": "physical.kg1.4xlarge.cp",
        "phone_model_name": "kg1.cp.c150.d10GPSSD.e2v2.br150",
        "keypair_name": "KeyPair-wangnan",
        "status": 5,
        "availability_zone": "br-iaas-odin1a",
        "create_time": "2021-02-18T11:36:20Z",
        "update_time": "2021-02-18T11:50:14Z",
        "resource_project_id": "06a5b529fa80d28b2f53c014024bed44",
        "metadata": {
            "product_id": "OFFI454827367575412738",
            "order_id": "CS2102181935Q80Q9"
        },
        "volumes": [
            {
                "volume_name": "VOLUME_519ebd1fff7e4bd78af1c4ebe5d9477b",
                "volume_id": "2a5dae30-8d28-4759-8d2c-5081237ea3cb",
                "volume_size": 600,
                "volume_type": "SSD",
                "create_time": "2021-02-18T11:36:20Z",
                "update_time": "2021-02-18T11:48:41Z"
            },
            {
                "volume_name": "VOLUME_ad0221b2e22c41d295831133491dd0d2",
                "volume_id": "8905aa69-51a9-4439-add5-5c8fb8aceeab",
                "volume_size": 600,
                "volume_type": "SSD",
                "create_time": "2021-02-18T11:36:20Z",
                "update_time": "2021-02-18T11:49:08Z"
            },
            {
                "volume_name": "VOLUME_88ac4752585c49dea6031931e60aebb4",
                "volume_id": "2673a67b-4154-4e24-a107-1c41bfb7efc4",
                "volume_size": 600,
                "volume_type": "SSD",
                "create_time": "2021-02-18T11:36:20Z",
                "update_time": "2021-02-18T11:48:41Z"
            }
        ],
        "addresses": [
            {
                "intranet_ip": "192.168.0.74",
                "access_ip": "10.246.169.234",
                "server_ip": "192.168.0.74",
                "public_ip": "10.246.169.234"
            },
            {
                "intranet_ip": "192.168.0.120",
                "access_ip": "10.246.168.135",
                "server_ip": "192.168.0.120",
                "public_ip": "10.246.168.135"
            }
        ],
        "band_widths": [
            {
                "band_width_name": "d2d5f7f49e2e409283d41cc0a63cacee",
                "band_width_id": "8b85d44b-ac6f-48fb-bbab-e876e9c3502a",
                "band_width_size": 300,
                "band_width_charge_mode": 1,
                "band_width_share_type": 0,
                "create_time": "2021-02-18 11:48:40",
                "update_time": "2021-02-18 11:48:40"
            },
            {
                "band_width_name": "5435eeaa669d4b84aea25e404cf3acf1",
                "band_width_id": "fa788f38-7198-44ec-867b-93d49e2c5c14",
                "band_width_size": 300,
                "band_width_charge_mode": 1,
                "band_width_share_type": 0,
                "create_time": "2021-02-18 11:48:38",
                "update_time": "2021-02-18 11:48:38"
            }
        ],
        "vpc_id": "4fdf12dc-7a53-489e-b448-32e0eed99ea7",
        "subnet_id": "99462cb1-511c-4b3e-8f09-c80565304843",
        "cidr": "172.31.0.0/16",
        "vpc_cidr": "172.31.0.0/16",
        "subnet_cidr": "172.31.0.0/16",
        "network_version": "v2",
        "security_groups": ["7f46bf9e-9050-48d6-9034-65711f9595f8"],
        "request_id": "e09b46f28bfa4ee58c3cbd0075db48fc"
    }

返回值

请参考返回值

错误码

请参考错误码

分享:

    相关文档

    相关产品

关闭导读