更新时间:2025-08-20 GMT+08:00

创建日志组

功能介绍

创建一个日志组。日志组是云日志服务进行日志管理的基本单位,主要用于对日志流进行分类。通过该接口可创建一个日志组,在该日志组下按需创建多个日志流,从而构建条理分明的日志管理架构,便于日志管理。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID。获取方式请参见:获取企业项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

default。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

用于定义消息体的格式,该字段填为:application/json;charset=utf8。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 请求Body参数

参数

是否必选

参数类型

描述

log_group_name

String

参数解释:

创建的日志组名称。

约束限制:

日志组名称不能与其他创建的日志组名称或原始名称相同。

取值范围:

  • 支持输入英文、数字、中文、中划线、下划线及小数点,且不能以小数点、下划线开头或以小数点结尾。

  • 长度限制为1~64个字符。

默认取值:

不涉及。

ttl_in_days

Integer

参数解释:

日志组的存储时间(单位:天),即日志上报到LTS后日志存储的时间。

约束限制:

不涉及

取值范围:

最小值:1

最大值:365

默认取值:

30,即日志数据默认存储30天。

tags

Array of tagsBody objects

参数解释:

日志组的标签信息。

约束限制:

最多支持20个标签。

log_group_name_alias

String

参数解释:

日志组名称别名。

约束限制:

日志组名称别名不能与其他日志组的名称或原始名称相同。

取值范围:

  • 只能由英文大小写字母、数字、特殊字符“_”“-”“.”组成,且不能以小数点、下划线开头或以小数点结尾。

  • 长度限制为1~64个字符。

默认取值:

不涉及。

表5 tagsBody

参数

是否必选

参数类型

描述

key

String

参数解释:

标签键。

约束限制:

  • 标签键名称不可重复。

  • 标签是以键值对(key-value)的形式表示,key和value为一一对应关系。

取值范围:

标签键可以包含任意语种的字母、数字和空格,以及_.:=+-@字符,但首尾不能包含空格,且不能以_sys_开头;长度不能超过128个字符。

默认取值:

不涉及。

value

String

参数解释:

标签值。

约束限制:

标签是以键值对(key-value)的形式表示,key和value为一一对应关系。

取值范围:

  • 标签值可以包含任意语种的字母、数字和空格,以及_.:=+-@字符。

  • 标签值长度不能超过255个字符。

默认取值:

不涉及。

响应参数

状态码:201

表6 响应Body参数

参数

参数类型

描述

log_group_id

String

参数解释:

创建的日志组ID。

取值范围:

不涉及。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:503

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

请求示例

创建日志组。

POST https://{endpoint}/v2/{project_id}/groups

{
  "log_group_name" : "lts-group-01nh",
  "ttl_in_days" : 7
}

响应示例

状态码:201

请求响应成功,成功创建日志组。

{
  "log_group_id" : "b6b9332b-091f-4b22-b810-264318d2d664"
}

状态码:400

非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。

{
  "error_code" : "LTS.0009",
  "error_msg" : "Failed to validate the request body"
}

状态码:401

鉴权失败, 请确认token后再次请求 。

{
  "error_code" : "LTS.0003",
  "error_msg" : "Invalid token"
}

状态码:403

请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

{
  "error_code" : "LTS.0001",
  "error_msg" : "Invalid projectId"
}

状态码:500

表明服务端能被请求访问到,但是服务内部出错。

{
  "error_code" : "LTS.0102",
  "error_msg" : "Failed to create log group"
}

SDK代码示例

SDK代码示例如下。

创建日志组。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;


public class CreateLogGroupSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateLogGroupRequest request = new CreateLogGroupRequest();
        CreateLogGroupParams body = new CreateLogGroupParams();
        body.withTtlInDays(7);
        body.withLogGroupName("lts-group-01nh");
        request.withBody(body);
        try {
            CreateLogGroupResponse response = client.createLogGroup(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

创建日志组。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateLogGroupRequest()
        request.body = CreateLogGroupParams(
            ttl_in_days=7,
            log_group_name="lts-group-01nh"
        )
        response = client.create_log_group(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建日志组。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateLogGroupRequest{}
	request.Body = &model.CreateLogGroupParams{
		TtlInDays: int32(7),
		LogGroupName: "lts-group-01nh",
	}
	response, err := client.CreateLogGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

请求响应成功,成功创建日志组。

400

非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。

401

鉴权失败, 请确认token后再次请求 。

403

请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

500

表明服务端能被请求访问到,但是服务内部出错。

503

被请求的服务无效, 服务不可用。

错误码

请参见错误码