International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
TencentDB for MariaDB
    Documentation
    Download PDF

    ModifyDBInstanceName

    Last updated: 2021-01-22 10:09:06
    Download PDF

    1. API Description

    Domain name for API request: mariadb.tencentcloudapi.com.

    This API is used to rename a TencentDB instance.

    A maximum of 20 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: mariadb.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: ModifyDBInstanceName.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    InstanceId Yes String ID of instance to be modified, which is in the format of tdsql-ow728lmc and can be obtained through the DescribeDBInstances API.
    InstanceName Yes String New name of instance, which can contain letters, digits, underscores, and hyphens.

    3. Output Parameters

    Parameter Name Type Description
    InstanceId String Instance ID
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying instance names

    Input Example

    https://mariadb.tencentcloudapi.com/?Action=ModifyDBInstanceName
&InstanceId=tdsql-fdpjf5zh
&InstanceName=newname
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "6a6b0cc7-c183-4e50-bf19-b83aa9fe77fc",
    "InstanceId": "tdsql-fdpjf5zh"
  }
}

    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
    InternalError.CamAuthFailed CAM authentication request failed.
    InternalError.DbOperationFailed Failed to query the database.
    InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
    InvalidParameter.InstanceNotFound Failed to find the requested instance.
    InvalidParameterValue.InstanceNameIllegal Invalid instance name.
    ResourceNotFound.NoInstanceFound The specified database instance was not found.
    UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyTerms of ServiceCookie Policy