Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Component/ Obtaining Component Configuration Information
Updated on 2026-04-10 GMT+08:00

Obtaining Component Configuration Information

Function

This API is used to obtain information about the application, environment, and enterprise project to which all components belong.

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:app:listComponent

    list

    -

    -

    servicestage:app:list

    -

URI

GET /v3/{project_id}/cas/components/filterOptions

Table 1 Path parameter

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

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

filter_options

Object

Definition

Component information parameter. See Table 4.

Table 4 Component parameters

Parameter

Type

Description

applications

Array of objects

Definition

Application information. See Table 5.

enterprise_projects

Array of strings

Definition

Enterprise project information, which is the ID list of enterprise projects used by the component.

Range

N/A

environments

Array of objects

Definition

Environment information. See Table 6.

Table 5 Application information

Parameter

Type

Description

id

String

Definition

Application ID.

Range

N/A

label

String

Definition

Application name.

Range

N/A

Table 6 Environment information

Parameter

Type

Description

id

String

Definition

Environment ID.

Range

N/A

label

String

Definition

Environment name.

Range

N/A

Example Request

None

Example Response

{
    "filter_options": {
        "environments": [
            {
                "label": "env-echotest-nodel",
                "id": "82005bc2-35d3-4fe1-87a8-4a1e1686f261"
            }
        ],
        "applications": [
            {
                "label": "wuzhiheng",
                "id": "f190e324-6dd8-4c97-ba21-53deafab7395"
            }
        ],
        "enterprise_projects": [
            "0"
        ]
    }
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

See ServiceStage Error Codes.