Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Add-on Management/ Querying Add-on Details Based on the Add-on ID
Updated on 2024-10-16 GMT+08:00

Querying Add-on Details Based on the Add-on ID

Function

This API is used to query details about an add-on in an environment.

URI

GET /v3/{project_id}/cas/environments/{environment_id}/addons/{addon_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

environment_id

Yes

String

Environment ID. See Obtaining All Environments.

addon_id

Yes

String

Add-on ID. See Querying the Add-on List.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

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 the token, see Authentication.

Response

Table 3 Response parameters

Parameter

Type

Description

addons

Arrays of objects

Add-on version. See Table 4.

Table 4 addons

Parameter

Type

Description

id

String

Add-on ID.

name

String

Add-on name.

sermantInjector: Sermant Injector add-on. It is used to automatically mount Sermant Agent and connect to ServiceComb engines with security authentication disabled through Sermant Agent. You can access the engine and use functions such as application registry and discovery, full-link dark launch, graceful startup and shutdown, and label routing without modifying application code. However, microservice governance is not supported.

version

String

Add-on version.

cce_id

String

ID of the CCE cluster where the add-on is installed.

cse_id

String

ID of the microservice engine bound for add-on installation.

job_id

String

ID of the job executed by the add-on.

environment_id

String

ID of the add-on environment.

status

String

Add-on status.

  • INITIALIZING
  • UPGRADING
  • FAILED
  • SUCCEEDED
  • DELETING

Example Request

None

Example Response

{
    "status": "SUCCEEDED",
    "id": "d52025c9-8e8f-44c0-994e-9f42f87eebd2",
    "name": "sermantInjector",
    "version": "1.3.1.0",
    "cce_id": "7bc15618-f875-11ee-9505-0255ac100b08",
    "cse_id": "98d033a9-d631-47d7-a63f-0cd8039f7028",
    "job_id": "JOB8d13e3a3-a0cc-404a-955d-efe148e6ab6f",
    "environment_id": "48874c71-4898-442f-87fc-afff135d65d1"
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

The error code format is SVCSTG.00100.[Error_ID], for example, SVCSTG.00100400. For details, see ServiceStage Error Codes.