doc-exports/docs/rds/api-ref/rds_05_0020.html
Wang , Deng Ke 21e968a153 rds 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-12 13:50:31 +00:00

11 KiB

Changing a Private IP Address

Function

This API is used to change the private IP address of a DB instance.

Constraints

  • Changing of Private IP Address might affect RDS instances access. Relevant Security group rules will need to be adapted. Also access from application/ECS side will need to change accordingly.
  • The private IP address of a DB instance cannot be changed when the instance is being created, rebooted, or upgraded, its specifications are being modified, or database users are being created or deleted.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ip

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    new_ip

    Yes

    String

    Indicates the private IP address.

  • Request example
    {
         "new_ip": "192.168.0.213"
    }

Response

  • Normal response

    Name

    Description

    workflowId

    Indicates the workflow ID.

    For details about how to query this parameter, see Obtaining Task Information.

  • Example normal response
    {
        "workflowId":"83abc7bc-2c70-4534-8565-351187b37715"
    }

Status Code

Error Code

For details, see Error Codes.