You need to enable JavaScript to run this app.
文档中心
云监控

云监控

复制全文
下载 pdf
对象分组
UpdateObjectGroup
复制全文
下载 pdf
UpdateObjectGroup
更新对象分组。​
使用限制​
一个对象分组最多包含 100 个云产品,每个云产品最多包含 1000 个资源;一个对象分组最多包含 5000 个云产品资源。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://cloudmonitor.cn-beijing.volcengineapi.com?Action=UpdateObjectGroup&Version=2018-01-01​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
UpdateObjectGroup​
接口名称。当前 API 的名称为 UpdateObjectGroup。​
Version​
String​
是​
2018-01-01​
接口版本。当前 API 的版本为 2018-01-01。​
Id​
String​
否​
1764547228734******​
对象分组 ID。​
Name​
String​
否​
object_group_demo​
对象分组名称。​
  • 只能包含中文、英文、数字和下划线_。​
  • 长度限制在 1~64 字符。​
Objects​
Array of Object​
否​
  • ​
需要分组的云产品资源列表,列表长度最大值 100。​
​
Object​
​
参数​
类型​
是否必选​
示例值​
描述​
Id​
String​
否​
1764547228934******​
对象分组ID。​
Namespace​
String​
否​
VCM_ECS​
云产品在云监控中所属的产品空间。详情请参见 云产品监控指标 下各产品的 Namespace。​
Dimensions​
JSON Map​
否​
  • ​
云产品资源 ID 集合。​
Region​
String​
否​
cn-beijing​
当前资源合集下云产品所属可用区。​
  • 当Type为enum时,只支持选择一个 Region。​
  • 当Type为dynamic时,支持选择多个 Region,不同 Region 之间通过英文逗号,分隔。​
Type​
String​
否​
enum​
资源合集类型。取值:​
  • enum:手动选择。如果定义为 enum,则Dimensions不能为空。​
  • dynamic:通过资源名称、项目和标签选择。如果定义为 dynamic,则DimensionConditions不能为空。​
DimensionConditions​
Object of DimensionConditions​
否​
  • ​
Dimension 配置。​
​
Dimensions​
​
参数​
类型​
是否必选​
示例值​
描述​
key​
String​
是​
ResourceID​
检索指标的 KEY。​
value​
Array of String​
是​
i-ydvpb***​
检索指标 Key 对应的 Value。​
​
DimensionConditions​
​
参数​
类型​
是否必选​
示例值​
描述​
Type​
String​
否​
meta​
Dimensions 类型。取值:​
  • project:根据项目选择告警对象。​
  • tag:根据标签选择告警对象。​
  • meta:根据资源名称选择告警对象。​
TagCondition​
Object of TagCondition​
否​
  • ​
根据标签选择告警对象的条件。当Type为tag时必填。​
MetaCondition​
Object of MetaCondition​
否​
  • ​
根据资源名称选择告警对象的条件。当Type为meta时必填。​
ProjectCondition​
Object of ProjectCondition​
否​
  • ​
根据项目选择告警对象的条件。当Type为project时必填。​
​
TagCondition​
​
参数​
类型​
是否必选​
示例值​
描述​
Tags​
Array of KVComparator​
否​
-​
标签列表。​
  • 最多支持配置 10 个标签列表。​
  • 标签值不能超过 50 个字符。​
Condition​
String​
否​
and​
判断条件。​
  • and:全部满足。​
  • or:任意满足。​
​
MetaCondition​
​
参数​
类型​
是否必选​
示例值​
描述​
Metas​
Array of MetaKVComparator​
否​
-​
资源列表。​
  • 最多支持配置 10 个资源名称列表。​
  • 当Comparator为equal或not_equal时,输入的资源名称字符长度没有限制。​
  • 当Comparator为contain、not_contain、prefix_match或suffix_match时,输入的资源名称不能超过 100 个字符。​
Condition​
String​
否​
or​
判断条件。​
  • and:全部满足。​
  • or:任意满足。​
AllDimensions​
Boolean​
否​
true​
是否为全量资源。​
  • true:全部资源。​
  • false:部分资源。​
​
ProjectCondition​
​
参数​
类型​
是否必选​
示例值​
描述​
Projects​
Array of String​
否​
["testDefault1", "testDefault2"]​
项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。​
​
KVComparator​
​
参数​
类型​
是否必选​
示例值​
描述​
Key​
String​
否​
testKey​
标签的键(Key)。​
Values​
Array of String​
否​
["testValues", "testValues2"]​
标签的值(Value)。​
  • 当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。​
  • 当Comparator为equal或not_equal时,支持输入多个 Value。​
  • 当Comparator为contain、not_contain、prefix_match或suffix_match时,仅支持输入 1 个 Value。​
Comparator​
String​
否​
equal​
标签匹配时的比较符。​
  • contain:包含​
  • not_contain:不包含​
  • prefix_match:前缀匹配​
  • suffix_match:后缀匹配​
  • equal:等于​
  • not_equal:不等于​
  • exist:存在​
​
MetaKVComparator​
​
参数​
类型​
是否必选​
示例值​
描述​
Key​
String​
否​
ResourceName​
资源名称。目前仅支持配置为ResourceName。​
Values​
Array of String​
否​
["testResource1", "testResource2"]​
资源的 Values。​
  • 当Comparator为equal或not_equal时,支持配置多个 Value。​
  • 当Comparator配置为contain、not_contain、prefix_match或suffix_match时,仅支持配置 1 个 Value。​
Comparator​
String​
否​
equal​
资源匹配时的比较符。​
  • contain:包含​
  • not_contain:不包含​
  • prefix_match:前缀匹配​
  • suffix_match:后缀匹配​
  • equal:等于​
  • not_equal:不等于​
​
请求示例​
​
POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=UpdateObjectGroup&Version=2018-01-01​
Content-Type: application/json​
{​
"Name": "object_group_demo",​
"Objects": [​
{​
"Namespace": "VCM_ECS",​
"Dimensions": {​
"ResourceID": [​
"i-yccipr76y47gra******",​
"i-ycbibi30pm8rx6******",​
"i-ycbibi2y5vb5oz******"​
]​
},​
"Region": "cn-beijing",​
"Type": "enum"​
},​
{​
"Namespace": "VCM_EIP",​
"Dimensions": {​
"ResourceID": [​
"eip-13fri2dcbxyps3n6nu5******",​
"eip-mil3eeb3axvk5smt1a******"​
]​
},​
"Region": "cn-beijing",​
"Type": "enum"​
}​
],​
"Id": "1764547228734******"​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Data​
String​
1764547228734******​
对象分组 ID。​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20240304152908454D22F975D29B******",​
"Action": "UpdateObjectGroup",​
"Version": "2018-01-01",​
"Service": "cloudmonitor",​
"Region": "cn-beijing"​
},​
"Result": {​
"Data": "1764547228734******"​
}​
}​
​
错误码​
本接口无特有的错误码,更多信息请参见 错误码。​
最近更新时间:2026.08.11 20:28:01
这个页面对您有帮助吗?
有用
有用
无用
无用