Query Collection Documents with ListDocuments API - AnalyticDB for PostgreSQL - Alibaba Cloud - AnalyticDB

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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 Call the DescribeDBInstances operation to query all AnalyticDB for PostgreSQL instances in a region, including instance IDs.	gp-xxxxxxxxx
Namespace	string	No	The name of the namespace. Default value: public. Note Call the CreateNamespace operation to create a namespace, or the ListNamespaces operation to query existing namespaces.	mynamespace
Collection	string	Yes	The name of the document collection. Note Call the CreateDocumentCollection operation to create a document collection, or the ListDocumentCollections operation to query existing collections.	document
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
NamespacePassword	string	Yes	The password of the namespace. Note Specified when calling 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 for retrieving the next page of results. Leave empty for the first request. For subsequent requests, use the NextToken value from the previous response.	caeba0bbb2be03f84eb48b699f0a4883

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	The returned message.	Successful
Status	string	Indicates whether the request was successful. Valid values: success fail	success
Items	object
DocumentList	array<object>	The queried documents.
	object	The queried document.
FileName	string	The name of the document.	music.txt
Source	string	The source of the document.	OSS
NextToken	string	A pagination token for retrieving the next page of results. If empty, no more pages exist.	caeba0bbb2be03f84eb48b699f0a4883
Count	integer	The total number of entries returned.	3

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success",
  "Items": {
    "DocumentList": [
      {
        "FileName": "music.txt",
        "Source": "OSS"
      }
    ]
  },
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Count": 3
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.