1. API Description
Domain name for API request: postgres.tencentcloudapi.com.
This API is used to modify the project of an instance.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common Params. The value used for this API: ModifyDBInstancesProject. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2017-03-12. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| DBInstanceIdSet.N |
Yes |
Array of String |
List of instance IDs. Note that currently you cannot manipulate multiple instances at the same time. Only one instance ID can be passed in here. |
| ProjectId |
Yes |
String |
ID of the new project |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Count |
Integer |
Number of successfully transferred instances |
| RequestId |
String |
The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 u200cu200cModifying the projects in batches
u200cu200cThis example shows you how to modify the projects in batches.
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstancesProject
<Common request parameters>
{
"ProjectId": "10467",
"DBInstanceIdSet": [
"postgres-lnp6j6172",
"postgres-6bwgamo3"
]
}
Output Example
{
"Response": {
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
"Count": 2
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| AuthFailure.UnauthorizedOperation |
Authentication failed. |
| FailedOperation.CamSigAndAuthError |
Authentication failed. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.CdbCgwConnectError |
Failed to get project information. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.DatabaseAccessError |
Failed to access database management service. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.FailedOperationError |
Operation failed. Please try again later. |
| FailedOperation.UpdateResourceProjectTagValueError |
Failed to modify the resource tag. |
| InternalError.DBError |
Backend database execution error. |
| InternalError.InternalHttpServerError |
An exception occurred while executing the request. |
| InternalError.SystemError |
System error. When this error occurs, please contact customer service for assistance. |
| InvalidParameter |
Parameter error. |
| InvalidParameterValue.IllegalProjectId |
Invalid ProjectId. |
| InvalidParameterValue.InstanceNotExist |
The current instance does not exist. |
| InvalidParameterValue.InvalidParameterValueError |
Incorrect parameter value |
| InvalidParameterValue.ParameterHandleError |
Failed to process the parameter. Please check if the parameter value is valid. |
| OperationDenied.CamDeniedError |
This operation cannot be performed. |
| OperationDenied.InstanceAccessDeniedError |
You do not have the permission to operate this resource. |
| ResourceNotFound.InstanceNotFoundError |
The instance does not exist. |