# 查询容器日志列表 - ListContainerLogs #### 功能介绍 查询容器日志列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/container/logs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 租户项目ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为"0"，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参"all_granted_eps"。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。 | | cluster_id | 否 | String | 集群id | | cluster_name | 否 | String | 集群名称 | | namespace | 否 | String | 产生日志的容器所属的命名空间 | | pod_name | 否 | String | 产生日志的容器所属pod的名称 | | pod_id | 否 | String | 产生日志的容器所属pod的id | | pod_ip | 否 | String | 产生日志的容器所属pod的ip | | host_ip | 否 | String | 产生日志的容器所在主机的ip | | container_id | 否 | String | 容器id | | container_name | 否 | String | 产生日志的容器名称 | | content | 否 | String | 日志内容 | | start_time | 否 | Long | 查询日志范围的最小时间 | | end_time | 否 | Long | 查询日志范围的最大时间 | | limit | 是 | Integer | 每页显示个数，默认为10 | | offset | 是 | Integer | 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 | | line_num | 否 | String | 查询cce集群容器日志时需要传的分页行号 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | 日志总条数 | | data_list | Array of [ClusterContainerLogResponseInfo] objects | k8s集群容器日志列表 | 表5ClusterContainerLogResponseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cluster_name | String | 集群名称 | | cluster_id | String | 集群id | | cluster_type | String | 集群类型，包含以下几种： - cce：cce集群 - ali：阿里云集群 - tencent：腾讯云集群 - azure：微软云集群 - aws：亚马逊集群 - self_built_hw：华为云自建集群 - self_built_idc：IDC自建集群 | | time | Long | 日志产生的时间 | | namespace | String | 容器日志所属的命名空间 | | pod_name | String | 产生日志的容器所属pod的名称 | | pod_id | String | 产生日志的容器所属pod的id | | pod_ip | String | 产生日志的容器所属pod的ip | | host_ip | String | 产生日志的容器所在的主机ip | | container_name | String | 产生日志的容器名称 | | container_id | String | 产生日志的容器id | | content | String | 日志的内容 | | line_num | String | cce集群容器日志的行号 | #### 请求示例 无 #### 响应示例 **状态码：200** 请求已成功 ``` { "total_num" : 1, "data_list" : [ { "cluster_name" : "ywk-55555", "cluster_id" : "b075094b-d21a-499a-9006-624089c94402", "cluster_type" : "cce", "time" : 1814080859608, "namespace" : "hss", "pod_name" : "infer-39cce5d3-07b2-4794-a69d-fc758d507ce1-gruhs-role-0-5d5hzbq", "pod_id" : "b075094b-d21a-499a-9006-624089c94402", "pod_ip" : "192.168.0.93", "host_ip" : "192.168.0.9", "container_name" : "k8s_infer-3bb780ef-01b2-45b3-bf0c-fc758d507ce1_infer-39cce5d3-07b2-4794-a69d-fc758d507ce1-gruhs-role-0-5d5hzbq_pool-x-infer-test-04f258c84780d5a52f3bc00dc15aa5e7_1dbafeed-e3bb-4bc6-9eaa-1f9bdb50df26_1", "container_id" : "16***0dc-94cb-4ca3-9087-06***cd168c1", "content" : "successfully started container k8s_infer-3bb780ef-01b2-45b3-bf0c-fc758d507ce1_infer-39cce5d3-07b2-4794-a69d-fc758d507ce1-gruhs-role-0-5d5hzbq_pool-x-infer-test-04f258c84780d5a52f3bc00dc15aa5e7_1dbafeed-e3bb-4bc6-9eaa-1f9bdb50df26_1", "line_num" : "123123" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListContainerLogsSolution { 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); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("")) .build(); ListContainerLogsRequest request = new ListContainerLogsRequest(); try { ListContainerLogsResponse response = client.listContainerLogs(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()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 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 = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("")) \ .build() try: request = ListContainerLogsRequest() response = client.list_container_logs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ListContainerLogsRequest{} response, err := client.ListContainerLogs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ListContainerLogs&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。