调用DescribeInstances查询实例的列表信息_数据安全中心(DSC)-阿里云帮助中心

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeInstances	系统规定参数。取值：DescribeInstances。
PageSize	Integer	否	20	设置的每页最多展示的数据量。默认取值为20，最大值为100。
PageNumber	Integer	否	1	查询的当前页码。
RegionId	String	否	cn-hangzhou	数据库审计实例的地域ID。说明您可以通过调用DescribeRegions获取地域ID。
InstanceStatus	String	否	RUNNING	实例状态。取值： PENDING：未初始化 CREATING：创建中 RUNNING：运行中 EXPIRED：已过期 CREATE_FAILED：创建失败 UPGRADING：变配中 UPGRADE_FAILED：变配失败
ResourceGroupId	String	否	rg-acfm26ougij6****	资源组ID。您可以通过调用ListResourceGroups接口获取资源组ID。
InstanceId.N	String	否	dbaudit-cn-78v1gc****	数据库审计实例ID。
Tag.N.Key	String	否	test	标签键。
Tag.N.Value	String	否	testValue	标签值。
GetCenterInstance	Boolean	否	false	是否查询所有地域的数据库审计实例列表。取值： true：查询所有地域 false：不查询所有地域（默认取值）
Lang	String	否	zh	请求和接收消息的语言类型，默认值zh。取值： zh：中文 en：英文

返回数据

名称	类型	示例值	描述
TotalCount	Long	1	查询到的数据库审计实例总数量。
RequestId	String	12AA0353-F01D-43E2-A85C-9040F7A35D93	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。
Instances	Array of Instance		数据库审计实例信息。
VpcId	String	vpc-bp1c85tzgqu1bf5b****	数据库审计实例绑定的VPC ID。
VswitchId	String	vsw-bp1kep1f0k5fnyfs****	数据库审计实例绑定的交换机ID。
ExpireTime	Long	1725638400000	数据库审计实例的过期时间戳。单位：毫秒。
InstanceId	String	dbaudit-cn-78v1gc****	数据库审计实例ID。
InternetEndpoint	String	tsiqv*****-public.dbaudit.aliyuncs.com	数据库审计实例的公网域名。
RegionId	String	cn-hangzhou	数据库审计实例所在的地域ID。
IntranetEndpoint	String	tsiqv*****.dbaudit.aliyuncs.com	数据库审计实例的私网域名。
StartTime	Long	1722926365000	购买数据库审计实例的时间戳。单位：毫秒。
SeriesCode	String	alpha	购买实例时的系列Code。
Description	String	Note	实例的备注信息。
InstanceStatus	String	RUNNING	实例状态。取值： PENDING：未初始化 CREATING：创建中 RUNNING：运行中 EXPIRED：已过期 CREATE_FAILED：创建失败 UPGRADING：变配中 UPGRADE_FAILED：变配失败
LicenseCode	String	alpha.professional	购买实例时选择的套餐对应的Code。
PublicNetworkAccess	Boolean	false	是否可以通过公网访问该数据库审计实例。取值： true：可以通过公网访问该审计实例。 false：不能通过公网访问该审计实例。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstances
&PageSize=20
&PageNumber=1
&RegionId=cn-hangzhou
&GetCenterInstance=false
&Lang=zh
&公共请求参数

正常返回示例

XML格式

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

<DescribeInstancesResponse>
    <TotalCount>1</TotalCount>
    <RequestId>12AA0353-F01D-43E2-A85C-9040F7A35D93</RequestId>
    <Instances>
        <VpcId>vpc-bp1c85tzgqu1bf5b****</VpcId>
        <VswitchId>vsw-bp1kep1f0k5fnyfs****</VswitchId>
        <ExpireTime>1725638400000</ExpireTime>
        <InstanceId>dbaudit-cn-78v1gc****</InstanceId>
        <InternetEndpoint>tsiqv*****-public.dbaudit.aliyuncs.com</InternetEndpoint>
        <RegionId>cn-hangzhou</RegionId>
        <IntranetEndpoint>tsiqv*****.dbaudit.aliyuncs.com</IntranetEndpoint>
        <StartTime>1722926365000</StartTime>
        <SeriesCode>alpha</SeriesCode>
        <Description>Note</Description>
        <InstanceStatus>RUNNING</InstanceStatus>
        <LicenseCode>alpha.professional</LicenseCode>
        <PublicNetworkAccess>false</PublicNetworkAccess>
    </Instances>
</DescribeInstancesResponse>

JSON格式

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

{
  "TotalCount" : 1,
  "RequestId" : "12AA0353-F01D-43E2-A85C-9040F7A35D93",
  "Instances" : [ {
    "VpcId" : "vpc-bp1c85tzgqu1bf5b****",
    "VswitchId" : "vsw-bp1kep1f0k5fnyfs****",
    "ExpireTime" : 1725638400000,
    "InstanceId" : "dbaudit-cn-78v1gc****",
    "InternetEndpoint" : "tsiqv*****-public.dbaudit.aliyuncs.com",
    "RegionId" : "cn-hangzhou",
    "IntranetEndpoint" : "tsiqv*****.dbaudit.aliyuncs.com",
    "StartTime" : 1722926365000,
    "SeriesCode" : "alpha",
    "Description" : "Note",
    "InstanceStatus" : "RUNNING",
    "LicenseCode" : "alpha.professional",
    "PublicNetworkAccess" : false
  } ]
}

错误码

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