元数据查询
功能介绍
该接口用于查询指标的元数据。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/aom/api/v1/metadata
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。获取方式请参见:获取Token。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
data |
Object |
元数据信息。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
errorType |
String |
错误类型。 |
error |
String |
错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
errorType |
String |
错误类型。 |
error |
String |
错误信息。 |
状态码:422
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
errorType |
String |
错误类型。 |
error |
String |
错误信息。 |
状态码:503
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
errorType |
String |
错误类型。 |
error |
String |
错误信息。 |
请求示例
获取指标元数据。
https://{EndPoint}/v1/{project_id}/aom/api/v1/metadata
响应示例
状态码:200
OK 请求响应成功。
{ "status" : "success", "data" : { "aggregator_openapi_v2_regeneration_count" : [ { "type" : "counter", "help" : "[ALPHA] Counter of OpenAPI v2 spec regeneration count broken down by causing APIService name and reason.", "unit" : "" } ] } }
状态码:400
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
{ "status" : "error", "errorType" : "bad_param", "error" : "param is invalid." }
状态码:403
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
{ "status" : "error", "errorType" : "auth", "error" : "auth project_id not pass." }
状态码:422
Unprocessable 表达式无法执行。
{ "status" : "error", "errorType" : "excution", "error" : "expression can't be executed." }
状态码:503
ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。
{ "status" : "error", "errorType" : "timeout", "error" : "query timed out in query execution." }
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功。 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
422 |
Unprocessable 表达式无法执行。 |
503 |
ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。