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

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeInstanceAttribute	系统规定参数。取值：DescribeInstanceAttribute。
InstanceId	String	是	dbaudit-cn-78v1gc****	审计的实例ID。可以通过调用DescribeInstances接口获取的审计实例列表获取实例ID。
RegionId	String	否	cn-hangzhou	数据库审计实例的地域ID。可以通过调用DescribeRegions接口获取地域ID。

调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用API的请求格式，请参见本文示例中的请求示例。

返回数据


名称	类型	示例值	描述
RequestId	String	28382024-466D-4641-A144-40FD0DD53766	本次请求的ID。
InstanceAttribute	Object		实例属性信息。
VpcId	String	vpc-bp1c85tzgqu1bf5b****	实例绑定的VPC ID。
VswitchId	String	vsw-bp1kep1f0k5fnyfs****	实例绑定的交换机ID。
ExpireTime	Long	1578067200000	实例的过期时间。单位：毫秒。
InstanceId	String	dbaudit-cn-78v1gc****	本次请求的实例ID。
InternetEndpoint	String	tsiqvqjjlq-public.dbaudit.aliyuncs.com	实例的公网域名。
RegionId	String	cn-hangzhou	地域ID。
IntranetEndpoint	String	tsiqvqjjlq.dbaudit.aliyuncs.com	实例的私网域名。
StartTime	Long	1577437765000	实例的开始时间。用时间戳表示，即购买实例的时间。单位：毫秒。
SeriesCode	String	alpha	购买实例时的系列Code。
Description	String	API	实例的备注信息。
InstanceStatus	String	RUNNING	实例状态。取值： PENDING：未初始化 CREATING：创建中 RUNNING：运行中 EXPIRED：已过期 CREATE_FAILED：创建失败 UPGRADING：变配中 UPGRADE_FAILED：变配失败
LicenseCode	String	alpha.professional	实例的套餐Code。用户购买实例时选择的套餐对应的Code。
PublicNetworkAccess	Boolean	true	是否可以通过公网访问该审计实例。取值： true：可以通过公网访问该审计实例。 false：不能通过公网访问该审计实例。
WhiteList	Array of String	["10.168.XX.XX/32"]	允许审计流量访问数据库审计实例的公网IP列表。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceAttributeResponse>
    <RequestId>28382024-466D-4641-A144-40FD0DD53766</RequestId>
    <InstanceAttribute>
        <VpcId>vpc-bp1c85tzgqu1bf5b****</VpcId>
        <VswitchId>vsw-bp1kep1f0k5fnyfs****</VswitchId>
        <ExpireTime>1578067200000</ExpireTime>
        <InstanceId>dbaudit-cn-78v1gc****</InstanceId>
        <InternetEndpoint>tsiqvqjjlq-public.dbaudit.aliyuncs.com</InternetEndpoint>
        <RegionId>cn-hangzhou</RegionId>
        <IntranetEndpoint>tsiqvqjjlq.dbaudit.aliyuncs.com</IntranetEndpoint>
        <StartTime>1577437765000</StartTime>
        <SeriesCode>alpha</SeriesCode>
        <Description>API</Description>
        <InstanceStatus>RUNNING</InstanceStatus>
        <LicenseCode>alpha.professional</LicenseCode>
        <PublicNetworkAccess>true</PublicNetworkAccess>
        <WhiteList>["10.168.XX.XX/32"]</WhiteList>
    </InstanceAttribute>
</DescribeInstanceAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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