文档

DescribeDataShareInstances - 查看数据共享详细信息

更新时间:

查看数据共享的状态。

接口说明

目前仅 Serverless 实例支持数据共享功能。

调试

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

授权信息

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

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

请求参数

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

实例当前所属的资源组 ID。如何获取资源组 ID,请参见查看资源组基本信息

rg-bp67acfmxazb4p****
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看可用的地域 ID。
cn-hangzhou
SearchValuestring

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

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

每页记录数,取值说明:

  • 30
  • 50
  • 100

默认值:30。

30
PageNumberinteger

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

1

返回参数

名称类型描述示例值
object
TotalRecordCountinteger

总记录数。

1
PageRecordCountinteger

本页记录数。

1
RequestIdstring

请求 ID。

B4CAF581-2AC7-41AD-8940-D5**********
PageNumberinteger

页码。

1
Itemsarray<object>

实例列表。

DBInstanceobject
RegionIdstring

地域 ID。

cn-hangzhou
ZoneIdstring

可用区 ID。

cn-hangzhou-j
DBInstanceIdstring

实例 ID。

gp-bp***************
DBInstanceModestring

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

  • Serverless:Serverless 版本。
  • StorageElasic:存储弹性模式。
  • Classic:存储预留模式。
Serverless
Descriptionstring

实例描述。

gp-bp***************
DataShareStatusstring

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

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史