This operation pre-checks modifications to the instance configuration of a Serverless StarRocks instance.
Try it now
Test
RAM authorization
Request syntax
POST /webapi/config/modifyInstanceConfigPreCheck HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
c-b25e21e24388**** |
| body |
object |
No |
The request body. |
|
| configsToUpdate |
array |
No |
The configurations to update. |
|
|
InstanceConfigDto |
No |
A configuration object. |
||
| configsToAdd |
array |
No |
The configurations to add. |
|
|
InstanceConfigDto |
No |
A configuration object. |
||
| configsToDelete |
array |
No |
The configurations to delete. |
|
|
InstanceConfigDto |
No |
A configuration object. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| RequestId |
string |
The request ID. |
32A44F0D-BFF6-5664-999A-218BBDE74XXX |
| Success |
boolean |
Indicates whether the request was successful. |
false |
| ErrCode |
string |
The error code. |
Success |
| ErrMessage |
string |
The error message. |
Invalid params: [instance not exists]. |
| Data |
array |
The response data. |
|
|
string |
An item in the response data. |
24151320976**** |
|
| AccessDeniedDetail |
string |
Details about the access denial. |
{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" } |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"RequestId": "32A44F0D-BFF6-5664-999A-218BBDE74XXX\n",
"Success": false,
"ErrCode": "Success",
"ErrMessage": "Invalid params: [instance not exists].",
"Data": [
"24151320976****"
],
"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.