|
Parameter |
Type |
Description |
Example |
|---|---|---|---|
|
object |
|||
| groupId |
string |
The globally unique ID of the observability group. Format: og-<16-character hash>. Used uniformly across metrics, alerts, and consoles. |
|
| groupName |
string |
The name of the observability group. Must be unique within the same workspace. |
|
| description |
string |
The description of the observability group, which explains its business purpose. |
|
| resourceGroupId |
string |
The Alibaba Cloud resource group ID. |
|
| aliUid |
string |
The UID of the Alibaba Cloud account to which the group belongs. |
|
| regionId |
string |
The region ID to which the group belongs. |
|
| createTime |
string |
The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ. |
|
| modifyTime |
string |
The last modification time in UTC format: yyyy-MM-ddTHH:mm:ssZ. Automatically updated when any resource attribute changes. |
|
| groupType |
string |
The type of the observability group. |
|
| discoverRules |
string |
The list of entity discovery rules that define which entities the group automatically matches. |
|
| extraInfo |
string |
The extended information as a JSON string, which carries alert templates, alert contact groups, and suspension policies. |
|
| workspaceId |
string |
The workspace ID to which the group belongs. This value is set at the workspace level and cannot be changed after creation. |
|
| sourceOrigin |
string |
The data source. Valid values:
|
|
| originGroupId |
string |
The product_group.id of the version 1.0 application group. This parameter is valid only when sourceOrigin is set to synced_from_1_0. |
|
| entityCounts |
object |
The number of entities in each category. The key is the category domain (acs for cloud services, apm, or rum, which is extensible). The value is the number of entities in that category that belong to this group. Returned only when withEntityCount is set to true. |
|
|
integer |
|||
| health |
integer |
The health status of the group. Valid values:
|
|
| favorited |
boolean |
Indicates whether the current user has followed this group. This value is used as the filter criterion for the My Favorites feature. |
|
| ogEntityInfoEnabled |
boolean |
Specifies whether og_entity_info metric output is enabled. When enabled, the data plane writes the group membership information to the target Prometheus instance. |
|
| ogEntityInfoPromInstances |
array |
The set of Prometheus instances to which og_entity_info is written. Includes two source types: system (automatically identified by the system) and custom (user-defined). |
|
| ObserveGroupPromInstance | |||
| tags |
array |
The resource tags (Alibaba Cloud standard tags) as an array of key-value pairs. |
|
|
object |
|||
| tagKey |
string |
The tag key. |
|
| tagValue |
string |
The tag value. |