Querying the Add-on List
Function
This API is used to query the add-on list in an environment.
URI
GET /v3/{project_id}/cas/environments/{environment_id}/addons
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant's project ID. See Obtaining a Project ID. |
environment_id |
Yes |
String |
Environment ID, which is the ID in the response parameter of the API for Creating an Environment. |
Request
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
Parameter |
Type |
Description |
---|---|---|
addons |
Arrays of objects |
Add-on list. See Table 4. |
Parameter |
Type |
Description |
---|---|---|
cce_id |
String |
ID of the CCE cluster bound to the add-on. |
cse_id |
String |
ID of the microservice engine bound to the add-on. |
environment_id |
String |
ID of the add-on environment. |
id |
String |
Add-on ID. |
job_id |
String |
ID of the last job executed by the add-on. |
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. |
status |
String |
Add-on status.
|
version |
String |
Add-on version. |
Example Request
None
Example Response
{ "addons": [ { "status": "FAILED", "id": "a2cdf0e2-8495-4db5-82f7-a23b97b57787", "name": "sermantInjector", "version": "1.3.1.0", "cce_id": "02f9a523-cefe-11ee-afc1-0255ac100045", "cse_id": "b4e49ad5-5142-437d-8a6b-1de66b1af0db", "job_id": "JOB195d62a9-6446-4ac4-a42e-034a48d6a10b", "environment_id": "7e2af5b5-4223-40b7-b89b-ee9059827248" } ] }
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot