文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-实例终端节点管理/ 接受或拒绝终端节点连接
更新时间：2024-11-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

接受或拒绝终端节点连接

功能介绍

接受或拒绝实例节点连接。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/connections/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

允许或拒绝连接

  • receive 接受

  • reject 拒绝

endpoints

是

Array of strings

终端节点列表

数组长度：1 - 50

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表5 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

connections

Array of EndpointConnection objects

连接列表
表6 EndpointConnection

参数

参数类型

描述

id

String

连接编号

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 删除中

状态码： 401

表7 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表9 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表11 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表13 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • 接受终端节点连接

    {
  "action" : "receive",
  "endpoints" : [ "9fa04c5e-64ec-4106-a014-2ad71ad9997d" ]
}

  • 拒绝终端节点连接

    {
  "action" : "reject",
  "endpoints" : [ "9fa04c5e-64ec-4106-a014-2ad71ad9997d" ]
}

响应示例

状态码： 200

OK

{
  "connections" : [ {
    "id" : "9cf102d8-aaa0-44cf-8222-fd6f2c073887",
    "marker_id" : 167792784,
    "created_at" : "2021-05-07T14:20:14Z",
    "updated_at" : "2021-05-07T14:30:25Z",
    "domain_id" : "c90f12a0f1ee43bc90a1f4d17bce35bc",
    "status" : "accepted"
  } ]
}

状态码： 401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

状态码： 404

Resource Not Found

{
  "error_code" : "APIC.7314",
  "error_msg" : "Endpoint service not found"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIC.9007",
  "error_msg" : "Failed to execute VCPEP request"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Resource Not Found

500

Internal Server Error

错误码

请参见错误码。