调用DescribeDataShareInstances接口查看数据共享的状态。

使用说明

本接口用于查看Serverless版本的AnalyticDB PostgreSQL版实例的数据共享的状态。

QPS限制

本接口的单用户QPS限制默认为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

请求参数

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

系统规定参数。取值:DescribeDataShareInstances

RegionId String cn-hangzhou

地域ID。

说明 您可以调用DescribeRegions接口查看可用的地域ID。
SearchValue String gp-bp***************

搜索关键字,可以根据实例ID或实例描述进行过滤。

说明 您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情,包括实例ID和实例描述。
PageSize Integer 30

每页记录数,取值说明:

  • 30
  • 50
  • 100

默认值:30。

PageNumber Integer 1

页码,大于0且不超过Integer的最大值。默认值:1。

返回数据

名称 类型 示例值 描述
TotalRecordCount Integer 1

总记录数。

PageRecordCount Integer 1

本页记录数。

RequestId String B4CAF581-2AC7-41AD-8940-D5**********

请求ID。

PageNumber Integer 1

页码。

Items Array of DBInstance

实例列表。

DBInstance
RegionId String cn-hangzhou

地域ID。

ZoneId String cn-hangzhou-j

可用区ID。

DBInstanceId String gp-bp***************

实例ID。

DBInstanceMode String Serverless

实例资源类型,取值说明:

  • Serverless:Serverless版本。
  • StorageElasic:存储弹性模式。
  • Classic:存储预留模式。
Description String gp-bp***************

实例描述。

DataShareStatus String opened

数据共享的状态,取值说明:

  • opening:开通中。
  • opened:已开通。
  • closing:关闭中。
  • closed:已关闭。

示例

请求示例

http(s)://gpdb.aliyuncs.com/?Action=DescribeDataShareInstances
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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

<DescribeDataShareInstancesResponse>
    <TotalRecordCount>1</TotalRecordCount>
    <PageRecordCount>1</PageRecordCount>
    <RequestId>B4CAF581-2AC7-41AD-8940-D5**********</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <RegionId>cn-hangzhou</RegionId>
        <ZoneId>cn-hangzhou-j</ZoneId>
        <DBInstanceId>gp-bp***************</DBInstanceId>
        <DBInstanceMode>Serverless</DBInstanceMode>
        <Description>gp-bp***************</Description>
        <DataShareStatus>opened</DataShareStatus>
    </Items>
</DescribeDataShareInstancesResponse>

JSON格式

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

{
  "TotalRecordCount" : 1,
  "PageRecordCount" : 1,
  "RequestId" : "B4CAF581-2AC7-41AD-8940-D5**********",
  "PageNumber" : 1,
  "Items" : [ {
    "RegionId" : "cn-hangzhou",
    "ZoneId" : "cn-hangzhou-j",
    "DBInstanceId" : "gp-bp***************",
    "DBInstanceMode" : "Serverless",
    "Description" : "gp-bp***************",
    "DataShareStatus" : "opened"
  } ]
}

错误码

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