ModifyInstanceConfig - 修改实例配置

更新时间:
复制 MD 格式

本接口用于修改 Serverless StarRocks 实例配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sr:ModifyInstanceConfig

update

*Instance

acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}

无 无

请求语法

POST /webapi/config/modifyInstanceConfig HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

是

示例 ID

c-991ca6180620****

ConfigList

string

否

附加信息

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

Reason

string

否

修改原因

test

AddConfigList

string

否

【已废弃】新增配置列表

[]

DeleteConfigList

string

否

【已废弃】待删除配置列表

[]

body

object

否

请求结构体。

configsToUpdate

array

否

需要更新的配置

InstanceConfigDto

否

配置列表

configsToAdd

array

否

需要新增的配置

InstanceConfigDto

否

配置列表

configsToDelete

array

否

需要删除的配置

InstanceConfigDto

否

配置列表

fastMode

boolean

否

是否快速重启

true

restart

boolean

否

是否重启。

true

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 请求状态码。

200

RequestId

string

请求 ID。

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

Success

boolean

请求是否成功。

True

ErrCode

string

错误码。

InvalidParams

ErrMessage

string

错误信息。

Invalid params: [instance not exists].

Data

boolean

实例信息。

True

AccessDeniedDetail

string

AccessDeniedDetail

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

示例

正常返回示例

JSON格式

{
  "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\"   }"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。