Updated on 2026-04-10 GMT+08:00

Creating an Add-on

Function

This API is used to create an add-on.

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:createAddon

write

environment *

-

servicestage:app:create

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:environment:createAddon	write	environment *	-	servicestage:app:create	-

URI

POST /v3/{project_id}/cas/environments/{environment_id}/addons

**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

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
cce_id	Yes	String	Definition ID of the CCE cluster bound to the environment. See Querying a Managed Resource Based on the Environment ID. Range N/A Default Value N/A
cse_id	No	String	Definition ID of the microservice engine bound to the environment. See Querying a Managed Resource Based on the Environment ID. Constraints This parameter is mandatory when name is set to sermantInjector. Range N/A Default Value N/A
name	Yes	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. Default Value N/A

Response

**Table 4** Response parameters
Parameter	Type	Description
job_id	String	Definition Task ID. Default Value N/A
id	String	Definition Add-on ID. Default Value N/A

Example Request

Create a Sermant Injector add-on and manage the microservice engine whose ID is b4e49ad5-5142-437d-8a6b-1de66b1af0db and the CCE cluster whose ID is 02f9a523-cefe-11ee-afc1-0255ac100045 for the add-on.

{
    "name": "sermantInjector",
    "cse_id": "b4e49ad5-5142-437d-8a6b-1de66b1af0db",
    "cce_id": "02f9a523-cefe-11ee-afc1-0255ac100045"
}

Example Response

{
    "job_id": "JOB7c165545-a415-4cc6-9b11-d7045aa24440",
    "id": "a2cdf0e2-8495-4db5-82f7-a23b97b57787"
}

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