文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API(v3版本)/ 组件/ 获取组件相关配置信息 - ObtainComponentConfigurationInformation
更新时间:2026-02-28 GMT+08:00
分享

获取组件相关配置信息 - ObtainComponentConfigurationInformation

功能介绍

此API用于获取所有组件所属的应用信息、环境信息、企业项目信息。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    servicestage:app:listComponent

    list

    -

    -

    servicestage:app:list

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户项目ID。获取方法,请参考获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

不涉及

取值范围:

application/json;charset=utf8

默认取值:

不涉及

X-Auth-Token

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应消息

表3 响应参数

参数

参数类型

描述

filter_options

Object

参数解释:

组件相关信息参数,请参考表4

表4 组件相关参数

参数

参数类型

描述

applications

Array of objects

参数解释:

应用信息,请参考表5

enterprise_projects

Array of strings

参数解释:

企业项目信息,组件使用的企业项目ID列表。

取值范围:

不涉及

environments

Array of objects

参数解释:

环境信息,请参考表6

表5 应用信息

参数

参数类型

描述

id

String

参数解释:

应用ID。

取值范围:

不涉及

label

String

参数解释:

应用名称。

取值范围:

不涉及

表6 环境信息

参数

参数类型

描述

id

String

参数解释:

环境ID。

取值范围:

不涉及

label

String

参数解释:

环境名称。

取值范围:

不涉及

请求示例

响应示例

{
    "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"
        ]
    }
}

状态码

状态码

描述

200

操作成功

400

错误的请求

404

请求对象不存在

500

内部错误

错误码

请参考ServiceStage错误码

相关文档