Help Center> ServiceStage> API Reference> Application Management APIs> Components> Obtaining Application Component Information Based on the Component ID
View PDF

Obtaining Application Component Information Based on the Component ID

Function

This API is used to obtain application component information based on the component ID.

URI

GET /v2/{project_id}/cas/applications/{application_id}/components/{component_id}

Table 1 Path parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Tenant's project ID.

application_id

String

Yes

Application ID.

component_id

String

Yes

Component ID.

Request Parameters

Request parameters

None

Response Parameters

Response parameters

Table 2 Response parameters

Parameter

Type

Description

id

String

Application component ID.

name

String

Application component name.

status

Integer

Value: 0 or 1.

0: Normal.

1: Being deleted.

runtime

String

Runtime.

category

String

Application component type. Example: Webapp, Microservice, or Common.

sub_category

String

Application component sub-type.

Webapp sub-types include Web, Magento, and Wordpress.

Microservice sub-types include Java Chassis, Go Chassis, and Mesher.

Common sub-type can be empty.

description

String

Description.

pipeline_ids

Array<String>

Pipeline ID list. A maximum of 10 pipeline IDs are supported.

project_id

String

Project ID.

application_id

String

Application ID.

source

Object

Source of the code or software package. See Table 3.

build

Object

Build. See Table 5.

creator

String

Creator.

create_time

Integer

Creation time.

update_time

Integer

Update time.
Table 3 source parameters

Parameter

Type

Description

kind

String

Type

spec

Object

See Table 4.
Table 4 spec parameters

Parameter

Type

Description

storage

String

Storage mode.

type

String

Type.

url

String

Source code address of the software package.

auth

String

Authentication mode.
Table 5 build parameters

Parameter

Type

Description

ID

String

Type.

parameters

Map<String,String>

See Table 6.
Table 6 parameters description

Parameter

Type

Description

build_cmd

String

Compilation command.

dockerfile_path

String

Address of the Docker file.

artifact_namespace

String

Build archive organization.

Example

Example request

None

Example response

{
    "id": "67581b8e-728a-4187-852a-8090c54531b5", 
    "name": "service-a", 
    "status": 0,
    "runtime": "Java8", 
    "category": "Webapp", 
    "sub_category": null, 
    "description": "demo service a", 
    "project_id": "bf8523d898b64e4eb956e3be3555ca16", 
    "application_id": "06cf2fda-af45-44b4-9e22-6294c4804515", 
    "source": {
        "kind": "artifact", 
        "spec": {
            "storage": "swr", 
            "type": "package", 
            "url": "https://{IP}:20202/xxx/xxx.jar", 
            "auth": "iam"
        }
    }, 
    "build": {
        "id": "ea011e01-2eb5-453f-87bf-874e4a855abe", 
        "parameters": null
    }, 
    "create_time": 1578984181455, 
    "update_time": 1578984181455
}

Status Code

Table 7 Status codes

HTTP Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error code must be in the format of SVCSTG.00100.[Error_ID]. Example: SVCSTG.00100400. See Error Codes of Application Management APIs.

Parent topic: Components