查询BCS组织实例监控数据详情
功能介绍
该接口用于BCS组织实例监控数据详情。
URI
POST /v2/{project_id}/blockchains/{blockchain_id}/entity/instance/metric/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 |
blockchain_id |
是 |
String |
区块链服务id。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
实体类型,[可选值如下: org(包括代理节点baas-agent、共识节点orderer、记账节点peer), plugin(插件)] 默认为org |
entity_name |
是 |
String |
所属实体的名称,即区块链服务详情页面的“区块链实例”中各节点的名称(代理节点、共识节点、记账节点) |
instance_name |
是 |
String |
具体实例的名称。若当前区块链服务部署在CCE集群上,该名称为各节点对应的负载(pod)名称;若当前区块链服务部署在IEF集群上,可进入“智能边缘平台”服务,进入“边缘应用”->“容器应用”,查询负载名称。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
metrics |
Array of MetricItemResultAPI objects |
指标对象列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
metric |
MetricDemision object |
指标描述信息 |
dataPoints |
Array of MetricDataPoints objects |
监控数据信息 |
参数 |
参数类型 |
描述 |
---|---|---|
namespace |
String |
命名空间 |
metricName |
String |
指标名称 |
dimensions |
Array of Dimension objects |
维度列表 |
参数 |
参数类型 |
描述 |
---|---|---|
timestamp |
Long |
时间戳。 |
unit |
String |
指标单位。 |
statistics |
Array of StatisticValue objects |
统计方式。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
{ "type" : "org", "entity_name" : "baas-agent", "instance_name" : "baas-agent-868946786c-sswcn" }
响应示例
状态码: 200
Ok
{ "metrics" : [ { "metric" : { "namespace" : "abc", "metricName" : "def", "dimensions" : [ { "name" : "ghi", "value" : "lmn" } ] }, "dataPoints" : [ { "timestamp" : "1467892800000", "unit" : "Percent", "statistics" : [ { "statistic" : "maximum", "value" : "23" } ] } ] } ] }
状态码: 400
Bad Request
{ "error_code" : "BCS.4004021", "error_msg" : "GetOrgInstanceMetricDetail operation does not support IEF cluster type" }
状态码: 401
Unauthorized
{ "error_code" : "BCS.4010401", "error_msg" : "Incorrect token or token resolution failed" }
状态码: 403
Forbidden
{ "error_code" : "BCS.4030403", "error_msg" : "No permissions to request this method" }
状态码: 404
Not Found
{ "error_code" : "BCS.4040404", "error_msg" : "Not Found:the url is not found" }
状态码: 500
InternalServerError
{ "error_code" : "BCS.5000500", "error_msg" : "Internal Server Error" }
状态码
状态码 |
描述 |
---|---|
200 |
Ok |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
InternalServerError |
错误码
请参见错误码。