文档

CreateDynamicTagGroup - 通过标签自动创建应用分组

更新时间:

调用CreateDynamicTagGroup接口通过标签自动创建应用分组。

接口说明

本接口支持的云服务包括:云服务器 ECS、云数据库 RDS 和负载均衡 SLB。

本文将提供一个示例,为绑定了标签键ecs_instance的资源自动创建应用分组,应用分组的报警联系组为ECS_Group

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:CreateDynamicTagGroupWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TagKeystring

资源的标签键。

关于如何查询资源的标签键,请参见 DescribeTagKeyList

ecs_instance
ContactGroupListarray

报警联系组。N 的取值范围:1~100。应用分组的报警通知会发送给该报警联系组中的报警联系人。

报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见 PutContactPutContactGroup 。关于如何获取报警联系组,请参见 DescribeContactGroupList

string

报警联系组。N 的取值范围:1~100。应用分组的报警通知会发送给该报警联系组中的报警联系人。

报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见 PutContactPutContactGroup 。关于如何获取报警联系组,请参见 DescribeContactGroupList

ECS_Group
MatchExpressobject []

标签生成应用分组的匹配表达式。

TagValueMatchFunctionstring

资源标签值的匹配方法。N 的取值为 1。取值:

  • contains:包含。
  • startWith:前缀。
  • endWith:后缀。
  • notContains:不包含。
  • equals:等于。
  • all:全部。
说明 参数MatchExpress.N.TagValueMatchFunctionMatchExpress.N.TagValue必须同时设置。
contains
TagValuestring

资源标签值。N 取值为 1。

说明 参数MatchExpress.N.TagValueMatchFunctionMatchExpress.N.TagValue必须同时设置。
instance
TagNamestring

用来创建分组的 Tag 的 Key。如果包含此 Key 的资源有多个,那么会根据过滤条件,把符合的资源按相同的 Key-Value,添加到相同的分组内。

appname
TagRegionIdstring

标签归属的地域 ID。

cn-hangzhou
EnableSubscribeEventboolean

应用分组是否开启自动订阅事件通知。当应用分组内资源发生严重和警告级别的事件时,云监控发送报警通知。取值:

  • true:开启。

  • false(默认值):关闭。

true
EnableInstallAgentboolean

应用分组是否开启自动安装云监控插件。云监控自动为应用分组内的主机安装云监控插件。取值:

  • true:开启。

  • false(默认值):关闭。

true
MatchExpressFilterRelationstring

资源标签值的条件表达式之间的关系。取值:

  • and(默认值):和。
  • or:或。
and
TemplateIdListarray

报警模板 ID。

关于如何查询报警模板 ID,请参见 DescribeMetricRuleTemplateList

string

报警模板 ID。

关于如何查询报警模板 ID,请参见 DescribeMetricRuleTemplateList

70****

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The specified resource is not found.
RequestIdstring

请求 ID。

84AC6F0B-7945-466A-AA44-99BB5A561F86
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Idstring

标签匹配规则 ID。

2534dc0a-e3e5-4ae1-a2fc-75ef166c****

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "84AC6F0B-7945-466A-AA44-99BB5A561F86",
  "Success": true,
  "Id": "2534dc0a-e3e5-4ae1-a2fc-75ef166c****"
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalid%s-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
429ResourceOverLimit%s-
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
2023-03-15OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:429
    删除错误码:500
  • 本页导读 (1)