Help Center/ Relational Database Service/ API Reference/ API v3/ Database Security/ Changing a Security Group
Updated on 2026-08-25 GMT+08:00
View PDF
Share

Changing a Security Group

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:modifySecurityGroup

write

-

-

-

-

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

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

security_group_id

Yes

String

Definition

Security group ID.

Constraints

N/A

Range

You can obtain the value of this parameter from the returned id by calling the API for querying security groups.

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

Default Value

N/A

Example Request

Change the security group of a DB instance.

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

{
     "security_group_id": "583ec782-3ac8-4466-9837-b03981814d72,77db6092-4495-482c-8e6e-462676718c95"
}

Response

  • Normal response

    Parameter

    Description

    workflowId

    Definition

    Workflow ID.

    Range

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

    For details, see Abnormal Response Results.

Status Code

Error Code

For details, see Error Codes.

Parent topic: Database Security