获取Kafka实例扩容前置检查信息 - ShowKafkaScalePreCheckInfo
功能介绍
获取Kafka实例扩容前置检查信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/kafka/instances/{instance_id}/extend-check
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
instance_id |
是 |
String |
参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 检查项名称。 取值范围: 不涉及。 |
|
success |
Boolean |
参数解释: 检查项状态。 取值范围:
|
|
reason |
String |
参数解释: 失败原因。 取值范围: 不涉及。 |
|
risk |
String |
参数解释: 风险等级。 取值范围:
|
请求示例
GET https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/extend-check
响应示例
状态码:200
获取Kafka实例扩容前置检查信息成功。
[ {
"name" : "CPU",
"success" : true,
"reason" : "",
"risk" : "low"
}, {
"name" : "RAM",
"success" : true,
"reason" : "",
"risk" : "low"
}, {
"name" : "REPLICA",
"success" : false,
"reason" : "topic-1-1",
"risk" : "medium"
}, {
"name" : "ISR",
"success" : true,
"reason" : "",
"risk" : "high"
}, {
"name" : "NETWORK",
"success" : true,
"reason" : "",
"risk" : "medium"
} ]
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
获取Kafka实例扩容前置检查信息成功。 |
错误码
请参见错误码。