查询指定环境安装的Addon信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| EnvironmentId |
string |
是 |
环境 ID。 |
env-xxx |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
response |
||
| RequestId |
string |
Id of the request |
32940175-181B-4B93-966E-4BB69176**** |
| Code |
integer |
状态码。 |
200 |
| Message |
string |
返回结果的提示信息。 |
message |
| Success |
boolean |
操作是否成功：true：操作成功 false：操作失败。 |
true |
| Data |
object |
返回结果。 |
|
| Addons |
array<object> |
Addon 列表。 |
|
|
array<object> |
Addon 信息。 |
||
| Alias |
string |
Addon 别名。 |
MySQL |
| Categories |
array |
Addon 标签列表。 |
|
|
string |
标签。 |
cloud |
|
| Dashboards |
array<object> |
大盘列表。 |
|
|
object |
大盘信息。 |
||
| Description |
string |
大盘描述。 |
MySQL监控大盘信息,监控了连接信息,使用信息等指标 |
| Name |
string |
大盘名称。 |
mysql-overview |
| Url |
string |
大盘地址。 |
http://xxxx |
| Description |
string |
Addon 描述信息。 |
通过 MySQL Exporter 监控数据库指标 |
| Environments |
array<object> |
支持的环境列表。 |
|
|
array<object> |
环境信息。 |
||
| Dependencies |
object |
环境的依赖列表。 |
|
| Features |
object |
环境可安装的 Feature。 |
|
|
boolean |
是否支持。 |
true |
|
| Services |
array |
服务列表。 |
|
|
string |
服务名称。 |
ResourceCenter |
|
| ClusterTypes |
array |
集群类型。 |
|
|
string |
集群类型。 |
Edge |
|
| Description |
string |
环境描述信息。 |
MySQL 服务部署在 Kubernetes 集群中。 |
| Enable |
boolean |
是否开启。 |
true |
| Label |
string |
环境标签。 |
容器环境 |
| Name |
string |
环境名称。 |
CS |
| Policies |
object |
环境中的控制策略信息。 |
|
| AlertDefaultStatus |
string |
默认告警状态。 |
default |
| DefaultInstall |
boolean |
默认安装状态。 |
false |
| TargetAddonName |
string |
Addon 的 Target 名称。 |
cloud-rds-mysql |
| Protocols |
array<object> |
支持的协议列表。 |
|
|
object |
协议。 |
||
| Name |
string |
协议名称。 |
arms |
| Icon |
string |
协议图标地址。 |
http://xxxxxxx |
| Label |
string |
协议标签。 |
ARMS |
| Description |
string |
协议描述。 |
ARMS |
| MetricCheckRule |
object |
指标正常检查的规则。 |
|
| PromQL |
array |
PromQL 查询语句。 |
|
|
string |
PromQL 查询语句。 |
max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId='983d8f2d-14a9-4af0-a23d-751a7818c239'}/1000) >= 600.0 |
|
| NeedRestartAfterIntegration |
boolean |
安装后是否需要重启。 |
true |
| EnableServiceAccount |
boolean |
是否开启服务账户。 |
true |
| Icon |
string |
图标地址。 |
http://xxxx |
| Keywords |
array |
关键字集合。 |
|
|
string |
关键字。 |
Java |
|
| Language |
string |
语言。 |
zh |
| Name |
string |
Addon 名称。 |
mysql |
| Once |
boolean |
是否只能安装一次。 |
false |
| Scene |
string |
定位到的场景。 |
database |
| Version |
string |
插件版本。 |
0.0.1 |
| Weight |
string |
权重。 |
857 |
| LatestReleaseCreateTime |
string |
最后一次被创建时间。 |
2023-09-22T16:56:29+08:00 |
| Total |
integer |
总条数。 |
1 |
| ContainsV2Addon |
boolean |
示例
正常返回示例
JSON格式
{
"RequestId": "32940175-181B-4B93-966E-4BB69176****",
"Code": 200,
"Message": "message",
"Success": true,
"Data": {
"Addons": [
{
"Alias": "MySQL",
"Categories": [
"cloud"
],
"Dashboards": [
{
"Description": "MySQL监控大盘信息,监控了连接信息,使用信息等指标",
"Name": "mysql-overview",
"Url": "http://xxxx"
}
],
"Description": "通过 MySQL Exporter 监控数据库指标",
"Environments": [
{
"Dependencies": {
"Features": {
"key": true
},
"Services": [
"ResourceCenter"
],
"ClusterTypes": [
"Edge"
]
},
"Description": "MySQL 服务部署在 Kubernetes 集群中。",
"Enable": true,
"Label": "容器环境",
"Name": "CS",
"Policies": {
"AlertDefaultStatus": "default",
"DefaultInstall": false,
"TargetAddonName": "cloud-rds-mysql",
"Protocols": [
{
"Name": "arms",
"Icon": "http://xxxxxxx",
"Label": "ARMS",
"Description": "ARMS"
}
],
"MetricCheckRule": {
"PromQL": [
"max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId='983d8f2d-14a9-4af0-a23d-751a7818c239'}/1000) >= 600.0"
]
},
"NeedRestartAfterIntegration": true,
"EnableServiceAccount": true
}
}
],
"Icon": "http://xxxx",
"Keywords": [
"Java"
],
"Language": "zh",
"Name": "mysql",
"Once": false,
"Scene": "database",
"Version": "0.0.1",
"Weight": "857",
"LatestReleaseCreateTime": "2023-09-22T16:56:29+08:00"
}
],
"Total": 1,
"ContainsV2Addon": true
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。