参数查询
接口功能介绍
查询集群参数。
接口约束
无
URI
GET /v1/parameter/query
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceId | 是 | String | 实例ID | 8e3a382e241d11ed957c0242ac110006 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池 ID | d8bbd132b53a11e9b0e40242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(2000成功,5000系统错误,18xxxx业务错误) | 1000 | |
error | String | 业务错误码,RCC_statusCode | RCC_1000 | |
message | String | 返回结果描述 | invalid param | |
returnObj | Array of Objects | 返回数据体 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceStatus | String | 实例状态 | normal | |
restartEnv | Array of Objects | 重启生效的参数 | restartEnv | |
runningEnv | Array of Objects | 运行时生效的参数 | runningEnv |
表 restartEnv
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
desc | String | 描述 | 是否开启 | |
range | String | 取值范围 | true/false | |
name | String | 参数名称 | dataEnable | |
value | String | 参数值 | true |
表 runningEnv
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
desc | String | 描述 | 是否开启 | |
range | String | 取值范围 | true/false | |
name | String | 参数名称 | dataEnable | |
value | String | 参数值 | true |
枚举参数
无
请求示例
请求url
http://endpoint.cn/v1/parameter/query?instanceId=1
请求头header
{"regionId": "d8bbd132b53a11e9b0e40242ac110002"}
请求体body
无
响应示例
{"statusCode": 0,"message": "string","returnObj": {"instanceStatus": "normal","restartEnv": [{"name": "dataTrackEnabled","value": "true","desc": "是否开启数据轨迹功能,默认true。","range": "true/false"}],"runningEnv": []}}