Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Changing a Security Group
Updated on 2022-12-12 GMT+08:00
View PDF

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

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

    The ID of the new security group.
  • Request example 
    {
    "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

    The ID of the new security group.
  • Response example 
    {
    "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
    "security_group_id":"73bed21a-708b-4985-b697-a96d0e0d2b39"
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management