Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Changing the Security Group of an Instance
Updated on 2025-12-04 GMT+08:00
View PDF
Share

Changing the Security Group of an Instance

Function

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

Constraints

This API supports the following instances:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

Abnormal instances do not support this operation.

Please confirm the modified security group rule. This policy may affect connections to the current instance, interrupting services.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • 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

    gaussdbfornosql:instance:updateSecurityGroup

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:modifySecurityGroup

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/security-group

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID.

Constraints:

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

Constraints:

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

security_group_id

Yes

String

Definition

ID of the new security group.

Constraints:

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

Example Requests

  • URI example 
    PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/security-group
  • Example request body 
    {
  "security_group_id" : "73bed21a-708b-4985-b697-a96d0e0d2b39"
}

Example Responses

Status code: 202

No Content

{
  "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances