Updates 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:ModifyCollection | update | *Collection acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | No | The instance ID. Note
You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
| gp-xxxxxxxxx |
| NamespacePassword | string | Yes | The password of the namespace. | testpassword |
| 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 collection. Note
You can call the ListCollections operation to query a list of collections.
| document |
| Metadata | string | Yes | The metadata of the addition or modification operation, which is in the JSON string format. You can specify this parameter to add a metadata definition, or rename an existing metadata definition and perform implicit type conversion. If you specify If you specify Note
** WarningReserved fields such as id, vector, to_tsvector, and source cannot be used. | {"operations":[ {"operator":"add","newMetaType":"int","newMetaName":"ext1"}, {"operator":"replace","oldMetaName":"ext2","newMetaName":"ext3"}, {"operator":"replace","newMetaType":"bigint","oldMetaName":"ext4"}, {"operator":"replace","newMetaType":"int","oldMetaName":"ext5","newMetaName":"ext6"} ]} |
| RegionId | string | Yes | The region ID of the instance. | cn-hangzhou |
| WorkspaceId | string | No | The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes precedence. | gp-ws-***** |
Response parameters
Examples
Sample success responses
JSONformat
{
"Message": "Successful",
"Metadata": {
"title": "text",
"content": "text",
"response": "int"
},
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Status": "success"
}Error codes
For a list of error codes, visit the Service error codes.