Updated on 2026-04-10 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.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the permission listed below is required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

servicestage:environment:getAddon

read

environment *

-

servicestage:app:get

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:environment:getAddon	read	environment *	-	servicestage:app:get	-

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Tenant's project ID. See Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
environment_id	Yes	String	Definition Environment ID. See Obtaining All Environments. Constraints N/A Range N/A Default Value N/A
addon_id	Yes	String	Definition Add-on ID. See Querying the Add-on List. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition Message body type (or format). Constraints N/A Range application/json;charset=utf8 Default Value N/A
X-Auth-Token	Yes	String	Definition 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. Constraints N/A Range N/A Default Value N/A

Response

**Table 3** Response parameters
Parameter	Type	Description
id	String	Definition Add-on ID. Range N/A
name	String	Definition Add-on name. Range 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	Definition Add-on version. Range N/A
cce_id	String	Definition ID of the CCE cluster where the add-on is installed. Range N/A
cse_id	String	Definition ID of the microservice engine bound for add-on installation. Range N/A
job_id	String	Definition ID of the job executed by the add-on. Range N/A
environment_id	String	Definition ID of the add-on environment. Range N/A
status	String	Definition Add-on status. Range 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

See ServiceStage Error Codes.

Parent topic: Add-on Management