Obtaining All Components

Function

This API is used to obtain all components.

URI

GET /v3/{project_id}/cas/components

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID. See Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	integer	Number of records to be queried. Value range: 0–100.
offset	No	integer	Offset.
order_by	No	String	Sorting field. By default, query results are sorted by creation time. Enumerated values: create_time, name, and update_time.
order	No	String	Sorting order. desc (default) asc
application_name	No	String	Application name.
component_name	No	String	Component name.

Request

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type or format.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

Response

**Table 4** Response parameters
Parameter	Type	Description
count	Integer	Total number of components.
components	Array of objects	Component parameters. See Table 5.

**Table 5** components parameters
Parameter	Type	Description
id	String	Component ID.
name	String	Component name.
labels	Array of objects	Label. For container-based deployment, you can query a workload by label. For VM-based deployment, you can configure a label of the corresponding microservice name to use graceful startup and shutdown. See Table 10.
status	Object	Component status. See Table 8.
runtime_stack	Object	Technology stack. See Table 7.
application_name	String	Application name.
application_id	String	Application ID.
environment_name	String	Environment name.
environment_id	String	Environment ID.
version	String	Version number.
source	Object	Source of the code or software package. See Table 6.
creator	String	Creator.
platform_type	String	Deployment type.
external_accesses	Array of Objects	External access. See Table 11.

**Table 6** source parameters
Parameter	Type	Description
kind	String	Component source kind. code package image
version	String	Version number.
url	String	Package address. This parameter is mandatory when kind is set to package or image.
storage	String	Storage mode, for example, obs.
auth	String	Authentication mode, for example, iam.
repo_auth	String	Authorization name.
repo_namespace	String	Namespace of the code repository.
repo_ref	String	Code branch or tag, for example, master.
repo_type	String	Code repository type. Value: GitHub, BitBucket, or GitLab.
web_url	String	Code redirection URL. Example: https://github.com/example/demo.git.
repo_url	String	Code repository URL. Example: https://github.com/example/demo.git.

**Table 7** runtime_stack parameters
Parameter	Type	Description
name	String	Technology stack name.
type	String	Technology stack type.
version	String	Technology stack version.
deploy_mode	String	Deployment mode.

**Table 8** status parameters
Parameter	Type	Description
component_status	String	Component status. INITIALIZING UPGRADING FAILED RUNNING DOWN DELETING DELETED RESERVED STARTING STOPPING STOPPED RESTARTING PENDING UNKNOWN PARTIALLY_FAILED
available_replica	Integer	Available instances.
replica	Integer	Total instances.
fail_detail	String	Failure cause. cluster_deleted cluster_unavailable cluster_inaccessible namespace_deleted namespace_unavailable namespace_inaccessible resource_deleted create_failed delete_failed
last_job_id	String	ID of the last executed task.
create_time	Integer	Creation time.
update_time	Integer	Update time.
creator	String	Creator.
artifact	Object	Artifact information. See Table 9.

**Table 9** artifact parameters
Parameter	Type	Description
type	String	Component source type. VM-based deployment supports package. Container-based deployment supports package and image.
url	String	Software package or image address.

**Table 10** labels parameters
Parameter	Type	Description
key	String	Label name.
value	String	Label value.

**Table 11** external_accesses parameters
Parameter	Type	Description
protocol	String	External access type. Value: http or https.
address	String	External access address.
forward_port	Integer	External access port.

Example Request

None

Example Response

{
    "components": [
        {
            "source": {
                "kind": "package",
                "url": "obs://bucket0001/weather-1.0.0.jar",
                "storage": "obs"
            },
            "name": "mycomponent",
            "id": "b8702b0f-94d3-4822-98a1-56815632a0a0",
            "labels": null,
            "runtime_stack": {
                "name": "OpenJDK8",
                "deploy_mode": "virtualmachine",
                "version": "1.1.1"
            },
            "external_accesses": null,
            "status": {
                "component_status": "RUNNING",
                "available_replica": 1,
                "replica": 1,
                "fail_detail": null,
                "last_job_id": "JOB8be53b2a-af9a-4e2b-8505-096688a52237",
                "creator": "ss-test",
                "create_time": 1679556221028,
                "update_time": 1679556318779
            },
            "environment_name": "sudo",
            "environment_id": "4d084044-0b80-4641-963c-b9c9f4092a4f",
            "application_name": "app-39mbbn",
            "application_id": "fc092465-a5fb-4a52-bc65-b735f18366d8",
            "creator": "ss-test",
            "platform_type": "cce",
            "version": "2023.0323.15181"
        }
    ],
    "count": 1
}