文档

ValidateVpcConnectivity - VPC授权连通性测试

更新时间:

测试API网关到指定VPC授权中指定实例的指定端口的网络连通性。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:ValidateVpcConnectivityget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
VpcAccessIdstring

Vpc 授权 ID

5f1b3216f9********e2c1297b6741dc
InstanceIdstring

API 网关实例 ID

apigateway-hz-72bc18******

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1
Connectedboolean

API 网关实例到指定 VPC 授权网络是否连通

  • true:网络连通
  • false:网络不连通
True
IpTypestring

当 VPC 授权中实例 ID 填写为 IP 时,表示 IP 的实例类型

  • ECS:IP 对应的实例为 ECS
  • SLB:IP 对应的实例为 ECS
  • INVALID:IP 对应的实例类型非法
ECS

示例

正常返回示例

JSON格式

{
  "RequestId": "9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1",
  "Connected": true,
  "IpType": "ECS"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史