DescribeHybridMonitorSLSGroup-阿里云帮助中心

Queries the list of Logstore groups by calling the DescribeHybridMonitorSLSGroup operation.

Operation description

This topic provides an example of how to query all Logstore groups in the current account. The response shows that the current account has two Logstore groups: Logstore_test and Logstore_aliyun.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeHybridMonitorSLSGroup

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The search keyword.	Logstore
PageSize	string	No	The number of entries per page. Minimum value: 1. Default value: 10.	10
PageNumber	string	No	The page number. Minimum value: 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 elements

Element	Type	Description	Example
	object	None.
Code	string	The status code. Note A value of 200 indicates success.	200
Message	string	The error message.	NotFound.SLSGroup
RequestId	string	The request ID.	66683237-7126-50F8-BBF8-D67ACC919A17
Success	string	Indicates whether the operation was successful. Valid values: true: Successful. false: Failed.	true
List	array<object>	The list of Logstore groups.
	array<object>	None.
SLSGroupName	string	The name of the Logstore group.	Logstore_test
SLSGroupDescription	string	The description of the Logstore group.	Logstore group of Alibaba Cloud products.
SLSGroupConfig	array<object>	The configuration information of the Logstore group.
	object	None.
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 timestamp when the Logstore group was created. Unit: milliseconds.	1652845630000
UpdateTime	string	The timestamp when the Logstore group was last modified. Unit: milliseconds.	1652845630000
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Total	integer	The total number of entries.	2

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "NotFound.SLSGroup",
  "RequestId": "66683237-7126-50F8-BBF8-D67ACC919A17",
  "Success": "true",
  "List": [
    {
      "SLSGroupName": "Logstore_test",
      "SLSGroupDescription": "Logstore group of Alibaba Cloud products.",
      "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
412	%s	%s
500	%s	%s
500	InternalError	%s
403	%s	%s
404	%s	%s
409	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.