查询插件列表 - QueryAdd-onList
功能介绍
此API用于查询环境下的插件列表。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
servicestage:environment:listAddon
list
environment *
-
servicestage:app:list
-
URI
GET /v3/{project_id}/cas/environments/{environment_id}/addons
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户项目ID。获取方法,请参考获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
environment_id | 是 | String | 参数解释: 环境ID。获取方法,请参考获取所有环境 - ObtainAllEnvironments。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求消息
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及 取值范围: application/json;charset=utf8 默认取值: 不涉及 |
X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应消息
参数 | 参数类型 | 描述 |
|---|---|---|
addons | Arrays of objects | 参数解释: 插件列表,请参考表4。 |
参数 | 参数类型 | 描述 |
|---|---|---|
cce_id | String | 参数解释: 插件所绑定的CCE集群ID。 取值范围: 不涉及 |
cse_id | String | 参数解释: 插件所绑定的CSE微服务引擎ID。 取值范围: 不涉及 |
environment_id | String | 参数解释: 插件所在的环境ID。 取值范围: 不涉及 |
id | String | 参数解释: 插件ID 取值范围: 不涉及 |
job_id | String | 参数解释: 插件执行的最后一个任务的ID。 取值范围: 不涉及 |
name | String | 参数解释: 插件名称。 取值范围: sermantInjector:Sermant Injector插件。用于自动挂载Sermant Agent,通过Sermant Agent接入未开启安全认证的ServiceComb引擎。无需修改应用代码即可接入引擎并使用应用注册发现、全链路灰度发布、优雅上下线、标签路由等功能,但是不支持使用微服务治理功能。 |
status | String | 参数解释: 插件状态。 取值范围:
|
version | String | 参数解释: 插件版本。 取值范围: 不涉及 |
请求示例
无
响应示例
{
"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"
}
]
} 状态码
状态码 | 描述 |
|---|---|
200 | 操作成功。 |
400 | 错误的请求。 |
404 | 请求对象不存在 |
500 | 内部错误 |
错误码
请参考ServiceStage错误码。

