文档首页/ VPC终端节点 VPCEP/ API参考 (巴黎区域) / API/ 终端节点服务功能/ 接受或拒绝终端节点的连接
更新时间：2024-03-14 GMT+08:00
查看PDF
分享

接受或拒绝终端节点的连接

功能介绍

接受或者拒绝终端节点连接到当前的终端节点服务。

URI

POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections/action

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

参数

是否必选

描述

project_id

是

项目ID，获取方法请参见获取项目ID。

vpc_endpoint_service_id

是

终端节点服务的ID。

请求消息

  • 参数说明
    表2 请求参数

    名称

    是否必选

    参数类型

    描述

    action

    是

    String

    允许或拒绝连接。

    • receive：允许连接。
    • reject：拒绝连接。

    endpoints

    是

    Array of strings

    终端节点ID列表。

    每次请求目前支持单条endpoint的接受或拒绝。
  • 请求样例
    接受ID为“705290f3-0d00-41f2-aedc-71f09844e879”的终端节点连接到ID为“4189d3c2-8882-4871-a3c2-d380272eed88”的终端节点服务。 
    POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections/action
    { 
   "endpoints":["705290f3-0d00-41f2-aedc-71f09844e879"],
   "action": "receive"
}

响应消息

  • 参数说明
    表3 响应参数

    参数

    参数类型

    描述

    connections

    Array of objects

    连接列表，详细内容请参见表4。
    表4 connection要素说明

    属性

    参数类型

    描述

    id

    String

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

    marker_id

    Integer

    终端节点的报文标识。

    created_at

    String

    终端节点的创建时间。

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

    updated_at

    String

    终端节点的更新时间。

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

    domain_id

    String

    用户的Domain ID。

    status

    String

    终端节点的连接状态。

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

    error

    Array of objects

    错误信息。

    当终端节点服务状态异常，即“status”的值为“failed”时，会返回该字段，详细内容请参见表5。
    表5 Error要素说明

    属性

    参数类型

    描述

    error_code

    String

    错误编码。

    error_message

    String

    错误信息。
  • 响应样例 
    {
  "connections":
 [
   {
      "id":"4189d3c2-8882-4871-a3c2-d380272eed83",
      "status":"accepted",
      "marker_id":422321321312321321,
      "domain_id":"6e9dfd51d1124e8d8498dce894923a0d",
      "created_at":"2018-01-30T07:42:01Z",
      "updated_at":"2018-01-30T07:42:01Z"
       }
   ]
}

    或

    {
  "error_code": "Endpoint.2013"
  "error_msg": "The endpoint does not belong to the endpoint service."
}

状态码

状态码请参见状态码。