DescribeProjectMeta - 查询云监控支持的时序类监控项产品列表

更新时间:
复制为 MD 格式

调用DescribeProjectMeta接口查询云监控支持的时序类监控项产品列表。

接口说明

获取接入的云产品信息,包括产品的描述信息、Namespace 和标签。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Labels

string

标签。根据标签过滤,标签为每个报警增加特殊标记。

目前仅支持按照产品过滤,即nameproduct的过滤方式,例如:{"name":"product","value":"ECS"}。

说明

对于阿里云中云监控控制台的特殊标签,不建议您使用。

[{"name":"product","value":"ECS"}]

PageNumber

integer

页码。

取值范围:1~100。

默认值:1。

1

PageSize

integer

分页大小。

取值范围:1~10000。

默认值:30。

说明

目前阿里云未限制该参数,如果您需要获取所有结果,则将分页大小设置为较大的值即可。

30

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

4C2061B2-3B1B-43BF-A4A4-C53426F479C0

Success

boolean

操作是否成功。true 表示成功,false 表示失败。

true

Code

string

状态码。

说明

200 表示成功。

200

Message

string

错误信息。

The Request is not authorization.

PageSize

string

分页大小。

5

PageNumber

string

页码。

1

Total

string

总记录条数。

12

Resources

object

Resource

array<object>

云产品信息。

object

Namespace

string

命名空间,用于区分产品。格式:acs_产品缩写,详情请参见云产品监控项

acs_cdn

Description

string

描述信息。

CDN

Labels

string

标签。根据标签过滤,标签为每个报警增加特殊标记。

例如:报警所属产品的规格,是否能设置告警,格式:[{"name":"标签名","value":"标签值"}、{"name":"标签名","value":"标签值"}]​。常用的标签如下:

  • alertUnit:报警的单位。 为了避免原始上报数据的单位过小,而导致告警规则输入的值过大而增加的alertUnit标签,目前主要应用于云监控控制台。

  • minAlertPeriod:最小上报周期。上报监控数据的时间间隔,通常为 1 分钟。

  • metricCategory:产品的规格。例如: kvstore_sharding。 部分阿里云产品分不同规格,定义在同一个 namespace 中,用该参数进行区分。

  • is_alarm:能否设置告警规则。 对于阿里云中云监控控制台的特殊标签,不建议您使用。

[{"metricCategory":ecs}]

示例

正常返回示例

JSON格式

{
  "RequestId": "4C2061B2-3B1B-43BF-A4A4-C53426F479C0",
  "Success": true,
  "Code": "200",
  "Message": "The Request is not authorization.",
  "PageSize": "5",
  "PageNumber": "1",
  "Total": "12",
  "Resources": {
    "Resource": [
      {
        "Namespace": "acs_cdn",
        "Description": "CDN",
        "Labels": "[{\"metricCategory\":ecs}]"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 ParameterInvalid Illegal parameters.
500 InternalError The request processing has failed due to some unknown error.
403 AccessForbidden User not authorized to operate on the specified resource.
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情