Help Center/Host Security Service/API Reference/API Description/Container Management/Querying the Container Log List
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the Container Log List

Function

This API is used to query the container log list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/container/logs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Specifies the ID of the enterprise project that the server belongs to.

An enterprise project can be configured only after the enterprise project function is enabled.

Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission.

cluster_id

No

String

Cluster ID

cluster_name

No

String

Cluster name

namespace

No

String

Namespace to which the container generating the log belongs.

pod_name

No

String

Name of the pod to which the container that generates the log belongs

pod_id

No

String

ID of the pod to which the container that generates the log belongs

pod_ip

No

String

IP address of the pod to which the container that generates the log belongs

host_ip

No

String

IP address of the host where the container that generates the log is located

container_id

No

String

Container ID

container_name

No

String

Name of the container for which a log is generated.

content

No

String

Log content

start_time

No

Long

Minimum time for querying logs.

end_time

No

Long

Maximum time for querying logs

limit

Yes

Integer

Number of records displayed on each page. The default value is 10.

offset

Yes

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

line_num

No

String

Page number that needs to be transferred when the CCE cluster container logs are queried.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of logs

data_list

Array of ClusterContainerLogResponseInfo objects

Container logs of the Kubernetes cluster

Table 5 ClusterContainerLogResponseInfo

Parameter

Type

Description

cluster_name

String

Cluster name

cluster_id

String

Cluster ID

cluster_type

String

Cluster type. Its value can be:

  • cce: CCE cluster

  • ali: Alibaba Cloud cluster

  • tencent: Tencent Cloud cluster

  • azure: Microsoft Azure Cloud cluster

  • aws: AWS Cloud cluster

  • self_built_hw: customer-built cluster on Huawei Cloud

  • self_built_idc: IDC on-premises cluster

time

Long

Time when a log is generated

namespace

String

Namespace to which container logs belong

pod_name

String

Name of the pod to which the container for which the log is generated belongs

pod_id

String

ID of the pod to which the container for which the log is generated belongs

pod_ip

String

IP address of the pod to which the container generating the log belongs

host_ip

String

IP address of the host where the container generating the log is located

container_name

String

Name of the container for which the log is generated.

container_id

String

ID of the container for which the log is generated.

content

String

Log content

line_num

String

Row number of a container log in the CCE cluster.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "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
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Management