All Products
Search
Document Center

AnalyticDB for PostgreSQL:SetDataShareInstance

Last Updated:Jan 22, 2024

Enables or disables data sharing for an AnalyticDB for PostgreSQL instance.

Operation description

This operation is called to enable or disable data sharing for an AnalyticDB for PostgreSQL instance in Serverless mode.

Limits

You can call this operation up to 1,000 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • 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:SetDataShareInstanceWrite
  • DBInstance
    acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

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

Specifies whether to enable or disable data sharing. Valid values:

  • add: enables data sharing.
  • remove: disables data sharing.
add
InstanceListarrayYes

The ID of the AnalyticDB for PostgreSQL instance in Serverless mode.

Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.
stringYes
gp-bp***************

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The state of the operation. Valid values:

  • success: The operation is successful.
  • failed: The operation fails.
success
ErrMessagestring

The error message returned if the operation fails.

error message

Examples

Sample success responses

JSONformat

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D5**********",
  "Status": "success",
  "ErrMessage": "error message"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history