ModifyInstanceConfig

更新时间:
复制 MD 格式

This API modifies the configuration of a Serverless StarRocks instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /webapi/config/modifyInstanceConfig HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

Sample ID

c-991ca6180620****

ConfigList

string

No

Additional information

[{\"type\":\"sas_analysis_online-sas-operation-log-sh-sas-event-rasp\",\"configItemList\":[{\"key\":\"item_level\",\"valueList\":[\"all\"]},{\"key\":\"alert_type\",\"valueList\":[\"all\"]}]}]

Reason

string

No

Reason for modification

test

AddConfigList

string

No

[Deprecated] List of configurations to add

[]

DeleteConfigList

string

No

[Deprecated] List of configurations to delete

[]

body

object

No

Request struct.

configsToUpdate

array

No

Configurations to update

InstanceConfigDto

No

List of configurations

configsToAdd

array

No

Configurations to add

InstanceConfigDto

No

List of configurations

configsToDelete

array

No

Configurations to delete

InstanceConfigDto

No

List of configurations

fastMode

boolean

No

Whether to restart quickly

true

restart

boolean

No

Whether to restart.

true

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

HTTP request status code.

200

RequestId

string

Request ID.

B1DBBA4E-6CD4-54F7-81E4-12C3425AB519

Success

boolean

Whether the request succeeded.

True

ErrCode

string

Error code.

InvalidParams

ErrMessage

string

Error message.

Invalid params: [instance not exists].

Data

boolean

Instance information.

True

AccessDeniedDetail

string

AccessDeniedDetail

{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "B1DBBA4E-6CD4-54F7-81E4-12C3425AB519",
  "Success": true,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Invalid params: [instance not exists].",
  "Data": true,
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxx\",     \"EncodedDiagnosticMessage\": \"xxx\",     \"AuthPrincipalType\": \"xxx\",     \"AuthPrincipalDisplayName\": \"xxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"sr:xxx\"   }"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.