Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Changing the Security Group of an Instance
Updated on 2026-04-10 GMT+08:00
View PDF
Share

Changing the Security Group of an Instance

Function

This API is used to change the security group of an instance. Before calling this API:

Constraints

Before changing the security group for an instance involved in a DR relationship, ensure that the port for connecting the primary instance to the DR instance is allowed in the inbound rules of the target security group.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required 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 permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdb:instance:modifySecurityGroup

    write

    instance

    -

    gaussdb:instance:modifySecurityGroup

    -

URI

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

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance. For details about how to obtain the instance ID, see Querying DB Instances.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

After a response is returned, the value of X-Subject-Token in the response header is the token.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us
Table 3 Parameter description

Parameter

Mandatory

Type

Description

security_group_id

Yes

String

Definition

ID of the target security group. For details about how to obtain the security group ID, see Querying Security Groups.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 4 Parameter description

Parameter

Type

Description

job_id

String

Definition

ID of the workflow for changing the security group of an instance.

Range

N/A

Example Request

PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/security-group
{
	"security_group_id": "2ea4d7a0-c317-4bbc-b53e-2c67b5499781"
}

Example Response

{
  "job_id": "e51532df-b94d-4fbc-9cf0-aea030ade45d"
}

Status Code

Error Codes

For details, see Error Codes.

Parent topic: Instance Management