更新时间:2024-11-22 GMT+08:00
分享

获取组件相关配置信息

功能介绍

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

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获取方式,请参考获取用户Token

响应消息

表3 响应参数

参数

参数类型

描述

filter_options

Array of objects

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

表4 组件相关参数

参数

参数类型

描述

applications

Array of objects

应用信息,请参考表5

enterprise_projects

Array of String

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

environments

Array of objects

环境信息,请参考表6

表5 应用信息

参数

参数类型

描述

id

String

应用ID。

lebel

String

应用名称。

表6 环境信息

参数

参数类型

描述

id

String

环境ID。

lebel

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

内部错误

错误码

错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考ServiceStage错误码

相关文档