All Products
Search
Document Center

AnalyticDB for PostgreSQL:SetDataShareInstance

Last Updated:Jul 18, 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.

Authorization information

There is currently no authorization information disclosed in the API.

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