获取插件详情(Addon)。
接口说明
获取 Addon 详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /addons/{addonName} HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| addonName |
string |
是 |
查询参数 |
security-actiontrail |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| version |
string |
否 |
Addon 版本号 |
* |
| aliyunLang |
string |
否 |
语言环境,默认为中文 zh | en |
zh |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| data |
object |
请求头对应的数据列表 |
|
| alias |
string |
接入组件别名。 |
resume_vector_alias |
| categories |
array |
接入组件分类目录列表。 |
|
|
string |
分类目录名称 |
alibaba-cloud-service |
|
| dashboards |
array<object> |
仪表盘的列表。 |
|
|
object |
仪表盘信息。 |
||
| description |
string |
仪表盘描述。 |
test |
| name |
string |
仪表盘名称。 |
rum_api_dot_metric_set |
| url |
string |
效果图 URL 地址。 |
http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f |
| description |
string |
Addon 描述 |
o11y-demo-cn-heyuan |
| environments |
array<object> |
环境信息。 |
|
|
array<object> |
单个环境信息。 |
||
| enable |
boolean |
是否启用 |
false |
| label |
string |
环境展示名称。 |
容器环境 |
| dependencies |
object |
附加依赖文件。 |
|
| clusterTypes |
array |
对集群类型的依赖。 |
|
|
string |
对集群类型的依赖。 |
ManagedKubernetes/Default |
|
| features |
object |
对探针的依赖。 |
|
|
boolean |
是否依赖目标探针组件 |
true |
|
| services |
array |
对开通服务的依赖 |
|
|
string |
服务名称 |
Prometheus |
|
| description |
string |
描述 |
Observability integration. |
| name |
string |
Addon 名称。 |
cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85 |
| policies |
object |
资源组 ID。 |
|
| alertDefaultStatus |
string |
告警规则默认策略的启用状态。 |
true |
| defaultInstall |
boolean |
是否默认安装 |
true |
| enableServiceAccount |
boolean |
是否分配 Service Account 用以与 Console API 通信。 |
true |
| metricCheckRule |
object |
指标检测规则。 |
|
| promQL |
array |
安装后数据检查规则 |
|
|
string |
安装后数据检查规则 |
up=1 |
|
| needRestartAfterIntegration |
boolean |
是否在插件接入时完成安装后即进入 Pod 重启引导。 |
true |
| protocols |
array<object> |
协议。 |
|
|
object |
协议。 |
||
| description |
string |
协议说明 |
Support OpenTelemetry Protocol |
| icon |
string |
图标地址 |
icon URL |
| label |
string |
协议展示名称。 |
OpenTelemetry |
| name |
string |
协议名称。 |
OpenTelemetry |
| targetAddonName |
string |
跳转的目标 Addon 名称 |
cs-default |
| policyType |
string |
接入策略类型。 |
CS |
| commonSchemaRefs |
array<object> |
关联的 Common Schema 列表 |
|
|
object |
关联的 Common Schema 信息 |
||
| group |
string |
CommonSchema 的分组名称 |
acs-ecs |
| version |
string |
CommonSchema 的版本 |
0.1.3 |
| icon |
string |
图标地址 |
https://xxxxx |
| keywords |
array |
关键词 |
|
|
string |
关键词 |
metrics |
|
| language |
string |
语言。 |
zh |
| latestReleaseCreateTime |
string |
最新一次创建时间。 |
2023-09-12 12:30:30 |
| name |
string |
Addon 名称。 |
rum_api_dashboard_explorer_link_metric_set |
| once |
boolean |
是否只能安装一次。 |
true |
| scene |
string |
组件场景。 |
middleware |
| version |
string |
组件版本。 |
* |
| weight |
string |
权重值。 |
10 |
| requestId |
string |
Id of the request |
0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8 |
示例
正常返回示例
JSON格式
{
"data": {
"alias": "resume_vector_alias",
"categories": [
"alibaba-cloud-service"
],
"dashboards": [
{
"description": "test",
"name": "rum_api_dot_metric_set",
"url": "http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f"
}
],
"description": "o11y-demo-cn-heyuan",
"environments": [
{
"enable": false,
"label": "容器环境",
"dependencies": {
"clusterTypes": [
"ManagedKubernetes/Default"
],
"features": {
"key": true
},
"services": [
"Prometheus"
]
},
"description": "Observability integration.",
"name": "cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85",
"policies": {
"alertDefaultStatus": "true",
"defaultInstall": true,
"enableServiceAccount": true,
"metricCheckRule": {
"promQL": [
"up=1"
]
},
"needRestartAfterIntegration": true,
"protocols": [
{
"description": "Support OpenTelemetry Protocol",
"icon": "icon URL",
"label": "OpenTelemetry",
"name": "OpenTelemetry"
}
],
"targetAddonName": "cs-default"
},
"policyType": "CS",
"commonSchemaRefs": [
{
"group": "acs-ecs",
"version": "0.1.3"
}
]
}
],
"icon": "https://xxxxx",
"keywords": [
"metrics"
],
"language": "zh",
"latestReleaseCreateTime": "2023-09-12 12:30:30",
"name": "rum_api_dashboard_explorer_link_metric_set",
"once": true,
"scene": "middleware",
"version": "*",
"weight": "10"
},
"requestId": "0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。