Changing a Private IP Address

Function

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

  • Before calling an API, you need to understand the API in Authentication.

  • Before calling this API, obtain the required region and endpoint.

Constraints

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

    PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ip
    
    {
         "new_ip": "192.168.0.213"
    }
    

Response

  • Normal response

    Name

    Description

    workflowId

    Indicates the task ID.

  • Example normal response

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

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.