调用DescribeInstanceAttribute查询实例所有的属性信息,例如:实例ID、实例的备注信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstanceAttribute

要执行的操作。

取值:DescribeInstanceAttribute。

InstanceId String dbaudit-cn-78v1gcxxxxx

审计的实例ID。

RegionId String cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 28382024-466D-4641-A144-40FD0DD53766

请求ID。

InstanceAttribute Struct

实例属性信息。

RegionId String cn-hangzhou

地域ID。

InstanceId String dbaudit-cn-78v1gcxxxxx

实例ID。

VpcId String vpc-bp1c85tzgqu1bf5bxxxxx

实例绑定的VPC ID。

VswitchId String vsw-bp1kep1f0k5fnyfsxxxxx

实例绑定的交换机ID。

IntranetEndpoint String tsiqvqjjlq.dbaudit.aliyuncs.com

私网域名。

InternetEndpoint String tsiqvqjjlq-public.dbaudit.aliyuncs.com

公网域名。

InstanceStatus String RUNNING

实例状态。取值范围:

  • PENDING:未初始化
  • CREATING:创建中
  • RUNNING:运行中
  • EXPIRED:已过期
  • CREATE_FAILED:创建失败
  • UPGRADING:变配中
  • UPGRADE_FAILED:变配失败
StartTime Long 1577437765000

实例的开始时间。

ExpireTime Long 1578067200000

过期时间。

Description String API

备注信息。

LicenseCode String alpha.professional

许可Code。

SeriesCode String alpha

系列Code。

PublicNetworkAccess Boolean true

公网是否可访问该审计实例。

WhiteList List [10.168.1.xx/32]

公网白名单IP列表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstanceAttribute
&InstanceId=dbaudit-cn-78v1gcxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>28382024-466D-4641-A144-40FD0DD53766</RequestId>
<InstanceAttribute>
    <LicenseCode>alpha.professional</LicenseCode>
    <Description>API</Description>
    <InstanceId>dbaudit-cn-78v1gcxxxxx</InstanceId>
    <WhiteList>10.168.1.xx/32</WhiteList>
    <StartTime>1577437765000</StartTime>
    <VswitchId>vsw-bp1kep1f0k5fnyfsxxxxx</VswitchId>
    <VpcId>vpc-bp1c85tzgqu1bf5bxxxxx</VpcId>
    <SeriesCode>alpha</SeriesCode>
    <InstanceStatus>RUNNING</InstanceStatus>
    <PublicNetworkAccess>true</PublicNetworkAccess>
    <InternetEndpoint>tsiqvqjjlq-public.dbaudit.aliyuncs.com</InternetEndpoint>
    <RegionId>cn-hangzhou</RegionId>
    <ExpireTime>1578067200000</ExpireTime>
    <IntranetEndpoint>tsiqvqjjlq.dbaudit.aliyuncs.com</IntranetEndpoint>
</InstanceAttribute>

JSON 格式

{
	"RequestId":"28382024-466D-4641-A144-40FD0DD53766",
	"InstanceAttribute":{
 "LicenseCode":"alpha.professional",
 "Description":"API",
 "InstanceId":"dbaudit-cn-78v1gcxxxxx",
 "WhiteList":[
 	"10.168.1.xx/32"
 ],
 "StartTime":1577437765000,
 "VswitchId":"vsw-bp1kep1f0k5fnyfsxxxxx",
 "VpcId":"vpc-bp1c85tzgqu1bf5bxxxxx",
 "SeriesCode":"alpha",
 "InstanceStatus":"RUNNING",
 "PublicNetworkAccess":true,
 "InternetEndpoint":"tsiqvqjjlq-public.dbaudit.aliyuncs.com",
 "RegionId":"cn-hangzhou",
 "ExpireTime":1578067200000,
 "IntranetEndpoint":"tsiqvqjjlq.dbaudit.aliyuncs.com"
	}
}

错误码

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