ModifyCollection-阿里云帮助中心

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:ModifyCollection

update

*Collection

acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	No	The instance ID. Note You can call the DescribeDBInstances operation to query details for all AnalyticDB for PostgreSQL instances in a region, including their instance IDs.	gp-xxxxxxxxx
NamespacePassword	string	Yes	The password for the namespace.	testpassword
Namespace	string	No	The namespace. The default value is `public`. Note You can call the CreateNamespace operation to create a namespace and the ListNamespaces operation to list existing namespaces.	mynamespace
Collection	string	Yes	The collection name. Note You can call the ListCollections operation to list all collections.	document
Metadata	string	Yes	A JSON string that specifies the operations to add or modify metadata fields. For the required format, see the example. Use this parameter to add new metadata fields, rename existing metadata fields, or perform implicit data type conversion on existing fields. Details: To add a new metadata field, set `operations[].operator = add`. Then, use `operations[].newMetaName` to specify the field's name, `operations[].newMetaType` for its data type, and `operations[].fullTextRetrieval` to enable full-text retrieval for it. To modify an existing metadata field, set `operations[].operator = replace`. You must specify the current field name in `operations[].oldMetaName`. To rename the field, provide the new name in `operations[].newMetaName`. To change its data type, provide the new type in `operations[].newMetaType`. Note For a list of supported data types, see Data types. The money data type is not supported. Full-text retrieval can be enabled for a field only during an `add` operation, not a `replace` operation. Warning The field names `id`, `vector`, `to_tsvector`, and `source` are reserved.	{"operations":[ {"operator":"add","newMetaType":"int","newMetaName":"ext1","fullTextRetrieval":true}, {"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 contains multiple database instances. You must specify either this parameter or `DBInstanceId`. If you specify both, this parameter takes precedence.	gp-ws-*****

Response elements

Element	Type	Description	Example
	object	The response object.
Message	string	The response message.	Successful
Metadata	string	The metadata schema of the collection, returned as a JSON string. This string represents a map where keys are field names and values are their data types. Note See Data types for the list of supported data types. The 'money' data type is not supported.	{"title":"text","content":"text","response":"int"}
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Status	string	The status of the API request. Valid values: Other values: The request failed. success: The request was successful.	success

Examples

Success response

JSON format

{
  "Message": "Successful",
  "Metadata": "{\"title\":\"text\",\"content\":\"text\",\"response\":\"int\"}",
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.