API网关 APIGAPI网关 APIG

更新时间:2021/06/18 GMT+08:00
分享

后端连通性检测接口

功能介绍

后端连通性检测接口

调试

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

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/backend/connectivity/check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目编号

instance_id

String

实例编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

backend_type

String

后端服务配置方式 backend_address - 配置后端服务地址(不使用负载通道) vpc_channel - 使用负载通道

枚举值:

  • backend_address

  • vpc_channel

backend_address

String

后端服务地址,当type为backend_address时必填

vpc_channel_id

String

负载通道编号,当type为vpc_channel时必填

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

check_result

String

后端服务连通性检测结果 SUCCESS - 连通 FAILED - 不连通

枚举值:

  • SUCCESS

  • FAILED

failures

Array of strings

后端服务连通检测失败的列表

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

{
  "backend_type" : "vpc_channel",
  "vpc_channel_id" : "3019f57095a94ec885031a16d3156f12"
}

响应示例

状态码: 201

OK

{
  "check_result" : "FAILED",
  "failures" : [ "10.***.***.250:30003", "10.***.***.251:30003" ]
}

状态码: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}

状态码: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码: 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}

状态码: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

201

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品