Updated on 2024-04-02 GMT+08:00

Changing a Security Group

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

User token obtained from IAM. For details, see Authentication.

project_id

string

path

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

instance_id

string

path

Yes

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.

Requests

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    security_group_id

    String

    Yes

    Security group ID list.

    • To use multiple security groups for a DDS instance, choose Service Tickets > Create Service Ticket in the upper right corner of the management console to apply for the required permissions.
    • You can add up to 10 security group IDs for each instance and separate them with commas (,).

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"
}

Responses

  • Parameter description
    Table 3 Parameter description

    Name

    Type

    Mandatory

    Description

    job_id

    String

    Yes

    The workflow ID.

    security_group_id

    String

    Yes

    Security group ID list.

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

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.