Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Add-on Management/ Creating an Add-on
Updated on 2024-10-16 GMT+08:00
View PDF
Share

Creating an Add-on

Function

This API is used to create an add-on.

URI

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

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.

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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

cce_id

Yes

String

ID of the CCE cluster bound to the environment. See Querying an Environment Resource Based on the Environment ID.

cse_id

No

String

ID of the microservice engine bound to the environment. See Querying an Environment Resource Based on the Environment ID.

This parameter is mandatory when name is set to sermantInjector.

name

Yes

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.

Response

Table 4 Response parameters

Parameter

Type

Description

job_id

String

Job ID.

id

String

Add-on ID.

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

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

Parent topic: Add-on Management