Updated on 2025-08-20 GMT+08:00

Changing a Security Group

Function

This API is used to change the security group of a DB instance.

Constraints

The security group cannot be changed if the DB instance is in any of the following statuses: creating, upgrading, changing instance class, creating users, or deleting users.

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/security-group

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

security_group_id

Yes

String

Security group ID.

You can add multiple security group IDs for each instance and separate them with commas (,).

Example Request

Change the security group of a DB instance.

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/security-group

{
     "security_group_id": "23423kljlj432lk0sdf0234eaa"
}

Response

  • Normal response

    Parameter

    Description

    workflowId

    Workflow 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.