Initializes vector databases.
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:
- The required resource types are displayed in bold characters.
- 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
gpdb:InitVectorDatabase | create | *DBInstance acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#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 |
ManagerAccount | string | Yes | The name of the manager account that has the rds_superuser permission. Note
You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the CreateAccount operation.
| testaccount |
ManagerAccountPassword | string | Yes | The password of the database account. | testpassword |
RegionId | string | Yes | The region ID of the instance. Note
You can call the DescribeRegions operation to query the most recent region list.
| 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 effect. | gp-ws-***** |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password",
"Status": "success"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-04 | The request parameters of the API has changed | View Change Details |
2023-11-07 | The internal configuration of the API is changed, but the call is not affected | View Change Details |