文档

DescribeInstanceClusterInfo - 查询专享实例集群信息

更新时间:

查询专享实例集群信息。

调试

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

授权信息

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

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

请求参数

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

专享实例集群名称

testvpc

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
InstanceClusterNamestring

专享实例集群名称

test
InstanceClusterIdstring

纳管该专享实例的专享实例集群的 ID

apigateway-ht-04e41d95e9c1
InstanceClusterStatusstring

专享实例集群状态

RUNNING
InstanceClusterVersionstring

专享实例集群版本

3.5.3.856
Descriptionstring

描述,不超过 200 个字符

v0.0.4
RegionIdstring

实例所属地域的 ID

cn-hangzhou
CreatedTimestring

创建时间

2022-10-10T18:29:27
ModifiedTimestring

修改时间

2023-06-19 10:40:29 +0800
InstanceClusterAttributeobject

专享实例集群的详细信息

HttpsPoliciesstring

https 安全策略

HTTPS2_TLS1_0
InternetEgressAddressstring

公网出口地址

39.106.XX.XX
IntranetEgressAddressstring

内网出口地址

100.104.XX.XX/26
VpcIntranetEnableboolean

是否开启内网 VPC 域名

IntranetSegmentsstring

自定义网段,所配置的网段将被视为私网地址

123.0.0.1
UserVpcIdstring

客户端 vpcid

vpc-2zew2v4vcg78mXXXX
UserVswitchIdstring

客户端 vpc 的交换机

vsw-2zecr5r7ao44tslsXXXX
VpcOwnerIdlong

VPC 实例所属账号 ID

165438596694XXXX
IPV4AclIdstring

IPV4 访问控制策略 ID

acl-t4n8i4rvvp70kcyuoXXXX
IPV4AclNamestring

IPV4 访问控制策略名称

test-black
IPV4AclStatusstring

是否开启 IPV4 访问控制功能。取值:

  • on:开启访问控制
  • off:关闭访问控制
on
IPV4AclTypestring

IPV4 访问控制策略类型

  • black:黑名单

  • white:白名单

black
EgressIpv6Enableboolean

IPV6 出访能力是否支持

true
SupportIpv6boolean

是否支持 ipv6

true
IPV6AclNamestring

IPV6 访问控制策略名称

test
IPV6AclIdstring

IPV6 访问控制策略 ID

acl-t4nevzhwbpe7cup18XXXX
IPV6AclStatusstring

是否开启 IPV6 访问控制功能。取值:

  • on:开启访问控制

  • off:关闭访问控制

on
IPV6AclTypestring

IPV6 访问控制策略类型

  • black:黑名单
  • white:白名单
white
VipTypeListstring

实例集群已开通的 VIP 列表

VPC_INTERNET_IPV6
VpcSlbIntranetEnableboolean

是否开启 API 网关自调用域名

false
ConnectVpcIdstring

VPC 融合类型实例集群联通的用户 VPC ID

vpc-p0w3kxxxxxxxxxxxxxxxx
ConnectCidrBlocksstring

VPC 融合类型实例集群可以访问到的用户 VPC 的内网网段

["192.168.1.0/24","192.168.0.0/24"]
InstanceListobject []

实例集群包含的专享实例列表

InstanceNamestring

实例名称

tf-testacceu-central-1apigatewayinstance8752
InstanceIdstring

专享实例 ID

apigateway-ht-04e41d95e9c1
Statusstring

专享实例状态

RUNNING
ErrorMessagestring

调用失败时,返回的出错信息

Instance not found.
InstanceClusterTypestring

专享实例集群类型

normal

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "InstanceClusterName": "test",
  "InstanceClusterId": "apigateway-ht-04e41d95e9c1\n",
  "InstanceClusterStatus": "RUNNING",
  "InstanceClusterVersion": "3.5.3.856",
  "Description": "v0.0.4",
  "RegionId": "cn-hangzhou",
  "CreatedTime": "2022-10-10T18:29:27",
  "ModifiedTime": "2023-06-19 10:40:29 +0800",
  "InstanceClusterAttribute": {
    "HttpsPolicies": "HTTPS2_TLS1_0",
    "InternetEgressAddress": "39.106.XX.XX",
    "IntranetEgressAddress": "100.104.XX.XX/26",
    "VpcIntranetEnable": true,
    "IntranetSegments": "123.0.0.1",
    "UserVpcId": "vpc-2zew2v4vcg78mXXXX",
    "UserVswitchId": "vsw-2zecr5r7ao44tslsXXXX",
    "VpcOwnerId": 0,
    "IPV4AclId": "acl-t4n8i4rvvp70kcyuoXXXX",
    "IPV4AclName": "test-black",
    "IPV4AclStatus": "on",
    "IPV4AclType": "black",
    "EgressIpv6Enable": true,
    "SupportIpv6": true,
    "IPV6AclName": "test",
    "IPV6AclId": "acl-t4nevzhwbpe7cup18XXXX",
    "IPV6AclStatus": "on",
    "IPV6AclType": "white",
    "VipTypeList": "VPC_INTERNET_IPV6",
    "VpcSlbIntranetEnable": false,
    "ConnectVpcId": "vpc-p0w3kxxxxxxxxxxxxxxxx",
    "ConnectCidrBlocks": "[\"192.168.1.0/24\",\"192.168.0.0/24\"]"
  },
  "InstanceList": {
    "Instance": [
      {
        "InstanceName": "tf-testacceu-central-1apigatewayinstance8752",
        "InstanceId": "apigateway-ht-04e41d95e9c1",
        "Status": "RUNNING",
        "ErrorMessage": "Instance not found."
      }
    ]
  },
  "InstanceClusterType": "normal"
}

错误码

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

  • 本页导读 (1)