Updated on 2025-02-14 GMT+08:00

Obtaining the Component List

Function

This API is used to obtain the component list.

URI

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

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.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

String

Maximum number of returned results.

offset

No

String

Pagination offset, that is, the start position for query.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Maximum characters: 16,384

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 more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

Enumerated value:

  • v1

kind

String

API type. Fixed value: Component.

Enumerated value:

  • Component

items

Array of ComponentItem objects

Component list.

total_count

Integer

Total number of pages.

Table 5 ComponentItem

Parameter

Type

Description

id

String

Component ID.

name

String

Component name.

annotations

map<string, object>

Additional information.

created_at

String

Creation time.

updated_at

String

Update time.

spec

ComponentSpec object

Component specifications.

Table 6 ComponentSpec

Parameter

Type

Description

runtime

String

Language or runtime.

Enumerated value:

  • Docker
  • Java8
  • Java11
  • Java17
  • Tomcat8
  • Tomcat9
  • Python3
  • Nodejs8
  • Nodejs14
  • Nodejs16
  • Php7

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 task ID.

status

String

Component status.

build_log_id

String

Build log ID.

configuration_operation_id

String

Latest operation ID.

Table 7 Source

Parameter

Type

Description

code

Repo object

Source code repository information.

type

String

Source type.

Enumerated values:

  • image
  • code
  • softwarePackage

sub_type

String

Source subtype.

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

Enumerated values:

  • BinObs
  • BinDevCloud
  • GitLab
  • GitHub
  • Bitbucket

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 8 Repo

Parameter

Type

Description

auth_name

String

Authorization name.

branch

String

Branch.

namespace

String

Namespace, which must be Base64-encoded.

Table 9 Build

Parameter

Type

Description

archive

Archive object

Place where build products are archived for management.

parameters

map<string, object>

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 10 Archive

Parameter

Type

Description

artifact_namespace

String

SWR organization for product management.

Table 11 ResourceLimit

Parameter

Type

Description

cpu_limit

String

CPU limit.

Enumerated values:

  • 500m
  • 1000m
  • 2000m

memory_limit

String

Memory limit.

Enumerated values:

  • 1Gi
  • 2Gi
  • 4Gi
Table 12 Access

Parameter

Type

Description

address

String

Access address.

type

String

Access mode.

Enumerated values:

  • LoadBalancer
  • Ingress

Example Request

Obtain the component list.

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

Example Response

Status code: 200

The request is successful.

{
  "api_version" : "v1",
  "kind" : "Component",
  "items" : [ {
    "id" : "610fb1de-5ac6-424e-b910-d7be902575d0",
    "name" : "demo-xxx",
    "annotations" : {
      "version" : "1.0.0",
      "enterprise_project_id" : ""
    },
    "created_at" : "2022-06-09T07:01:05.323979Z",
    "updated_at" : "2022-06-09T07:01:05.323979Z",
    "spec" : {
      "runtime" : "Docker",
      "env_id" : "50d18173-5df0-4db4-a2b6-8a428d42146b",
      "replica" : 1,
      "source" : {
        "type" : "image",
        "url" : "xxx/demo-jar:v2"
      },
      "build" : {
        "archive" : {
          "artifact_namespace" : "xxx"
        },
        "parameters" : {
          "base_image" : ""
        }
      },
      "resource_limit" : {
        "cpu_limit" : "500m",
        "memory_limit" : "1Gi"
      },
      "image_url" : "xxx/demo-jar:v2",
      "available_replica" : 1,
      "job_id" : "251b7d84-c353-416a-864f-5878a94c3d28",
      "status" : "running",
      "configuration_operation_id" : "xxx"
    }
  } ],
  "total_count" : 1
}

Status Code

Status Code

Description

200

The request is successful.

Error Code

For details, see Error Codes.