DescribeDataShareInstances

0.0.201

現時此頁面僅用英語顯示，繁體中文內容正在準備中。感謝您的耐心等待。

Queries the status of data sharing for AnalyticDB for PostgreSQL instances.

Operation description

Data sharing is supported only for instances in Serverless mode.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeDataShareInstances	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see View basic information of a resource group.	rg-bp67acfmxazb4p****
RegionId	string	Yes	The region ID of the instance. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
SearchValue	string	No	The keyword used to filter instances, which can be an instance ID or instance description. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs and instance descriptions.	gp-bp***************
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100 Default value: 30.	30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example

Parameter	Type	Description	Example
	object
TotalRecordCount	integer	The total number of entries returned.	1
PageRecordCount	integer	The number of entries per page.	1
RequestId	string	The request ID.	B4CAF581-2AC7-41AD-8940-D5**********
PageNumber	integer	The page number.	1
Items	array<object>	The state of data sharing. Valid values: opening opened closing closed
DBInstance	object
RegionId	string	The region ID of the instance.	cn-hangzhou
ZoneId	string	The zone ID of the instance.	cn-hangzhou-j
DBInstanceId	string	The ID of the instance.	gp-bp***************
DBInstanceMode	string	The resource type of the instance. Valid values: Serverless: Serverless mode StorageElasic: elastic storage mode Classic: reserved storage mode	Serverless
Description	string	The description of the instance.	gp-bp***************
DataShareStatus	string	The state of data sharing. Valid values: opening: Data sharing is being enabled. opened: Data sharing is enabled. closing: Data sharing is being disabled. closed: Data sharing is disabled.	opened

Examples

Sample success responses

JSONformat

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