DescribeSampleData - AnalyticDB for PostgreSQL - Alibaba Cloud Documentation Center

Queries whether a sample dataset is loaded to an AnalyticDB for PostgreSQL instance.

Operation description

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the 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.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeSampleData	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. Note You can call the DescribeDBInstances operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.	gp-bp12ga6v69h86****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111
HasSampleData	boolean	Indicates whether a sample dataset is loaded to the instance. Valid values: true: A sample dataset is loaded. false: No sample dataset is loaded.	true
ErrorMessage	string	The error message returned if an error occurs. This message does not affect the execution of the operation.	******
DBInstanceId	string	The ID of the instance.	gp-bp12ga6v69h86****

Examples

Sample success responses

JSONformat

{
  "RequestId": "84CD7CAF-FA7B-5178-B19F-D8CDE307D5FA_8111",
  "HasSampleData": true,
  "ErrorMessage": "******",
  "DBInstanceId": "gp-bp12ga6v69h86****"
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2023-08-01

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.