插件schema详情(Addon)。
接口说明
获取 Addon 的 Schema 信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /addons/{addonName}/schema HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| addonName |
string |
是 |
Addon 的名称信息 |
cloud-rds-audit-log |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| aliyunLang |
string |
否 |
语言环境,默认为中文 zh | en |
zh |
| environmentType |
string |
否 |
环境类型 CS(容器) | ECS |
CS |
| version |
string |
否 |
组件版本。 |
0.1.1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| fields |
array<object> |
数据表字段列表。 |
|
|
array<object> |
数据表字段信息。 |
||
| conditions |
array<object> |
展示条件列表。 |
|
|
object |
展示条件。 |
||
| action |
string |
字段控制模式。 |
show |
| field |
string |
字段名称 |
store.storageTarget |
| op |
string |
判断条件操作符。 |
== |
| value |
any |
判断目标值。 |
Custom |
| defaultValue |
any |
默认值 |
mysql.default |
| description |
string |
描述 |
MySQL datasource |
| disabled |
boolean |
是否隐藏: true - 隐藏， false - 显示 |
false |
| element |
string |
元素类型。 |
input |
| fieldPath |
string |
字段路径。 |
mysql.host |
| label |
string |
字段展示名称。 |
mysql |
| name |
string |
字段名称。 |
host |
| placeholder |
string |
输入提示。 |
Please enter the metrics collection interval |
| props |
object |
组件其他属性。 |
|
| dataSource |
array<object> |
数据源信息。 |
|
|
object |
数据源信息。 |
||
| label |
string |
标签。 |
tagKey |
| value |
string |
标签 Value。 |
tagValue |
| related |
array |
相关的数据集合。 |
|
|
string |
相关数据。 |
mysql.host |
|
| selectMode |
string |
模式。 |
single |
| type |
string |
字段类型。 |
string |
| validation |
object |
字段校验规则 |
|
| max |
integer |
分数区间最大值（包含） |
2000 |
| maxLength |
integer |
文本控件支持的最大长度。 |
100 |
| message |
string |
详细信息。 |
length limit |
| min |
integer |
最小值。 |
0 |
| minLength |
integer |
最短长度。 |
16 |
| regular |
string |
正则表达式。 |
^(http|https):// |
| required |
boolean |
参数是否必填。 |
false |
| requestId |
string |
请求 ID。 |
E5B1D3D4-BB28-5996-8AD2-*********** |
| type |
string |
Schema 类型。 |
common |
示例
正常返回示例
JSON格式
{
"fields": [
{
"conditions": [
{
"action": "show",
"field": "store.storageTarget",
"op": "==",
"value": "Custom"
}
],
"defaultValue": "mysql.default",
"description": "MySQL datasource",
"disabled": false,
"element": "input",
"fieldPath": "mysql.host",
"label": "mysql",
"name": "host",
"placeholder": "Please enter the metrics collection interval",
"props": {
"dataSource": [
{
"label": "tagKey",
"value": "tagValue"
}
],
"related": [
"mysql.host"
],
"selectMode": "single"
},
"type": "string",
"validation": {
"max": 2000,
"maxLength": 100,
"message": "length limit",
"min": 0,
"minLength": 16,
"regular": "^(http|https)://",
"required": false
}
}
],
"requestId": "E5B1D3D4-BB28-5996-8AD2-***********",
"type": "common"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。