新版接入中心产品列表(分组)。
接口说明
用于创建一个站点监控任务
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /addons HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| aliyunLang |
string |
否 |
语言环境:zh / en 默认为中文 zh |
zh |
| category |
string |
否 |
标签筛选 |
database |
| search |
string |
否 |
支持 Addon 名称、描述、关键词查询 |
105095 |
| regexp |
boolean |
否 |
查询字段, 是否正则匹配, 默认为 false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| addons |
array<object> |
可用接入组件列表。 |
|
|
array<object> |
接入组件详情。 |
||
| alias |
string |
接入组件别名。 |
resume_vector_alias |
| categories |
array |
接入组件标签列表。 |
|
|
string |
标签。 |
middleware |
|
| dashboards |
array<object> |
仪表盘的列表。 |
|
|
object |
仪表盘信息。 |
||
| description |
string |
仪表盘描述。 |
test |
| name |
string |
仪表盘名称。 |
rum_view_link_rum_api |
| url |
string |
仪表盘效果图地址。 |
http://xxxxxxx |
| description |
string |
描述 |
workspace api monitor test |
| environments |
array<object> |
支持的接入策略类型列表。 |
|
|
array<object> |
接入策略类型信息 |
||
| dependencies |
object |
接入组件的依赖列表。 |
|
| clusterTypes |
array |
支持的集群类型。 |
|
|
string |
集群类型。 |
ManagedKubernetes/Default |
|
| features |
object |
接入依赖的探针。 |
|
|
boolean |
是否支持。 |
true |
|
| services |
array |
依赖的服务列表 |
|
|
string |
服务名称 |
Prometheus |
|
| description |
string |
接入策略类型描述信息 |
o11y-demo-cn-heyuan |
| enable |
boolean |
是否启用 |
false |
| label |
string |
接入策略类型标签。 |
容器环境 |
| name |
string |
接入策略类型名称。 |
CS |
| policies |
object |
接入策略配置。 |
|
| alertDefaultStatus |
string |
告警规则默认策略的启用状态。 |
RUNNING |
| defaultInstall |
boolean |
是否默认安装 |
true |
| enableServiceAccount |
boolean |
是否分配 Service Account 用以与 Console API 通信。 |
true |
| metricCheckRule |
object |
指标检测规则。 |
|
| promQL |
array |
PromQL 查询语句列表。 |
|
|
string |
PromQL 查询语句。 |
scraper_up{scraper=\"ecs\"}==1 |
|
| needRestartAfterIntegration |
boolean |
是否在插件接入时完成安装后即进入 Pod 重启引导。 |
true |
| protocols |
array<object> |
配置支持的协议类型。 |
|
|
object |
配置支持的协议类型详情。 |
||
| description |
string |
协议描述。 |
Support OpenTelemetry Protocal |
| icon |
string |
图标 URL。 |
http://xxxxxxx |
| label |
string |
协议展示名称。 |
OpenTelemetry |
| name |
string |
协议名称。 |
openTelemetry |
| targetAddonName |
string |
目标 Addon 名称。 |
cloud-acs-ecs |
| policyType |
string |
接入中心策略类型 |
CS |
| commonSchemaRefs |
array<object> |
关联的 Common Schema 列表 |
|
|
object |
关联的 Common Schema 信息 |
||
| group |
string |
Common Schema 的分组名称 |
acs-ecs |
| version |
string |
Common Schema 的版本 |
0.1.4 |
| icon |
string |
图标 URL 地址 |
http://xxxxxxx |
| keywords |
array |
关键词列表 |
|
|
string |
关键词 |
Container |
|
| language |
string |
语言。 |
zh |
| latestReleaseCreateTime |
string |
最新一次创建时间。 |
2025-09-03T03:15:56Z |
| name |
string |
接入组件名称。 |
rum_api_dashboard_explorer_link_metric_set |
| once |
boolean |
是否只能安装一次。 |
true |
| scene |
string |
组件场景。 |
middleware |
| version |
string |
组件版本。 |
* |
| weight |
string |
接入组件展示权重。 |
99 |
| requestId |
string |
Id of the request |
8FDE2569-626B-5176-9844-28877A***** |
示例
正常返回示例
JSON格式
{
"addons": [
{
"alias": "resume_vector_alias",
"categories": [
"middleware"
],
"dashboards": [
{
"description": "test",
"name": "rum_view_link_rum_api",
"url": "http://xxxxxxx"
}
],
"description": "workspace api monitor test",
"environments": [
{
"dependencies": {
"clusterTypes": [
"ManagedKubernetes/Default"
],
"features": {
"key": true
},
"services": [
"Prometheus"
]
},
"description": "o11y-demo-cn-heyuan",
"enable": false,
"label": "容器环境",
"name": "CS",
"policies": {
"alertDefaultStatus": "RUNNING",
"defaultInstall": true,
"enableServiceAccount": true,
"metricCheckRule": {
"promQL": [
"scraper_up{scraper=\\\"ecs\\\"}==1"
]
},
"needRestartAfterIntegration": true,
"protocols": [
{
"description": "Support OpenTelemetry Protocal",
"icon": "http://xxxxxxx",
"label": "OpenTelemetry",
"name": "openTelemetry"
}
],
"targetAddonName": "cloud-acs-ecs"
},
"policyType": "CS",
"commonSchemaRefs": [
{
"group": "acs-ecs",
"version": "0.1.4"
}
]
}
],
"icon": "http://xxxxxxx",
"keywords": [
"Container"
],
"language": "zh",
"latestReleaseCreateTime": "2025-09-03T03:15:56Z",
"name": "rum_api_dashboard_explorer_link_metric_set",
"once": true,
"scene": "middleware",
"version": "*",
"weight": "99"
}
],
"requestId": "8FDE2569-626B-5176-9844-28877A*****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。