Queries a list of documents in a collection.
Debugging
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 Resourcesis 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:ListDocuments | create | *Document acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The instance ID. Note
You can call the DescribeDBInstances operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
| gp-xxxxxxxxx |
| Namespace | string | No | The name of the namespace. Default value: public. Note
You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.
| mynamespace |
| Collection | string | Yes | The name of the document collection. Note
You can call the CreateDocumentCollection operation to create a document collection and call the ListDocumentCollections operation to query a list of document collections.
| document |
| RegionId | string | Yes | The region ID of the instance. | cn-hangzhou |
| NamespacePassword | string | Yes | The password of the namespace. Note
This value is specified when you call the CreateNamespace operation.
| testpassword |
| MaxResults | integer | No | The maximum number of entries per page. Valid values: 1 to 100. | 100 |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. | caeba0bbb2be03f84eb48b699f0a4883 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "Successful",
"Status": "success",
"Items": {
"DocumentList": [
{
"FileName": "music.txt",
"Source": "http://oss.xxx/music.txt"
}
]
},
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"Count": 3
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-18 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |