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

Querying the List of Commands Running in a Container

Function

This API is used to query the list of commands running in a container.

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/cmd-histories

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

host_name

No

String

Name of the host where the container generating the log is located

host_id

No

String

ID of the host where the container generating the log is located

host_ip

No

String

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

container_id

No

String

Container ID

container_name

No

String

Name of the container for which a log is generated.

cmd

No

String

Running command line

path

No

String

Process path corresponding to the command line

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.

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 ContainerCmdLogResponseInfo objects

Logs of running commands in the container

Table 5 ContainerCmdLogResponseInfo

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

host_id

String

Server ID.

host_name

String

Host name

private_ip

String

Private IP address of the host where the container is located

public_ip

String

Host IP address.

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.

cmd

String

Command to be executed

path

String

Process path corresponding to the command line

process_pid

Integer

PID of the process corresponding to the command line

user_name

String

User

group_name

String

User group to which the user who runs the command belongs

parent_process_pid

Integer

Parent process PID

parent_path

String

Parent process path

Example Requests

None

Example Responses

Status code: 200

List of commands running in a container

{
  "total_num" : 1,
  "data_list" : [ {
    "cluster_name" : "cluster_1323",
    "cluster_id" : "d8980c20-fd83-418a-a9c1-1abe9044ee3a",
    "cluster_type" : "cce",
    "time" : 1736925153481,
    "host_id" : "09724867-7b91-482d-9702-daf9113f1b62",
    "host_name" : "agentcompile-2",
    "private_ip" : "172.16.0.**",
    "public_ip" : "100.0.0.1",
    "container_name" : "edfry",
    "container_id" : "eedf8817-f486-4c4f-a395-b8373ecc7ef4",
    "cmd" : "nsenter -t 1 -m -n -i -p -u systemctl is-enabled docker",
    "path" : "/usr/bin/ls",
    "process_pid" : 12345,
    "user_name" : "testuser",
    "group_name" : "testuser",
    "parent_process_pid" : 542637,
    "parent_path" : "/usr/bin/containerd-shim"
  } ]
}

Status Codes

Status Code

Description

200

List of commands running in a container

Error Codes

See Error Codes.

Parent Topic: Container Management