Help Center/ Cloud Application Engine/ API Reference/ CAE API/ Component./ Obtaining the Details of a Component
Updated on 2025-10-22 GMT+08:00

Obtaining the Details of a Component

Function

Obtain the details of a component.

URI

GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

application_id

Yes

String

Application ID.

component_id

Yes

String

Component ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

  • Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html).

  • The value of X-Subject-Token in the response header is the token value.

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.

  • Enter 0 or up to 36 characters in UUID format with hyphens (-).

  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.

NOTE:
For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

kind

String

API type. Fixed value: Component.

metadata

MetadataResponse object

Response data.

spec

ComponentSpec object

Component specifications.

Table 4 MetadataResponse

Parameter

Type

Description

id

String

Component ID.

name

String

Component name.

annotations

Map<String,String>

Additional attributes of the component. Options:

  • log_group_id: ID of an LTS log group.

  • log_stream_id: ID of an LTS log stream.

  • version: component version.

created_at

String

Creation time.

updated_at

String

Update time.

Table 5 ComponentSpec

Parameter

Type

Description

runtime

String

Language or runtime.

env_id

String

Environment ID.

replica

Integer

Number of instances.

source

Source object

Source information.

build

Build object

Build information.

resource_limit

ResourceLimit object

Instance specifications

access_info

Array of Access objects

Access mode list.

image_url

String

Image address.

available_replica

Integer

Number of available instances.

job_id

String

Job ID.

build_id

String

Build job ID.

status

String

Component status.

  • created: not deployed.

  • running

  • paused

  • notReady

build_log_id

String

Build log ID.

configuration_operation_id

String

Latest operation ID.

terminated

String

Whether the task executed on the component is forcibly terminated.

Table 6 Source

Parameter

Type

Description

code

Repo object

Source code repository information.

type

String

Source type.

sub_type

String

Source subtype.

  • If type is code, sub_type indicates a code repository, such as DevCloud (CodeArts), GitLab, GitHub, Gitee, or Bitbucket.

  • If type is softwarePackage, sub_type indicates a software package repository, such as BinObs or BinDevCloud (CodeArts Release Repo).

url

String

URL.

  • If type is image, url indicates an image address.

  • If type is code, url indicates a Git address.

  • If type is softwarePackage, url indicates a software package address.

Table 7 Repo

Parameter

Type

Description

auth_name

String

Authorization name.

branch

String

Branch.

namespace

String

Namespace, which must be Base64-encoded.

Table 8 Build

Parameter

Type

Description

archive

Archive object

Place where build products are archived for management.

parameters

Parameters object

Table 9 Archive

Parameter

Type

Description

artifact_namespace

String

SWR organization for product management.

Table 10 parameters

Parameter

Type

Description

{User defined key}

Map<String,String>

Additional parameters. Options:

  • base_image: base image address.

  • build_cmd: custom build command.

  • dockerfile_path: custom dockerfile path.

  • dockerfile_content: custom dockerfile content.

  • artifact_name: product to be run after the Java multi-module build. The value ends with .jar.

Table 11 ResourceLimit

Parameter

Type

Description

cpu_limit

String

CPU limit.

memory_limit

String

Memory limit.

Table 12 Access

Parameter

Type

Description

address

String

Access address.

type

String

Access mode type.

Example Requests

Obtain the details of a component.

GET https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}

Example Responses

Status code: 200

OK

{
  "api_version" : "v1",
  "kind" : "Component",
  "metadata" : {
    "id" : "b04980af-5f20-49ec-b499-79b5a4eb8a43",
    "name" : "test",
    "annotations" : {
      "log_group_id" : "96fe4c34-578a-4ea8-8e77-ee59bf8a0fd1",
      "log_stream_id" : "9c024ad2-5c80-45ee-8651-5f2bd89d3c7e",
      "version" : "1.0.0"
    },
    "created_at" : "2023-03-03T03:32:10.040303Z",
    "updated_at" : "2023-03-03T03:32:10.040303Z"
  },
  "spec" : {
    "runtime" : "Docker",
    "env_id" : "7eb2f920-e183-4d4e-9b9d-fffb875ae520",
    "replica" : 1,
    "source" : {
      "type" : "image",
      "url" : "nginx:stable-alpine-perl"
    },
    "resource_limit" : {
      "cpu_limit" : "500m",
      "memory_limit" : "1Gi"
    },
    "image_url" : "nginx:stable-alpine-perl",
    "available_replica" : 1,
    "job_id" : "c96c6907-5c69-4d72-bce0-03926a857b21",
    "status" : "running"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.