获取当前策略安装的Addon列表。
接口说明
获取当前策略安装的 Addon 列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /integration-policies/{policyId}/addons HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| policyId |
string |
是 |
环境 id |
policy-3563e6bf338141b3b92c118e2c318c37 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
当前API无需请求参数
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| addons |
array<object> |
Addon 列表。 |
|
|
array<object> |
Addon 信息。 |
||
| alias |
string |
展示名。 |
MySQL |
| categories |
array |
类别。 |
|
|
string |
类别。 |
database |
|
| dashboards |
array<object> |
仪表盘的列表。 |
|
|
object |
仪表盘。 |
||
| description |
string |
描述 |
用于mysql的监控大盘 |
| name |
string |
名称。 |
MySQL Overview |
| url |
string |
大盘地址。 |
http://xxxxxxx |
| description |
string |
描述。 |
Observability integration. |
| environments |
array<object> |
支持的环境列表。 |
|
|
array<object> |
环境信息。 |
||
| dependencies |
object |
依赖。 |
|
| clusterTypes |
array |
对集群类型的依赖。 |
|
|
string |
集群类型。 |
ACK |
|
| features |
object |
对探针的依赖。 |
|
|
boolean |
metric-agent |
true |
|
| services |
array |
对产品 Code 的依赖。 |
|
|
string |
服务名称 |
Prometheus |
|
| description |
string |
描述。 |
o11y-demo-cn-heyuan |
| enable |
boolean |
是否启用 |
true |
| label |
string |
环境展示名称。 |
Cloud |
| name |
string |
环境名称。 |
Cloud |
| policies |
object |
策略。 |
|
| alertDefaultStatus |
string |
告警规则默认策略的启用状态。 |
RUNNING |
| defaultInstall |
boolean |
是否默认安装 |
true |
| enableServiceAccount |
boolean |
是否分配 Service Account 用以与 Console API 通信。 |
true |
| metricCheckRule |
object |
指标检测规则。 |
|
| promQl |
array |
Prom 查询语句。 |
|
|
string |
Prom 查询语句 |
up{job="mysql"} > 0 |
|
| needRestartAfterIntegration |
boolean |
是否在插件接入时完成安装后即进入 Pod 重启引导。 |
true |
| protocols |
array<object> |
协议。 |
|
|
object |
协议。 |
||
| description |
string |
描述 |
test |
| icon |
string |
图标 |
https://img.alixxxx |
| label |
string |
展示名称。 |
Golang |
| name |
string |
协议名称。 |
golang |
| targetAddonName |
string |
目标 Addon 名称。 |
mysql |
| icon |
string |
组件图标。 |
asert/mysql.svg |
| keywords |
array |
关键词 |
|
|
string |
关键词 |
container |
|
| language |
string |
语言。 |
zh |
| latestReleaseCreateTime |
string |
最新一次创建时间。 |
2025-09-03T03:15:56Z |
| name |
string |
Addon 名称。 |
mysql |
| once |
boolean |
是否只能安装一次。 |
true |
| scene |
string |
组件场景。 |
container |
| version |
string |
组件版本。 |
0.1.1 |
| weight |
integer |
权重。 |
99 |
| requestId |
string |
Id of the request |
7E00EF90-CEF9-57C9-9AE9-5AA937D37C03 |
| total |
integer |
总条数。 |
5 |
示例
正常返回示例
JSON格式
{
"addons": [
{
"alias": "MySQL",
"categories": [
"database"
],
"dashboards": [
{
"description": "用于mysql的监控大盘",
"name": "MySQL Overview",
"url": "http://xxxxxxx"
}
],
"description": "Observability integration.",
"environments": [
{
"dependencies": {
"clusterTypes": [
"ACK"
],
"features": {
"key": true
},
"services": [
"Prometheus"
]
},
"description": "o11y-demo-cn-heyuan",
"enable": true,
"label": "Cloud",
"name": "Cloud",
"policies": {
"alertDefaultStatus": "RUNNING",
"defaultInstall": true,
"enableServiceAccount": true,
"metricCheckRule": {
"promQl": [
"up{job=\"mysql\"} > 0"
]
},
"needRestartAfterIntegration": true,
"protocols": [
{
"description": "test",
"icon": " https://img.alixxxx",
"label": "Golang",
"name": "golang"
}
],
"targetAddonName": "mysql"
}
}
],
"icon": "asert/mysql.svg",
"keywords": [
"container"
],
"language": "zh",
"latestReleaseCreateTime": "2025-09-03T03:15:56Z",
"name": "mysql",
"once": true,
"scene": "container",
"version": "0.1.1",
"weight": 99
}
],
"requestId": "7E00EF90-CEF9-57C9-9AE9-5AA937D37C03",
"total": 5
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。