All Products
Search
Document Center

AnalyticDB:DeleteDocument

Last Updated:Nov 05, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Delete Document

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 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:DeleteDocumentcreate
*Document
acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

Instance ID.

Note You can call the DescribeDBInstances API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.
gp-xxxxxxxxx
NamespacestringNo

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
CollectionstringYes

Document collection name.

Note Created by the CreateDocumentCollection API. You can use the ListDocumentCollections API to view the list of created document collections.
document
RegionIdstringYes

Region ID where the instance is located.

cn-hangzhou
NamespacePasswordstringYes

Password for the namespace.

Note This value is specified in the CreateNamespace API.
testpassword
FileNamestringYes

File name.

Note The name of an uploaded file. You can query the list of files using the ListDocuments API.
music.txt

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

Detailed information returned by the API.

success
Statusstring

Creation status, value description: - success: Success - fail: Fail

success

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history