查询实例配置
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /webapi/config/describeInstanceConfigs HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
c-b25e21e24388**** |
| ConfigType |
string |
否 |
配置项类型。包含以下取值：
|
FE |
| ConfigKey |
string |
否 |
配置项键。 |
enable_udf |
| Description |
string |
否 |
配置项功能描述。 |
是否开启 UDF。 |
| AllowModify |
boolean |
否 |
配置项是否允许修改。 |
true |
| NeedTotal |
boolean |
否 |
是否返回全部配置项。 |
true |
| PageNumber |
integer |
否 |
查询页码，默认值为 1。 |
1 |
| PageSize |
integer |
否 |
分页查询时每页的条目数，默认值为 20。 |
10 |
| NodeGroupId |
string |
否 |
计算组 ID。 |
ng-3d5ce6454354**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 请求状态码。 |
200 |
| RequestId |
string |
请求 ID。 |
32A44F0D-BFF6-5664-999A-218BBDE7**** |
| Success |
boolean |
请求是否成功。 |
false |
| ErrCode |
string |
错误码。 |
InvalidParams |
| ErrMessage |
string |
错误信息。 |
Invalid params: [instance not exists]. |
| Total |
integer |
查询结果总数。 |
4 |
| Data |
array<object> |
返回数据。 |
|
|
object |
返回数据。 |
||
| ConfigType |
string |
配置项类型。包含以下取值：
|
FE |
| ConfigKey |
string |
配置项键。 |
enable_udf |
| DefaultValue |
string |
配置项默认值。 |
true |
| ConfigValue |
string |
配置项值。 |
false |
| Restart |
boolean |
更改配置项后是否需要重启实例，取值：
|
true |
| Unit |
string |
配置项单位。没有则返回空串。 |
s |
| ValueType |
string |
配置项值的数据类型。 |
INT |
| ValueRange |
string |
配置项值的取值范围。没有则返回空串。 |
true,false |
| AllowModify |
string |
配置项是否允许修改。 |
true |
| Description |
string |
配置项功能描述。 |
是否开启 UDF。 |
| Custom |
boolean |
是否为用户自定义配置项。 |
false |
| NodeGroupId |
string |
计算组 ID。 |
ng-3d5ce6454354**** |
| DefaultNodeGroup |
boolean |
是否为默认计算组。 |
true |
| NodeGroupName |
string |
计算组名称。 |
ng_1 |
| DescriptionEn |
string |
配置项英文描述。 |
A boolean value to control whether to enable the synchronization of the tablet metadata. true indicates enabling synchronization, and false indicates disabling it. |
| AccessDeniedDetail |
string |
权限校验失败详情。 |
{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" } |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"RequestId": "32A44F0D-BFF6-5664-999A-218BBDE7****",
"Success": false,
"ErrCode": "InvalidParams",
"ErrMessage": "Invalid params: [instance not exists].",
"Total": 4,
"Data": [
{
"ConfigType": "FE",
"ConfigKey": "enable_udf",
"DefaultValue": "true",
"ConfigValue": "false",
"Restart": true,
"Unit": "s",
"ValueType": "INT",
"ValueRange": "true,false",
"AllowModify": "true",
"Description": "是否开启 UDF。",
"Custom": false,
"NodeGroupId": "ng-3d5ce6454354****",
"DefaultNodeGroup": true,
"NodeGroupName": "ng_1",
"DescriptionEn": "A boolean value to control whether to enable the synchronization of the tablet metadata. true indicates enabling synchronization, and false indicates disabling it."
}
],
"AccessDeniedDetail": "{ \"PolicyType\": \"AccountLevelIdentityBasedPolicy\", \"AuthPrincipalOwnerId\": \"xxx\", \"EncodedDiagnosticMessage\": \"xxx\", \"AuthPrincipalType\": \"xxx\", \"AuthPrincipalDisplayName\": \"xxx\", \"NoPermissionType\": \"ImplicitDeny\", \"AuthAction\": \"sr:xxx\" }"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。