Updated on 2024-07-26 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

Project ID, which is used for resource isolation

graph_id

Yes

String

Graph ID

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (The token is the value of X-Subject-Token in the response header.)

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

security_group_id

Yes

String

ID of the target security group

Response Parameters

Status code: 200

None

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

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.

error_msg

String

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.

Example Request

Changing the security group of a graph instance

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

Example Response

Status code: 200

Request succeeded.

{ }

Status code: 400

Failed request.

{
  "error_msg" : "The graph does not exist or has been deleted.",
  "error_code" : "GES.7000"
}

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.