全部產品
Search
文件中心

AnalyticDB:DescribeDataShareInstances - 查看資料共用詳細資料

更新時間:Mar 21, 2026

查看資料共用的狀態。

介面說明

目前僅 Serverless 執行個體支援資料共用功能。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:DescribeDataShareInstances

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

ResourceGroupId

string

執行個體當前所屬的資源群組 ID。如何擷取資源群組 ID,請參見查看資源群組基本資料

rg-bp67acfmxazb4p****

RegionId

string

地區 ID。

說明

您可以調用 DescribeRegions 介面查看可用的地區 ID。

cn-hangzhou

SearchValue

string

搜尋索引鍵,可以根據執行個體 ID 或執行個體描述進行過濾。

說明

您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情,包括執行個體 ID 和執行個體描述。

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

PageSize

integer

每頁記錄數,取值說明:

  • 30

  • 50

  • 100

預設值:30。

30

PageNumber

integer

頁碼,大於 0 且不超過 Integer 的最大值。預設值:1。

1

返回參數

名稱

類型

描述

樣本值

object

TotalRecordCount

integer

總記錄數。

1

PageRecordCount

integer

本頁記錄數。

1

RequestId

string

請求 ID。

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

PageNumber

integer

頁碼。

1

Items

object

DBInstance

array<object>

執行個體列表。

object

RegionId

string

地區 ID。

cn-hangzhou

ZoneId

string

可用性區域 ID。

cn-hangzhou-j

DBInstanceId

string

執行個體 ID。

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

DBInstanceMode

string

執行個體資源類型,取值說明:

  • Serverless:Serverless 版本。

  • StorageElasic:儲存彈性模式。

  • Classic:儲存預留模式。

Serverless

Description

string

執行個體描述。

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

DataShareStatus

string

資料共用的狀態,取值說明:

  • 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"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情