Files
doc-exports/docs/geminidb/api-ref/nosql_05_0103.html
wangdengke2 8d0926f0e5 geminidb_api
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2025-09-04 07:22:35 +00:00

10 KiB

Changing the Security Group of an Instance

Function

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

Constraints

This API can be used for GeminiDB Cassandra instances.

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.

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/security-group

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. application/json is recommended.

X-Auth-Token

Yes

String

User token.

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

security_group_id

Yes

String

ID of the new security group.

Response Parameters

Status code: 202

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Task ID.

Example Request

  • URI example
    PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/security-group
  • Example request body
    {
      "security_group_id" : "73bed21a-708b-4985-b697-a96d0e0d2b39"
    }

Example Response

Status code: 202

No Content

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

Status Codes

See Status Codes.

Error Codes

See Error Codes.