Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Changing the Security Group of a StarRocks Instance
Updated on 2025-09-04 GMT+08:00

Changing the Security Group of a StarRocks Instance

Function

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

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Standard HTAP instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in17. 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. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

security_group_id

Yes

String

Definition

Security group ID.

Constraints

If a network ACL is enabled for the subnet where the instance is located, this parameter is optional. If a network ACL is not enabled, this parameter is mandatory. To obtain this value, use either of the following methods:

  • Method 1: Log in to VPC console. Choose Access Control > Security Groups in the navigation pane. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
  • Method 2: Call the API for querying security groups. For details, see Querying Security Groups.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

workflow_id

String

Definition

Workflow ID.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/security-group

{
  "security_group_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1"
}

Example Response

Status code: 200

Success.

{
  "job_id" : "467258e0-4e6e-4167-b072-7f4e23231bf3"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.