Help Center/ Host Security Service/ API Reference/ API Description/ Container Management/ Querying Container Details
Updated on 2026-05-12 GMT+08:00
View PDF
Share

Querying Container Details

Function

This API is used to query container details.

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}/kubernetes/container/detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

container_id

Yes

String

Container ID

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

service_name

String

Service name.

service_username

String

Service subscriber name.

service_password

String

Service password.

service_port_list

Array of ServicePortInfo objects

Container service port information

enable_simulate

String

Data simulation, which is disabled by default. After this function is enabled, simulation data will be injected to the sandbox.

  • open: enabled

  • close: disabled

hosts

String

Sandbox domain name. Use commas (,) to separate domain names.

extra

ContainerExtraInfo object

Additional configuration of a sandbox. It can be specified for the VPN traffic diversion sandbox, Linux sandbox, RDP sandbox, and MySQL sandbox. It is left blank for other sandboxes by default.
Table 5 ServicePortInfo

Parameter

Type

Description

desc

String

Service name

type

String

Definition

Type.

Constraints

N/A

Range

  • ** http**: HTTP port

  • ** https**: HTTPS port

Default Value

N/A

protocol

String

The default value is tcp. The value can be tcp or udp.

user_port

Integer

User Port

port

Integer

Internal port of the container
Table 6 ContainerExtraInfo

Parameter

Type

Description

openvpn

ContainerExtraOpenvpnInfo object

Sandbox type. It can only be specified for the VPN traffic diversion sandbox.

linux

ContainerExtraLinuxInfo object

Sandbox type. It can only be specified for the Linux sandbox.

rdp

ContainerExtraRdpInfo object

Sandbox type. It can only be specified for the RDP sandbox.

mysql

ContainerExtraMysqlInfo object

Sandbox type. It can only be specified for the MySQL and MySQLCHEAT sandboxes.
Table 7 ContainerExtraOpenvpnInfo

Parameter

Type

Description

outside_ip

String

Mapping IP address

outside_port

String

Mapped port
Table 8 ContainerExtraLinuxInfo

Parameter

Type

Description

os

String

OS.

  • ubt : ubuntu

  • centos : centos

  • debian

  • redhat

  • opensuse

  • kylin

  • uos

  • euleros
Table 9 ContainerExtraRdpInfo

Parameter

Type

Description

proto_env

String

Protocol type. The value can be:

  • 0: protocol simulation

  • 1: system simulation

system

String

System type, which is used for system simulation.

  • win7 : win 7

  • win8 : win 8

  • win10 : win 10

  • win-server2012 : win-server 2012

  • win-server2016 : win-server 2016
Table 10 ContainerExtraMysqlInfo

Parameter

Type

Description

custom_path

String

Custom containment path

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "service_name" : "xxx",
  "service_username" : "xxx",
  "service_password" : "xxx",
  "service_port_list" : [ {
    "desc" : null,
    "type" : "https",
    "protocol" : "tcp",
    "user_port" : 111,
    "port" : 111
  } ],
  "enable_simulate" : "open",
  "hosts" : "xxx",
  "extra" : {
    "openvpn" : {
      "outside_ip" : "xxx",
      "outside_port" : "xxx"
    },
    "linux" : {
      "os" : "centos"
    },
    "rdp" : {
      "proto_env" : 1,
      "system" : "win7"
    },
    "mysql" : {
      "custom_path" : "xxx"
    }
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Management