All Products
Search
Document Center

AnalyticDB:DescribeDataShareInstances

更新時間:Dec 20, 2024

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:DescribeDataShareInstancesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

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****
RegionIdstringYes

The region ID of the instance.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
SearchValuestringNo

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***************
PageSizeintegerNo

The number of entries per page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

30
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
TotalRecordCountinteger

The total number of entries returned.

1
PageRecordCountinteger

The number of entries per page.

1
RequestIdstring

The request ID.

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

The page number.

1
Itemsarray<object>

The state of data sharing. Valid values:

  • opening
  • opened
  • closing
  • closed
DBInstanceobject
RegionIdstring

The region ID of the instance.

cn-hangzhou
ZoneIdstring

The zone ID of the instance.

cn-hangzhou-j
DBInstanceIdstring

The ID of the instance.

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

The resource type of the instance. Valid values:

  • Serverless: Serverless mode
  • StorageElasic: elastic storage mode
  • Classic: reserved storage mode
Serverless
Descriptionstring

The description of the instance.

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

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history