Help Center> Document Database Service> API Reference> API Description> DB Instance Management> Changing a Security Group
View PDF

Changing a Security Group

Function

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

Constraints

  • 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 /v3/{project_id}/instances/{instance_id}/modify-security-group

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instance_id

    Yes

    Specifies the DB instance ID.

Requests

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    security_group_id

    Yes

    String

    Specifies the ID of the new security group.
  • Request header 
    POSThttps://DDS endpoint/v3/{project_id}/instances/{instance_id}/modify-security-group
  • Example request 
    {
    "security_group_id": "73bed21a-708b-4985-b697-a96d0e0d2b39"
}

Responses

  • Parameter description
    Table 3 Parameter description

    Name

    Type

    Description

    job_id

    String

    Indicates the workflow ID.

    security_group_id

    String

    Indicates 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