Help Center/ Host Security Service/ API Reference/ API Description/ Container Installation and Configuration/ Obtaining the Deployment Template
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Obtaining the Deployment Template

Function

This API is used to obtain the deployment template, which provides parameters for daemonset installation.

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/kubernetes/template

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.

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

is_default

Boolean

Whether the template is a default template

runtime_info

Array of RuntimeRequestBody objects

Container runtime configuration

schedule_info

schedule_info object

Node scheduling information
Table 5 RuntimeRequestBody

Parameter

Type

Description

runtime_name

String

Runtime name. Its value can be:

  • crio_endpoint: CRIO

  • containerd_endpoint: Containerd

  • docker_endpoint: Docker

  • isulad_endpoint: Isulad

  • podman_endpoint: Podman

runtime_path

String

Runtime path
Table 6 schedule_info

Parameter

Type

Description

node_selector

Array of strings

Node selector

pod_tolerances

Array of strings

Pod tolerance

Example Requests

Obtain the deployment template, which provides parameters for daemonset installation.

GET https://{endpoint}/v5/{project_id}/container/kubernetes/template?enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "is_default" : true,
  "runtime_info" : [ {
    "runtime_name" : "crio_endpoint",
    "runtime_path" : "/var/run/crio/crio.sock"
  }, {
    "runtime_name" : "containerd_endpoint",
    "runtime_path" : "/var/run/containerd/containerd.sock"
  }, {
    "runtime_name" : "docker_endpoint",
    "runtime_path" : "/var/run/docker.sock"
  }, {
    "runtime_name" : "podman_endpoint",
    "runtime_path" : "/var/run/podman/podman.sock"
  }, {
    "runtime_name" : "isulad_endpoint",
    "runtime_path" : "/var/run/isulad.sock"
  } ],
  "schedule_info" : { }
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Installation and Configuration