Queries Logstore groups.

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeHybridMonitorSLSGroup

The operation that you want to perform. Set the value to DescribeHybridMonitorSLSGroup.

Keyword String No Logstore

The keyword that is used to search for Logstore groups.

PageSize String No 10

The number of entries to return on each page.

A minimum of 1 entry can be returned on each page. Default value: 10.

PageNumber String No 1

The number of the page to return.

Pages start from page 1. Default value: 1.

SLSGroupName String No Logstore_test

The name of the Logstore group.

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

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code.

Note The status code 200 indicates that the call is successful.
Message String NotFound.SLSGroup

The error message.

RequestId String 66683237-7126-50F8-BBF8-D67ACC919A17

The ID of the request.

Success String N/A

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
List Array of Data

The list of Logstore groups.

SLSGroupName Long Logstore_test

The name of the Logstore group.

SLSGroupDescription String The Logstore group to which the Alibaba Cloud service belongs.

The description of the Logstore group.

SLSGroupConfig Array of SLS

The configurations of the Logstore group.

SLSRegion String cn-hangzhou

The region ID.

SLSProject String aliyun-project

The Log Service project.

SLSLogstore String Logstore-aliyun-all

The Logstore.

SLSUserId String 120886317861****

The ID of the member account.

Note This parameter is returned only when you call API operations by using a management account.
CreateTime String 1652845630000

The timestamp that was generated when the Logstore group was created.

Unit: milliseconds.

UpdateTime String 1652845630000

The timestamp that was generated when the Logstore group was modified.

Unit: milliseconds.

PageSize Long 10

The number of entries returned per page.

PageNumber Long 1

The page number of the returned page.

Total Long 2

The total number of returned entries.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeHybridMonitorSLSGroup
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeHybridMonitorSLSGroupResponse>
    <RequestId>66683237-7126-50F8-BBF8-D67ACC919A17</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Total>2</Total>
    <List>
        <CreateTime>1652845630000</CreateTime>
        <SLSGroupName>Logstore_test</SLSGroupName>
        <UpdateTime>1652845630000</UpdateTime>
        <SLSGroupDescription/>
        <SLSGroupConfig>
            <SLSProject>aliyun-project</SLSProject>
            <SLSRegion>cn-hangzhou</SLSRegion>
            <SLSLogstore>Logstore-aliyun-all</SLSLogstore>
        </SLSGroupConfig>
    </List>
    <List>
        <CreateTime>1649230049000</CreateTime>
        <SLSGroupName>Logstore_aliyun</SLSGroupName>
        <UpdateTime>1649230049000</UpdateTime>
        <SLSGroupDescription/>
        <SLSGroupConfig>
            <SLSProject>aliyun-test</SLSProject>
            <SLSRegion>cn-qingdao</SLSRegion>
            <SLSLogstore>oss_log</SLSLogstore>
        </SLSGroupConfig>
    </List>
    <Code>200</Code>
    <Success>true</Success>
</DescribeHybridMonitorSLSGroupResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "66683237-7126-50F8-BBF8-D67ACC919A17",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Total" : 2,
  "List" : [ {
    "CreateTime" : 1652845630000,
    "SLSGroupName" : "Logstore_test",
    "UpdateTime" : 1652845630000,
    "SLSGroupDescription" : "",
    "SLSGroupConfig" : [ {
      "SLSProject" : "aliyun-project",
      "SLSRegion" : "cn-hangzhou",
      "SLSLogstore" : "Logstore-aliyun-all"
    } ]
  }, {
    "CreateTime" : 1649230049000,
    "SLSGroupName" : "Logstore_aliyun",
    "UpdateTime" : 1649230049000,
    "SLSGroupDescription" : "",
    "SLSGroupConfig" : [ {
      "SLSProject" : "aliyun-test",
      "SLSRegion" : "cn-qingdao",
      "SLSLogstore" : "oss_log"
    } ]
  } ],
  "Code" : 200,
  "Success" : true
}

Error codes

For a list of error codes, visit the Error Center.