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

Querying Add-on Metadata

Function

This API is used to query the add-on metadata 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:listAddon

    list

    environment *

    -

    servicestage:app:list

    -

URI

GET /v3/{project_id}/cas/environments/{environment_id}/addons-metadata

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

Response

Table 3 Response parameters

Parameter

Type

Description

addons

Arrays of objects

Definition

Add-on version. See Table 4.

Table 4 addons

Parameter

Type

Description

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.

latest_version

String

Definition

Latest add-on version.

Range

N/A

Example Request

None

Example Response

{
    "addons": [
        {
            "name": "sermantInjector",
            "latest_version": "1.3.1.0"
        }
    ]
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

See ServiceStage Error Codes.