Changing a Security Group

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

View PDF

API Description

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

Restrictions

Abnormal instances do not support this operation.
Please confirm the modified security group policy. This policy may affect the current instance connection, causing the connection interruption.

URI

URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-security-group
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-security-group

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	Explanation: User token obtained from IAM. For details, see Authentication. Constraints: N/A Value range: N/A Default value: N/A
project_id	string	path	Yes	Explanation: Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	string	path	Yes	Explanation: Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

Parameter description

**Table 2** Parameter description
Name	Type	Mandatory	Description
security_group_id	String	Yes	Definition Security group ID list. Constraints You can add up to 10 security group IDs for each instance and separate them with commas (,). Range N/A Default Value N/A

Example Request

Changing the security group associated with an instance (The ID of the new security group is 73bed21a-708b-4985-b697-a96d0e0d2b39.)

{
    "security_group_id": "73bed21a-708b-4985-b697-a96d0e0d2b39"
}

Response Parameters

Parameter description

**Table 3** Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	Definition Task ID. Range N/A
security_group_id	String	Yes	Definition Security group ID list. Range N/A

Response example

{
    "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
    "security_group_id":"73bed21a-708b-4985-b697-a96d0e0d2b39"
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.