tencent cloud

TencentDB for PostgreSQL

DocumentaçãoTencentDB for PostgreSQL​​API ReferenceInstance APIsModifyDBInstanceName

ModifyDBInstanceName

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-21 10:43:44

1. API Description

Domain name for API request: postgres.intl.tencentcloudapi.com.

This API is used to rename a TencentDB for PostgreSQL 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.

2. Input Parameters

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: ModifyDBInstanceName.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DBInstanceId Yes String Specifies the database instance ID, such as postgres-6fego161. obtain through the api DescribeDBInstances.
InstanceName Yes String Instance name. only supports chinese, english, digits, "_", or "-" with length less than 60.

3. Output Parameters

Parameter Name Type Description
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 Modifying the Name of Instance postgres-6ougo465, Modification Failed

This example shows you how to modify instance name fails.

Input Example

POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceName
<Common request parameters>

{
    "InstanceName": "testModifyInstanceName",
    "DBInstanceId": "postgres-6ougo465"
}

Output Example

{
    "Response": {
        "RequestId": "8a61f510-aa33-454c-9ec2-dq2a368c39ab",
        "Error": {
            "Message": "Failed to get instance",
            "Code": "InternalError.DBError"
        }
    }
}

Example2 Modifying the Instance Name From postgres-6fego161 to testModifyInstanceName

This example shows you how to modify the instance name to testModifyInstanceName.

Input Example

POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceName
<Common request parameters>

{
    "InstanceName": "testModifyInstanceName",
    "DBInstanceId": "postgres-6fego161"
}

Output Example

{
    "Response": {
        "RequestId": "8a61e500-aa33-454c-9ec2-da2a368c39ab"
    }
}

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.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.OssAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
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.InstanceNotExist The current instance does not exist.
InvalidParameterValue.InvalidAccountFormat Incorrect account format.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterCharacterError Invalid parameter. The parameter can contain only letters, digits, underscores, and hyphens.
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
InvalidParameterValue.ParameterLengthLimitError The length of parameter exceeds the limit.
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.
Anterior: SwitchDBInstancePrimaryPróximo: ModifyDBInstanceSpec

Ajuda e Suporte

Esta página foi útil?

comentários