更新时间:2024-04-15 GMT+08:00

查询终端节点详情

功能介绍

查询终端节点的详细信息。

URI

GET /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}

参数说明如表1所示。
表1 参数说明

参数

是否必选

描述

project_id

项目ID,获取方法请参见获取项目ID

vpc_endpoint_id

终端节点的ID。

请求消息

  • 参数说明

    无。

  • 请求样例
    查询ID为“4189d3c2-8882-4871-a3c2-d380272eed83”的终端节点详情。
    GET https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2-d380272eed83

响应消息

  • 参数说明
    表2 响应参数

    参数

    参数类型

    描述

    id

    String

    终端节点的ID,唯一标识。

    service_type

    String

    终端节点连接的终端节点服务类型。

    • gateway:由运维人员配置。用户无需创建,可直接使用。
    • interface:包括运维人员配置的云服务和用户自己创建的私有服务。其中,运维人员配置的云服务无需创建,用户可直接使用。

    status

    String

    终端节点的连接状态。

    • pendingAcceptance:待接受
    • creating:创建中
    • accepted:已接受
    • rejected:已拒绝
    • failed:失败
    • deleting:删除中

    active_status

    String

    账号状态。

    • arrear_frozen:欠费冻结
    • verify_frozen:未实名认证冻结
    • police_frozen:公安冻结
    • illegal_frozen:违规冻结
    • partner_frozen:合作伙伴冻结
    • active:解冻

    endpoint_service_name

    String

    终端节点服务的名称。

    marker_id

    Integer

    终端节点的报文标识。

    endpoint_service_id

    String

    终端节点服务的ID。

    enable_dns

    Boolean

    是否创建域名。

    • true:创建域名
    • false:不创建域名
    说明:

    当创建连接gateway类型终端节点服务的终端节点时,“enable_dns”设置为true或者false,均不创建域名。

    dns_names

    Array of strings

    访问所连接的终端节点服务的域名。

    说明:

    当创建连接Interface类型终端节点服务的终端节点,且“enable_dns”设置为true时,显示该参数。

    ip

    String

    访问所连接的终端节点服务的IP。

    仅当同时满足如下条件时,返回该参数:

    • 当查询连接interface类型终端节点服务的终端节点时。
    • 终端节点服务启用“连接审批”功能,且已经“接受”连接审批。

      “status”可以是“accepted”或者“rejected(仅支持“接受”连接审批后再“拒绝”的情况)”。

    vpc_id

    String

    终端节点所在的VPC的ID。

    subnet_id

    String

    vpc_id对应VPC下已创建的网络(network)的ID,UUID格式。

    说明:

    仅当查询连接interface类型终端节点服务的终端节点时返回该参数。

    created_at

    String

    终端节点的创建时间。

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

    updated_at

    String

    终端节点的更新时间。

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

    project_id

    String

    项目ID,获取方法请参见获取项目ID

    error

    Array of objects

    错误信息。

    当终端节点状态异常,即“status”的值为“failed”时,会返回该字段,详细内容请参见表3

    whitelist

    Array of strings

    控制访问终端节点的白名单。

    若未创建,则返回空列表。

    说明:

    创建连接Interface类型终端节点服务的终端节点时,显示此参数。

    enable_whitelist

    Boolean

    是否开启网络ACL隔离。

    • true:开启网络ACL隔离
    • false:不开启网络ACL隔离

    若未指定,则返回false。

    说明:

    创建连接Interface类型终端节点服务的终端节点时,显示此参数。

    routetables

    Array of strings

    路由表ID列表。

    若未指定,返回默认VPC下路由表ID。

    说明:

    创建连接Gateway类型终端节点服务的终端节点时,显示此参数。

    enable_status

    String

    是否启用终端节点。

    • enable:启用。
    • disable:禁用。
    表3 Error要素说明

    属性

    参数类型

    描述

    error_code

    String

    错误编码。

    error_message

    String

    错误信息。

  • 响应样例
    {
        "id": "4189d3c2-8882-4871-a3c2-d380272eed83",
        "status": "accepted",
        "service_type": "interface",
        "marker_id": 322312312312,
        "active_status":"active",
        "vpc_id": "4189d3c2-8882-4871-a3c2-d380272eed83",
        "enable_dns": false,
        "endpoint_service_name": "test123",
        "endpoint_service_id": "test123",
        "project_id": "6e9dfd51d1124e8d8498dce894923a0d",
        "whitelist": [
            "127.0.0.1"
        ],
        "enable_whitelist": true,
        "created_at": "2018-01-30T07:42:01Z",
        "updated_at": "2018-01-30T07:42:01Z",
        "tags": [
            {
                "key": "test1",
                "value": "test1"
            }
        ]
    }

状态码

状态码请参见状态码