Help Center/ Database Security Service/ API Reference (Paris and Amsterdam Regions)/ API/ Management APIs/ Modifying a Security Group
Updated on 2024-01-15 GMT+08:00
View PDF
Share

Modifying a Security Group

Function

This API is used to modify a security group.

URI

POST /v1/{project_id}/dbss/audit/security-group

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-type

Yes

String

The fixed value of this parameter is application/json;charset=UTF-8, which cannot be changed.

X-Auth-Token

Yes

String

User token
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resource_id

Yes

String

Resource ID (DBSS instances ID, the instance ID is not in the basic information.)

This parameter can be obtained through the interface : GET /v1/{project_id}/dbss/audit/instances

securitygroup_ids

Yes

Array of strings

Security group ID list (Only one update is allowed at present)

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

String

Response status.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Example Requests

/v1/{project_id}/dbss/audit/security-group

{
  "resource_id" : "062212d8-8e30-4783-9671-43f3f1f3bb1e",
  "securitygroup_ids" : [ "f0fbec06-bcf6-4c7e-99fa-f0ddfbb1d9bd" ]
}

Example Responses

Status code: 200

Success

""

Status code: 400

Failure

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status Codes

Status Code

Description

200

Success

400

Failure

403

Authentication failed.

500

Server error.

Error Codes

See Error Codes.

Parent topic: Management APIs