查询实例配置历史
接口说明
该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /webapi/config/describeConfigHistory HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
c-b25e21e24388**** |
| NeedTotal |
boolean |
否 |
是否返回全部配置。 |
true |
| PageNumber |
integer |
否 |
查询页码，默认值是 1。 |
1 |
| PageSize |
integer |
否 |
分页查询时每页的条目数。默认为 10。 |
20 |
| StartTime |
integer |
否 |
修改历史的起始时间。 |
1742178604000 |
| EndTime |
integer |
否 |
修改历史的结束时间。 |
1742178604000 |
| EffectStatuses |
string |
否 |
生效状态。 |
effective |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
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 |
总记录条数。 |
3 |
| Data |
array<object> |
返回数据。 |
|
|
array<object> |
返回数据。 |
||
| GmtCreate |
integer |
配置修改时间。 |
1742178604000 |
| OperatorId |
string |
修改配置的用户 ID。 |
149920818483**** |
| Reason |
string |
修改配置的原因。 |
Test. |
| Effected |
boolean |
配置修改是否生效。 |
true |
| ConfigMementos |
array<object> |
配置修改前后值记录。 |
|
|
object |
配置修改前后值记录。 |
||
| ConfigType |
string |
配置类型。有以下取值：
|
FE |
| ConfigKey |
string |
配置项名称。 |
create_tablet_worker_count |
| Before |
string |
修改前的值。 |
3 |
| After |
string |
修改后的值。 |
4 |
| Action |
string |
修改类型。包含以下取值：
|
MODIFY |
| ConfigHistoryId |
string |
配置历史 ID。 |
6838 |
| Rollback |
boolean |
是否为一次配置回滚。 |
false |
| EffectStatus |
string |
生效状态。 |
effective |
| ConfigHistoryEffectDetails |
array<object> |
配置变更历史明细。 |
|
|
object |
|||
| NodeGroupId |
string |
计算组 ID。 |
ng-e6e15d2cdefdb38c |
| NodeId |
string |
节点 ID。 |
10000367486 |
| EffectStatus |
string |
生效状态。 |
effective |
| 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": 3,
"Data": [
{
"GmtCreate": 1742178604000,
"OperatorId": "149920818483****",
"Reason": "Test.",
"Effected": true,
"ConfigMementos": [
{
"ConfigType": "FE",
"ConfigKey": "create_tablet_worker_count",
"Before": "3",
"After": "4",
"Action": "MODIFY"
}
],
"ConfigHistoryId": "6838",
"Rollback": false,
"EffectStatus": "effective",
"ConfigHistoryEffectDetails": [
{
"NodeGroupId": "ng-e6e15d2cdefdb38c",
"NodeId": "10000367486",
"EffectStatus": "effective"
}
]
}
],
"AccessDeniedDetail": "{ \"PolicyType\": \"AccountLevelIdentityBasedPolicy\", \"AuthPrincipalOwnerId\": \"xxx\", \"EncodedDiagnosticMessage\": \"xxx\", \"AuthPrincipalType\": \"xxx\", \"AuthPrincipalDisplayName\": \"xxx\", \"NoPermissionType\": \"ImplicitDeny\", \"AuthAction\": \"sr:xxx\" }"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。