Help Center/ ModelArts/ API Reference/ Node configuration template/ Obtaining a Node Configuration Template
Updated on 2025-11-19 GMT+08:00
View PDF
Share

Obtaining a Node Configuration Template

Function

This API is used to obtain details about a node configuration template. This API is used when you need to view a node configuration template, manage node configurations, or perform related operations. Before using this API, ensure that the node configuration template exists and you have the required permission. After this API is called, the system returns the details of the specified node configuration template, including the template name, version, configuration parameters, and description. If the node configuration template does not exist or you do not have the access permission, the API will return an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v1/{project_id}/nodeconfigtemplates/{nodeconfigtemplate_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: User project ID. For details, see Obtaining a Project ID and Name.

Constraints: N/A

Range: N/A

Default Value: N/A

nodeconfigtemplate_name

Yes

String

Definition: Name of the node configuration template.

Constraints: N/A

Range: N/A

Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

apiVersion

String

Definition: API version.

Range:

  • v1

kind

String

Definition: Resource type.

Range:

  • NodeConfigTemplate: node configuration template

metadata

NodeConfigTemplateMeta object

Definition: Metadata of the node configuration template.

spec

NodeConfigTemplateSpec object

Definition: Specifications of the node configuration template.
Table 3 NodeConfigTemplateMeta

Parameter

Type

Description

name

String

Definition: Name of the node configuration template.

Range: N/A
Table 4 NodeConfigTemplateSpec

Parameter

Type

Description

dockerBaseSize

Integer

Definition: Available disk space of a single container on a resource pool node, in GB.

Range: N/A

dockerLvmConfig

DockerLvmConfig object

Definition: Docker data disk configuration of a resource pool node.
Table 5 DockerLvmConfig

Parameter

Type

Description

dockerThinPool

Integer

Definition: Percentage of Docker disks to data disks on nodes in a resource pool. For example, if the Docker disks take 20/ %of the data disks, the value of this parameter is 20.

Range: N/A

kubernetesLV

Integer

Definition: Percentage of Kubernetes disks to data disks on nodes in a resource pool. For example, if the Docker disks take 20/ %of the data disks, the value of this parameter is 20.

Range: N/A

dockerDiskType

String

Definition: Disk type.

Range:

  • evs: EVS disks

  • ssd: local SSDs

lvType

String

Definition: LVM write mode.

Range:

  • striped: striped mode in which multiple disks are used to form a strip to improve disk performance

  • linear: linear mode

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

  • Definition: ModelArts error code.

Range: N/A

error_msg

String

Definition: Error message.

Range: N/A

Example Requests

None

Example Responses

Status code: 200

OK.

{
  "kind" : "NodeConfigTemplate",
  "apiVersion" : "v1",
  "metadata" : {
    "name" : "base.template"
  },
  "spec" : {
    "dockerBaseSize" : 50,
    "dockerLvmConfig" : {
      "dockerThinPool" : 90,
      "kubernetesLV" : 10,
      "dockerDiskType" : "evs"
    }
  }
}

Status code: 404

Not found.

{
  "error_code" : "ModelArts.50005101",
  "error_msg" : "Nodeconfigtemplate {name} not found"
}

Status Codes

Status Code

Description

200

OK.

404

Not found.

Error Codes

See Error Codes.