DescribeHybridMonitorSLSGroup - CloudMonitor - Alibaba Cloud Documentation Center

Queries Logstore groups.

Operation description

In this example, all Logstore groups within the current account are queried. The response shows that the current account has two Logstore groups: Logstore_test and Logstore_aliyun.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cms:DescribeHybridMonitorSLSGroup	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword that is used to search for Logstore groups.	Logstore
PageSize	string	No	The number of entries per page. Minimum value: 1. Default value: 10.	10
PageNumber	string	No	The page number. Pages start from page 1. Default value: 1.	1
SLSGroupName	string	No	The name of the Logstore group.	Logstore_test

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object	None.
Code	string	The HTTP status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message.	NotFound.SLSGroup
RequestId	string	The request ID.	66683237-7126-50F8-BBF8-D67ACC919A17
Success	string	Indicates whether the request was successful. Valid values: true false
List	array<object>	The queried Logstore groups.
	object
SLSGroupName	long	The name of the Logstore group.	Logstore_test
SLSGroupDescription	string	The description of the Logstore group.
SLSGroupConfig	array<object>	The configurations of the Logstore group.
	object
SLSRegion	string	The region ID.	cn-hangzhou
SLSProject	string	The Simple Log Service project.	aliyun-project
SLSLogstore	string	The Logstore.	Logstore-aliyun-all
SLSUserId	string	The member ID. Description This parameter is returned when you call the operation by using an administrative account.	120886317861****
CreateTime	string	The time when the Logstore group was created. Unit: milliseconds.	1652845630000
UpdateTime	string	The time when the Logstore group was modified. Unit: milliseconds.	1652845630000
PageSize	long	The number of entries per page.	10
PageNumber	long	The page number.	1
Total	long	The total number of entries returned.	2

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "NotFound.SLSGroup",
  "RequestId": "66683237-7126-50F8-BBF8-D67ACC919A17",
  "Success": "",
  "List": [
    {
      "SLSGroupName": 0,
      "SLSGroupDescription": "",
      "SLSGroupConfig": [
        {
          "SLSRegion": "cn-hangzhou",
          "SLSProject": "aliyun-project",
          "SLSLogstore": "Logstore-aliyun-all",
          "SLSUserId": "120886317861****"
        }
      ],
      "CreateTime": "1652845630000",
      "UpdateTime": "1652845630000"
    }
  ],
  "PageSize": 10,
  "PageNumber": 1,
  "Total": 2
}

Error codes

HTTP status code	Error code	Error message
400	%s	%s
500	InternalError	%s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-06-20	The Error code has changed. The response structure of the API has changed	View Change Details
2022-01-25	Add Operation	View Change Details