diff options
Diffstat (limited to 'data/zh_cn/arms/2018-10-15')
| -rw-r--r-- | data/zh_cn/arms/2018-10-15/api-docs.php | 1701 |
1 files changed, 1701 insertions, 0 deletions
diff --git a/data/zh_cn/arms/2018-10-15/api-docs.php b/data/zh_cn/arms/2018-10-15/api-docs.php new file mode 100644 index 0000000..e382ab9 --- /dev/null +++ b/data/zh_cn/arms/2018-10-15/api-docs.php @@ -0,0 +1,1701 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'V3', + 'product' => 'ARMS', + 'version' => '2018-10-15', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'ARMSQueryDataSet', + 'MetricQuery', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'CallChainInfo' => [ + 'title' => 'CallChainInfo', + 'type' => 'object', + 'properties' => [ + 'LogTime' => [ + 'title' => 'logTime', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ResultCode' => [ + 'title' => 'resultCode', + 'type' => 'string', + ], + 'Children' => [ + 'title' => 'children', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/CallChainInfo', + ], + ], + 'RpcId' => [ + 'title' => 'rpcId', + 'type' => 'string', + ], + 'RpcType' => [ + 'title' => 'rpcType', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ServerIp' => [ + 'title' => 'serverIp', + 'type' => 'string', + ], + 'AppName' => [ + 'title' => 'appName', + 'type' => 'string', + ], + 'Rpc' => [ + 'title' => 'rpc', + 'type' => 'string', + ], + 'TraceId' => [ + 'title' => 'traceId', + 'type' => 'string', + ], + 'Span' => [ + 'title' => 'span', + 'type' => 'integer', + 'format' => 'int64', + ], + 'HaveSpan' => [ + 'title' => 'haveSpan', + 'type' => 'boolean', + ], + 'AdditionalInfo' => [ + 'title' => 'additionalInfo', + 'type' => 'string', + ], + 'ParentSpanId' => [ + 'title' => 'parentSpanId', + 'type' => 'string', + ], + 'SpanId' => [ + 'title' => 'spanId', + 'type' => 'string', + ], + 'TagMap' => [ + 'title' => 'tagMap', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'LogMap' => [ + 'title' => 'logMap', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + 'Pid' => [ + 'title' => 'pid', + 'type' => 'string', + ], + 'AppType' => [ + 'title' => 'appType', + 'type' => 'string', + ], + 'RegionId' => [ + 'title' => 'regionId', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspace' => [ + 'title' => 'grafana', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '状态', + 'type' => 'string', + 'example' => 'Starting/Running/Stop/DeleteSucceed', + ], + 'description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'grafanaWorkspaceEdition' => [ + 'title' => '版本', + 'type' => 'string', + 'example' => 'experts_edition/advanced_edition/standard', + ], + 'endTime' => [ + 'title' => '到期时间', + 'type' => 'number', + 'format' => 'float', + 'example' => '1652803200000', + ], + 'grafanaWorkspaceId' => [ + 'title' => '工作区Id', + 'type' => 'string', + 'example' => 'g-thisisademo666', + ], + 'upgradeVersion' => [ + 'title' => '可升级的版本', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'grafanaWorkspaceIp' => [ + 'title' => '公网ip带端口', + 'type' => 'string', + 'example' => '127.0.0.1:3000', + ], + 'snatIp' => [ + 'title' => '出口IP', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'grafanaWorkspaceDomain' => [ + 'title' => '工作区域名', + 'type' => 'string', + ], + 'grafanaWorkspaceDomainStatus' => [ + 'title' => '工作区域名状态', + 'type' => 'string', + 'example' => 'on', + ], + 'commercial' => [ + 'title' => '是否商业化', + 'type' => 'boolean', + ], + 'grafanaWorkspaceName' => [ + 'title' => '工作区名称', + 'type' => 'string', + ], + 'grafanaVersion' => [ + 'title' => '对应的Grafana版本', + 'type' => 'string', + ], + 'gmtCreate' => [ + 'title' => '1642079398000', + 'type' => 'number', + 'format' => 'float', + 'example' => '创建时间', + ], + 'userId' => [ + 'title' => '用户id', + 'type' => 'string', + 'example' => '66666666', + ], + 'maxAccount' => [ + 'title' => '最大账号数量', + 'type' => 'string', + 'example' => '10', + ], + 'regionId' => [ + 'title' => '地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'protocol' => [ + 'title' => '协议', + 'type' => 'string', + 'example' => 'http/https', + ], + 'shareSynced' => [ + 'title' => '是否有过共享版迁移引导', + 'type' => 'boolean', + ], + 'ntmId' => [ + 'title' => '实例id', + 'type' => 'string', + ], + 'personalDomain' => [ + 'title' => '个性化域名', + 'type' => 'string', + ], + 'personalDomainPrefix' => [ + 'title' => '个性化域名前缀', + 'type' => 'string', + ], + 'resourceGroupId' => [ + 'title' => '资源组id', + 'type' => 'string', + ], + 'deployType' => [ + 'title' => '部署模式', + 'type' => 'string', + ], + 'tags' => [ + 'title' => '标签', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '键', + 'type' => 'string', + ], + 'value' => [ + 'title' => '值', + 'type' => 'string', + ], + ], + ], + ], + 'privateIp' => [ + 'title' => '私网ip带端口', + 'type' => 'string', + ], + 'privateDomain' => [ + 'title' => '私网工作区域名', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceAccount' => [ + 'title' => '账号', + 'description' => 'Grafana阿里云账号', + 'type' => 'object', + 'properties' => [ + 'accountId' => [ + 'title' => '账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'aliyunUid' => [ + 'title' => '阿里云UID', + 'type' => 'string', + 'example' => '131243781293', + ], + 'aliyunUserName' => [ + 'title' => '阿里云账号名', + 'type' => 'string', + 'example' => 'test', + ], + 'accountNotes' => [ + 'title' => '备注', + 'type' => 'string', + ], + 'gmtCreate' => [ + 'title' => '1642079398000', + 'type' => 'number', + 'format' => 'float', + 'example' => '创建时间', + ], + 'orgs' => [ + 'title' => '组织权限', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceUserOrg', + ], + ], + ], + ], + 'GrafanaWorkspaceAlertNotification' => [ + 'title' => 'Grafana Notification信息', + 'description' => 'Grafana告警Notification信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => 'ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'name' => [ + 'title' => '名称', + 'type' => 'string', + 'example' => 'test', + ], + 'uid' => [ + 'title' => 'Grafana UID', + 'type' => 'string', + 'example' => 'Xfdf******', + ], + 'type' => [ + 'title' => '类型', + 'type' => 'string', + 'example' => 'Email', + ], + 'isDefault' => [ + 'title' => '是否默认', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isArms' => [ + 'title' => '是否ARMS系统类型', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sendReminder' => [ + 'title' => '发送提醒', + 'type' => 'boolean', + 'example' => 'true', + ], + 'settings' => [ + 'title' => '其他配置', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + 'GrafanaWorkspaceArmsAlertConfig' => [ + 'title' => 'Grafana ARMS 告警配置', + 'description' => 'Grafana ARMS告警信息配置', + 'type' => 'object', + 'properties' => [ + 'armsAlertsEnable' => [ + 'title' => '是否启用', + 'type' => 'string', + 'example' => 'true', + ], + 'armsAlertsWebhookUrl' => [ + 'title' => '告警Webhook地址', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceCustomDomain' => [ + 'title' => 'Grafana工作区自定义域名配置', + 'description' => 'Grafana自定义域名', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'date' => [ + 'title' => '配置创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1688627798017', + ], + 'grafanaWorkspaceId' => [ + 'title' => 'Grafana工作区ID', + 'type' => 'string', + 'example' => 'grafana-cn-***********', + ], + 'status' => [ + 'title' => '状态', + 'type' => 'string', + 'example' => 'CreateSucceed', + 'enum' => [ + 'Creating', + 'CreateFailed', + 'CreateSucceed', + 'Deleting', + 'DeleteFailed', + 'DeleteSucceed', + ], + ], + 'domain' => [ + 'title' => '域名', + 'type' => 'string', + 'example' => 'mydomain.com', + ], + 'uri' => [ + 'title' => '路由配置', + 'type' => 'string', + 'example' => '/', + ], + 'protocol' => [ + 'title' => '网络协议', + 'type' => 'string', + 'example' => 'https', + ], + 'cert' => [ + 'title' => 'PEM 证书内容', + 'type' => 'string', + 'example' => 'protocol为http时无需填写;', + ], + 'key' => [ + 'title' => 'PEM 证书密钥', + 'type' => 'string', + 'example' => 'protocol为http时无需填写;', + ], + 'privateZone' => [ + 'title' => '是否私网域名', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'GrafanaWorkspaceDashboardReport' => [ + 'title' => 'Grafana Dashboard数据报表', + 'description' => 'Grafana Dashboard数据报表', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '备份配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'gmtCreate' => [ + 'title' => '配置创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'lastSendTime' => [ + 'title' => '最近发送时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'grafanaWorkspaceId' => [ + 'title' => 'Grafana工作区ID', + 'type' => 'string', + 'example' => 'grafana-cn-**********', + ], + 'userId' => [ + 'title' => '用户ID', + 'type' => 'string', + ], + 'name' => [ + 'title' => '配置名称', + 'type' => 'string', + ], + 'url' => [ + 'title' => '配置链接地址', + 'type' => 'string', + 'example' => 'Dashboard URL', + ], + 'status' => [ + 'title' => '配置状态', + 'type' => 'string', + ], + 'msg' => [ + 'title' => '配置信息', + 'type' => 'string', + ], + 'reportChannelType' => [ + 'title' => '通知渠道类型', + 'type' => 'string', + 'example' => 'Email', + ], + 'reportChannelTarget' => [ + 'title' => '通知目标', + 'type' => 'string', + 'example' => '******@aliyun.com', + ], + 'reportType' => [ + 'title' => '导出类型', + 'type' => 'string', + 'example' => 'Image', + ], + 'reportStyle' => [ + 'title' => '布局类型', + 'type' => 'string', + 'example' => 'Grid,Simple', + ], + 'triggerType' => [ + 'title' => '发送时间类型', + 'type' => 'string', + 'example' => 'ByWeek', + ], + 'triggerDay' => [ + 'title' => '发送时间 天', + 'type' => 'string', + 'example' => '1', + ], + 'triggerTime' => [ + 'title' => '发送时间 时分', + 'type' => 'string', + 'example' => '12:25', + ], + ], + ], + 'GrafanaWorkspaceDataBackup' => [ + 'title' => 'Grafana数据备份配置', + 'description' => 'Grafana数据备份配置', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '备份配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'gmtCreate' => [ + 'title' => '配置创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'gmtModified' => [ + 'title' => '配置更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'grafanaWorkspaceId' => [ + 'title' => 'Grafana工作区ID', + 'type' => 'string', + 'example' => 'grafana-cn-**********', + ], + 'userId' => [ + 'title' => '用户ID', + 'type' => 'string', + ], + 'processName' => [ + 'title' => '配置名称', + 'type' => 'string', + ], + 'subType' => [ + 'title' => '配置类型', + 'type' => 'string', + 'example' => 'User', + 'enum' => [ + 'System', + 'User', + 'Restore', + ], + ], + 'processStatus' => [ + 'title' => '配置状态', + 'type' => 'string', + ], + 'msg' => [ + 'title' => '配置信息', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceIniBackup' => [ + 'title' => 'Grafana配置参数备份配置', + 'description' => 'Grafana参数备份配置', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '备份配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'gmtCreate' => [ + 'title' => '配置创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'gmtModified' => [ + 'title' => '配置更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'grafanaWorkspaceId' => [ + 'title' => 'Grafana工作区ID', + 'type' => 'string', + 'example' => 'grafana-cn-**********', + ], + 'userId' => [ + 'title' => '用户ID', + 'type' => 'string', + ], + 'processName' => [ + 'title' => '配置名称', + 'type' => 'string', + ], + 'subType' => [ + 'title' => '配置类型', + 'type' => 'string', + 'example' => 'User', + 'enum' => [ + 'System', + 'User', + 'Restore', + ], + ], + 'processStatus' => [ + 'title' => '配置状态', + 'type' => 'string', + ], + 'msg' => [ + 'title' => '配置信息', + 'type' => 'string', + ], + 'ext' => [ + 'title' => '扩展信息', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceIniProperty' => [ + 'title' => 'GrafanaIni配置参数属性', + 'description' => 'Grafana工作区参数属性', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '参数名称', + 'type' => 'string', + ], + 'value' => [ + 'title' => '参数值', + 'type' => 'string', + ], + 'defaultValue' => [ + 'title' => '参数默认值', + 'type' => 'string', + ], + 'description' => [ + 'title' => '参数描述', + 'type' => 'string', + ], + 'example' => [ + 'title' => '参数值示例', + 'type' => 'string', + ], + 'secret' => [ + 'title' => '是否加密字段', + 'type' => 'boolean', + ], + ], + ], + 'GrafanaWorkspaceIniSection' => [ + 'title' => 'GrafanaIni参数对象', + 'description' => 'Grafana工作区参数对象', + 'type' => 'object', + 'properties' => [ + 'section' => [ + 'title' => '参数区块名称', + 'type' => 'string', + ], + 'propertys' => [ + 'title' => '参数属性列表', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceIniProperty', + ], + ], + ], + ], + 'GrafanaWorkspaceIntegration' => [ + 'title' => '集成信息', + 'description' => 'Grafana集成项', + 'type' => 'object', + 'properties' => [ + 'integrationName' => [ + 'title' => '集成名称', + 'type' => 'string', + ], + 'integrationId' => [ + 'title' => '集成配置Id', + 'type' => 'string', + ], + 'status' => [ + 'title' => '集成状态', + 'type' => 'string', + ], + 'datasourceAmount' => [ + 'title' => '已集成的数据源数量', + 'type' => 'integer', + 'format' => 'int64', + ], + 'supportRegions' => [ + 'title' => '支持的region列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'previews' => [ + 'title' => '预览信息', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceIntegrationPreview', + ], + ], + ], + ], + 'GrafanaWorkspaceIntegrationDataSource' => [ + 'title' => '集成的数据源信息', + 'description' => 'Grafana集成的数据源', + 'type' => 'object', + 'properties' => [ + 'datasourceId' => [ + 'title' => '数据源id', + 'type' => 'string', + ], + 'datasourceName' => [ + 'title' => '数据源名称', + 'type' => 'string', + ], + 'clusterType' => [ + 'title' => '集群类型', + 'type' => 'string', + ], + 'regionId' => [ + 'title' => 'regionId', + 'type' => 'string', + ], + 'type' => [ + 'title' => '数据源类型', + 'type' => 'string', + ], + 'status' => [ + 'title' => '集成状态', + 'type' => 'string', + ], + 'datasourceUrl' => [ + 'title' => '数据源地址', + 'type' => 'string', + ], + 'folderUrl' => [ + 'title' => 'Grafana文件夹地址', + 'type' => 'string', + ], + 'exploreUrl' => [ + 'title' => 'Grafana浏览地址', + 'type' => 'string', + ], + 'description' => [ + 'title' => '数据源描述', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceIntegrationDetail' => [ + 'title' => '具体集成项信息', + 'description' => 'Grafana集成明细', + 'type' => 'object', + 'properties' => [ + 'integrationId' => [ + 'title' => '集成配置key', + 'type' => 'string', + ], + 'status' => [ + 'title' => '集成状态', + 'type' => 'string', + ], + 'dataSources' => [ + 'title' => '集成的数据源', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceIntegrationDataSource', + ], + ], + ], + ], + 'GrafanaWorkspaceIntegrationPreview' => [ + 'title' => '集成预览信息', + 'description' => 'Grafana集成项预览', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '预览大盘id', + 'type' => 'string', + ], + 'name' => [ + 'title' => '预览名称', + 'type' => 'string', + ], + 'thumbnail' => [ + 'title' => '缩略图地址', + 'type' => 'string', + ], + 'image' => [ + 'title' => '原图地址', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceNews' => [ + 'title' => 'Grafana News', + 'description' => 'Grafana工作区快报信息', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'title' => 'News Title', + 'type' => 'string', + ], + 'image' => [ + 'title' => 'News Image URL', + 'type' => 'string', + ], + 'link' => [ + 'title' => 'News Detail Link', + 'type' => 'string', + ], + 'date' => [ + 'title' => 'News Date', + 'type' => 'integer', + 'format' => 'int64', + ], + 'description' => [ + 'title' => 'News Description', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceOperateLog' => [ + 'title' => '操作日志', + 'description' => 'Grafana工作区操作日志', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '日志id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'date' => [ + 'title' => '操作时间', + 'type' => 'number', + 'format' => 'float', + ], + 'grafanaWorkspaceId' => [ + 'title' => '工作区ID', + 'type' => 'string', + ], + 'detail' => [ + 'title' => '操作明细', + 'type' => 'string', + ], + 'operatorId' => [ + 'title' => '操作人用户ID', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceOrg' => [ + 'title' => 'org', + 'description' => 'Grafana组织', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '组织id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'name' => [ + 'title' => '组织名称', + 'type' => 'string', + 'example' => 'main org', + ], + ], + ], + 'GrafanaWorkspaceTrans' => [ + 'title' => '数据迁移记录', + 'description' => 'Grafana数据迁移记录', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录主键id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'type' => 'number', + 'format' => 'float', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'type' => 'number', + 'format' => 'float', + ], + 'grafanaWorkspaceId' => [ + 'title' => '工作区ID', + 'type' => 'string', + ], + 'userId' => [ + 'title' => '用户id', + 'type' => 'string', + ], + 'authType' => [ + 'title' => '授权方式', + 'type' => 'string', + ], + 'processStatus' => [ + 'title' => '迁移状态', + 'type' => 'string', + ], + 'msg' => [ + 'title' => '迁移信息', + 'type' => 'string', + ], + 'apiUrl' => [ + 'title' => '迁移侧Grafana地址', + 'type' => 'string', + ], + 'transDetails' => [ + 'title' => '迁移明细', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceTransDetail', + ], + ], + ], + ], + 'GrafanaWorkspaceTransDetail' => [ + 'title' => '迁移明细', + 'description' => 'Grafana数据迁移明细', + 'type' => 'object', + 'properties' => [ + 'original' => [ + 'title' => '迁移侧grafana的组织id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'originalName' => [ + 'title' => '迁移侧grafana的组织名称', + 'type' => 'string', + ], + 'target' => [ + 'title' => '目标侧grafana的组织id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'targetName' => [ + 'title' => '目标侧grafana的组织名称', + 'type' => 'string', + ], + 'dataSourceAmount' => [ + 'title' => '处理的数据源数量', + 'type' => 'integer', + 'format' => 'int32', + ], + 'dashboardAmount' => [ + 'title' => '处理的大盘数量', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'GrafanaWorkspaceUserCert' => [ + 'title' => '用户阿里云SSL证书', + 'description' => '用户阿里云证书', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '证书ID', + 'type' => 'string', + 'example' => '8096753', + ], + 'name' => [ + 'title' => '证书名称', + 'type' => 'string', + 'example' => 'cert-7700050 [grafana.tongtong-max.cn]', + ], + ], + ], + 'GrafanaWorkspaceUserOrg' => [ + 'title' => '用户组织关系', + 'description' => 'Grafana用户组织关系', + 'type' => 'object', + 'properties' => [ + 'orgId' => [ + 'title' => '组织id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'orgName' => [ + 'title' => '组织名称', + 'type' => 'string', + 'example' => 'main org', + ], + 'role' => [ + 'title' => '角色', + 'type' => 'string', + 'example' => 'admin', + ], + ], + ], + 'GrafanaWorkspaceVpcConfig' => [ + 'title' => 'VPC Config', + 'description' => 'Grafana工作区VPC数据通道配置', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'name' => [ + 'title' => '配置名称', + 'type' => 'string', + 'example' => '北京VPC-A通道', + ], + 'installStatus' => [ + 'title' => '配置状态', + 'type' => 'string', + 'example' => 'CreateSucceed', + 'enum' => [ + 'Creating', + 'CreateSucceed', + 'CreateFailed', + 'Deleting', + 'DeleteSucceed', + 'DeleteFailed', + ], + ], + 'userId' => [ + 'title' => '用户ID', + 'type' => 'string', + 'example' => '10983***********', + ], + 'securityGroupId' => [ + 'title' => '安全组ID', + 'type' => 'string', + 'example' => 'sg-6we94uvybteyc******', + ], + 'vpcId' => [ + 'title' => 'VPC ID', + 'type' => 'string', + 'example' => 'vpc-6wehr2x**********', + ], + 'vSwitchId' => [ + 'title' => '交换机ID', + 'type' => 'string', + 'example' => 'vsw-6we3**********', + ], + 'fcConfig' => [ + 'title' => '通道类型', + 'type' => 'string', + 'example' => 'fc、ansm', + ], + 'regionId' => [ + 'title' => '地域', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'installMsg' => [ + 'title' => '安装信息', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceVpcRegion' => [ + 'title' => 'Grafana VPC 地域信息', + 'description' => 'Grafana工作区VPC数据通道地域信息', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '地域ID', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'regionName' => [ + 'title' => '地域名称', + 'type' => 'string', + 'example' => '华北2(北京)', + ], + ], + ], + 'GrafanaWorkspaceVpcRegionDetail' => [ + 'title' => 'Grafana 未安装通道VPC地域详情', + 'description' => 'Grafana工作区VPC数据通道地域信息详情', + 'type' => 'object', + 'properties' => [ + 'vpcId' => [ + 'title' => 'VPC ID', + 'type' => 'string', + 'example' => 'vpc-2ze4siu98**********', + ], + 'name' => [ + 'title' => 'VPC名称', + 'type' => 'string', + 'example' => 'vpc-abc*****', + ], + 'regionId' => [ + 'title' => 'VPC所在地域', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'userId' => [ + 'title' => 'VPC所属用户ID', + 'type' => 'string', + 'example' => '10988**********', + ], + 'installStatus' => [ + 'title' => '安装状态', + 'type' => 'string', + 'example' => 'Uninitialized', + 'enum' => [ + 'Uninitialized', + 'DeleteSucceed', + 'DeleteFailed', + ], + ], + 'securityGroupIds' => [ + 'title' => 'VPC 安全组列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'sg-*********', + ], + ], + 'vSwitchIds' => [ + 'title' => 'VPC 交换机列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'vsw-**********', + ], + ], + 'id' => [ + 'title' => 'ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '配置ID', + ], + 'fcConfig' => [ + 'title' => '网络类型', + 'type' => 'string', + 'example' => 'fc、ansm', + ], + 'securityGroupId' => [ + 'title' => '上次选择安全组ID', + 'type' => 'string', + ], + 'vSwitchId' => [ + 'title' => '上次选择交换机ID', + 'type' => 'string', + ], + ], + ], + ], + ], + 'apis' => [ + 'ARMSQueryDataSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IntervalInSec', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + ], + ], + [ + 'name' => 'DateStr', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MinTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'MaxTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'IsDrillDown', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'OrderByKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'ReduceTail', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'HungryMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'required' => false, + ], + 'Type' => [ + 'type' => 'string', + 'required' => false, + ], + 'Value' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Measures', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'RequiredDims', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'required' => false, + ], + 'Type' => [ + 'type' => 'string', + 'required' => false, + ], + 'Value' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'OptionalDims', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'required' => false, + ], + 'Type' => [ + 'type' => 'string', + 'required' => false, + ], + 'Value' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'HackerUserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '必选参数不能为空', + ], + ], + ], + 'responseDemo' => '', + ], + 'MetricQuery' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IintervalInSec', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'required' => false, + ], + 'Value' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Measures', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'HackerUserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '必选参数不能为空', + ], + ], + ], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'arms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'arms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'arms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'arms.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'arms.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'arms.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'arms.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'arms.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'arms.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'arms.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'arms.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'arms.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'arms.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'arms.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'arms.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'arms.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'arms.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'arms.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'arms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'arms.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'arms.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'arms.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'arms.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'arms.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'arms.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'arms.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'arms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'arms.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'arms.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'arms.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'arms.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'arms.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'arms.cn-heyuan-acdr-1.aliyuncs.com', + ], + ], +]; |
