doc-exports/docs/dds/api-ref/dds_api_0053.html
Wang , Deng Ke 60010eb9d0 dds api 2.0.38sp24 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2023-01-13 08:55:41 +00:00

6.5 KiB

Modifying a DB Instance Name

Function

This API is used to modify a DB instance name.

Constraints

The name of the DB instance that is being created or fails to be created cannot be modified.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instance_id

    Yes

    Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.

Requests

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    new_instance_name

    Yes

    String

    Specifies the DB instance name. The instance name can be the same as an existing instance name.

    • The instance name must contain 4 to 64 characters and must start with a letter. It is case sensitive and can contain letters, digits, hyphens (-), and underscores (_). It cannot contain other special characters.

Responses

  • Response example
    {}

Status Code

Status Code:200.

For more information, see Status Code.

Error Code

For more information, see Error Code.