Updated on 2025-12-25 GMT+08:00

Changing the Security Group (2.4.3)

Function

This API is used to change the security group of a graph after the graph is created.

URI

POST /v2/{project_id}/graphs/{graph_id}/sg/change

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain up to 64 characters. Only letters and digits are allowed.

Default Value

N/A

graph_id

Yes

String

Definition

Graph ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.)

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 target security group.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

None

Status code: 404

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

System prompt.

  • If the execution succeeds, this parameter may be left blank.
  • If the execution fails, this parameter is used to display the error code.

Range

N/A

error_msg

String

Definition

System prompt.

  • If the execution succeeds, this parameter may be left blank.
  • If the execution fails, this parameter is used to display the error message.

Range

N/A

Example Request

Changing the security group of a graph instance

POST https://{Endpoint}/v2/{project_id}/graphs/{graph_id}/sg/change
{
  "security_group_id" : "b1038649-1f77-4ae9-b64d-9af56e422652"
}

Example Response

Status code: 200

Example response for a successful request

{ }

Status code: 404

Example response for a failed request

{
    "error_msg": "Cluster does not exist or has been deleted.",
    "error_code": "GES.0047"
}

Status Codes

Return Value

Description

400 Bad Request

Request error.

401 Unauthorized

Authorization failed.

403 Forbidden

No operation permissions.

404 Not Found

No resources found.

500 Internal Server Error

Internal server error.

503 Service Unavailable

Service unavailable.