文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点服务功能> 接受或拒绝终端节点的连接
更新时间:2022-04-27 GMT+08:00
分享

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

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

vpc_endpoint_service_id

String

终端节点服务的ID。

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:2048

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

最小长度:1

最大长度:64

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

允许或拒绝连接。

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

最小长度:1

最大长度:32

endpoints

Array of strings

终端节点ID列表。 每次请求目前支持单条endpoint的接受或拒绝。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

connections

Array of ConnectionEndpoints objects

连接列表。

表5 ConnectionEndpoints

参数

参数类型

描述

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 QueryError objects

错误信息。

当终端节点服务状态异常,即“status”的值为“failed”时,会返回该字段。

表6 QueryError

参数

参数类型

描述

error_code

String

错误编码。

error_message

String

错误信息。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表8 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表10 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表12 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 404

表13 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表14 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 405

表15 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表16 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 406

表17 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表18 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 407

表19 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表20 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 408

表21 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表22 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 409

表23 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表24 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 500

表25 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表26 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 501

表27 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表28 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 502

表29 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表30 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 503

表31 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表32 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 504

表33 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表34 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

请求示例

POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88/connections/action

{
  "endpoints" : [ "705290f3-0d00-41f2-aedc-71f09844e879" ],
  "action" : "receive"
}

响应示例

状态码: 200

服务器已成功处理了请求

"{\n\"connections\":\n[\n{\"id\":\"4189d3c2-8882-4871-a3c2-d380272eed83\",\n\"status\":\"accepted\",\n\"marker_id\":422321321312321321,\n\"domain_id\":\"6e9dfd51d1124e8d8498dce894923a0d\",\n\"created_at\":\"2018-01-30T07:42:01Z\",\n\"updated_at\":\"2018-01-30T07:42:01Z\"\n}\n]\n}\n或\n{\n\"error_code\": \"Endpoint.2013\"\n\"error_msg\": \"The endpoint does not belong to the endpoint service.\"\n}"

状态码

状态码

描述

200

服务器已成功处理了请求

400

服务器未能处理请求

401

被请求的页面需要用户名和密码

403

对被请求页面的访问被禁止

404

服务器无法找到被请求的页面

405

请求中指定的方法不被允许

406

服务器生成的响应无法被客户端所接受

407

用户必须首先使用代理服务器进行验证,这样请求才会被处理

408

请求超出了服务器的等待时间

409

由于冲突,请求无法被完成

500

请求未完成。服务异常

501

请求未完成。服务器不支持所请求的功能

502

请求未完成。服务器从上游服务器收到一个无效的响应

503

请求未完成。系统暂时异常

504

网关超时

错误码

请参见错误码

分享:

    相关文档

    相关产品

close