From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/adb/2019-03-15/api-docs.php | 25278 +++++++++++++++++ data/zh_cn/adb/2021-12-01/api-docs.php | 45804 +++++++++++++++++++++++++++++++ 2 files changed, 71082 insertions(+) create mode 100644 data/zh_cn/adb/2019-03-15/api-docs.php create mode 100644 data/zh_cn/adb/2021-12-01/api-docs.php (limited to 'data/zh_cn/adb') diff --git a/data/zh_cn/adb/2019-03-15/api-docs.php b/data/zh_cn/adb/2019-03-15/api-docs.php new file mode 100644 index 0000000..bd3ebea --- /dev/null +++ b/data/zh_cn/adb/2019-03-15/api-docs.php @@ -0,0 +1,25278 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'adb', + 'version' => '2019-03-15', + ], + 'directories' => [ + [ + 'id' => 74180, + 'title' => '集群管理', + 'type' => 'directory', + 'children' => [ + 'CreateDBCluster', + 'DeleteDBCluster', + 'ModifyDBCluster', + 'ModifyDBClusterMaintainTime', + 'ModifyDBClusterPayType', + 'ModifyAutoRenewAttribute', + 'ModifyDBClusterDescription', + 'ModifyDBClusterResourceGroup', + 'DescribeDBClusters', + 'DescribeDBClusterStatus', + 'DescribeDBClusterAttribute', + 'DescribeAutoRenewAttribute', + 'DescribeAvailableResource', + 'DescribeComputeResource', + 'DescribeEIURange', + 'AttachUserENI', + 'DetachUserENI', + 'DescribeKernelVersion', + 'UpgradeKernelVersion', + 'MigrateDBCluster', + ], + ], + [ + 'id' => 74192, + 'title' => '资源组管理（旧版）', + 'type' => 'directory', + 'children' => [ + 'CreateDBResourcePool', + 'DeleteDBResourcePool', + 'ModifyDBResourcePool', + 'DescribeDBResourcePool', + 'BindDBResourcePoolWithUser', + 'UnbindDBResourcePoolWithUser', + ], + ], + [ + 'id' => 181276, + 'title' => '资源组管理（新版）', + 'type' => 'directory', + 'children' => [ + 'CreateDBResourceGroup', + 'BindDBResourceGroupWithUser', + 'UnbindDBResourceGroupWithUser', + 'DescribeDBResourceGroup', + 'ModifyDBResourceGroup', + 'DeleteDBResourceGroup', + 'DescribeResubmitConfig', + 'ModifyResubmitConfig', + 'ModifySQAConfig', + 'DescribeSQAConfig', + ], + ], + [ + 'id' => 74199, + 'title' => '弹性计划管理', + 'type' => 'directory', + 'children' => [ + 'CreateElasticPlan', + 'DeleteElasticPlan', + 'ModifyElasticPlan', + 'DescribeElasticDailyPlan', + 'DescribeElasticPlan', + ], + ], + [ + 'id' => 74205, + 'title' => '数据库', + 'type' => 'directory', + 'children' => [ + 'DescribeTables', + 'DescribeAllDataSource', + 'DescribeSchemas', + 'DescribeTableDetail', + 'DescribeProcessList', + 'DescribeColumns', + 'DescribeTaskInfo', + 'DescribeSQLPlan', + 'DescribeSQLPlanTask', + 'DescribeTablePartitionDiagnose', + 'DescribeLoadTasksRecords', + 'DescribeConnectionCountRecords', + 'KillProcess', + ], + ], + [ + 'id' => 74219, + 'title' => '日志管理', + 'type' => 'directory', + 'children' => [ + 'ModifyAuditLogConfig', + 'DescribeSlowLogRecords', + 'DescribeAuditLogConfig', + 'DescribeAuditLogRecords', + ], + ], + [ + 'id' => 74225, + 'title' => '地域管理', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 74227, + 'title' => '网络管理', + 'type' => 'directory', + 'children' => [ + 'ModifyClusterConnectionString', + 'DescribeDBClusterNetInfo', + 'AllocateClusterPublicConnection', + 'ReleaseClusterPublicConnection', + 'DescribeVSwitches', + ], + ], + [ + 'id' => 74232, + 'title' => '账号管理', + 'type' => 'directory', + 'children' => [ + 'CreateAccount', + 'DeleteAccount', + 'ModifyAccountDescription', + 'DescribeAllAccounts', + 'DescribeAccounts', + 'DescribeOperatorPermission', + 'GrantOperatorPermission', + 'ResetAccountPassword', + 'RevokeOperatorPermission', + ], + ], + [ + 'id' => 74242, + 'title' => '标签管理', + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 74251, + 'title' => '安全管理', + 'type' => 'directory', + 'children' => [ + 'ModifyDBClusterAccessWhiteList', + 'DescribeDBClusterAccessWhiteList', + 'DescribeDBClusterSSL', + 'ModifyDBClusterSSL', + ], + ], + [ + 'id' => 186969, + 'title' => '备份恢复', + 'type' => 'directory', + 'children' => [ + 'ModifyBackupPolicy', + 'ModifyLogBackupPolicy', + 'DescribeBackupPolicy', + 'DescribeBackups', + ], + ], + [ + 'id' => 74254, + 'title' => '监控管理', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterHealthStatus', + 'DescribeDBClusterPerformance', + 'DescribeDBClusterResourcePoolPerformance', + 'DescribeInclinedTables', + ], + ], + [ + 'id' => 74259, + 'title' => '运维事件', + 'type' => 'directory', + 'children' => [ + 'ModifyMaintenanceAction', + 'DescribeMaintenanceAction', + ], + ], + [ + 'id' => 74262, + 'title' => 'SQL诊断', + 'type' => 'directory', + 'children' => [ + 'DescribeDiagnosisTasks', + 'DescribeDiagnosisRecords', + 'DescribeDiagnosisDimensions', + 'DescribeDownloadRecords', + 'DownloadDiagnosisRecords', + 'DescribeDiagnosisSQLInfo', + 'DescribeDiagnosisMonitorPerformance', + 'DescribeSQLPatterns', + 'DescribePatternPerformance', + 'EnableAdviceService', + 'ApplyAdviceById', + 'BatchApplyAdviceByIdList', + 'DescribeAdviceServiceEnabled', + 'DescribeAppliedAdvices', + 'DescribeAvailableAdvices', + 'DisableAdviceService', + ], + ], + [ + 'id' => 190394, + 'title' => '空间分析', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterSpaceSummary', + 'DescribeTableStatistics', + 'DescribeExcessivePrimaryKeys', + ], + ], + [ + 'id' => 74267, + 'title' => '实例运行报告', + 'type' => 'directory', + 'children' => [ + 'DescribeTableAccessCount', + 'DescribeSqlPattern', + ], + ], + [ + 'id' => 362567, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'CheckServiceLinkedRole', + 'CreateServiceLinkedRole', + 'DescribeKmsKeys', + 'DescribeLogHubAttribute', + 'DescribeLogStoreKeys', + 'DescribeLoghubDetail', + 'DescribeRdsAnalysisResourceQuotas', + 'DescribeRegionsMixed', + 'DescribeSyncAvailableDBClusterList', + 'DescribeSyncJobList', + 'DescribeVSwitchs', + 'DescribeVpcs', + 'ModifyLogHubStatus', + 'ModifySyncJob', + 'OperateLogHub', + 'CancelActiveOperationTasks', + 'DescribeHistoryEventsStat', + 'ModifyActiveOperationMaintainConf', + 'DescribeActiveOperationTasks', + 'DescribeActiveOperationMaintainConf', + 'ModifyActiveOperationTasks', + 'DescribeControllerDetection', + 'DescribeWorkerDetection', + 'DescribeAbnormalPatternDetection', + 'DescribeBadSqlDetection', + 'DescribeExecutorDetection', + 'ModifyDBClusterVip', + 'GetCreateTableSQL', + 'DescribeInclinedNodes', + 'DescribeOversizeNonPartitionTableInfos', + 'ModifyDBClusterShardNumber', + 'DeleteBackups', + 'DescribeDBClusterShardNumber', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateDBCluster' => [ + 'summary' => '创建数仓版集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10768', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL数仓版集群版本。取值：**3.0**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3.0', + ], + ], + [ + 'name' => 'DBClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '系列。取值说明：'."\n" + .'- **Cluster**：预留模式集群版。'."\n" + ."\n" + .''."\n" + .'> 仅中国内地地域和新加坡地域支持购买预留模式集群版。其中，新加坡地域仅支持在按量付费模式下购买预留模式集群版。'."\n" + ."\n" + .'- **MixedStorage**：弹性模式集群版（新版）。'."\n" + ."\n" + .'> 当DBClusterCategory为Cluster时，Mode参数必须填写Reserver；当DBClusterCategory为MixedStorage时，Mode参数必须填写Flexible，否则会导致创建集群失败。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Cluster', + ], + ], + [ + 'name' => 'DBClusterClass', + 'in' => 'query', + 'schema' => [ + 'description' => '集群规格，取值：'."\n" + ."\n" + .'- **C8**'."\n" + .'- **C32**'."\n" + ."\n" + .'>Mode取值为Reserver（即预留模式）时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'C8', + ], + ], + [ + 'name' => 'DBNodeGroupCount', + 'in' => 'query', + 'schema' => [ + 'description' => '节点组数量，取值范围为：1~200（整数）。'."\n" + .'>Mode取值为Reserver（即预留模式）时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'DBNodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '节点存储空间，单位：GB。取值说明：'."\n" + ."\n" + .'- 规格为C8时，取值范围为：100~1000。'."\n" + .'- 规格为C32时，取值范围为：100~8000。'."\n" + ."\n" + .'> - Mode取值为Reserver（即预留模式）时，本参数必填。'."\n" + .'> - 1000 GB以下步长为100 GB，1000 GB以上步长为1000 GB。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'DBClusterNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络类型：**VPC**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。'."\n" + .'- 不能以`http://`或者`https`开头。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型。取值说明：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '指定预付费集群为包年或包月类型。取值说明：'."\n" + .'- **Year**：包年类型。'."\n" + .'- **Month**：包月类型。'."\n" + ."\n" + .'>PayType为Prepaid（即预付费（包年包月））时，本参数为必填参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费集群的购买时长。取值说明：'."\n" + ."\n" + .'- 当Period为Year时，UsedTime取值范围为：1、2、3、5（整数）。'."\n" + .'- 当Period为Month时，UsedTime取值范围为：1~11（整数）。'."\n" + ."\n" + .'> - PayType为Prepaid（即预付费（包年包月））时，本参数为必填参数。'."\n" + .'> - 购买的时间越长价格越优惠，购买1年的实际价格会比购买10个月或11个月更划算。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1at5ze0t5u3xtqn****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1aadw9k19x6cis9****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一。大小写敏感、不超过64个ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + [ + 'name' => 'ExecutorCount', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '模式。取值说明：'."\n" + .'- **Reserver**：预留模式。'."\n" + .'- **Flexible**：弹性模式。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Reserver', + ], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '计算资源用于数据计算，增加计算资源可以提高数据查询速度。计算资源分为集群版和单机版，其中：'."\n" + .'- 集群版为16核64 GB（集群版）、24核96 GB（集群版）和32核及以上规格。集群版支持资源池隔离，分时弹性功能和数据冷热分层。'."\n" + .'- 单机版为8核32 GB和16核64 GB（单机版）。单机版不提供SLA承诺，故障恢复耗时长（大约为4~8小时），不建议用于生产环境。'."\n" + ."\n" + .'> - 您可以调用[DescribeAvailableResource](~~190632~~)接口查询指定地域中可用的计算资源。'."\n" + .'> - Mode取值为**Flexible**（即弹性模式）时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '32Core128GBNEW', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'SourceDBInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'BackupSetID', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'ElasticIOResource', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '弹性IO资源（Elastic IO Unit，简称EIU），更多详情，请参见[EIU详解](~~189505~~)。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'DiskEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启云盘加密。取值：'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'KmsId', + 'in' => 'query', + 'schema' => [ + 'description' => '用于云盘加密的kmsId，仅当DiskEncryption为true时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxxx-xxxx-xxxx-xxxx-xxxx', + ], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启SSL链路加密功能，取值：'."\n" + ."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-4690g37929****', + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp1r053byu48p****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '202353278****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"ResourceGroupId\\": \\"rg-4690g37929****\\",\\n \\"DBClusterId\\": \\"am-bp1r053byu48p****\\",\\n \\"OrderId\\": \\"202353278****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n rg-4690g37929****\\n am-bp1r053byu48p****\\n 202353278****\\n","errorExample":""}]', + 'title' => '创建集群', + 'description' => '### 注意事项'."\n" + .'集群创建成功后，将按照您选的集群规格计费。数仓版集群的计费项与定价，详情请参见[数仓版计费项](~~303131~~)和[数仓版产品定价](~~135229~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDBCluster' => [ + 'summary' => '删除数仓版集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1u8c0mgfg58****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '421693038', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp1u8c0mgfg58****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 421693038,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp1u8c0mgfg58****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 421693038\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n am-bp1u8c0mgfg58****\\n","errorExample":""}]', + 'title' => '删除集群', + 'description' => '- 包年包月集群无法通过API删除，到期后会自动被释放。如果在确保集群不再使用后，您可以在费用与成本页面申请退订。关于集群退款的详细信息，请参见[退款说明](~~471477~~)。'."\n" + .'- 删除集群后，资源会立即释放，数据不再保留且无法找回，请谨慎操作。'."\n" + .'- 集群状态为运行中。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBCluster' => [ + 'summary' => '对数仓版集群进行升降配。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1u8c0mgfg58****', + ], + ], + [ + 'name' => 'DBNodeGroupCount', + 'in' => 'query', + 'schema' => [ + 'description' => '节点组数量，取值范围为：1~200。'."\n" + .'> Mode取值为Reserver（即预留模式）时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'DBNodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '节点存储空间，取值说明：'."\n" + .''."\n" + .'- 规格为C8时，取值范围为：100~1000GB。'."\n" + .''."\n" + .'- 规格为C8时，取值范围为：100~2000GB。'."\n" + .'- 规格为C32时，取值范围为：100~8000GB。'."\n" + ."\n" + .'> - Mode取值为Reserver（即预留模式）时，本参数必填。'."\n" + .'> - 1000GB以下步长为100GB，1000GB以上步长为1000GB。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => '节点规格，取值：'."\n" + .'- **C8**'."\n" + .'- **C32**'."\n" + .'> Mode取值为Reserver（即预留模式）时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'C32', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '变更类型，取值说明：'."\n" + ."\n" + .'- **Upgrade**：升级。'."\n" + .'- **Downgrade**：降级。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'ExecutorCount', + 'in' => 'query', + 'schema' => [ + 'description' => '不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，通过[DescribeRegions](~~143074~~)查看可用的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + 'schema' => [ + 'description' => '不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '计算资源，您可以调用[DescribeAvailableResource](~~190632~~)接口查询指定地域中可用的计算资源。'."\n" + .'> Mode取值为Flexible（即弹性模式）时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '32Core128GBNEW', + ], + ], + [ + 'name' => 'ElasticIOResourceSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '弹性资源单节点规格。取值说明：'."\n" + .'- **8Core64GB**：单节点规格选择**8Core64GB**时，一组弹性IO资源的规格为24Core192 GB。'."\n" + .'- **12Core96GB**：单节点规格选择**12Core96GB**时，一组弹性IO资源的规格为36Core288 GB。'."\n" + ."\n" + .'> 仅当集群满足如下条件时，支持该配置。'."\n" + .'> - 集群系列需为弹性模式。'."\n" + .'> - 华南3（广州）、华南1（深圳）、华东1（杭州）、华东2（上海）、华北1（青岛）、华北2（北京）和华北3（张家口）地域计算资源为16核64 GB（集群版）或以上规格的集群。'."\n" + .'> - 其他地域计算资源为32核128 GB或以上规格的集群。', + 'type' => 'string', + 'required' => false, + 'example' => '8Core64GB', + 'enum' => [ + '8Core64GB', + '12Core96GB', + '16Core128GB', + ], + ], + ], + [ + 'name' => 'ElasticIOResource', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '弹性IO资源的数量。不同的弹性IO资源规格，可购买的数量不同。'."\n" + .'- 弹性IO资源规格为8核64 GB，最多可购买32组。'."\n" + .'- 弹性IO资源规格为12核96 GB，最多可购买16组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'DBClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '系列。取值说明：'."\n" + .'- **Cluster**：预留模式集群版。'."\n" + ."\n" + .''."\n" + .'> 仅中国内地地域和新加坡地域支持购买预留模式集群版。其中，新加坡地域仅支持在按量付费模式下购买预留模式集群版。'."\n" + ."\n" + .'- **MixedStorage**：弹性模式集群版（新版）。'."\n" + .'> 当DBClusterCategory为Cluster时，Mode参数必须填写Reserver；当DBClusterCategory为MixedStorage时，Mode参数必须填写Flexible，否则会导致创建集群失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'MixedStorage', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '模式。取值说明：'."\n" + ."\n" + .'- **Reserver**：预留模式。'."\n" + .'- **Flexible**：弹性模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'Flexible', + ], + ], + [ + 'name' => 'DiskPerformanceLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '云盘PL等级。取值可选：'."\n" + .'- PL0'."\n" + .'- PL1'."\n" + .'- PL2'."\n" + .'- PL3', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + 'enum' => [ + 'PL1', + 'PL2', + 'PL3', + 'PL0', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp1u8c0mgfg58****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2035629****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp1u8c0mgfg58****\\",\\n \\"OrderId\\": \\"2035629****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n am-bp1u8c0mgfg58****\\n 2035629****\\n","errorExample":""}]', + 'title' => '对集群进行升降配', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterMaintainTime' => [ + 'summary' => '调用ModifyDBClusterMaintainTime接口修改实例可维护时间段。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10848', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp111m2cfrdl****', + ], + ], + [ + 'name' => 'MaintainTime', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的可维护时间段，格式为hh:mmZ-hh:mmZ。'."\n" + .'> 时间间隔只能为1小时，且需要设置为整点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '22:00Z-23:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n","errorExample":""}]', + 'title' => '修改集群可维护时间段', + ], + 'ModifyDBClusterPayType' => [ + 'summary' => '调用ModifyDBClusterPayType接口修改AnalyticDB MySQL集群的付费类型。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '119987', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型。取值说明：'."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'Prepaid', + 'enum' => [ + 'Postpaid', + 'Prepaid', + ], + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '指定预付费集群为包年或包月类型。取值说明：'."\n" + .'- **Year**：包年类型。'."\n" + .'- **Month**：包月类型。'."\n" + ."\n" + .'> PayType为Prepaid（即预付费（包年包月））时，本参数为必填参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + 'enum' => [ + 'Year', + 'Month', + ], + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费集群的购买时长。取值说明：'."\n" + ."\n" + .'- 当Period为Year时，UsedTime取值范围为：1、2、3、5（整数）。'."\n" + .'- 当Period为Month时，UsedTime取值范围为：1~11（整数）。'."\n" + ."\n" + .'> - PayType为Prepaid（即预付费（包年包月））时，本参数为必填参数。'."\n" + .'> - 购买的时间越长价格越优惠，购买1年的实际价格会比购买10个月或11个月更划算。', + 'type' => 'string', + 'required' => false, + 'maximum' => '9', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp11q28kvl688****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2023532****', + ], + 'PayType' => [ + 'description' => '付费类型。取值说明：'."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'example' => 'Prepaid', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPayType.Malformed', + 'errorMessage' => 'The specified parameter "PayType" is not changed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\",\\n \\"OrderId\\": \\"2023532****\\",\\n \\"PayType\\": \\"Prepaid\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n am-bp11q28kvl688****\\n 2023532****\\n Prepaid\\n","errorExample":""}]', + 'title' => '修改集群的付费类型', + ], + 'ModifyAutoRenewAttribute' => [ + 'summary' => '调用ModifyAutoRenewAttribute接口设置包年包月集群自动续费状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10841', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1u389j9zjh5****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '续费状态。取值：'."\n" + ."\n" + .'- **AutoRenewal**：自动续费；'."\n" + ."\n" + .'- **Normal**：手动续费；'."\n" + ."\n" + .'- **NotRenewal**：到期不续费。', + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + 'default' => 'AutoRenewal', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '续费时长。默认值为**1**。'."\n" + ."\n" + .'- 当PeriodUnit为**Month**时，取值为1~11（整数）。'."\n" + ."\n" + .'- 当PeriodUnit为**Year**时，取值为1、2、3、5（整数）。'."\n" + .'>购买的时间越长价格越优惠，购买1年的实际价格会比购买10个月或11个月更划算。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '续费时长单位。默认值为**Month**。'."\n" + ."\n" + .'- **Year**：年。'."\n" + ."\n" + .'- **Month**：月。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + 'default' => 'Month', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4CE6DF97-AEA4-484F-906F-C407EE3770EB', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE3770EB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4CE6DF97-AEA4-484F-906F-C407EE3770EB\\n","errorExample":""}]', + 'title' => '设置包年包月集群自动续费状态', + ], + 'ModifyDBClusterDescription' => [ + 'summary' => '调用ModifyDBClusterDescription接口修改集群的备注名，方便维护管理。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10847', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。'."\n" + ."\n" + .'- 不能以`http://`或者`https`开头；'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'adb_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\n","errorExample":""}]', + 'title' => '修改集群的备注名', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterResourceGroup' => [ + 'summary' => '调用ModifyDBClusterResourceGroup接口修改AnalyticDB MySQL集群的资源组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bpxxxxx', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组id。资源组详情请参见[查看资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rg-acxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]', + 'title' => '修改数据库集群资源组', + ], + 'DescribeDBClusters' => [ + 'summary' => '查询数仓版集群列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10802', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看可用地域的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以输入上述地域中任意的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。'."\n" + .'- 不能以`http://`或者`https://`开头。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '集群状态，取值说明：'."\n" + .'- **Preparing**：准备中'."\n" + .'- **Creating**：创建中'."\n" + .'- **Restoring**：备份恢复中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：删除中'."\n" + .'- **ClassChanging**：变配中'."\n" + .'- **NetAddressCreating**：创建网络中'."\n" + .'- **NetAddressDeleting**：删除网络中', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929XXXX', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '集群版本，固定取值为**3.0**。', + 'type' => 'string', + 'required' => false, + 'example' => '3.0', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'All', + 'enum' => [ + 'All', + '3.0', + '5.0', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '集群信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'DtsJobId' => [ + 'description' => 'DTS同步任务ID。仅MySQL分析实例会返回该参数。更多详情，请参见[MySQL分析实例简介](~~154779~~)。'."\n", + 'type' => 'string', + 'example' => 'dtsb1578j90XXXX', + ], + 'DBNodeCount' => [ + 'description' => '节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Expired' => [ + 'description' => '集群是否过期。取值说明：'."\n" + .'* **true**：已过期。'."\n" + .'* **false**：未过期。', + 'type' => 'string', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => '集群创建时间，UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ，例如2021-04-01T09:50:18Z。', + 'type' => 'string', + 'example' => '2021-04-01T09:50:18Z', + ], + 'PayType' => [ + 'description' => '集群付费类型，取值说明：'."\n" + .'* **Postpaid**：按量付费（即后付费）。'."\n" + .'* **Prepaid**：包年包月（即预付费）。', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'DiskType' => [ + 'description' => '集群的磁盘类型，取值说明：'."\n" + .'* **local_ssd**：本地磁盘。'."\n" + .'* **cloud**：普通云盘。'."\n" + .'* **cloud_ssd**：SSD云盘。'."\n" + .'* **cloud_efficiency**：高效云盘。'."\n" + .'* **cloud_essd0**：PL0等级的ESSD云盘。'."\n" + .'* **cloud_essd**：PL1等级的ESSD云盘。'."\n" + .'* **cloud_essd2**：PL2 等级的ESSD云盘。'."\n" + .'* **cloud_essd3**：PL3 等级的ESSD云盘。'."\n" + ."\n" + .'> 更多关于ESSD云盘的详情，请参见[ESSD云盘规格](~~122389~~)。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + .'> 您可以调用[TagResources](~~179253~~)接口为目标集群创建标签。', + 'type' => 'string', + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + 'Mode' => [ + 'description' => '集群模式，取值说明：'."\n" + .'* **flexible**：弹性模式。'."\n" + .'* **reserver**：预留模式。'."\n" + ."\n" + .'> - 更多关于集群模式的介绍，请参见[产品系列](~~205001~~)。', + 'type' => 'string', + 'example' => 'flexible', + ], + 'Port' => [ + 'description' => '集群端口号，默认为3306。', + 'type' => 'string', + 'example' => '3306', + ], + 'LockMode' => [ + 'description' => '集群的锁定模式，取值说明：'."\n" + .'* **Unlock**：正常（即未锁定）。'."\n" + .'* **ManualLock**：手动触发锁定。'."\n" + .'* **LockByExpiration**：集群过期自动锁定。'."\n" + .'* **LockByRestoration**：集群回滚前自动锁定。'."\n" + .'* **LockByDiskQuota**：集群中空间满（即数据占用的存储空间已到达上限水位的90%）自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'StorageResource' => [ + 'description' => '弹性模式用的存储资源规格，用于数据读写，增加该资源能提高集群读写能力。', + 'type' => 'string', + 'example' => '8Core32GB', + ], + 'ExecutorCount' => [ + 'description' => '弹性模式下集群使用的计算节点数量。', + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => ' 集群ID。', + 'type' => 'string', + 'example' => 'am-bp163885f8q21****', + ], + 'ConnectionString' => [ + 'description' => '集群的公网连接地址。', + 'type' => 'string', + 'example' => 'am-bp163885f8q21****.ads.aliyuncs.com', + ], + 'RdsInstanceId' => [ + 'description' => '同步源RDS实例ID。仅MySQL分析实例会返回该参数。更多详情，请参见[MySQL分析实例简介](~~154779~~)。', + 'type' => 'string', + 'example' => 'rm-bp11q28kvl688****', + ], + 'DBClusterType' => [ + 'description' => '集群类型，取值说明：'."\n" + .'* **Common**：常规集群。'."\n" + .'* **RDS_ANALYSIS**：MySQL分析实例。更多详情，请参见[MySQL分析实例简介](~~154779~~)。'."\n", + 'type' => 'string', + 'example' => 'Common', + ], + 'CommodityCode' => [ + 'description' => '商品code，固定为**ads**。', + 'type' => 'string', + 'example' => 'ads', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间，UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ，例如2999-09-08T16:00:00Z。'."\n" + ."\n" + .'> * 若目标集群付费模式为包年包月，则返回实际到期时间。'."\n" + .'> * 若目标集群付费模式为按量付费，则返回固定值**2999-09-08T16:00:00Z**。', + 'type' => 'string', + 'example' => '2999-09-08T16:00:00Z', + ], + 'DBNodeStorage' => [ + 'description' => '集群的存储空间，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'E8', + ], + 'LockReason' => [ + 'description' => '集群锁定原因。'."\n" + .'> 仅当集群被锁定时会返回该参数，固定为**instance_expire**。', + 'type' => 'string', + 'example' => 'instance_expired', + ], + 'VPCId' => [ + 'description' => '专有网络（VPC）ID。', + 'type' => 'string', + 'example' => 'vpc-bp13h7uzhulpuxvnpXXXX', + ], + 'RegionId' => [ + 'description' => '集群所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ComputeResource' => [ + 'description' => '弹性模式下使用的计算资源规格，用于数据计算。增加计算资源能加快查询速度，可以根据集群实际性能按需弹性扩缩。', + 'type' => 'string', + 'example' => '8Core32GB', + ], + 'ElasticIOResource' => [ + 'description' => '弹性IO资源（Elastic IO Unit，简称EIU），更多详情，请参见[EIU详解](~~189505~~)。'."\n" + .'> 仅弹性模式集群会返回该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1syh8vvw8yech7nXXXX', + ], + 'DBVersion' => [ + 'description' => '数据库版本，当前仅支持**3.0**版本。', + 'type' => 'string', + 'example' => '3.0', + ], + 'VPCCloudInstanceId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'am-bp163885f8q21****-controller', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态。更多详情，请参见[集群状态表](~~143075~~)。', + 'type' => 'string', + 'example' => 'Running', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + ], + 'DBClusterNetworkType' => [ + 'description' => '集群网络类型。仅支持**VPC**（专有网络）类型。', + 'type' => 'string', + 'example' => 'vpc', + ], + 'DBClusterDescription' => [ + 'description' => '集群的描述信息。', + 'type' => 'string', + 'example' => 'adb_test', + ], + 'ZoneId' => [ + 'description' => '集群所在的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Category' => [ + 'description' => '产品系列，取值说明：'."\n" + .'* **BASIC**：预留模式基础版'."\n" + .'* **CLUSTER**：预留模式集群版'."\n" + .'* **MIXED_STORAGE**：弹性模式集群版（新版）'."\n" + ."\n" + .'> 更多关于集群系列的介绍，请参见[产品系列](~~205001~~)。', + 'type' => 'string', + 'example' => 'MIXED_STORAGE', + ], + 'Engine' => [ + 'description' => '集群引擎，固定为**AnalyticDB**。', + 'type' => 'string', + 'example' => 'AnalyticDB', + ], + 'InnerIp' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '10.1.xx.xx', + ], + 'InnerPort' => [ + 'description' => '端口号。', + 'type' => 'string', + 'example' => '3306', + ], + 'TaskInfo' => [ + 'description' => '任务进度信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'analyticDBFlexibleScaleOut', + ], + 'Status' => [ + 'description' => '任务状态，取值为：'."\n" + .'- **NOT_RUN**：等待运行。'."\n" + .'- **RUNNING**：运行中。'."\n" + .'- **SUCCEED**：已结束。', + 'type' => 'string', + 'example' => 'RUNNING', + 'enum' => [ + 'RUNNING', + 'SUCCEED', + 'NOT_RUN', + ], + ], + 'Progress' => [ + 'description' => '任务进度，单位：%。', + 'type' => 'string', + 'example' => '10', + ], + 'StepList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StepList' => [ + 'description' => '任务步骤。', + 'type' => 'array', + 'items' => [ + 'description' => '任务步骤。', + 'type' => 'object', + 'properties' => [ + 'StepName' => [ + 'description' => '步骤名称。', + 'type' => 'string', + 'example' => 'ApplyResource', + ], + 'StepDesc' => [ + 'description' => '步骤描述。', + 'type' => 'string', + 'example' => 'Apply resource', + ], + 'StepStatus' => [ + 'description' => '步骤状态，取值为：'."\n" + .'- **NOT_RUN**：等待运行。'."\n" + .'- **RUNNING**：运行中。'."\n" + .'- **SUCCEED**：已结束。', + 'type' => 'string', + 'example' => 'SUCCEED', + 'enum' => [ + 'RUNNING', + 'SUCCEED', + 'NOT_RUN', + ], + ], + 'StepProgress' => [ + 'description' => '步骤进度，单位：%。', + 'type' => 'string', + 'example' => '50', + ], + 'StartTime' => [ + 'description' => '步骤开始时间，格式为 YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-03-10T09:28:34Z', + ], + 'EndTime' => [ + 'description' => '步骤结束时间，格式为 YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-03-10T10:28:34Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'ProductVersion' => [ + 'description' => '产品版本。取值为：'."\n" + .'- **BasicVersion**：基础版。'."\n" + .'- **EnterpriseVersion**：企业版。', + 'type' => 'string', + 'example' => 'EnterpriseVersion', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"DtsJobId\\": \\"dtsb1578j90XXXX\\",\\n \\"DBNodeCount\\": 1,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-04-01T09:50:18Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DiskType\\": \\"cloud_essd\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"Mode\\": \\"flexible\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageResource\\": \\"8Core32GB\\",\\n \\"ExecutorCount\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-bp163885f8q21****\\",\\n \\"ConnectionString\\": \\"am-bp163885f8q21****.ads.aliyuncs.com\\",\\n \\"RdsInstanceId\\": \\"rm-bp11q28kvl688****\\",\\n \\"DBClusterType\\": \\"Common\\",\\n \\"CommodityCode\\": \\"ads\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"DBNodeStorage\\": 300,\\n \\"DBNodeClass\\": \\"E8\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"VPCId\\": \\"vpc-bp13h7uzhulpuxvnpXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ComputeResource\\": \\"8Core32GB\\",\\n \\"ElasticIOResource\\": 0,\\n \\"VSwitchId\\": \\"vsw-bp1syh8vvw8yech7nXXXX\\",\\n \\"DBVersion\\": \\"3.0\\",\\n \\"VPCCloudInstanceId\\": \\"am-bp163885f8q21****-controller\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"DBClusterNetworkType\\": \\"vpc\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Category\\": \\"MIXED_STORAGE\\",\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"InnerIp\\": \\"10.1.xx.xx\\",\\n \\"InnerPort\\": \\"3306\\",\\n \\"TaskInfo\\": {\\n \\"Name\\": \\"analyticDBFlexibleScaleOut\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Progress\\": \\"10\\",\\n \\"StepList\\": {\\n \\"StepList\\": [\\n {\\n \\"StepName\\": \\"ApplyResource\\",\\n \\"StepDesc\\": \\"Apply resource\\",\\n \\"StepStatus\\": \\"SUCCEED\\",\\n \\"StepProgress\\": \\"50\\",\\n \\"StartTime\\": \\"2024-03-10T09:28:34Z\\",\\n \\"EndTime\\": \\"2024-03-10T10:28:34Z\\"\\n }\\n ]\\n }\\n },\\n \\"ProductVersion\\": \\"EnterpriseVersion\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 30\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n 1\\n \\n dtsb1578j90XXXX\\n 1\\n false\\n 2021-04-01T09:50:18Z\\n Postpaid\\n cloud_essd\\n \\n tag1\\n test1\\n \\n flexible\\n 3306\\n Unlock\\n 8Core32GB\\n 1\\n am-bp163885f8q21****\\n am-bp163885f8q21****.ads.aliyuncs.com\\n rm-bp11q28kvl688****\\n Common\\n ads\\n 2999-09-08T16:00:00Z\\n 300\\n E8\\n instance_expired\\n vpc-bp13h7uzhulpuxvnpXXXX\\n cn-hangzhou\\n 8Core32GB\\n 0\\n vsw-bp1syh8vvw8yech7nXXXX\\n 3.0\\n am-bp163885f8q21****-controller\\n Running\\n rg-acfmyiu4ekp****\\n vpc\\n adb_test\\n cn-hangzhou-h\\n MIXED_STORAGE\\n AnalyticDB\\n 10.1.xx.xx\\n 3306\\n \\n","errorExample":""}]', + 'title' => '查询实例列表', + ], + 'DescribeDBClusterStatus' => [ + 'summary' => '调用DescribeDBClusterStatus接口查询数仓版集群的状态列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10803', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '集群的状态列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '集群状态。', + 'type' => 'array', + 'items' => [ + 'description' => '集群状态，取值说明：'."\n" + .'- **Preparing**：准备中。'."\n" + ."\n" + .'- **Creating**：创建中。'."\n" + ."\n" + .'- **Restoring**：备份恢复中。'."\n" + ."\n" + .'- **Running**：运行中。'."\n" + ."\n" + .'- **Deleting**：删除中。'."\n" + ."\n" + .'- **ClassChanging**：变配中。'."\n" + ."\n" + .'- **NetAddressCreating**：创建网络中。'."\n" + ."\n" + .'- **NetAddressDeleting**：释放网络中。'."\n" + ."\n" + .'- **NetAddressModifying**：网络地址修改中。'."\n" + ."\n" + .'- **EngineVersionUpgrading**：版本升级中。', + 'type' => 'string', + 'example' => '["Preparing","Creating","Restoring","Running","Deleting","ClassChanging","NetAddressCreating","NetAddressDeleting","NetAddressModifying","EngineVersionUpgrading"]', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAU', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": [\\n \\"[\\\\\\"Preparing\\\\\\",\\\\\\"Creating\\\\\\",\\\\\\"Restoring\\\\\\",\\\\\\"Running\\\\\\",\\\\\\"Deleting\\\\\\",\\\\\\"ClassChanging\\\\\\",\\\\\\"NetAddressCreating\\\\\\",\\\\\\"NetAddressDeleting\\\\\\",\\\\\\"NetAddressModifying\\\\\\",\\\\\\"EngineVersionUpgrading\\\\\\"]\\"\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAU\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Preparing\\n Creating\\n Restoring\\n Running\\n Deleting\\n ClassChanging\\n NetAddressCreating\\n NetAddressDeleting\\n NetAddressModifying\\n EngineVersionUpgrading\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEAU\\n","errorExample":""}]', + 'title' => '查看集群的运行状态', + ], + 'DescribeDBClusterAttribute' => [ + 'summary' => '调用DescribeDBClusterAttribute接口查看目标AnalyticDB MySQL版集群的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10798', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp111m2cfrdl1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所在的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2895BB82-B2C1-408E-AA73-DB8D59******', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '集群信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '集群创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-04-01T09:50:18Z', + ], + 'EnableSpark' => [ + 'description' => '是否创建了Spark集群。取值说明：'."\n" + .'* **true**：已创建。'."\n" + .'* **false**：未创建。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'DtsJobId' => [ + 'description' => 'DTS同步任务ID。仅MySQL分析实例会返回该参数。更多详情，请参见[MySQL分析实例简介](~~154779~~)。'."\n", + 'type' => 'string', + 'example' => 'dtsb1hp3790****', + ], + 'DBNodeCount' => [ + 'description' => '节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Expired' => [ + 'description' => '集群是否过期。取值说明：'."\n" + .'* **true**：已过期。'."\n" + .'* **false**：未过期。', + 'type' => 'string', + 'example' => 'false', + ], + 'MaintainTime' => [ + 'description' => '集群的可维护时间段，格式为HH:mmZ- HH:mmZ，例如：04:00Z-05:00Z，表示可维护时间段为4点至5点。'."\n" + .'> 更多关于可维护时间段的信息，请参见[设置可维护时间段](~~122569~~)。', + 'type' => 'string', + 'example' => '04:00Z-05:00Z', + ], + 'PayType' => [ + 'description' => '集群付费类型，取值说明：'."\n" + .'* **Postpaid**：按量付费（即后付费）。'."\n" + .'* **Prepaid**：包年包月（即预付费）。', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'DiskType' => [ + 'description' => '集群的磁盘类型，取值说明：'."\n" + .'* **local_ssd**：本地磁盘。'."\n" + .'* **cloud**：普通云盘。'."\n" + .'* **cloud_ssd**：SSD云盘。'."\n" + .'* **cloud_efficiency**：高效云盘。'."\n" + .'* **cloud_essd0**：PL0等级的ESSD云盘。'."\n" + .'* **cloud_essd**：PL1等级的ESSD云盘。'."\n" + .'* **cloud_essd2**：PL2 等级的ESSD云盘。'."\n" + .'* **cloud_essd3**：PL3 等级的ESSD云盘。'."\n" + ."\n" + .'> 更多关于ESSD云盘的详情，请参见[ESSD云盘规格](~~122389~~)。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + .'> 您可以调用[TagResources](~~179253~~)接口为目标集群创建标签。', + 'type' => 'string', + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + 'Mode' => [ + 'description' => '集群模式，取值说明：'."\n" + .'* **flexible**：弹性模式。'."\n" + .'* **reserver**：预留模式。'."\n" + ."\n" + .'> 更多关于集群模式的介绍，请参见[产品系列](~~205001~~)。', + 'type' => 'string', + 'example' => 'flexible', + ], + 'Port' => [ + 'description' => '集群端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'LockMode' => [ + 'description' => '集群的锁定模式，取值说明：'."\n" + .'* **Unlock**：正常（即未锁定）。'."\n" + .'* **ManualLock**：手动触发锁定。'."\n" + .'* **LockByExpiration**：集群过期自动锁定。'."\n" + .'* **LockByRestoration**：集群回滚前自动锁定。'."\n" + .'* **LockByDiskQuota**：集群中空间满（即数据占用的存储空间已到达上限水位的90%）自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'EngineVersion' => [ + 'description' => '集群引擎版本。', + 'type' => 'string', + 'example' => '3.1.1.9', + ], + 'EnableAirflow' => [ + 'description' => '是否创建了Airflow集群。取值说明：'."\n" + .'* **true**：已创建。'."\n" + .'* **false**：未创建。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExecutorCount' => [ + 'description' => '弹性模式下集群使用的计算节点数量。', + 'type' => 'string', + 'example' => '1', + ], + 'StorageResource' => [ + 'description' => '弹性模式用的存储资源规格，用于数据读写，增加该资源能提高集群读写能力。', + 'type' => 'string', + 'example' => '8Core32GB', + ], + 'DBClusterId' => [ + 'description' => 'AnalyticDB MySQL数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp111m2cfrdl1****', + ], + 'ConnectionString' => [ + 'description' => '集群的VPC连接地址。', + 'type' => 'string', + 'example' => 'am-bp111m2cfrdl1****.ads.aliyuncs.com', + ], + 'RdsInstanceId' => [ + 'description' => '同步源RDS实例ID。仅MySQL分析实例会返回该参数。更多详情，请参见[MySQL分析实例简介](~~154779~~)。'."\n", + 'type' => 'string', + 'example' => 'rm-bp837jsdp2****', + ], + 'DBClusterType' => [ + 'description' => '集群类型。取值说明：'."\n" + .'* **Common**：常规集群。'."\n" + .'* **RDS_ANALYSIS**：MySQL分析实例。更多详情，请参见[MySQL分析实例简介](~~154779~~)。'."\n", + 'type' => 'string', + 'example' => 'Common', + ], + 'CommodityCode' => [ + 'description' => '商品付费类型，取值说明：'."\n" + .'- **ads**：按量付费商品。'."\n" + .'- **ads_pre**：包年包月商品。', + 'type' => 'string', + 'example' => 'ads', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），例如2999-09-08T16:00:00Z。'."\n" + ."\n" + .'> * 若目标集群付费模式为包年包月，则返回实际到期时间。'."\n" + .'> * 若目标集群付费模式为按量付费，则返回固定值**2999-09-08T16:00:00Z**。', + 'type' => 'string', + 'example' => '2999-09-08T16:00:00Z', + ], + 'DBNodeStorage' => [ + 'description' => '集群的存储空间，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'E8', + ], + 'LockReason' => [ + 'description' => '集群锁定原因。'."\n" + .'> 仅当集群被锁定时会返回该参数，固定为**instance_expire**。', + 'type' => 'string', + 'example' => 'instance_expired', + ], + 'VPCId' => [ + 'description' => '专有网络（VPC）ID。', + 'type' => 'string', + 'example' => 'vpc-bp13h7uzhulpuxvnp****', + ], + 'ComputeResource' => [ + 'description' => '弹性模式下使用的计算资源规格，用于数据计算。增加计算资源能加快查询速度，可以根据集群实际性能按需弹性扩缩。', + 'type' => 'string', + 'example' => '8Core32GB', + ], + 'RegionId' => [ + 'description' => '集群所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ElasticIOResource' => [ + 'description' => '弹性IO资源的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1syh8vvw8yech7n****', + ], + 'DBVersion' => [ + 'description' => '数据库版本，当前仅支持**3.0**版本。', + 'type' => 'string', + 'example' => '3.0', + ], + 'VPCCloudInstanceId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'am-bp111m2cfrdl1****-controller', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态。更多详情，请参见[集群状态表](~~143075~~)。', + 'type' => 'string', + 'example' => 'Running', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + ], + 'DBClusterNetworkType' => [ + 'description' => '集群网络类型。仅支持**VPC**（专有网络）类型。', + 'type' => 'string', + 'example' => 'vpc', + ], + 'DBClusterDescription' => [ + 'description' => '集群的描述信息。', + 'type' => 'string', + 'example' => 'adb_test', + ], + 'UserENIStatus' => [ + 'description' => '是否已启用ENI（Elastic Network Interface，弹性网卡）网络，取值说明：'."\n" + .'* **true**：已启用。'."\n" + .'* **false**：未启用。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ZoneId' => [ + 'description' => '集群所在的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Category' => [ + 'description' => '产品系列，取值说明：'."\n" + .'* **BASIC**：预留模式基础版'."\n" + .'* **CLUSTER**：预留模式集群版'."\n" + .'* **MIXED_STORAGE**：弹性模式集群版（新版）'."\n" + ."\n" + .'> 更多关于集群系列的介绍，请参见[产品系列](~~205001~~)。', + 'type' => 'string', + 'example' => 'MIXED_STORAGE', + ], + 'Engine' => [ + 'description' => '集群引擎，固定为**AnalyticDB**。', + 'type' => 'string', + 'example' => 'AnalyticDB', + ], + 'KmsId' => [ + 'description' => '用于加密云盘数据的密钥ID。'."\n" + .'> 仅当AnalyticDB MySQL集群开启云盘加密时才会返回该参数。', + 'type' => 'string', + 'example' => 'e1935511-cf88-1123-a0f8-1be8d251****', + ], + 'InnerIp' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '10.1.XX.XX', + ], + 'InnerPort' => [ + 'description' => '公网端口号。', + 'type' => 'string', + 'example' => '3306', + ], + 'DiskPerformanceLevel' => [ + 'description' => '云盘等级。', + 'type' => 'string', + 'example' => 'PL1', + ], + 'ElasticIOResourceSize' => [ + 'description' => '弹性资源单节点规格。取值说明：'."\n" + .'- 8Core64GB：单节点规格为8Core64GB时，一组弹性IO资源的规格为24Core192 GB。'."\n" + .'- 12Core96GB：单节点规格为12Core96GB时，一组弹性IO资源的规格为36Core288 GB。', + 'type' => 'string', + 'example' => '8Core64GB', + ], + 'DiskEncryption' => [ + 'description' => '是否开启云盘加密。取值：'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TaskInfo' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'analyticDBFlexibleScaleOut', + ], + 'Status' => [ + 'description' => '任务状态，取值为：'."\n" + .'- **NOT_RUN**：等待运行。'."\n" + .'- **RUNNING**：运行中。'."\n" + .'- **SUCCEED**：已结束。', + 'type' => 'string', + 'example' => 'RUNNING', + 'enum' => [ + 'RUNNING', + 'SUCCEED', + 'NOT_RUN', + ], + ], + 'Progress' => [ + 'description' => '任务进度，单位：%。', + 'type' => 'string', + 'example' => '10', + ], + 'StepList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StepList' => [ + 'description' => '任务步骤。', + 'type' => 'array', + 'items' => [ + 'description' => '任务步骤。', + 'type' => 'object', + 'properties' => [ + 'StepName' => [ + 'description' => '步骤名称。', + 'type' => 'string', + 'example' => 'ApplyResource', + ], + 'StepDesc' => [ + 'description' => '步骤描述。', + 'type' => 'string', + 'example' => 'Apply resource', + ], + 'StepStatus' => [ + 'description' => '步骤状态，取值为：'."\n" + .'- **NOT_RUN**：等待运行。'."\n" + .'- **RUNNING**：运行中。'."\n" + .'- **SUCCEED**：已结束。', + 'type' => 'string', + 'example' => 'SUCCEED', + 'enum' => [ + 'RUNNING', + 'SUCCEED', + 'NOT_RUN', + ], + ], + 'StepProgress' => [ + 'description' => '步骤进度，单位：%。', + 'type' => 'string', + 'example' => '50', + ], + 'StartTime' => [ + 'description' => '步骤开始时间，格式为 YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-03-10T09:28:34Z', + ], + 'EndTime' => [ + 'description' => '步骤结束时间，格式为 YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-03-10T10:28:34Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'ProductVersion' => [ + 'description' => '产品版本。取值为：'."\n" + .'- **BasicVersion**：基础版。'."\n" + .'- **EnterpriseVersion**：企业版。', + 'type' => 'string', + 'example' => 'BasicVersion', + ], + 'SecondaryZoneId' => [ + 'description' => '备可用区ID。'."\n" + .'> 本参数和ZoneId参数传入的值不能相同。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'SecondaryVSwitchId' => [ + 'description' => '备虚拟交换机ID。'."\n" + .'> 本参数和VSwitchId参数传入的值不能相同。', + 'type' => 'string', + 'example' => 'vsw-0jlxwqt4531fsb3jdzx6h', + ], + 'ReservedNodeSize' => [ + 'type' => 'string', + ], + 'ReservedNodeCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ProductForm' => [ + 'type' => 'string', + 'enum' => [ + 'IntegrationForm', + 'LegacyForm', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2895BB82-B2C1-408E-AA73-DB8D59******\\",\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"CreationTime\\": \\"2021-04-01T09:50:18Z\\",\\n \\"EnableSpark\\": false,\\n \\"DtsJobId\\": \\"dtsb1hp3790****\\",\\n \\"DBNodeCount\\": 1,\\n \\"Expired\\": \\"false\\",\\n \\"MaintainTime\\": \\"04:00Z-05:00Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DiskType\\": \\"cloud_essd\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"Mode\\": \\"flexible\\",\\n \\"Port\\": 3306,\\n \\"LockMode\\": \\"Unlock\\",\\n \\"EngineVersion\\": \\"3.1.1.9\\",\\n \\"EnableAirflow\\": true,\\n \\"ExecutorCount\\": \\"1\\",\\n \\"StorageResource\\": \\"8Core32GB\\",\\n \\"DBClusterId\\": \\"am-bp111m2cfrdl1****\\",\\n \\"ConnectionString\\": \\"am-bp111m2cfrdl1****.ads.aliyuncs.com\\",\\n \\"RdsInstanceId\\": \\"rm-bp837jsdp2****\\",\\n \\"DBClusterType\\": \\"Common\\",\\n \\"CommodityCode\\": \\"ads\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"DBNodeStorage\\": 300,\\n \\"DBNodeClass\\": \\"E8\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"VPCId\\": \\"vpc-bp13h7uzhulpuxvnp****\\",\\n \\"ComputeResource\\": \\"8Core32GB\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ElasticIOResource\\": 2,\\n \\"VSwitchId\\": \\"vsw-bp1syh8vvw8yech7n****\\",\\n \\"DBVersion\\": \\"3.0\\",\\n \\"VPCCloudInstanceId\\": \\"am-bp111m2cfrdl1****-controller\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"DBClusterNetworkType\\": \\"vpc\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"UserENIStatus\\": true,\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Category\\": \\"MIXED_STORAGE\\",\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"KmsId\\": \\"e1935511-cf88-1123-a0f8-1be8d251****\\",\\n \\"InnerIp\\": \\"10.1.XX.XX\\",\\n \\"InnerPort\\": \\"3306\\",\\n \\"DiskPerformanceLevel\\": \\"PL1\\",\\n \\"ElasticIOResourceSize\\": \\"8Core64GB\\",\\n \\"DiskEncryption\\": false,\\n \\"TaskInfo\\": {\\n \\"Name\\": \\"analyticDBFlexibleScaleOut\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Progress\\": \\"10\\",\\n \\"StepList\\": {\\n \\"StepList\\": [\\n {\\n \\"StepName\\": \\"ApplyResource\\",\\n \\"StepDesc\\": \\"Apply resource\\",\\n \\"StepStatus\\": \\"SUCCEED\\",\\n \\"StepProgress\\": \\"50\\",\\n \\"StartTime\\": \\"2024-03-10T09:28:34Z\\",\\n \\"EndTime\\": \\"2024-03-10T10:28:34Z\\"\\n }\\n ]\\n }\\n },\\n \\"ProductVersion\\": \\"BasicVersion\\",\\n \\"SecondaryZoneId\\": \\"cn-hangzhou-i\\",\\n \\"SecondaryVSwitchId\\": \\"vsw-0jlxwqt4531fsb3jdzx6h\\",\\n \\"ReservedNodeSize\\": \\"\\",\\n \\"ReservedNodeCount\\": 0,\\n \\"ProductForm\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2895BB82-B2C1-408E-AA73-DB8D59******\\n \\n 2021-04-01T09:50:18Z\\n false\\n dtsb1hp3790****\\n 1\\n false\\n 04:00Z-05:00Z\\n Postpaid\\n cloud_essd\\n \\n tag1\\n test1\\n \\n flexible\\n 3306\\n Unlock\\n 3.1.1.9\\n true\\n 1\\n 8Core32GB\\n am-bp111m2cfrdl1****\\n am-bp111m2cfrdl1****.ads.aliyuncs.com\\n rm-bp837jsdp2****\\n Common\\n ads\\n 2999-09-08T16:00:00Z\\n 300\\n E8\\n instance_expired\\n vpc-bp13h7uzhulpuxvnp****\\n 8Core32GB\\n cn-hangzhou\\n 2\\n vsw-bp1syh8vvw8yech7n****\\n 3.0\\n am-bp111m2cfrdl1****-controller\\n Running\\n rg-acfmyiu4ekp****\\n vpc\\n adb_test\\n true\\n cn-hangzhou-h\\n MIXED_STORAGE\\n AnalyticDB\\n e1935511-cf88-1123-a0f8-1be8d251****\\n 10.1.XX.XX\\n 3306\\n PL1\\n 8Core64GB\\n \\n","errorExample":""}]', + 'title' => '查询集群的详细属性', + ], + 'DescribeAutoRenewAttribute' => [ + 'summary' => '调用DescribeAutoRenewAttribute接口查询包年包月集群自动续费状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10788', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'如果有多个集群ID，以英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- 30'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'默认值：30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值：大于0且不超过Integer的最大值。'."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageRecordCount' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoRenewAttribute' => [ + 'description' => '集群续费信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp11q28kvl688****', + ], + 'PeriodUnit' => [ + 'description' => '续费时长单位，取值说明：'."\n" + .'- **Year**：年。'."\n" + .'- **Month**：月。', + 'type' => 'string', + 'example' => 'Year', + ], + 'Duration' => [ + 'description' => '续费时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RenewalStatus' => [ + 'description' => '续费状态。取值说明：'."\n" + .'- **AutoRenewal**：自动续费。'."\n" + .'- **Normal**：手动续费，集群到期前通过短信提醒。'."\n" + .'- **NotRenewal**：到期不续费，集群到期前无提醒，只在到期前第三天发送不续费提醒。', + 'type' => 'string', + 'example' => 'AutoRenewal', + ], + 'AutoRenewEnabled' => [ + 'description' => '是否开启自动续费，取值说明：'."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 20,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"AutoRenewAttribute\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\",\\n \\"PeriodUnit\\": \\"Year\\",\\n \\"Duration\\": 1,\\n \\"RenewalStatus\\": \\"AutoRenewal\\",\\n \\"AutoRenewEnabled\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"20\\n30\\n1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n1\\n\\n \\n true\\n AutoRenewal\\n am-bp11q28kvl688****\\n 1\\n cn-hangzhou\\n Year\\n \\n","errorExample":""}]', + 'title' => '查询包年包月集群自动续费状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAvailableResource' => [ + 'summary' => '调用DescribeAvailableResource接口查询指定可用区资源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)查看。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值说明：'."\n" + .'- **PrePaid**：包年包月。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'PostPaid', + 'default' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '返回值的语言，取值说明：'."\n" + .'- **zh-CN**（默认值）：中文。'."\n" + .'- **en-US**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群版本。', + 'type' => 'string', + 'required' => false, + 'example' => '3.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '支持的地域列表。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'AvailableZoneList' => [ + 'description' => '支持的可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的可用区列表。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'SupportedMode' => [ + 'description' => '支持的模式列表。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的模式列表。', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'description' => '支持的模式，取值说明：'."\n" + .'- **flexible**：弹性模式。'."\n" + .'- **reserver**：预留模式。', + 'type' => 'string', + 'example' => 'flexible', + ], + 'SupportedSerialList' => [ + 'description' => '支持的系列列表。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的系列列表。', + 'type' => 'object', + 'properties' => [ + 'Serial' => [ + 'description' => '支持的系列，取值说明：'."\n" + .'- **basic**：基础版'."\n" + .'- **cluster**：集群版'."\n" + .'- **mixed_storage**：集群版（新版）'."\n", + 'type' => 'string', + 'example' => 'mixed_storage', + ], + 'SupportedFlexibleResource' => [ + 'description' => '弹性模式支持的资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '弹性模式支持的资源列表。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'description' => '磁盘类型，取值说明：'."\n" + .'- **hdd**：机械硬盘'."\n" + .'- **ssd**：固态硬盘', + 'type' => 'string', + 'example' => 'hdd', + ], + 'SupportedComputeResource' => [ + 'description' => '支持的计算资源。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的计算资源列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "8Core32GB",'."\n" + .' "16Core64GB",'."\n" + .' "16Core64GBNEW",'."\n" + .' "24Core96GBNEW",'."\n" + .' "32Core128GBNEW",'."\n" + .' "48Core192GBNEW",'."\n" + .' "64Core256GBNEW",'."\n" + .' "80Core320GBNEW",'."\n" + .' "96Core384GBNEW",'."\n" + .' "128Core512GBNEW",'."\n" + .' "160Core640GBNEW",'."\n" + .' "192Core768GBNEW",'."\n" + .' "224Core896GBNEW",'."\n" + .' "256Core1024GBNEW",'."\n" + .' "288Core1152GBNEW",'."\n" + .' "320Core1280GBNEW",'."\n" + .' "384Core1536GBNEW",'."\n" + .' "416Core1664GBNEW",'."\n" + .' "448Core1792GBNEW",'."\n" + .' "480Core1920GBNEW",'."\n" + .' "512Core2048GBNEW",'."\n" + .' "576Core2304GBNEW",'."\n" + .' "640Core2560GBNEW",'."\n" + .' "768Core3072GBNEW",'."\n" + .' "800Core3200GBNEW",'."\n" + .' "896Core3584GBNEW",'."\n" + .' "960Core3840GBNEW",'."\n" + .' "1024Core4096GBNEW",'."\n" + .' "1120Core4480GBNEW",'."\n" + .' "1280Core5120GBNEW",'."\n" + .' "1440Core5760GBNEW",'."\n" + .' "1600Core6400GBNEW",'."\n" + .' "1792Core7168GBNEW",'."\n" + .' "1920Core7680GBNEW",'."\n" + .' "2048Core8192GBNEW",'."\n" + .' "2400Core9600GBNEW",'."\n" + .' "2560Core10240GBNEW",'."\n" + .' "2880Core11520GBNEW",'."\n" + .' "3200Core12800GBNEW",'."\n" + .' "4800Core19200GBNEW",'."\n" + .' "5600Core22400GBNEW",'."\n" + .' "6400Core25600GBNEW",'."\n" + .' "8000Core32000GBNEW",'."\n" + .' "8800Core35200GBNEW",'."\n" + .' "9600Core38400GBNEW"'."\n" + .' ]', + ], + ], + 'SupportedStorageResource' => [ + 'description' => '支持的存储资源。', + 'type' => 'array', + 'items' => [ + 'description' => '不涉及。', + 'type' => 'string', + 'example' => '无', + ], + ], + 'SupportedElasticIOResource' => [ + 'description' => '支持的弹性IO资源。', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'description' => '步长。', + 'type' => 'string', + 'example' => '1', + ], + 'MinCount' => [ + 'description' => '最小值。', + 'type' => 'string', + 'example' => '0', + ], + 'MaxCount' => [ + 'description' => '最大值。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + 'SupportedInstanceClassList' => [ + 'description' => '预留模式支持的资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '预留模式支持的资源列表。', + 'type' => 'object', + 'properties' => [ + 'InstanceClass' => [ + 'description' => '支持的规格。', + 'type' => 'string', + 'example' => 'C32', + ], + 'Tips' => [ + 'description' => '规格的描述。', + 'type' => 'string', + 'example' => 'C32', + ], + 'SupportedNodeCountList' => [ + 'description' => '支持的计算节点数。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的计算节点数。', + 'type' => 'object', + 'properties' => [ + 'StorageSize' => [ + 'description' => '支持的存储大小，单位GB。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的存储大小，单位GB。', + 'type' => 'string', + 'example' => '100', + ], + ], + 'NodeCount' => [ + 'description' => '支持的节点数。', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'description' => '步长。', + 'type' => 'string', + 'example' => '1', + ], + 'MinCount' => [ + 'description' => '最小值。', + 'type' => 'string', + 'example' => '1', + ], + 'MaxCount' => [ + 'description' => '最大值。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + 'SupportedExecutorList' => [ + 'description' => '预留参数不涉及。', + 'type' => 'array', + 'items' => [ + 'description' => '预留参数不涉及。', + 'type' => 'object', + 'properties' => [ + 'NodeCount' => [ + 'description' => '节点数详情。', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => '无', + ], + 'MinCount' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => '无', + ], + 'MaxCount' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'SupportedComputeResource' => [ + 'description' => '预留参数不涉及。', + 'type' => 'array', + 'items' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => '无', + ], + ], + 'SupportedStorageResource' => [ + 'description' => '预留参数不涉及。', + 'type' => 'array', + 'items' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => '无', + ], + ], + 'ZoneName' => [ + 'description' => '可用区名称。', + 'type' => 'string', + 'example' => '杭州可用区A', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"AvailableZoneList\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"SupportedMode\\": [\\n {\\n \\"Mode\\": \\"flexible\\",\\n \\"SupportedSerialList\\": [\\n {\\n \\"Serial\\": \\"mixed_storage\\",\\n \\"SupportedFlexibleResource\\": [\\n {\\n \\"StorageType\\": \\"hdd\\",\\n \\"SupportedComputeResource\\": [\\n \\"[\\\\n \\\\\\"8Core32GB\\\\\\",\\\\n \\\\\\"16Core64GB\\\\\\",\\\\n \\\\\\"16Core64GBNEW\\\\\\",\\\\n \\\\\\"24Core96GBNEW\\\\\\",\\\\n \\\\\\"32Core128GBNEW\\\\\\",\\\\n \\\\\\"48Core192GBNEW\\\\\\",\\\\n \\\\\\"64Core256GBNEW\\\\\\",\\\\n \\\\\\"80Core320GBNEW\\\\\\",\\\\n \\\\\\"96Core384GBNEW\\\\\\",\\\\n \\\\\\"128Core512GBNEW\\\\\\",\\\\n \\\\\\"160Core640GBNEW\\\\\\",\\\\n \\\\\\"192Core768GBNEW\\\\\\",\\\\n \\\\\\"224Core896GBNEW\\\\\\",\\\\n \\\\\\"256Core1024GBNEW\\\\\\",\\\\n \\\\\\"288Core1152GBNEW\\\\\\",\\\\n \\\\\\"320Core1280GBNEW\\\\\\",\\\\n \\\\\\"384Core1536GBNEW\\\\\\",\\\\n \\\\\\"416Core1664GBNEW\\\\\\",\\\\n \\\\\\"448Core1792GBNEW\\\\\\",\\\\n \\\\\\"480Core1920GBNEW\\\\\\",\\\\n \\\\\\"512Core2048GBNEW\\\\\\",\\\\n \\\\\\"576Core2304GBNEW\\\\\\",\\\\n \\\\\\"640Core2560GBNEW\\\\\\",\\\\n \\\\\\"768Core3072GBNEW\\\\\\",\\\\n \\\\\\"800Core3200GBNEW\\\\\\",\\\\n \\\\\\"896Core3584GBNEW\\\\\\",\\\\n \\\\\\"960Core3840GBNEW\\\\\\",\\\\n \\\\\\"1024Core4096GBNEW\\\\\\",\\\\n \\\\\\"1120Core4480GBNEW\\\\\\",\\\\n \\\\\\"1280Core5120GBNEW\\\\\\",\\\\n \\\\\\"1440Core5760GBNEW\\\\\\",\\\\n \\\\\\"1600Core6400GBNEW\\\\\\",\\\\n \\\\\\"1792Core7168GBNEW\\\\\\",\\\\n \\\\\\"1920Core7680GBNEW\\\\\\",\\\\n \\\\\\"2048Core8192GBNEW\\\\\\",\\\\n \\\\\\"2400Core9600GBNEW\\\\\\",\\\\n \\\\\\"2560Core10240GBNEW\\\\\\",\\\\n \\\\\\"2880Core11520GBNEW\\\\\\",\\\\n \\\\\\"3200Core12800GBNEW\\\\\\",\\\\n \\\\\\"4800Core19200GBNEW\\\\\\",\\\\n \\\\\\"5600Core22400GBNEW\\\\\\",\\\\n \\\\\\"6400Core25600GBNEW\\\\\\",\\\\n \\\\\\"8000Core32000GBNEW\\\\\\",\\\\n \\\\\\"8800Core35200GBNEW\\\\\\",\\\\n \\\\\\"9600Core38400GBNEW\\\\\\"\\\\n ]\\"\\n ],\\n \\"SupportedStorageResource\\": [\\n \\"无\\"\\n ],\\n \\"SupportedElasticIOResource\\": {\\n \\"Step\\": \\"1\\",\\n \\"MinCount\\": \\"0\\",\\n \\"MaxCount\\": \\"200\\"\\n }\\n }\\n ],\\n \\"SupportedInstanceClassList\\": [\\n {\\n \\"InstanceClass\\": \\"C32\\",\\n \\"Tips\\": \\"C32\\",\\n \\"SupportedNodeCountList\\": [\\n {\\n \\"StorageSize\\": [\\n \\"100\\"\\n ],\\n \\"NodeCount\\": {\\n \\"Step\\": \\"1\\",\\n \\"MinCount\\": \\"1\\",\\n \\"MaxCount\\": \\"200\\"\\n }\\n }\\n ],\\n \\"SupportedExecutorList\\": [\\n {\\n \\"NodeCount\\": {\\n \\"Step\\": \\"无\\",\\n \\"MinCount\\": \\"无\\",\\n \\"MaxCount\\": \\"无\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"SupportedComputeResource\\": [\\n \\"无\\"\\n ],\\n \\"SupportedStorageResource\\": [\\n \\"无\\"\\n ],\\n \\"ZoneName\\": \\"杭州可用区A\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n cn-hangzhou\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n cn-hangzhou-h\\n \\n flexible\\n \\n mixed_storage\\n \\n hdd\\n 32Core128GB\\n \\n 1\\n 0\\n 200\\n \\n \\n \\n C32\\n C32\\n \\n 100\\n \\n 1\\n 1\\n 200\\n \\n \\n \\n \\n \\n \\n","errorExample":""}]', + 'title' => '查询指定可用区资源', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeComputeResource' => [ + 'summary' => '调用DescribeComputeResource接口查询数仓版集群指定地域下的计算资源规格。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群版本。取值：**3.0**。', + 'type' => 'string', + 'required' => false, + 'example' => '3.0', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-f', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'Migrate', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询AnalyticDB MySQL数仓版迁移至AnalyticDB MySQL湖仓版的可用计算资源。取值：'."\n" + .'- **true**'."\n" + .'- **false**（默认值）', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ComputeResource' => [ + 'description' => '计算资源规格列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayValue' => [ + 'description' => '控制台显示的计算资源规格。', + 'type' => 'string', + 'example' => '8 Core 32 GB（单机版）', + ], + 'RealValue' => [ + 'description' => '真实的计算资源规格。', + 'type' => 'string', + 'example' => '8 Core 32 GB', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ComputeResource\\": [\\n {\\n \\"DisplayValue\\": \\"8 Core 32 GB（单机版）\\",\\n \\"RealValue\\": \\"8 Core 32 GB\\"\\n }\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAW\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 8 Core 32 GB（单机版）\\n 8 Core 32 GB\\n \\n 1AD222E9-E606-4A42-BF6D-8A4442913CEAW\\n","errorExample":""}]', + 'title' => '查询物理资源', + ], + 'DescribeEIURange' => [ + 'summary' => '调用DescribeEIURange接口查询数仓版集群可选择的弹性IO资源数量范围。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'- 当**Operation**为**Buy**时，该参数可以为空。'."\n" + .'- 当**Operation**为**Upgrade**或**Downgrade**时，该参数必填。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp16t5ci7r74s****', + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '计算资源规格。'."\n" + .'>您可以调用[DescribeComputeResource](~~469002~~)接口查看计算资源规格。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "RealValue": "32Core128GBNEW",'."\n" + .' "DisplayValue": "32Core128GB"'."\n" + .' }', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '操作类型，取值说明：'."\n" + .'- **Buy**：新购集群。'."\n" + .'- **Modify**：变配集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'Buy', + 'default' => 'buy', + 'enum' => [], + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '集群版本，取值说明：'."\n" + .'- **3.0**（默认值）：数仓版。'."\n" + .'- **5.0**：包括湖仓版、企业版和基础版。', + 'type' => 'string', + 'required' => false, + 'example' => '3.0', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~612293~~)接口查看集群的可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '存储资源规格，默认规格为**8ACU**，取值范围：'."\n" + .'- **8ACU**'."\n" + .'- **12ACU**'."\n" + .'- **16ACU**', + 'type' => 'string', + 'required' => false, + 'example' => '8ACU', + ], + ], + [ + 'name' => 'SubOperation', + 'in' => 'query', + 'schema' => [ + 'description' => '子操作类型，取值说明：'."\n" + .'- **Upgrade**：升配集群。'."\n" + .'- **Downgrade**：降配集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'ProductVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '产品版本：'."\n" + .'- **EnterpriseVersion**：企业版。'."\n" + .'- **BasicVersion**：基础版。', + 'type' => 'string', + 'required' => false, + 'example' => 'EnterpriseVersion', + 'enum' => [ + 'BasicVersion', + 'EnterpriseVersion', + 'basic_version', + 'enterprise_version', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EIUInfo' => [ + 'description' => '弹性IO资源的数量列表。', + 'type' => 'object', + 'properties' => [ + 'EIURange' => [ + 'description' => '弹性IO资源数量的取值范围列表。', + 'type' => 'array', + 'items' => [ + 'description' => '弹性IO资源数量的取值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1,2,3,4,...200', + ], + ], + 'DefaultValue' => [ + 'description' => '弹性IO资源数量的建议取值。', + 'type' => 'string', + 'example' => '2', + ], + 'StorageResourceRange' => [ + 'description' => '预留参数不涉及。', + 'type' => 'array', + 'items' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => 'none', + ], + ], + 'MinValue' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => 'none'."\n", + ], + 'MaxValue' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => 'none'."\n", + ], + 'Step' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => 'none'."\n", + ], + 'DefaultReservedNodeSize' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => 'none', + ], + 'ReservedNodeSizeRange' => [ + 'description' => '预留参数不涉及。', + 'type' => 'array', + 'items' => [ + 'description' => '预留参数不涉及。', + 'type' => 'string', + 'example' => 'none', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ET****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EIUInfo\\": {\\n \\"EIURange\\": [\\n 0\\n ],\\n \\"DefaultValue\\": \\"2\\",\\n \\"StorageResourceRange\\": [\\n \\"none\\"\\n ],\\n \\"MinValue\\": \\"none\\\\n\\",\\n \\"MaxValue\\": \\"none\\\\n\\",\\n \\"Step\\": \\"none\\\\n\\",\\n \\"DefaultReservedNodeSize\\": \\"none\\",\\n \\"ReservedNodeSizeRange\\": [\\n \\"none\\"\\n ]\\n },\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ET****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2\\n \\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n","errorExample":""}]', + 'title' => '查询弹性IO资源数量信息', + ], + 'AttachUserENI' => [ + 'summary' => '为数仓版集群创建VPC弹性网卡，从而打通ADB节点到用户VPC的网络访问。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10760', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'The specified instance state does not support this operation.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '打通用户ENI', + 'description' => '### 使用说明'."\n" + .'该接口仅适用于数仓版弹性模式集群版（新版）。', + ], + 'DetachUserENI' => [ + 'summary' => '调用DetachUserENI接口删除数仓版集群已创建的VPC弹性网卡。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10831', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '关闭用户ENI', + 'description' => '### 使用说明'."\n" + .'该接口仅适用于数仓版弹性模式集群版（新版）。', + ], + 'DescribeKernelVersion' => [ + 'summary' => '调用DescrbeKernelVersion接口查看目标数仓版集群的内核版本信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216345', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> * 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~612293~~)接口查看地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'KernelVersion' => [ + 'description' => '集群内核版本号，例如：**3.1.8**。', + 'type' => 'string', + 'example' => '3.1.8', + ], + 'ExpireDate' => [ + 'description' => '版本维护到期时间，时间格式为yyyy-MM-DD HH:mm:ss。超过此时间后，系统将不再维护该版本，若有问题，请升级到更高版本。', + 'type' => 'string', + 'example' => '2023-06-01T10:36:30Z', + ], + 'AvailableKernelVersions' => [ + 'description' => '当前版本支持升级到的目标版本列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'KernelVersion' => [ + 'description' => '集群内核版本号，例如：**3.1.9**。', + 'type' => 'string', + 'example' => '3.1.9', + ], + 'ReleaseDate' => [ + 'description' => '内核版本的发布时间。时间格式为yyyy-MM-DD HH:mm:ss。', + 'type' => 'string', + 'example' => '2023-06-01T10:36:30Z'."\n", + ], + 'ExpireDate' => [ + 'description' => '版本维护到期时间，时间格式为yyyy-MM-DD HH:mm:ss。超过此时间后，系统将不再维护该版本，若有问题，请升级到更高版本。', + 'type' => 'string', + 'example' => '2024-06-01T10:36:30Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"KernelVersion\\": \\"3.1.8\\",\\n \\"ExpireDate\\": \\"2023-06-01T10:36:30Z\\",\\n \\"AvailableKernelVersions\\": [\\n {\\n \\"KernelVersion\\": \\"3.1.9\\",\\n \\"ReleaseDate\\": \\"2023-06-01T10:36:30Z\\\\n\\",\\n \\"ExpireDate\\": \\"2024-06-01T10:36:30Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群内核版本', + ], + 'UpgradeKernelVersion' => [ + 'summary' => '升级目标AnalyticDB MySQL版集群的内核版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216466', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~612241~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '需要升级到的目标内核版本。'."\n" + .'> 您可以调用**DescribeKernelVersion**接口查询集群支持的内核版本列表。', + 'type' => 'string', + 'required' => false, + 'example' => '3.1.9', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '执行时间，取值：'."\n" + .'* **0**：立即执行，默认值。'."\n" + .'* **1**：在可维护时间段执行。'."\n" + ."\n" + .'> 您可以调用[ModifyDBClusterMaintainTime](~~612236~~)修改集群的可维护时间段。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'The specified instance state does not support this operation.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '升级集群内核版本', + ], + 'MigrateDBCluster' => [ + 'summary' => '调用MigrateDBCluster将数仓版迁移至湖仓版或企业版集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '187415', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '计算预留资源。取值范围：0ACU～4096ACU，步长：16。1 ACU约等于1核4 GB。'."\n" + .'> 参数填写时，需要带单位，仅ProductForm取值为LegacyForm时，填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '32ACU', + ], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + 'schema' => [ + 'description' => '存储预留资源。取值范围：0ACU～2064ACU，步长等于StorageResourceSize参数指定ACU数 * 3 （默认24ACU）。1 ACU约等于1核4 GB。'."\n" + .'> 参数填写时，需要带单位，仅ProductForm取值为LegacyForm时，填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '24ACU', + ], + ], + [ + 'name' => 'StorageResourceSize', + 'in' => 'query', + 'schema' => [ + 'description' => '存储预留资源节点规格，支持8ACU，12ACU，16ACU'."\n" + .'> 参数填写时，需要带单位，仅ProductForm取值为LegacyForm时，填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '8ACU', + ], + ], + [ + 'name' => 'ShardNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分片数。指定迁移同时修改实例分片（Shard）数目。'."\n" + .'> 仅ProductForm取值为LegacyForm时，填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '128', + ], + ], + [ + 'name' => 'ReservedNodeSize', + 'in' => 'query', + 'schema' => [ + 'description' => '存储预留资源节点规格，支持8ACU，12ACU，16ACU'."\n" + .'> 参数填写时，需要带单位，仅ProductForm取值为IntegrationForm时，填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '8ACU', + 'default' => '8ACU', + ], + ], + [ + 'name' => 'ReservedNodeCount', + 'in' => 'query', + 'schema' => [ + 'description' => '预留节点数。 '."\n" + .'- 企业版默认为3节点，步长为3。'."\n" + .'- 基础版默认为1节点。'."\n" + .'> 仅ProductForm取值为IntegrationForm时，填写该参数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'ProductVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '产品版本。取值为：'."\n" + .'- **BasicVersion**：基础版。'."\n" + .'- **EnterpriseVersion**：企业版。'."\n" + .'> 仅ProductForm取值为IntegrationForm时，填写该参数', + 'type' => 'string', + 'required' => false, + 'example' => 'EnterpriseVersion', + ], + ], + [ + 'name' => 'ProductForm', + 'in' => 'query', + 'schema' => [ + 'description' => '产品形态。取值为：'."\n" + .'- **IntegrationForm**：融合形态。'."\n" + .'- **LegacyForm**：湖仓版。', + 'type' => 'string', + 'required' => false, + 'example' => 'LegacyForm', + 'default' => 'LegacyForm', + 'enum' => [ + 'IntegrationForm', + 'LegacyForm', + ], + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区ID。'."\n" + .'> 本参数和ZoneId属性不能相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-h', + ], + ], + [ + 'name' => 'SecondaryVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '备虚拟交换机ID。'."\n" + .'> 本参数和VSwitchId属性不能相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1aadw9k19x451gx****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求, 默认为 false。取值范围：'."\n" + .'- **true**：发送检查请求，检查是否满足迁移要求，并**不会**执行实际执行迁移操作。'."\n" + .'- **false（默认）**：发送正常请求。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'The specified instance state does not support this operation.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\"\\n}","type":"json"}]', + 'title' => '迁移集群', + ], + 'CreateDBResourcePool' => [ + 'summary' => '调用CreateDBResourcePool接口创建资源组。仅适用于AnalyticDB MySQL弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10769', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'- 长度不超过255个字符。'."\n" + .'- 必须以数字、大写字母或小写字母开头。'."\n" + .'- 可包含数字、大写字母、小写字母、中划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL查询的执行模式，取值说明：'."\n" + .'- **batch**：批处理模式。'."\n" + .'- **interactive**（默认值）：交互执行模式。'."\n" + .'> 详情请参见[查询执行模式](~~189502~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'interactive', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => '节点数量，默认节点数0。'."\n" + .'- 1个节点的资源量为16核64 GB。'."\n" + .'- （节点数量*16核64 GB）的资源量不能超过集群总的资源量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4294967296', + 'minimum' => '0', + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '创建资源组', + 'description' => '### 注意事项'."\n" + .'该接口仅适用于32核及以上规格的弹性模式集群版（新版）集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDBResourcePool' => [ + 'summary' => '调用DeleteDBResourcePool接口删除资源组。该接口仅适用于数仓版弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10778', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '删除资源组', + 'description' => '**注意事项**'."\n" + .'- 该接口仅适用于32核及以上规格的弹性模式集群版（新版）集群。'."\n" + .'- 不能删除默认资源组USER_DEFAULT。', + ], + 'ModifyDBResourcePool' => [ + 'summary' => '调用ModifyDBResourcePool接口更新资源组的资源。该接口仅适用于数仓版弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10850', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL查询的执行模式，取值说明：'."\n" + .'- **batch**：批处理模式。'."\n" + .'- **interactive**：交互执行模式。'."\n" + .'> 此参数不填写时，SQL查询的执行模式仍为原值。', + 'type' => 'string', + 'required' => false, + 'example' => 'batch', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => '节点数量。'."\n" + ."\n" + .'- 1个节点的资源量为16核64 GB。'."\n" + .'- 修改的资源量不能超过集群总的资源量。'."\n" + ."\n" + .'> - 此参数不填写时，节点数量仍为原值。'."\n" + .'> - 参数QueryType和NodeNum至少填写一个。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4294967296', + 'minimum' => '0', + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '更新资源组资源', + 'description' => '### 注意事项'."\n" + .'- 该接口仅适用于32核及以上规格的弹性模式集群版（新版）集群。'."\n" + .'- 不支持修改默认资源组USER_DEFAULT的节点数量。', + ], + 'DescribeDBResourcePool' => [ + 'summary' => '调用DescribeDBResourcePool接口查询集群的资源组信息。该接口仅适用于数仓版弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10804', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'USER_DEFAULT', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '资源组', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PoolsInfo' => [ + 'description' => '资源组信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组', + 'type' => 'object', + 'properties' => [ + 'QueryType' => [ + 'description' => 'SQL查询的执行模式，取值说明：'."\n" + .'- **batch**：批查询模式。'."\n" + .'- **interactive**：交互执行模式。'."\n" + ."\n" + .'> 详情请参见[查询执行模式](~~189502~~)。', + 'type' => 'string', + 'example' => 'default_type', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-03-09 16:57:35.241', + ], + 'PoolName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'USER_DEFAULT', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-03-09 16:57:35.241', + ], + 'PoolUsers' => [ + 'description' => '资源组绑定的数据库账号。', + 'type' => 'string', + 'example' => 'testb,testc', + ], + 'NodeNum' => [ + 'description' => '节点数量。'."\n" + .'> 1个节点的资源量为16核64 GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PoolsInfo\\": [\\n {\\n \\"QueryType\\": \\"default_type\\",\\n \\"UpdateTime\\": \\"2022-03-09 16:57:35.241\\",\\n \\"PoolName\\": \\"USER_DEFAULT\\",\\n \\"CreateTime\\": \\"2022-03-09 16:57:35.241\\",\\n \\"PoolUsers\\": \\"testb,testc\\",\\n \\"NodeNum\\": 2\\n }\\n ],\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n default_type\\n 2022-03-09 16:57:35.241\\n USER_DEFAULT\\n 2022-03-09 16:57:35.241\\n testb,testc\\n 2\\n \\n am-bp11q28kvl688****\\n","errorExample":""}]', + 'title' => '查询集群的资源组信息', + 'description' => '### 注意事项'."\n" + .'该接口仅适用于32核及以上规格的弹性模式集群版（新版）集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindDBResourcePoolWithUser' => [ + 'summary' => '调用BindDBResourcePoolWithUser接口将资源组与数据库用户进行绑定。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10761', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'PoolUser', + 'in' => 'query', + 'schema' => [ + 'description' => '需要绑定的数据库账号。既可以绑定数据库普通账号，也可以绑定数据库高权限账号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'accout', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一。大小写敏感、不超过64个ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '将资源组与数据库用户进行绑定', + 'description' => '### 注意事项'."\n" + .'- 该接口仅适用于32核及以上规格的弹性模式集群版（新版）集群。'."\n" + .'- 默认资源组USER_DEFAULT不支持绑定数据库账号。', + ], + 'UnbindDBResourcePoolWithUser' => [ + 'summary' => '调用UnbindDBResourcePoolWithUser接口解绑资源组用户。该接口仅适用于数仓版弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10866', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'PoolUser', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定的数据库账号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'accout', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一。大小写敏感、不超过64个ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '解绑资源组用户', + ], + 'CreateDBResourceGroup' => [ + 'summary' => '调用CreateDBResourceGroup接口为集群创建资源组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136468', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'- 长度不超过255个字符。'."\n" + .'- 必须以数字或大写字母开头。'."\n" + .'- 可包含数字、大写字母、中划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TEST_GROUP', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型，取值说明：'."\n" + .'- **interactive**（默认值）：交互查询模式。'."\n" + .'- **batch**：分批查询模式。'."\n" + .'- **Job**：离线查询模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'interactive', + ], + ], + [ + 'name' => 'MinComputeResource', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '最小计算预留资源，单位为ACU。'."\n" + .'- 当资源组类型为Interactive时，计算预留资源最小为16 ACU。'."\n" + .'- 当资源组类型为Job时，计算预留资源最小为0 ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '0ACU', + ], + ], + [ + 'name' => 'MaxComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '最大计算预留资源，单位为ACU。'."\n" + .'- 当资源组类型为Interactive时，计算预留资源最大为集群当前未分配资源，步长为16 ACU。'."\n" + .'- 当资源组类型为Job时，计算预留资源最大为集群当前未分配资源，步长为8 ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '32ACU', + ], + ], + [ + 'name' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '单个Cluster资源规格，单位为ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '16ACU', + ], + ], + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组内至少需要运行的Cluster个数，最小为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组内最多可以运行的Cluster个数，最大为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组模式，取值：'."\n" + ."\n" + .'- **Disable**（默认）：常规模式。'."\n" + .'- **AutoScale**：自动弹性模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'AutoScale', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB for MySQL引擎。'."\n" + .'- **SparkWarehouse**：SparkWarehouse引擎。', + 'type' => 'string', + 'required' => false, + 'example' => 'AnalyticDB', + ], + ], + [ + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Spark应用配置参数，应用于该资源组执行的所有Spark作业。如需为某个Spark作业单独配置参数，可以在提交作业时通过代码设置。', + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => '节点数量，默认值为0。'."\n" + .'- 1个节点的资源量为16核64 GB。'."\n" + .'- 节点数量不能过大，需满足节点数量*16核64 GB小于等于集群剩余可用资源。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4294967296', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一。大小写敏感、不超过64个ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterStatus', + 'errorMessage' => 'The operation is not permitted due to cluster status.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8\\n","errorExample":""}]', + 'title' => '创建资源组', + 'description' => '适用的产品系列：'."\n" + .'- **企业版**。'."\n" + .'- **基础版**。'."\n" + .'- **湖仓版**。'."\n" + .'- **数仓版弹性模式**：规格需为32核128GB及以上。', + ], + 'BindDBResourceGroupWithUser' => [ + 'summary' => '调用BindDBResourceGroupWithUser接口为数仓版集群的资源组绑定数据库账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136470', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'GroupUser', + 'in' => 'query', + 'schema' => [ + 'description' => '需要绑定的数据库账号。既可以绑定数据库普通账号，也可以绑定数据库高权限账号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'accout', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一。大小写敏感、不超过64个ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UserAndPoolAlreadyBind', + 'errorMessage' => 'The specified user already binds the resource pool.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '将资源组与数据库用户进行绑定', + 'description' => '### 注意事项'."\n" + .'- 该接口仅适用于32核及以上规格的弹性模式集群版（新版）集群。'."\n" + .'- 默认资源组USER_DEFAULT不支持绑定数据库账号。', + ], + 'UnbindDBResourceGroupWithUser' => [ + 'summary' => '调用UnbindDBResourceGroupWithUser接口为数仓版集群的资源组解绑数据库账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136469', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'GroupUser', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定的数据库账号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'accout', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一。大小写敏感、不超过64个ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '解绑资源组和用户', + ], + 'DescribeDBResourceGroup' => [ + 'summary' => '调用DescribeDBResourceGroup接口查询集群的资源组信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136466', + 'abilityTreeNodes' => [ + 'FEATUREadsQ3E0F2', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'USER_DEFAULT', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '资源组', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'GroupsInfo' => [ + 'description' => '资源组信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组', + 'type' => 'object', + 'properties' => [ + 'GroupType' => [ + 'description' => '查询类型，取值说明：'."\n" + .'- **interactive**（默认值）：交互查询模式。'."\n" + .'- **batch**：分批查询模式。'."\n" + .'- **Job**：离线查询模式。', + 'type' => 'string', + 'example' => 'interactive', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-11-09 16:57:35.241', + ], + 'GroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'USER_DEFAULT', + ], + 'MinComputeResource' => [ + 'description' => '最小计算预留资源，单位ACU。'."\n" + .'- 当GroupType为**Interactive**时，计算预留资源最小为16 ACU。'."\n" + .'- 当GroupType为**Job**时，计算预留资源最小为0 ACU。', + 'type' => 'string', + 'example' => '0ACU', + ], + 'MaxComputeResource' => [ + 'description' => '最大计算预留资源，单位ACU。'."\n" + .'- 当GroupType为**Interactive**时，计算预留资源最大为集群当前未分配资源，步长为16 ACU。'."\n" + .'- 当GroupType为**Job**时，计算预留资源最大为集群当前未分配资源，步长为8 ACU。', + 'type' => 'string', + 'example' => '32ACU', + ], + 'ClusterSizeResource' => [ + 'description' => '单个Cluster资源规格，单位为ACU。', + 'type' => 'string', + 'example' => '16ACU', + ], + 'MinClusterCount' => [ + 'description' => '资源组内至少需要运行的Cluster个数，最小为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxClusterCount' => [ + 'description' => '资源组内最多可以运行的Cluster个数，最大为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'RunningClusterCount' => [ + 'description' => '资源组内正在运行的Cluster个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ClusterMode' => [ + 'description' => '资源组模式，取值：'."\n" + ."\n" + .'- **Disable**（默认）：常规模式。'."\n" + .'- **AutoScale**：自动弹性模式。', + 'type' => 'string', + 'example' => 'AutoScale', + ], + 'ElasticMinComputeResource' => [ + 'description' => '最小计算弹性资源，单位为ACU。', + 'type' => 'string', + 'example' => '16ACU', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-10-09 16:57:35.241', + ], + 'GroupUsers' => [ + 'description' => '资源组绑定的数据库账号列表，多个账号以英文逗号（,）分隔。', + 'type' => 'string', + 'example' => 'testb,testc', + ], + 'NodeNum' => [ + 'description' => '节点数量。1个节点的资源量为16核64 GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GroupUserList' => [ + 'description' => '资源组绑定的数据库账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组绑定的数据库账号。', + 'type' => 'string', + 'example' => 'user1', + ], + ], + 'Engine' => [ + 'description' => '资源组引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB for MySQL引擎。'."\n" + .'- **SparkWarehouse**：SparkWarehouse引擎。', + 'type' => 'string', + 'example' => 'AnalyticDB', + ], + 'EngineParams' => [ + 'description' => 'Spark应用配置参数，应用于该资源组执行的所有Spark作业。如需为某个Spark作业单独配置参数，可以在提交作业时通过代码设置。', + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + 'Status' => [ + 'description' => '资源组状态，取值说明：'."\n" + .'- **Pending**：创建中。'."\n" + .'- **Running**：运行中。'."\n" + .'- **Scaling**：变配中。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **Deleted**：已删除。', + 'type' => 'string', + 'example' => 'Running', + ], + 'ConnectionString' => [ + 'description' => '资源组连接地址。'."\n" + ."\n" + .'> 仅Engine为SparkWarehouse时返回该参数。', + 'type' => 'string', + 'example' => 'amv-bp1nw64y******.ads.aliyuncs.com', + ], + 'Port' => [ + 'description' => '资源组端口号。'."\n" + ."\n" + .'> 仅Engine为SparkWarehouse时返回该参数。', + 'type' => 'string', + 'example' => '3306', + ], + ], + ], + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp1ub9grke1****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"GroupsInfo\\": [\\n {\\n \\"GroupType\\": \\"interactive\\",\\n \\"UpdateTime\\": \\"2022-11-09 16:57:35.241\\",\\n \\"GroupName\\": \\"USER_DEFAULT\\",\\n \\"MinComputeResource\\": \\"0ACU\\",\\n \\"MaxComputeResource\\": \\"32ACU\\",\\n \\"ClusterSizeResource\\": \\"16ACU\\",\\n \\"MinClusterCount\\": 1,\\n \\"MaxClusterCount\\": 4,\\n \\"RunningClusterCount\\": 2,\\n \\"ClusterMode\\": \\"AutoScale\\",\\n \\"ElasticMinComputeResource\\": \\"16ACU\\",\\n \\"CreateTime\\": \\"2022-10-09 16:57:35.241\\",\\n \\"GroupUsers\\": \\"testb,testc\\",\\n \\"NodeNum\\": 2,\\n \\"GroupUserList\\": [\\n \\"user1\\"\\n ],\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"EngineParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Status\\": \\"Running\\",\\n \\"ConnectionString\\": \\"amv-bp1nw64y******.ads.aliyuncs.com\\",\\n \\"Port\\": \\"3306\\"\\n }\\n ],\\n \\"DBClusterId\\": \\"am-bp1ub9grke1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n interactive\\n 2022-11-09 16:57:35.241\\n USER_DEFAULT\\n 2022-10-09 16:57:35.241\\n testb,testc\\n 2\\n \\n am-bp1ub9grke1****\\n","errorExample":""}]', + 'title' => '查询数据库资源组信息', + 'description' => '适用的产品系列：'."\n" + .'- **企业版**。'."\n" + .'- **基础版**。'."\n" + .'- **湖仓版**。'."\n" + .'- **数仓版弹性模式**：规格需为32核128GB及以上。', + ], + 'ModifyDBResourceGroup' => [ + 'summary' => '调用ModifyDBResourceGroup接口变更数仓版集群资源组的节点数量或查询模式。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136465', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'MinComputeResource', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '最小计算预留资源。'."\n" + .'- 当资源组类型为Interactive时，计算预留资源最小为16ACU。'."\n" + .'- 当资源组类型为Job时，计算预留资源最小为0ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '0ACU', + ], + ], + [ + 'name' => 'MaxComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '最大计算预留资源。'."\n" + .'- 当资源组类型为Interactive时，计算预留资源最大为集群当前未分配资源，步长为16ACU。'."\n" + .'- 当资源组类型为Job时，计算预留资源最大为集群当前未分配资源，步长为8ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '48ACU', + ], + ], + [ + 'name' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '单个Cluster资源规格，单位为ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '16ACU', + ], + ], + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组内至少需要运行的Cluster个数，最小为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组内最多可以运行的Cluster个数，最大为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组模式，取值：'."\n" + ."\n" + .'- **Disable**（默认）：常规模式。'."\n" + .'- **AutoScale**：自动弹性模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'AutoScale', + ], + ], + [ + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Spark应用配置参数，应用于该资源组执行的所有Spark作业。如需为某个Spark作业单独配置参数，可以在提交作业时通过代码设置。', + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型，取值说明：'."\n" + .'- **interactive**（默认值）：交互查询模式。'."\n" + .'- **batch**：分批查询模式。'."\n" + .'- **Job**：离线查询模式。'."\n" + ."\n" + .'> 详情请参见[查询执行模式](~~189502~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'batch', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => '节点数量，默认值为0。'."\n" + .'- 1个节点的资源量为16核64 GB。'."\n" + .'- 节点数量不能过大，需满足节点数量*16核64 GB小于等于集群剩余可用资源。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4294967296', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'PoolUserList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要绑定的数据库账号列表。既可以绑定数据库普通账号，也可以绑定数据库高权限账号。', + 'type' => 'array', + 'items' => [ + 'description' => '需要绑定的数据库账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一。大小写敏感、不超过64个ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'The specified instance state does not support this operation.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '修改数据库集群资源组', + 'description' => '适用的产品系列：'."\n" + .'- **企业版**。'."\n" + .'- **基础版**。'."\n" + .'- **湖仓版**。'."\n" + .'- **数仓版弹性模式**：规格需为32核128GB及以上，不支持修改默认资源组USER_DEFAULT的节点数量。', + ], + 'DeleteDBResourceGroup' => [ + 'summary' => '调用DeleteDBResourceGroup接口删除数仓版集群的指定资源组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136467', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '删除资源组', + 'description' => '### 注意事项'."\n" + .'- 该接口仅适用于32核及以上规格的弹性模式集群版（新版）集群。'."\n" + .'- 不能删除默认资源组USER_DEFAULT。', + ], + 'DescribeResubmitConfig' => [ + 'summary' => '查询Resubmit配置', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929XXXX', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-8vbyw9awuj141haf9', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'> 您可以调用[DescribeDBResourceGroup](~~459446~~)接口查看指定集群的资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8D217417-BBA7-566C-9B9D-FFCBC86112B0', + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'example' => 'am-8vbyw9awuj141haf9', + ], + 'Rules' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PeakMemory' => [ + 'description' => '峰值内存。', + 'type' => 'string', + 'example' => '32', + ], + 'QueryTime' => [ + 'description' => 'SQL语句执行时长，单位：毫秒（ms）。', + 'type' => 'string', + 'example' => '300', + ], + 'TargetGroupName' => [ + 'description' => '目标资源组名称。', + 'type' => 'string', + 'example' => 'test_target_group', + ], + 'ExceedMemoryException' => [ + 'description' => '是否配置内存溢出异常。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'GroupName' => [ + 'description' => '源资源组名称。', + 'type' => 'string', + 'example' => 'test_group', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D217417-BBA7-566C-9B9D-FFCBC86112B0\\",\\n \\"DBClusterId\\": \\"am-8vbyw9awuj141haf9\\",\\n \\"Rules\\": [\\n {\\n \\"PeakMemory\\": \\"32\\",\\n \\"QueryTime\\": \\"300\\",\\n \\"TargetGroupName\\": \\"test_target_group\\",\\n \\"ExceedMemoryException\\": false,\\n \\"GroupName\\": \\"test_group\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询作业投递规则', + ], + 'ModifyResubmitConfig' => [ + 'summary' => '修改Resubmit配置', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '作业投递规则。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '源资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test2', + ], + 'PeakMemory' => [ + 'description' => '峰值内存。', + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'QueryTime' => [ + 'description' => 'SQL语句执行时长，单位：毫秒（ms）。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + 'ExceedMemoryException' => [ + 'description' => '是否配置内存溢出异常。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'TargetGroupName' => [ + 'description' => '目标资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_target_group', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '修改作业投递规则', + ], + 'ModifySQAConfig' => [ + 'summary' => '修改SQA配置', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQ3E0F2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-8vb369k7zxdt10tz0', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'> 您可以调用[DescribeDBResourceGroup](~~459446~~)接口查看指定集群的资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SQAStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用小查询加速。', + 'type' => 'string', + 'required' => true, + 'example' => 'off', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '494486CE-6F49-574E-B304-29127EA12E36', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"494486CE-6F49-574E-B304-29127EA12E36\\"\\n}","type":"json"}]', + 'title' => '修改作业投递规则', + ], + 'DescribeSQAConfig' => [ + 'summary' => '调用DescribeSQAConfig接口查询集群小查询加速的配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsS1DX44', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看指定数仓版支持的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-8vbyw9awuj141haf9', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'> 您可以调用[DescribeDBResourceGroup](~~612410~~)接口查看指定集群的资源组信息，包括资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBE843D8-964D-5EA3-9D31-822125611B6E', + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域下数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-8vbyw9awuj141haf9', + ], + 'GroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'test_group', + ], + 'SQAStatus' => [ + 'description' => '是否启用小查询加速。', + 'type' => 'string', + 'example' => 'off', + 'enum' => [], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBE843D8-964D-5EA3-9D31-822125611B6E\\",\\n \\"DBClusterId\\": \\"am-8vbyw9awuj141haf9\\",\\n \\"GroupName\\": \\"test_group\\",\\n \\"SQAStatus\\": \\"off\\"\\n}","type":"json"}]', + 'title' => '查询小查询加速配置', + ], + 'CreateElasticPlan' => [ + 'summary' => '调用CreateElasticPlan创建分时弹性计划。该接口仅适用于数仓版弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1d8lbdj22rx****', + ], + ], + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。取值说明：'."\n" + .'- 长度为2~30字符。'."\n" + .'- 由大写字母、小写字母、数字或下划线（_）组成。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ResourcePoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'>您可以调用[DescribeDBResourceGroup](~~466685~~)接口查看资源组名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'realtime', + 'default' => 'USER_DEFAULT', + ], + ], + [ + 'name' => 'ElasticPlanNodeNum', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '弹性计划节点数。'."\n" + ."\n" + .'- 当ElasticPlanType为**worker**时，该参数可以不填写或者填写0。'."\n" + ."\n" + .'- 当ElasticPlanType为**executorcombineworker**或**executor**时，该参数必须填写大于0的数字。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ElasticPlanTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划扩容时间，只支持设置整点时间。格式：HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '08:00:00', + ], + ], + [ + 'name' => 'ElasticPlanTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划还原时间，只支持设置整点时间，与弹性计划扩容时间的间隔不能超过24小时。格式：HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10:00:00', + ], + ], + [ + 'name' => 'ElasticPlanWeeklyRepeat', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '执行弹性计划的周期。0~6表示周日到周六，多个日期用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1,2,3,4,5', + ], + ], + [ + 'name' => 'ElasticPlanMonthlyRepeat', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '执行弹性计划的周期。数字表示每个月的几号，多个日期用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1,15,25', + ], + ], + [ + 'name' => 'ElasticPlanStartDay', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划起始日期，格式：yyyy-MM-dd。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-12-02', + ], + ], + [ + 'name' => 'ElasticPlanEndDay', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划结束日期，格式：yyyy-MM-dd。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-12-09', + ], + ], + [ + 'name' => 'ElasticPlanEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划是否生效，取值说明：'."\n" + ."\n" + .'- **true**（默认值）：生效。'."\n" + ."\n" + .'- **false**：不生效。'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ElasticPlanType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '表示分时弹性计划类型'."\n" + .' ■ ExecutorCombineWorker：计算存储联动变配'."\n" + .' ■ Executor：计算独立弹性'."\n" + .' ■ Worker：存储独立弹性', + 'description' => '弹性计划资源类型，取值说明：'."\n" + ."\n" + .'- **worker**：弹性IO资源单独弹性。'."\n" + .'- **executor**：计算资源单独弹性。'."\n" + .'- **executorcombineworker**（默认值）：计算，弹性IO资源按默认比例弹性。'."\n" + ."\n" + .'> - 如果要使用**executorcombineworker**，集群内核版本需为3.1.3.2及以上版本。'."\n" + .'> - 如果要使用**worker**或**executor**，集群内核版本需为3.1.6.1及以上版本，且需要通过提交工单申请。申请通过后，才能使用**worker**或**executor**。', + 'type' => 'string', + 'required' => false, + 'example' => 'worker', + ], + ], + [ + 'name' => 'ElasticPlanWorkerSpec', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '表示存储独立弹性时worker垂直变配到哪种规格', + 'description' => '弹性计划支持扩容的资源规格。取值说明：'."\n" + .'- 8 Core 64 GB（默认规格）'."\n" + .'- 16 Core 64 GB'."\n" + .'- 32 Core 64 GB'."\n" + .'- 64 Core 128 GB'."\n" + .'- 12 Core 96 GB'."\n" + .'- 24 Core 96 GB'."\n" + .'- 52 Core 86 GB', + 'type' => 'string', + 'required' => false, + 'example' => '32 Core 64 GB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '创建分时弹性计划', + 'description' => '### 使用说明'."\n" + .'该接口仅适用于数仓版弹性模式集群版（新版）32核及以上规格的集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteElasticPlan' => [ + 'summary' => '调用DeleteElasticPlan接口删除分时弹性计划。该接口仅适用于数仓版弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~612241~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。'."\n" + .'> 调用[DescribeElasticPlan](~~612271~~)接口可以查看集群的弹性计划名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A4442913CEF","errorExample":""}]', + 'title' => '删除分时弹性计划', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyElasticPlan' => [ + 'summary' => '调用ModifyElasticPlan修改分时弹性计划。该接口仅适用于数仓版弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1rqvm70uh2v****', + ], + ], + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称，取值说明：'."\n" + ."\n" + .'- 长度为2~30字符。'."\n" + .'- 由大写字母、小写字母、数字或下划线（_）组成。'."\n" + .'>您可以调用[DescribeElasticPlan](~~190596~~)接口查看指定集群下所有弹性计划的详细信息，包括弹性计划名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'realtime', + ], + ], + [ + 'name' => 'ResourcePoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'>您可以调用[DescribeDBResourceGroup](~~466685~~)接口查看资源组名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test', + 'default' => 'USER_DEFAULT', + ], + ], + [ + 'name' => 'ElasticPlanNodeNum', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '弹性计划节点数。'."\n" + ."\n" + .'- 当ElasticPlanType为**worker**时，该参数可以不填写或者填写0。'."\n" + ."\n" + .'- 当ElasticPlanType为**executorcombineworker**或**executor**时，该参数必须填写大于0的数字。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'ElasticPlanTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划扩容时间，只支持设置整点时间。格式：HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '8:00:00', + ], + ], + [ + 'name' => 'ElasticPlanTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划还原时间，只支持设置整点时间，与弹性计划扩容时间的间隔不能超过24小时。格式：HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '10:00:00', + ], + ], + [ + 'name' => 'ElasticPlanWeeklyRepeat', + 'in' => 'query', + 'schema' => [ + 'description' => '执行弹性计划的周期。0~6表示周日到周六，多个日期用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3,4,5', + ], + ], + [ + 'name' => 'ElasticPlanMonthlyRepeat', + 'in' => 'query', + 'schema' => [ + 'description' => '执行弹性计划的周期。数字表示每个月的几号，多个日期用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '1,15,25', + ], + ], + [ + 'name' => 'ElasticPlanStartDay', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划起始日期，格式：yyyy-MM-dd。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-02', + ], + ], + [ + 'name' => 'ElasticPlanEndDay', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划结束日期，格式：yyyy-MM-dd。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-09', + ], + ], + [ + 'name' => 'ElasticPlanEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划是否生效，取值说明：'."\n" + ."\n" + .'- **true**（默认值）：生效。'."\n" + .'- **false**：不生效。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ElasticPlanType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '弹性计划资源类型，取值说明：'."\n" + ."\n" + .'- **worker**：弹性IO资源单独弹性。'."\n" + .'- **executor**：计算资源单独弹性。'."\n" + .'- **executorcombineworker**（默认值）：计算，弹性IO资源按默认比例弹性。'."\n" + ."\n" + .'> - 如果要使用**executorcombineworker**，集群内核版本需为3.1.3.2及以上版本。'."\n" + .'> - 如果要使用**worker**或**executor**，集群内核版本需为3.1.6.1及以上版本，且需要通过提交工单申请。申请通过后，才能使用**worker**或**executor**。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'worker', + ], + ], + [ + 'name' => 'ElasticPlanWorkerSpec', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '弹性计划支持扩容的资源规格，取值说明：'."\n" + ."\n" + .'- 8 Core 64 GB（默认规格）'."\n" + ."\n" + .'- 16 Core 64 GB'."\n" + ."\n" + .'- 32 Core 64 GB'."\n" + ."\n" + .'- 64 Core 128 GB'."\n" + ."\n" + .'- 12 Core 96 GB'."\n" + ."\n" + .'- 24 Core 96 GB'."\n" + ."\n" + .'- 52 Core 86 GB', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '16 Core 64 GB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ElasticPlanParameterError', + 'errorMessage' => 'The specified elastic plan parameter is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '修改分时弹性计划', + 'description' => '该接口仅适用于数仓版弹性模式集群版（新版）32核及以上规格的集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeElasticDailyPlan' => [ + 'summary' => '调用DescribeElasticDailyPlan接口查询分时弹性计划日计划执行信息。该接口仅适用于数仓版弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。取值说明：'."\n" + .'- 长度为2~30字符。'."\n" + .'- 由大写字母、小写字母、数字或下划线（_）组成。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'realtimeplan', + ], + ], + [ + 'name' => 'ResourcePoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'>您可以调用[DescribeDBResourceGroup](~~466685~~)接口查看资源组名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ElasticDailyPlanDay', + 'in' => 'query', + 'schema' => [ + 'description' => '当天弹性计划的起始日期，格式：yyyy-MM-dd。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-12-02', + ], + ], + [ + 'name' => 'ElasticDailyPlanStatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '当天弹性计划执行状态，同时查询多个状态用半角逗号（,）分隔，取值说明：'."\n" + .'- **1**：未执行。'."\n" + .'- **2**：执行中。'."\n" + .'- **3**：执行成功。'."\n" + .'- **4**：执行失败。'."\n" + ."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'ElasticDailyPlanList' => [ + 'description' => '当天弹性计划的信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '当天弹性计划执行状态，同时查询多个状态用半角逗号（,）分隔，取值说明：'."\n" + .'- **1**：未执行。'."\n" + .'- **2**：执行中。'."\n" + .'- **3**：执行成功。'."\n" + .'- **4**：执行失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Day' => [ + 'description' => '当天弹性计划的起始日期，格式：yyyy-MM-dd。', + 'type' => 'string', + 'example' => '2022-12-02', + ], + 'ResourcePoolName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'StartTs' => [ + 'description' => '实际扩容时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', + 'type' => 'string', + 'example' => '2022-12-02 16:00:00', + ], + 'PlanEndTs' => [ + 'description' => '计划还原时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', + 'type' => 'string', + 'example' => '2022-12-02 16:00:00', + ], + 'PlanStartTs' => [ + 'description' => '计划扩容时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', + 'type' => 'string', + 'example' => '2022-12-02 15:00:00', + ], + 'ElasticNodeNum' => [ + 'description' => '弹性计划节点数。'."\n" + ."\n" + .'- 当ElasticPlanType为**worker**时，该参数不返回或返回结果为0。'."\n" + ."\n" + .'- 当ElasticPlanType为**executorcombineworker**或**executor**时，该参数返回结果为大于0的数字。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EndTs' => [ + 'description' => '实际还原时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', + 'type' => 'string', + 'example' => '2022-12-02 16:00:00', + ], + 'PlanName' => [ + 'description' => '弹性计划名称。', + 'type' => 'string', + 'example' => 'realtimeplan', + ], + 'ElasticPlanType' => [ + 'description' => '弹性计划资源类型，取值说明：'."\n" + ."\n" + .'- **worker**：弹性IO资源单独弹性。'."\n" + ."\n" + .'- **executor**：计算资源单独弹性。'."\n" + ."\n" + .'- **executorcombineworker**（默认值）：计算，弹性IO资源按默认比例弹性。', + 'type' => 'string', + 'example' => 'worker', + ], + 'ElasticPlanWorkerSpec' => [ + 'description' => '弹性计划支持扩容的资源规格。取值说明：'."\n" + ."\n" + .'- 8 Core 64 GB（默认规格）'."\n" + ."\n" + .'- 16 Core 64 GB'."\n" + ."\n" + .'- 32 Core 64 GB'."\n" + ."\n" + .'- 64 Core 128 GB'."\n" + ."\n" + .'- 12 Core 96 GB'."\n" + ."\n" + .'- 24 Core 96 GB'."\n" + ."\n" + .'- 52 Core 86 GB', + 'type' => 'string', + 'example' => '16 Core 64 GB', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"ElasticDailyPlanList\\": [\\n {\\n \\"Status\\": 3,\\n \\"Day\\": \\"2022-12-02\\",\\n \\"ResourcePoolName\\": \\"test\\",\\n \\"StartTs\\": \\"2022-12-02 16:00:00\\",\\n \\"PlanEndTs\\": \\"2022-12-02 16:00:00\\",\\n \\"PlanStartTs\\": \\"2022-12-02 15:00:00\\",\\n \\"ElasticNodeNum\\": 0,\\n \\"EndTs\\": \\"2022-12-02 16:00:00\\",\\n \\"PlanName\\": \\"realtimeplan\\",\\n \\"ElasticPlanType\\": \\"worker\\",\\n \\"ElasticPlanWorkerSpec\\": \\"16 Core 64 GB\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n 3\\n 2022-12-02\\n test\\n 2022-12-02 16:00:00\\n 2022-12-02 16:00:00\\n 2022-12-02 15:00:00\\n 1\\n 2022-12-02 16:00:00\\n realtimeplan\\n worker\\n 16 Core 64 GB\\n \\n","errorExample":""}]', + 'title' => '查询分时弹性计划日计划执行信息', + 'description' => '### 使用说明'."\n" + .'该接口仅适用于数仓版弹性模式集群版（新版）32核及以上规格的集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeElasticPlan' => [ + 'summary' => '调用DescribeElasticPlan接口查询弹性计划。该接口仅适用于数仓版弹性模式集群版（新版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp278jg9****', + ], + ], + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称，取值说明：'."\n" + .'- 长度为2~30字符。'."\n" + .'- 由大写字母、小写字母、数字或下划线（_）组成。'."\n" + .'>不填写该参数时，返回指定集群下所有弹性计划的详细信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'realtime', + ], + ], + [ + 'name' => 'ResourcePoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'>- 您可以调用[DescribeDBResourceGroup](~~466685~~)接口查看资源组名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'USER_DEFAULT', + ], + ], + [ + 'name' => 'ElasticPlanEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划是否生效，取值说明：'."\n" + .'- **true**（默认值）：生效。'."\n" + .'- **false**：不生效。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'ElasticPlanList' => [ + 'description' => '弹性计划列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '弹性计划还原时间，与弹性计划扩容时间的间隔不能超过24小时。格式：HH:mm:ss。', + 'type' => 'string', + 'example' => '10:00:00', + ], + 'WeeklyRepeat' => [ + 'description' => '执行弹性计划的周期。0～6表示周日到周六，多个日期用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '3,4,5,6', + ], + 'MonthlyRepeat' => [ + 'description' => '执行弹性计划的周期。表示每个月的几号，多个日期用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '1,15,25', + ], + 'StartTime' => [ + 'description' => '弹性计划扩容时间，格式：HH:mm:ss。', + 'type' => 'string', + 'example' => '08:00:00', + ], + 'ResourcePoolName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'USER_DEFAULT', + ], + 'StartDay' => [ + 'description' => '弹性计划起始日期，只有设置了弹性计划起始日期才会返回参数值。格式：yyyy-MM-dd。', + 'type' => 'string', + 'example' => '2022-12-02', + ], + 'ElasticNodeNum' => [ + 'description' => '弹性计划节点数。'."\n" + ."\n" + .'- 当ElasticPlanType为**worker**时，该参数不返回或返回结果为0。'."\n" + ."\n" + .'- 当ElasticPlanType为**executorcombineworker**或**executor**时，该参数返回结果为大于0的数字。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Enable' => [ + 'description' => '弹性计划是否生效，取值说明：'."\n" + .'- **true**（默认值）：生效。'."\n" + .'- **false**：不生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EndDay' => [ + 'description' => '弹性计划结束日期，只有设置了弹性计划结束日期才会返回参数值。格式：yyyy-MM-dd。', + 'type' => 'string', + 'example' => '2022-12-09', + ], + 'PlanName' => [ + 'description' => '弹性计划名称。', + 'type' => 'string', + 'example' => 'realtime', + ], + 'ElasticPlanType' => [ + 'description' => '弹性计划资源类型，取值说明：'."\n" + ."\n" + .'- **worker**：弹性IO资源单独弹性。'."\n" + .'- **executor**：计算资源单独弹性。'."\n" + .'- **executorcombineworker**（默认值）：计算，弹性IO资源按默认比例弹性。', + 'type' => 'string', + 'example' => 'worker', + ], + 'ElasticPlanWorkerSpec' => [ + 'description' => '弹性计划支持扩容的资源规格，取值说明：'."\n" + ."\n" + .'- 8 Core 64 GB（默认规格）'."\n" + ."\n" + .'- 16 Core 64 GB'."\n" + ."\n" + .'- 32 Core 64 GB'."\n" + ."\n" + .'- 64 Core 128 GB'."\n" + ."\n" + .'- 12 Core 96 GB'."\n" + ."\n" + .'- 24 Core 96 GB'."\n" + ."\n" + .'- 52 Core 86 GB', + 'type' => 'string', + 'example' => '16 Core 64 GB', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"ElasticPlanList\\": [\\n {\\n \\"EndTime\\": \\"10:00:00\\",\\n \\"WeeklyRepeat\\": \\"3,4,5,6\\",\\n \\"MonthlyRepeat\\": \\"1,15,25\\",\\n \\"StartTime\\": \\"08:00:00\\",\\n \\"ResourcePoolName\\": \\"USER_DEFAULT\\",\\n \\"StartDay\\": \\"2022-12-02\\",\\n \\"ElasticNodeNum\\": 0,\\n \\"Enable\\": true,\\n \\"EndDay\\": \\"2022-12-09\\",\\n \\"PlanName\\": \\"realtime\\",\\n \\"ElasticPlanType\\": \\"worker\\",\\n \\"ElasticPlanWorkerSpec\\": \\"16 Core 64 GB\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n 10:00:00\\n 3,4,5,6\\n 08:00:00\\n USER_DEFAULT\\n 2022-12-02\\n 0\\n true\\n 2022-12-09\\n realtime\\n WORKER\\n 16 Core 64 GB\\n \\n","errorExample":""}]', + 'title' => '查询弹性计划', + 'description' => '### 使用说明'."\n" + .'该接口仅适用于数仓版弹性模式集群版（新版）32核及以上规格的集群。', + ], + 'DescribeTables' => [ + 'summary' => '调用DescribeTables接口枚举实例指定数据库下所有表列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'adb_demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => '表列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp1r053byu48p****', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"DBClusterId\\": \\"am-bp1r053byu48p****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取表信息列表', + ], + 'DescribeAllDataSource' => [ + 'summary' => '枚举实例下所有数据库列表、表列表和列列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~612241~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1pke2pcfavw****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', + ], + 'Tables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => '表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '表列表。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp1pke2pcfavw****', + ], + 'SchemaName' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + 'Columns' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列数据类型。', + 'type' => 'string', + 'example' => 'bigint', + ], + 'ColumnName' => [ + 'description' => '列名', + 'type' => 'string', + 'example' => 'id', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'AutoIncrementColumn' => [ + 'description' => '列是否自增，取值说明：'."\n" + .'- **true**：自增。'."\n" + .'- **false**：不自增。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp1pke2pcfavw****', + ], + 'PrimaryKey' => [ + 'description' => '列是否为主键，取值说明：'."\n" + .'- **true**：主键。'."\n" + .'- **false**：非主键。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + 'Schemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => '数据库信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库列表。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp1pke2pcfavw****', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"Tables\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"DBClusterId\\": \\"am-bp1pke2pcfavw****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n },\\n \\"Columns\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"bigint\\",\\n \\"ColumnName\\": \\"id\\",\\n \\"TableName\\": \\"test\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"am-bp1pke2pcfavw****\\",\\n \\"PrimaryKey\\": false,\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n },\\n \\"Schemas\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp1pke2pcfavw****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '枚举数据库列表', + ], + 'DescribeSchemas' => [ + 'summary' => '调用DescribeSchemas接口枚举实例下所有数据库列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp1xxxxxxxx47', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp1xxxxxxxx47\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n am-bp1xxxxxxxx47\\n adb_demo\\n \\n","errorExample":""}]', + 'title' => '枚举实例下所有数据库列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTableDetail' => [ + 'summary' => '调用DescribeTableDetail接口查看表在每个Shard的数据分布情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10825', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口可以查询集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~612393~~)接口可以查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AvgSize' => [ + 'description' => '平均分区行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'description' => '分区列表。', + 'type' => 'object', + 'properties' => [ + 'Shard' => [ + 'description' => '分区列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '表大小，行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Id' => [ + 'description' => '分区号（只返回分区名数字部分）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AvgSize\\": 0,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Shard\\": [\\n {\\n \\"Size\\": 0,\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0\\n1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n\\n \\n 0\\n 1\\n \\n \\n 0\\n 2\\n \\n \\n 0\\n 3\\n \\n \\n 0\\n 4\\n \\n \\n 0\\n 5\\n \\n \\n 0\\n 6\\n \\n \\n 0\\n 7\\n \\n \\n 0\\n 8\\n \\n \\n 0\\n 9\\n \\n \\n 0\\n 10\\n \\n \\n 0\\n 11\\n \\n \\n 0\\n 12\\n \\n \\n 0\\n 13\\n \\n \\n 0\\n 14\\n \\n \\n 0\\n 15\\n \\n \\n 0\\n 16\\n \\n","errorExample":""}]', + 'title' => '查询表详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeProcessList' => [ + 'summary' => '调用DescribeProcessList接口查看实例正在运行的查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'ShowFull', + 'in' => 'query', + 'schema' => [ + 'description' => '是否展示完整的SQL语句。取值说明：'."\n" + .'- **True**：展示完整的SQL语句。'."\n" + .'- **False**：只展示SQL语句的前100个字符。'."\n" + ."\n" + .'> 默认值False。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + [ + 'name' => 'RunningTime', + 'in' => 'query', + 'schema' => [ + 'description' => '按运行时间过滤，展示大于该运行时间的查询。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '按用户名过滤。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤关键字，目前仅支持过滤**SELECT**。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定字段排序，JSON格式，`[{"Field":"Time","Type":"Desc" },{ "Field":"User", "Type":"Asc" }]`，取值说明：'."\n" + .'- **Field**：需要排序的字段名，支持Time，User，Host，DB字段。'."\n" + .'- **Type**：排序类型，**Desc**为降序，**Asc**为升序。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Field":"Time","Type":"Desc" }, { "Field":"User", "Type":"Asc" }]', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '总页数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Process' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '任务的开始时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2020-11-19T02:48:15Z', + ], + 'Time' => [ + 'description' => '查询任务已运行时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'ProcessId' => [ + 'description' => '任务的唯一标识，KILL PROCESS时使用。', + 'type' => 'string', + 'example' => '202011191048151921681492420315100****', + ], + 'Host' => [ + 'description' => '发起查询的IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX:12308', + ], + 'DB' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'Command' => [ + 'description' => '命令类型，仅支持SELECT类型。', + 'type' => 'string', + 'example' => 'SELECT', + ], + 'User' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test', + ], + 'Id' => [ + 'description' => '工作线程ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '49104', + ], + 'Info' => [ + 'description' => '正在运行的SQL语句，默认返回前100字符。当传入参数ShowFull为True时，显示全文。', + 'type' => 'string', + 'example' => 'select * from sbtest1,sbtest2,sbtest3,sbtest4', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectModuleVersion', + 'errorMessage' => 'The specified module version does not support this operation.', + ], + [ + 'errorCode' => 'AnalyticDBKernelError', + 'errorMessage' => 'Calling AnalyticDB Kernel error', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Process\\": [\\n {\\n \\"StartTime\\": \\"2020-11-19T02:48:15Z\\",\\n \\"Time\\": 11,\\n \\"ProcessId\\": \\"202011191048151921681492420315100****\\",\\n \\"Host\\": \\"192.168.XX.XX:12308\\",\\n \\"DB\\": \\"adb_demo\\",\\n \\"Command\\": \\"SELECT\\",\\n \\"User\\": \\"test\\",\\n \\"Id\\": 49104,\\n \\"Info\\": \\"select * from sbtest1,sbtest2,sbtest3,sbtest4\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 30\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n 1\\n \\n 2020-11-19T02:48:15Z\\n \\n 202011191048151921681492420315100****\\n 192.168.XX.XX:12308\\n adb_demo\\n SELECT\\n test\\n 49104\\n select * from sbtest1,sbtest2,sbtest3,sbtest4\\n \\n","errorExample":""}]', + 'title' => '查看集群正在运行的查询', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeColumns' => [ + 'summary' => '调用DescribeColumns接口枚举实例下指定表格的列列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => '列列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列数据类型。', + 'type' => 'string', + 'example' => 'bigint', + ], + 'ColumnName' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'id', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'AutoIncrementColumn' => [ + 'description' => '是否自增。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'am-bp1xxxxxxxx47', + ], + 'PrimaryKey' => [ + 'description' => '是否主键。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"bigint\\",\\n \\"ColumnName\\": \\"id\\",\\n \\"TableName\\": \\"test\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"am-bp1xxxxxxxx47\\",\\n \\"PrimaryKey\\": false,\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n\\n \\n test\\n id\\n bigint\\n true\\n am-bp1xxxxxxxx47\\n false\\n adb_demo\\n \\n \\n test\\n name\\n varchar\\n false\\n am-bp1xxxxxxxx47\\n false\\n adb_demo\\n \\n \\n test\\n value\\n int\\n false\\n am-bp1xxxxxxxx47\\n false\\n adb_demo\\n \\n \\n test\\n ts\\n timestamp\\n false\\n am-bp1xxxxxxxx47\\n false\\n adb_demo\\n \\n","errorExample":""}]', + 'title' => '枚举实例下指定表格的列列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTaskInfo' => [ + 'summary' => '调用DescribeTaskInfo接口查看相关管控任务流进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hongkong', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '225685759', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskInfo' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态：'."\n" + ."\n" + .'- Waiting：等待中'."\n" + .'- Running：执行中'."\n" + .'- Finished：已结束'."\n" + .'- Failed：失败'."\n" + .'- Closed：已关闭'."\n" + .'- Cancel：已取消'."\n" + .'- Retry：重试'."\n" + .'- Pause：暂停'."\n" + .'- Stop：中断', + 'type' => 'string', + 'example' => 'Finished', + ], + 'FinishTime' => [ + 'description' => '结束时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2020-01-07T08:08:50Z', + ], + 'Progress' => [ + 'description' => '进度，单位：百分比（%）。', + 'type' => 'string', + 'example' => '100', + ], + 'BeginTime' => [ + 'description' => '开始时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2020-01-07T07:39:56Z', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '225685759', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"Finished\\",\\n \\"FinishTime\\": \\"2020-01-07T08:08:50Z\\",\\n \\"Progress\\": \\"100\\",\\n \\"BeginTime\\": \\"2020-01-07T07:39:56Z\\",\\n \\"TaskId\\": 225685759\\n },\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '查询相关管控任务流进度', + ], + 'DescribeSQLPlan' => [ + 'summary' => '调用DescribeSQLPlan接口查询目标SQL，例如查询语句或ETL（Extract Transform Load）任务语句的计划信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-****************', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。'."\n" + .'> 您可以调用[DescribeProcessList](~~612277~~)接口查看目标SQL的任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '202105271604431720161662490345*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '22D6DEF0-CBC7-4388-A41C-D5FD62******', + ], + 'StageList' => [ + 'description' => '计划阶段的信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'State' => [ + 'description' => '该计划阶段的最终执行状态，取值范围如下：'."\n" + .'* FINISHED：完成。'."\n" + .'* CANCELED：取消。'."\n" + .'* ABORTED：中止。'."\n" + .'* FAILED：失败。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'CPUTimeAvg' => [ + 'description' => '该阶段的`CPU Time`在各个计算节点的平均值，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5984', + ], + 'CPUTimeMax' => [ + 'description' => '该阶段的`CPU Time`在各个计算节点的最大值，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5984', + ], + 'OperatorCost' => [ + 'description' => '该阶段内部总的算子耗时，等同于该阶段的CPU Time，可用于判断查询哪些部分消耗了较多的计算资源。单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5984', + ], + 'ScanTimeMax' => [ + 'description' => '带数据扫描算子的阶段在各个存储节点读取数据耗时的最大值，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InputSizeMax' => [ + 'description' => '阶段在各个计算节点的输入数据量的最大值，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173', + ], + 'StageId' => [ + 'description' => '阶段ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScanSizeMax' => [ + 'description' => '带数据扫描算子的阶段在各个存储节点的扫描数据量的最大值，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CPUTimeMin' => [ + 'description' => '该阶段的`CPU Time`在各个计算节点的最小值，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '47', + ], + 'ScanTimeMin' => [ + 'description' => '带数据扫描算子的阶段在各个存储节点读取数据耗时的最小值，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScanSizeMin' => [ + 'description' => '带数据扫描算子的阶段在各个存储节点的扫描数据量的最小值，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InputSizeMin' => [ + 'description' => '阶段在各个计算节点的输入数据量的最小值，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173', + ], + 'PeakMemory' => [ + 'description' => '执行目标SQL时的峰值内存，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74208', + ], + 'ScanTimeAvg' => [ + 'description' => '带数据扫描算子的阶段在各个存储节点读取数据耗时的平均值，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScanSizeAvg' => [ + 'description' => '带数据扫描算子的阶段在各个存储节点的扫描数据量的平均值，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InputSizeAvg' => [ + 'description' => '阶段在各个计算节点的输入数据量的平均值，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173', + ], + ], + ], + ], + 'OriginInfo' => [ + 'description' => 'SQL Plan的详细原始数据。', + 'type' => 'string', + 'example' => '{\\"queryId\\":\\"20210527_160443_10581_hdhzr\\",\\"session\\":{\\"queryId\\":\\"20210527_160443_10581_hdhzr\\",\\"hasSharedStage\\":false,\\"parentId\\":0}}', + ], + 'Detail' => [ + 'description' => '目标SQL的详细执行信息。', + 'type' => 'object', + 'properties' => [ + 'SQL' => [ + 'description' => 'SQL语句。', + 'type' => 'string', + 'example' => 'INSERT OVERWRITE INTO hdfs_import_external\\nSELECT *\\nFROM adb_hdfs_import_source', + ], + 'OutputSize' => [ + 'description' => '目标SQL语句的总输出数据量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'State' => [ + 'description' => '目标SQL语句的最终执行状态，取值范围如下：'."\n" + .'* FINISHED：完成。'."\n" + .'* FAILED ：失败。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'OutputRows' => [ + 'description' => '目标SQL的总输出行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'User' => [ + 'description' => '提交目标SQL语句的用户名。', + 'type' => 'string', + 'example' => 'test_acc', + ], + 'StartTime' => [ + 'description' => '目标SQL语句的执行开始时间，格式为Unix时间戳，单位为毫秒。', + 'type' => 'string', + 'example' => '1622102683243', + ], + 'TotalStage' => [ + 'description' => '目标SQL中包含的总阶段个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'QueuedTime' => [ + 'description' => '执行目标SQL的排队时间，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalTime' => [ + 'description' => '目标SQL的执行总耗时，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2340', + ], + 'TotalTask' => [ + 'description' => '目标SQL中包含的总任务个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Database' => [ + 'description' => '执行目标SQL的数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'PeakMemory' => [ + 'description' => '执行目标SQL时的峰值内存，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '441802', + ], + 'ClientIP' => [ + 'description' => '提交目标SQL语句的客户端IP地址。', + 'type' => 'string', + 'example' => '172.16.***.***', + ], + 'PlanningTime' => [ + 'description' => '执行目标SQL时生成执行计划的时间，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '86', + ], + 'CPUTime' => [ + 'description' => '执行目标SQL时，算子处理数据单元的总耗时，是多服务器多线程上的累计值。单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6100', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"22D6DEF0-CBC7-4388-A41C-D5FD62******\\",\\n \\"StageList\\": [\\n {\\n \\"State\\": \\"FINISHED\\",\\n \\"CPUTimeAvg\\": 5984,\\n \\"CPUTimeMax\\": 5984,\\n \\"OperatorCost\\": 5984,\\n \\"ScanTimeMax\\": 0,\\n \\"InputSizeMax\\": 173,\\n \\"StageId\\": 1,\\n \\"ScanSizeMax\\": 0,\\n \\"CPUTimeMin\\": 47,\\n \\"ScanTimeMin\\": 0,\\n \\"ScanSizeMin\\": 0,\\n \\"InputSizeMin\\": 173,\\n \\"PeakMemory\\": 74208,\\n \\"ScanTimeAvg\\": 0,\\n \\"ScanSizeAvg\\": 0,\\n \\"InputSizeAvg\\": 173\\n }\\n ],\\n \\"OriginInfo\\": \\"{\\\\\\\\\\\\\\"queryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20210527_160443_10581_hdhzr\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"session\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"queryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20210527_160443_10581_hdhzr\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hasSharedStage\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"parentId\\\\\\\\\\\\\\":0}}\\",\\n \\"Detail\\": {\\n \\"SQL\\": \\"INSERT OVERWRITE INTO hdfs_import_external\\\\\\\\nSELECT *\\\\\\\\nFROM adb_hdfs_import_source\\",\\n \\"OutputSize\\": 9,\\n \\"State\\": \\"FINISHED\\",\\n \\"OutputRows\\": 1,\\n \\"User\\": \\"test_acc\\",\\n \\"StartTime\\": \\"1622102683243\\",\\n \\"TotalStage\\": 4,\\n \\"QueuedTime\\": 0,\\n \\"TotalTime\\": 2340,\\n \\"TotalTask\\": 4,\\n \\"Database\\": \\"adb_demo\\",\\n \\"PeakMemory\\": 441802,\\n \\"ClientIP\\": \\"172.16.***.***\\",\\n \\"PlanningTime\\": 86,\\n \\"CPUTime\\": 6100\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 22D6DEF0-CBC7-4388-A41C-D5FD62******\\n \\n 0\\n 0\\n 0\\n 264960\\n 47\\n 0\\n 0\\n 1023\\n 1023\\n 1023\\n 0\\n FINISHED\\n 47\\n 0\\n 47\\n 47\\n \\n \\n 0\\n 0\\n 1\\n 74208\\n 5984\\n 0\\n 0\\n 173\\n 173\\n 173\\n 0\\n FINISHED\\n 5984\\n 0\\n 5984\\n 5984\\n \\n \\n 0\\n 0\\n 2\\n 102634\\n 18\\n 0\\n 0\\n 173\\n 173\\n 173\\n 0\\n FINISHED\\n 18\\n 0\\n 18\\n 18\\n \\n \\n 36\\n 36\\n 3\\n 0\\n 51\\n 10\\n 10\\n 36\\n 36\\n 36\\n 36\\n FINISHED\\n 51\\n 10\\n 51\\n 51\\n \\n {\\"queryId\\":\\"20210527_160443_10581_hdhzr\\",\\"session\\":{\\"queryId\\":\\"20210527_160443_10581_hdhzr\\",\\"hasSharedStage\\":false,\\"parentId\\":0}}\\n \\n 4\\n 9\\n test_acc\\n 4\\n 441802\\n 1622102683243\\n 172.16.***.***\\n INSERT OVERWRITE INTO hdfs_import_external\\nSELECT *\\nFROM adb_hdfs_import_source\\n 6100\\n 0\\n FINISHED\\n adb_demo\\n 2340\\n 86\\n 1\\n \\n","errorExample":""}]', + 'title' => '查询基础信息和计划信息', + ], + 'DescribeSQLPlanTask' => [ + 'summary' => '调用DescribeSQLPlanTask查询任务信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '查询任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '201907241445301720211111570315107****', + ], + ], + [ + 'name' => 'StageId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务所属阶段。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1785135913****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'TaskList' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ScanCost' => [ + 'description' => '带数据源的任务的扫描数据耗时。单位：ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OutputSize' => [ + 'description' => '任务的输出数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '945', + ], + 'InputSize' => [ + 'description' => '任务的输入数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3763', + ], + 'State' => [ + 'description' => '任务最终执行状态：'."\n" + ."\n" + .'- FINISHED：完成。'."\n" + .'- CANCELED：取消。'."\n" + .'- ABORTED：中止。'."\n" + .'- FAILED：失败。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'OperatorCost' => [ + 'description' => '任务在某个节点的算子总耗时，是个多线程累加值，可以用于判断计算是否存在长尾。单位：ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'OutputRows' => [ + 'description' => '任务的输出数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105', + ], + 'ScanSize' => [ + 'description' => '带数据源的任务的扫描数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ElapsedTime' => [ + 'description' => '任务从创建到结束的时间差。单位：ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ScanRows' => [ + 'description' => '带数据源的任务的扫描数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PeakMemory' => [ + 'description' => '任务在某个节点的峰值内存。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '898576', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '198877623', + ], + 'InputRows' => [ + 'description' => '任务的输入数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TaskList\\": [\\n {\\n \\"OutputSize\\": 945,\\n \\"ScanCost\\": 0,\\n \\"InputSize\\": 3763,\\n \\"State\\": \\"FINISHED\\",\\n \\"OperatorCost\\": 3,\\n \\"OutputRows\\": 105,\\n \\"ScanSize\\": 0,\\n \\"ElapsedTime\\": 10,\\n \\"ScanRows\\": 0,\\n \\"PeakMemory\\": 898576,\\n \\"TaskId\\": 198877623,\\n \\"InputRows\\": 105\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n\\n 945\\n 198877623\\n 3763\\n 898576\\n 10\\n 105\\n 0\\n 0\\n FINISHED\\n 105\\n 3\\n 0\\n","errorExample":""}]', + 'title' => '查询计划任务信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTablePartitionDiagnose' => [ + 'summary' => '调用DescribeTablePartitionDiagnose接口查询分区诊断信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10826', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~612241~~)接口查看目标地域下所有AnalyticDB MySQL数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bpxxxxxxxx47', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- 30；'."\n" + .'- 50；'."\n" + .'- 100；'."\n" + ."\n" + .'默认值：30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JOSN字符串，例如`[{"Field":"TotalSize","Type":"Desc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `SchemaName`：表所属的数据库名。'."\n" + .' - `TableName`：表名。'."\n" + .' - `TotalSize`：总数据量。'."\n" + .' - `SpaceRatio`：空间占比。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照目标表的总数据量倒序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"Field\\":\\"TotalSize\\",\\"Type\\":\\"Desc\\"}]', + 'default' => '[{"Field":"SchemaName", "Type": "desc" }]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageSize' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '34', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + 'SuggestMaxRecordsPerPartition' => [ + 'description' => '建议每个二级分区的最大行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640000000', + ], + 'SuggestMinRecordsPerPartition' => [ + 'description' => '建议每个二级分区的最小行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64000000', + ], + 'Items' => [ + 'description' => '表统计信息。', + 'type' => 'array', + 'items' => [ + 'description' => '信息列表。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'user', + ], + 'PartitionDetail' => [ + 'description' => '不合理分区。', + 'type' => 'string', + 'example' => '[20210110, 20210113,20210123]', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'PartitionNumber' => [ + 'description' => '分区个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '34', + ], + 'SpaceRatio' => [ + 'description' => '表空间占比，单位：%。'."\n" + ."\n" + .'> 计算公式为：表空间占比 = 表总数据量 / 实例总数据量 * 100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '66.23', + ], + 'TotalSize' => [ + 'description' => '总数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42949672960', + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => '表分区合理性检测', + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到表存在分区不合理的情况', + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageSize\\": 123,\\n \\"PageNumber\\": 34,\\n \\"DBClusterId\\": \\"rm-uf6wjk5xxxxxxxxxx\\",\\n \\"SuggestMaxRecordsPerPartition\\": 640000000,\\n \\"SuggestMinRecordsPerPartition\\": 64000000,\\n \\"Items\\": [\\n {\\n \\"TableName\\": \\"user\\",\\n \\"PartitionDetail\\": \\"[20210110, 20210113,20210123]\\",\\n \\"SchemaName\\": \\"test_db\\",\\n \\"PartitionNumber\\": 34,\\n \\"SpaceRatio\\": 66.23,\\n \\"TotalSize\\": 42949672960\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"表分区合理性检测\\",\\n \\"Message\\": \\"检测到表存在分区不合理的情况\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"1\\n1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n123\\n34\\nrm-uf6wjk5xxxxxxxxxx\\n640000000\\n64000000\\n\\n user\\n [20210110, 20210113,20210123]\\n test_db\\n 34\\n","errorExample":""}]', + 'title' => '查询分区诊断信息', + ], + 'DescribeLoadTasksRecords' => [ + 'summary' => '查看异步导入导出任务的详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看指定数仓版支持的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp2590j****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 建议查询开始时间设置为30天内的任意时间点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-18T06:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需晚于查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-18T06:30:00Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '导入导出任务所涉及的数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定字段对任务进行升序或降序排列。参数值需为JSON字符串类型，例如：`[{"Field":"CreateTime", "Type":"desc"}]`'."\n" + ."\n" + .'> * `Field`表示需要排序的字段名，支持的字段为：`State`、`CreateTime`、`DBName`、`ProcessID`、`UpdateTime`、`JobName`和`ProcessRows`。'."\n" + .'> * `Type`表示排序类型，取值范围为`Desc`（降序）或`Asc`（升序），取值不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"CreateTime", "Type":"desc"}]', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的异步导入或导出任务的状态，取值范围如下：'."\n" + .'* **INIT**：任务初始化。'."\n" + .'* **RUNNING**：任务进行中。'."\n" + .'* **FINISH**：任务执行成功。'."\n" + .'* **FAILED**：任务执行失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'FINISH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '任务总数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C60B05DB-2B77-421A-98E9-92C20E******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp2590j****', + ], + 'LoadTasksRecords' => [ + 'description' => '任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'Sql' => [ + 'description' => '异步导入导出任务中使用的SQL语句详情。', + 'type' => 'string', + 'example' => 'insert overwrite into courses_external_table\\nselect * from courses', + ], + 'State' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'FINISH', + ], + 'CreateTime' => [ + 'description' => '任务开始时间，精确到毫秒，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。', + 'type' => 'string', + 'example' => '2021-05-18 18:47:27.0', + ], + 'DBName' => [ + 'description' => '导入导出任务涉及的数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'ProcessID' => [ + 'description' => '进程ID。', + 'type' => 'string', + 'example' => '2021051818472717201616624903453******', + ], + 'UpdateTime' => [ + 'description' => '任务状态的更新时间，精确到毫秒，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。', + 'type' => 'string', + 'example' => '2021-05-18 18:47:31.0', + ], + 'JobName' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '2021051818472717201616624903453******', + ], + 'ProcessRows' => [ + 'description' => '异步导入导出任务所处理的数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"C60B05DB-2B77-421A-98E9-92C20E******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-bp2590j****\\",\\n \\"LoadTasksRecords\\": [\\n {\\n \\"Sql\\": \\"insert overwrite into courses_external_table\\\\\\\\nselect * from courses\\",\\n \\"State\\": \\"FINISH\\",\\n \\"CreateTime\\": \\"2021-05-18 18:47:27.0\\",\\n \\"DBName\\": \\"adb_demo\\",\\n \\"ProcessID\\": \\"2021051818472717201616624903453******\\",\\n \\"UpdateTime\\": \\"2021-05-18 18:47:31.0\\",\\n \\"JobName\\": \\"2021051818472717201616624903453******\\",\\n \\"ProcessRows\\": 6\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 30\\n C60B05DB-2B77-421A-98E9-92C20E******\\n 1\\n am-bp2590j****\\n \\n insert overwrite into courses_external_table\\\\nselect * from courses\\n FINISH\\n 2021-05-18 18:47:27.0\\n adb_demo\\n 2021051818472717201616624903453******\\n 2021-05-18 18:47:31.0\\n 2021051818472717201616624903453******\\n 6\\n \\n","errorExample":""}]', + 'title' => '查询加载任务记录', + 'description' => '更多关于异步提交导入导出任务的详情，请参见[异步提交导入导出任务](~~160291~~)。', + ], + 'DescribeConnectionCountRecords' => [ + 'summary' => '返回目标AnalyticDB MySQL版集群当前的连接数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1jj9xqft1po****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '562C7F89-FBE6-4A04-AAAA-7EBC25******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp1jj9xqft1po****', + ], + 'AccessIpRecords' => [ + 'description' => '客户端IP信息。', + 'type' => 'array', + 'items' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'AccessIp' => [ + 'description' => '客户端IP。', + 'type' => 'string', + 'example' => '42.120.XX.XX', + ], + 'Count' => [ + 'description' => '连接数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'UserRecords' => [ + 'description' => '用户信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'User' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test', + ], + 'Count' => [ + 'description' => '连接数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"562C7F89-FBE6-4A04-AAAA-7EBC25******\\",\\n \\"DBClusterId\\": \\"am-bp1jj9xqft1po****\\",\\n \\"AccessIpRecords\\": [\\n {\\n \\"AccessIp\\": \\"42.120.XX.XX\\",\\n \\"Count\\": 1\\n }\\n ],\\n \\"UserRecords\\": [\\n {\\n \\"User\\": \\"test\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 562C7F89-FBE6-4A04-AAAA-7EBC25******\\n am-bp1jj9xqft1po****\\n \\n 42.120.XX.XX\\n 1\\n \\n \\n test\\n 1\\n \\n","errorExample":""}]', + 'title' => '查询连接记录数', + ], + 'KillProcess' => [ + 'summary' => '调用KillProcess接口终止正在进行的任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要被终止任务的唯一标识，调用[DescribeProcessList](~~190092~~)返回。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '202011191048151921681492420315100****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A4442913CEF","errorExample":""}]', + 'title' => '终止正在进行的任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAuditLogConfig' => [ + 'summary' => '调用ModifyAuditLogConfig接口修改审计日志设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10840', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-t4nj8619bz2w3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，您可通过接口[DescribeRegions](~~143074~~)查看可用的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AuditLogStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL审计的开启状态。取值说明：'."\n" + .'- **on**：开启SQL审计。'."\n" + .'- **off**：关闭SQL审计。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'on', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'UpdateSucceed' => [ + 'description' => '是否已更新SQL审计的开启状态。取值说明：'."\n" + .'- **true**：状态已更新。'."\n" + .'- **false**：状态更新失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"UpdateSucceed\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n true\\n","errorExample":""}]', + 'title' => '修改审计日志设置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => '调用DescribeSlowLogRecords接口查看AnalyticDB MySQL版集群的慢日志明细。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL数仓版（3.0）集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL数仓版（3.0）集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1rqvm70uh2****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-20T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 查询结束时间需晚于查询开始时间，且与查询开始时间间隔小于7天。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-27T16:00:00Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为**30**（默认值）、**50**或**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型最大值的正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProcessID', + 'in' => 'query', + 'schema' => [ + 'description' => '进程ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2021052716044317201616624903453******', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定字段进行排序，格式为JSON，是一个有序JSON数组，按输入数组的顺序进行复合排序，包含`Field`和`Type`两个字段，例如`[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]`。其中：'."\n" + .'* `Field`表示需要排序的字段名，支持如下取值：'."\n" + .' * **HostAddress**：连接数据库的客户端地址。'."\n" + .' * **UserName**：用户名。'."\n" + .' * **ExecutionStartTime**：目标SQL的执行开始时间。'."\n" + .' * **QueryTime**：目标SQL执行时长。'."\n" + .' * **PeakMemoryUsage**：执行目标SQL语句时的峰值内存。'."\n" + .' * **ScanRows**：带数据源的任务的扫描数据行数。'."\n" + .' * **ScanSize**：扫描的数据量。'."\n" + .' * **ScanTime**：扫描数据总耗时。'."\n" + .' * **PlanningTime**：执行计划生成耗时。'."\n" + .' * **WallTime**：查询中的所有算子在各个节点CPU Time的累加值。'."\n" + .' * **ProcessID**：进程ID。'."\n" + ."\n" + .'* `Type`表示排序类型，支持如下取值：'."\n" + .' * **Desc**：降序。'."\n" + .' * **Asc**：升序。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]', + ], + ], + [ + 'name' => 'Range', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定字段的最大值（`Max`）和最小值（`Min`）进行范围过滤，格式为JSON格式，是一个JSON数组，例如`[{"Field":"ScanSize","Min":"1000000","Max":"10000000"},{"Field":"QueryTime","Min":"1000","Max":"10000"}]`。'."\n" + ."\n" + .'其中`Field`字段表示需要限制范围的字段，支持如下取值：'."\n" + .'* **ScanSize**：扫描的数据量，单位：KB。'."\n" + .'* **QueryTime**：执行时长，单位：毫秒（ms）。'."\n" + .'* **PeakMemoryUsage**：执行目标SQL语句时的峰值内存，单位：KB。'."\n" + ."\n" + .'> `Min`表示查询范围最小值（左值），`Max`表示查询范围最大值（右值），数据类型都为String。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"ScanSize","Min":"1000000","Max":"10000000"},{"Field":"QueryTime","Min":"1000","Max":"10000"}]', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '查询状态。取值说明：'."\n" + .'- **Successed**：成功。'."\n" + .'- **Failed**：失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Successed', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D7559209-7EC3-41E1-8F78-156990******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => 'AnalyticDB MySQL数仓版（3.0）集群ID。', + 'type' => 'string', + 'example' => 'am-bp1rqvm70uh2****', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SlowLogRecord' => [ + 'description' => '慢日志明细列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数列表。'."\n", + 'type' => 'object', + 'properties' => [ + 'HostAddress' => [ + 'description' => '连接数据库的客户端地址。', + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'ScanTime' => [ + 'description' => '扫描数据总耗时，是多个TableScanNode在多个节点上的累加值，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SQLText' => [ + 'description' => 'SQL语句详情。', + 'type' => 'string', + 'example' => 'INSERT OVERWRITE INTO hdfs_import_external\\nSELECT *\\nFROM adb_hdfs_import_source', + ], + 'OutputSize' => [ + 'description' => '任务的输出数据量。单位：Byte。', + 'type' => 'string', + 'example' => '0.009', + ], + 'PeakMemoryUsage' => [ + 'description' => '执行目标SQL语句时的峰值内存，单位：KB。', + 'type' => 'string', + 'example' => '431.447', + ], + 'State' => [ + 'description' => 'SQL语句的执行状态。', + 'type' => 'string', + 'example' => 'SUCCESSED', + ], + 'WallTime' => [ + 'description' => '查询中的所有算子在各个节点CPU Time的累加值，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6100', + ], + 'ScanSize' => [ + 'description' => '扫描的数据量，单位：KB。', + 'type' => 'string', + 'example' => '0.035', + ], + 'ExecutionStartTime' => [ + 'description' => '执行开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-05-27T08:04:43Z', + ], + 'QueryTime' => [ + 'description' => 'SQL语句执行时长，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2344', + ], + 'ReturnRowCounts' => [ + 'description' => '返回行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ScanRows' => [ + 'description' => '带数据源的任务的扫描数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ParseRowCounts' => [ + 'description' => '解析行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DBName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'PlanningTime' => [ + 'description' => '执行计划生成耗时，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'QueueTime' => [ + 'description' => '查询执行前的排队时间，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProcessID' => [ + 'description' => '进程ID。', + 'type' => 'string', + 'example' => '2021052716044317201616624903453******', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"100\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"D7559209-7EC3-41E1-8F78-156990******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-bp1rqvm70uh2****\\",\\n \\"Items\\": {\\n \\"SlowLogRecord\\": [\\n {\\n \\"HostAddress\\": \\"172.16.**.**\\",\\n \\"ScanTime\\": 10,\\n \\"SQLText\\": \\"INSERT OVERWRITE INTO hdfs_import_external\\\\\\\\nSELECT *\\\\\\\\nFROM adb_hdfs_import_source\\",\\n \\"OutputSize\\": \\"0.009\\",\\n \\"PeakMemoryUsage\\": \\"431.447\\",\\n \\"State\\": \\"SUCCESSED\\",\\n \\"WallTime\\": 6100,\\n \\"ScanSize\\": \\"0.035\\",\\n \\"ExecutionStartTime\\": \\"2021-05-27T08:04:43Z\\",\\n \\"QueryTime\\": 2344,\\n \\"ReturnRowCounts\\": 1,\\n \\"ScanRows\\": 3,\\n \\"ParseRowCounts\\": 0,\\n \\"DBName\\": \\"adb_demo\\",\\n \\"PlanningTime\\": 12,\\n \\"QueueTime\\": 0,\\n \\"UserName\\": \\"test\\",\\n \\"ProcessID\\": \\"2021052716044317201616624903453******\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 100\\n 30\\n D7559209-7EC3-41E1-8F78-156990******\\n 1\\n am-bp1rqvm70uh2****\\n \\n 172.16.**.**\\n 10\\n INSERT OVERWRITE INTO hdfs_import_external\\\\nSELECT *\\\\nFROM adb_hdfs_import_source\\n 0.009\\n 431.447\\n SUCCESSED\\n 6100\\n 0.035\\n 2021-05-27T08:04:43Z\\n 2344\\n 1\\n 3\\n 0\\n adb_demo\\n 12\\n 0\\n test\\n 2021052716044317201616624903453******\\n \\n","errorExample":""}]', + 'title' => '查询慢日志明细', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAuditLogConfig' => [ + 'summary' => '查询集群审计日志设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10786', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-t4nj8619bz2w3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可通过接口[DescribeRegions](~~143074~~)查看可用的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详细信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', + ], + 'AuditLogStatus' => [ + 'description' => 'SQL审计的开启状态。取值说明：'."\n" + .'- **on**：开启SQL审计。'."\n" + .'- **off**：关闭SQL审计。', + 'type' => 'string', + 'example' => 'on', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-t4nj8619bz2w3****', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有Ram校验失败才会返回此字段', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\",\\n \\"AuditLogStatus\\": \\"on\\",\\n \\"DBClusterId\\": \\"am-t4nj8619bz2w3****\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F0983B43-B2EC-536A-8791-142B5CF1E9B6\\n on\\n am-t4nj8619bz2w3****\\n","errorExample":""}]', + 'title' => '查询集群审计日志设置', + ], + 'DescribeAuditLogRecords' => [ + 'summary' => '调用DescribeAuditLogRecords接口查询数仓版集群的SQL审计日志。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10787', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-t4nj8619bz2w3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，UTC时间，格式为：yyyy-MM-ddTHH:mmZ。'."\n" + .'> 仅当SQL审计状态为开启时，才能查询到SQL审计日志，且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计，再次打开时，仅能查询到再次打开后的SQL审计日志。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-01-23T02:18Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，UTC时间，格式为：yyyy-MM-ddTHH:mmZ。'."\n" + ."\n" + .'> - 查询结束时间需晚于查询开始时间。'."\n" + .'> - 查询开始时间与查询结束时间的间隔不能超过24小时。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-01-23T22:18Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '执行SQL的数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '对查询包含目标关键字的SQL进行查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb', + ], + ], + [ + 'name' => 'SqlType', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL类型，取值：'."\n" + .'- **DELETE**'."\n" + .'- **SELECT**'."\n" + .'- **UPDATE**'."\n" + .'- **INSERT_INTO_SELECT**'."\n" + .'- **ALTER**'."\n" + .'- **DROP**'."\n" + .'- **CREATE**'."\n" + ."\n\n" + .'> 每次仅允许传入一种类型查询，若该参数为空，默认查询所有类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'Succeed', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL是否执行成功，取值说明：'."\n" + .'* **true**：执行成功。'."\n" + .'* **false**：执行失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'HostAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '执行目标SQL的客户端IP地址和端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '100.104.XX.XX:43908', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '按SQL执行时间进行正序或倒序排序，取值说明：'."\n" + .'* **asc**：正序。'."\n" + .'* **desc**：倒序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '执行目标SQL的用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定字段进行排序，格式为JSON，是一个有序JSON数组，按输入数组的顺序进行复合排序，包含Field和Type两个字段。'."\n" + .'- Field表示需要排序的字段名，取值说明：'."\n" + .' - HostAddress：连接数据库的客户端地址。'."\n" + .' - Succeed：目标SQL是否执行成功。'."\n" + .' - TotalTime：目标SQL的执行总耗时。'."\n" + .' - DBName：执行目标SQL的数据库名称。'."\n" + .' - SQLType：SQL类型。'."\n" + .' - User：执行目标SQL的用户名。'."\n" + .' - ExecuteTime：目标SQL的执行开始时间。'."\n" + .'- Type表示排序类型，取值说明：'."\n" + .' - Desc：降序。'."\n" + .' - Asc：升序。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **10**'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + .'> 本参数不填写时，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8A564B7F-8C00-43C0-8EC5-919FBB70573', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-t4nj8619bz2w3****', + ], + 'Items' => [ + 'description' => 'SQL审计日志详情。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'HostAddress' => [ + 'description' => '执行目标SQL的客户端IP地址和端口号。', + 'type' => 'string', + 'example' => '100.104.XX.XX:43908', + ], + 'Succeed' => [ + 'description' => '目标SQL是否执行成功。取值说明：'."\n" + .'- **true**：执行成功。'."\n" + .'- **false**：执行失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'SQLText' => [ + 'description' => 'SQL语句详情。', + 'type' => 'string', + 'example' => 'SELECT * FROM tb_courses', + ], + 'TotalTime' => [ + 'description' => '目标SQL的执行时长，单位：毫秒（ms）。', + 'type' => 'string', + 'example' => '216', + ], + 'ConnId' => [ + 'description' => '此参数无效。', + 'type' => 'string', + 'example' => '无', + ], + 'DBName' => [ + 'description' => '执行目标SQL的数据库名称。', + 'type' => 'string', + 'example' => 'adb_test', + ], + 'SQLType' => [ + 'description' => '目标SQL的类型。', + 'type' => 'string', + 'example' => 'SELECT', + ], + 'ProcessID' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '202106081752021720161662490345362390', + ], + 'User' => [ + 'description' => '执行目标SQL的用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'ExecuteTime' => [ + 'description' => '目标SQL的执行开始时间，本地时间，格式为：yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2022-01-23 16:05:08', + ], + 'ExecuteTimestamp' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"RequestId\\": \\"8A564B7F-8C00-43C0-8EC5-919FBB70573\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-t4nj8619bz2w3****\\",\\n \\"Items\\": [\\n {\\n \\"HostAddress\\": \\"100.104.XX.XX:43908\\",\\n \\"Succeed\\": \\"true\\",\\n \\"SQLText\\": \\"SELECT * FROM tb_courses\\",\\n \\"TotalTime\\": \\"216\\",\\n \\"ConnId\\": \\"无\\",\\n \\"DBName\\": \\"adb_test\\",\\n \\"SQLType\\": \\"SELECT\\",\\n \\"ProcessID\\": \\"202106081752021720161662490345362390\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": \\"2022-01-23 16:05:08\\",\\n \\"ExecuteTimestamp\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 10\\n 8A564B7F-8C00-43C0-8EC5-919FBB70573\\n 1\\n am-t4nj8619bz2w3****\\n \\n 100.104.XX.XX:43908\\n true\\n SELECT * FROM tb_courses\\n 216\\n 无\\n adb_test\\n SELECT\\n 2022-01-23 16:05:08\\n 202106081752021720161662490345362390\\n test_user\\n \\n","errorExample":""}]', + 'title' => '查询集群的SQL审计日志', + 'description' => '调用本接口查看AnalyticDB MySQL集群的SQL审计日志前，需要开启SQL审计。您可以调用[DescribeAuditLogConfig](~~190628~~)接口查询SQL审计的开启状态，如未开启，可调用[ModifyAuditLogConfig](~~190629~~)接口开启SQL审计。'."\n" + ."\n" + .'仅当SQL审计状态为开启时，才能查询到SQL审计日志，且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计，再次打开时，仅能查询到再次打开后的SQL审计日志。SQL审计日志不记录**INSERT INTO VALUES**、**REPLACE INTO VALUES**和**UPSERT INTO VALUES**操作。', + ], + 'DescribeRegions' => [ + 'summary' => '调用DescribeRegions接口查询ADB可选的地域和可用区。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '95108', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '地域名称和可用区名称（即返回数据中`LocalName`）返回值所使用的语言，取值说明：'."\n" + .'* **zh-CN**：中文。'."\n" + .'* **en-US**：英文。'."\n" + .'* **ja**：日文。'."\n" + ."\n" + .'> 若该参数不填写，默认使用中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'en-US', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~612293~~)接口查看地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => '地域对应的接入地址。', + 'type' => 'string', + 'example' => 'adb.aliyuncs.com', + ], + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => 'China (Hangzhou)', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'VpcEnabled' => [ + 'description' => '目标可用区是否支持VPC，取值说明：'."\n" + .'* **true**：支持。'."\n" + .'* **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LocalName' => [ + 'description' => '可用区名称。', + 'type' => 'string', + 'example' => 'Hangzhou Zone H', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"adb.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"VpcEnabled\\": true,\\n \\"LocalName\\": \\"Hangzhou Zone H\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 421794A3-72A5-5D27-9E8B-A75A4C503E17\\n \\n adb.aliyuncs.com\\n China (Hangzhou)\\n cn-hangzhou\\n \\n cn-hangzhou-h\\n true\\n Hangzhou Zone H\\n \\n \\n","errorExample":""}]', + 'title' => '查询用户可选的地域和可用区', + ], + 'ModifyClusterConnectionString' => [ + 'summary' => '调用ModifyClusterConnectionString接口修改实例的网络连接地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp18934i73vb****', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义连接地址的前缀。'."\n" + .'- 以小写字母开头，可包含小写字母、数字和中划线（-）。'."\n" + .'- 长度5-29个字符', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-123', + ], + ], + [ + 'name' => 'CurrentConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的数仓版集群的连接地址。'."\n" + .'> 您可以调用[DescribeDBClusterNetInfo](~~143384~~)接口查看集群的连接地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp18934i73vb****.ads.aliyuncs.com', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号，固定为**3306**暂时不支持修改。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '3306', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '370D09FD-442A-5225-AAD3-7362CAE39177', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"370D09FD-442A-5225-AAD3-7362CAE39177\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 370D09FD-442A-5225-AAD3-7362CAE39177\\n","errorExample":""}]', + 'title' => '修改集群的网络连接地址', + ], + 'DescribeDBClusterNetInfo' => [ + 'summary' => '调用DescribeDBClusterNetInfo接口查询集群的网络信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10799', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所在的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterNetworkType' => [ + 'description' => '集群网络类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Address' => [ + 'description' => '集群列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '交换机ID。'."\n" + .'> 当NetType取值为Public时，交换机ID返回为空。', + 'type' => 'string', + 'example' => 'vsw-xxxxxx', + ], + 'ConnectionString' => [ + 'description' => '集群连接地址。', + 'type' => 'string', + 'example' => 'am-bpxxxxxxxx.ads.aliyuncs.com', + ], + 'NetType' => [ + 'description' => '网络类型。取值说明：'."\n" + ."\n" + .'- **Public**：公网；'."\n" + .'- **VPC**：VPC。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => '集群连接端口。', + 'type' => 'string', + 'example' => '3306', + ], + 'VPCId' => [ + 'description' => 'VPC ID。'."\n" + .'> 当NetType取值为Public时，VPC ID返回为空。', + 'type' => 'string', + 'example' => 'vpc-xxxxxxxxx', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '192.168.x.x', + ], + 'ConnectionStringPrefix' => [ + 'description' => '集群连接地址前缀。', + 'type' => 'string', + 'example' => 'am-bpxxxxxxxx89k51380', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClusterNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Address\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-xxxxxx\\",\\n \\"ConnectionString\\": \\"am-bpxxxxxxxx.ads.aliyuncs.com\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-xxxxxxxxx\\",\\n \\"IPAddress\\": \\"192.168.x.x\\",\\n \\"ConnectionStringPrefix\\": \\"am-bpxxxxxxxx89k51380\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n VPC\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n vsw-xxxxxx\\n am-bpxxxxxxxx.ads.aliyuncs.com\\n VPC\\n 3306\\n vpc-xxxxxxxxx\\n 192.168.x.x\\n am-bpxxxxxxxx89k51380\\n \\n","errorExample":""}]', + 'title' => '查询集群的网络信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AllocateClusterPublicConnection' => [ + 'summary' => '为数仓版集群申请公网连接地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10759', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp278jg9****', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '公网连接地址的前缀。'."\n" + .'- 由小写字母开头，必须包含小写字母、数字和中划线（-）组成。'."\n" + .'- 长度不超过30个字符。'."\n" + .'- 默认使用集群名。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'am-bp278jg9****.ads.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '为集群申请公网连接地址', + ], + 'ReleaseClusterPublicConnection' => [ + 'summary' => '调用ReleaseClusterPublicConnection接口释放集群的公网连接地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '10857', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A4442913CEF","errorExample":""}]', + 'title' => '释放集群的公网连接地址', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVSwitches' => [ + 'summary' => '调用DescribeVSwitches接口查询交换机列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp13h7uzhulpuxvnp****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'VswId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-8vbpu1teend1qcosfojlz', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'VSwitches' => [ + 'description' => '交换机列表。', + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'description' => '交换机信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '交换机的状态，取值：'."\n" + .'**Pending**：配置中。'."\n" + .'**Available**：可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'IsDefault' => [ + 'description' => '是否为默认交换机，取值：'."\n" + .'**true**：是默认交换机。'."\n" + .'**false**：不是默认交换机。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'VSwitchId' => [ + 'description' => '交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-25bcdxs7pv1****', + ], + 'CidrBlock' => [ + 'description' => '交换机的IPv4网段。', + 'type' => 'string', + 'example' => '172.16.0.0/24', + ], + 'RegionNo' => [ + 'description' => '交换机所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => '交换机的创建时间。', + 'type' => 'string', + 'example' => '2022-01-18T12:43:57Z', + ], + 'AliUid' => [ + 'description' => 'RAM账号ID。', + 'type' => 'string', + 'example' => '195813423043****', + ], + 'GmtModified' => [ + 'description' => '交换机的修改时间。', + 'type' => 'string', + 'example' => '2022-01-22T12:43:57Z', + ], + 'Bid' => [ + 'description' => '用户渠道ID。', + 'type' => 'string', + 'example' => '2****', + ], + 'IzNo' => [ + 'description' => '交换机所属的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'VSwitchName' => [ + 'description' => '交换机的名称。', + 'type' => 'string', + 'example' => 'vswitch', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": false,\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\",\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2022-01-18T12:43:57Z\\",\\n \\"AliUid\\": \\"195813423043****\\",\\n \\"GmtModified\\": \\"2022-01-22T12:43:57Z\\",\\n \\"Bid\\": \\"2****\\",\\n \\"IzNo\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchName\\": \\"vswitch\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n \\n \\n Available\\n false\\n vsw-25bcdxs7pv1****\\n 172.16.0.0/24\\n cn-hangzhou\\n 2022-01-18T12:43:57Z\\n 195813423043****\\n 2022-01-22T12:43:57Z\\n 2****\\n cn-hangzhou-k\\n vswitch\\n \\n \\n","errorExample":""}]', + 'title' => '查询可组网信息', + ], + 'CreateAccount' => [ + 'summary' => '调用CreateAccount接口创建账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10764', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名称，需符合如下要求：'."\n" + .'- 以小写字母开头，以小写字母或数字结尾。'."\n" + .'- 由小写字母、数字或下划线（_）组成。'."\n" + .'- 长度为2~16个字符。'."\n" + .'- 不能使用预留的账号名称，如root、admin和opsadmin。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名的密码，需符合如下要求：'."\n" + .'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- 特殊符号包含：`!@#$%^&*()_+-=`'."\n" + .'- 密码长度为8~32个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test_accout1', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '账号描述。'."\n" + .'- 不能以`http://`或者`https://`开头。'."\n" + .'- 长度不超过256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '数据库测试账号', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '账号类型，取值说明：'."\n" + .'- **Normal**：普通账号。一个集群最多可以创建256个普通账号。'."\n" + .'- **Super**（默认值）：高权限账号。一个集群只能创建一个高权限账号。'."\n" + .'> - 当集群无账号，调用接口创建账号时，既可以创建高权限账号，也可以创建普通账号。如果集群已有高权限账号，调用接口创建账号时，必须选择Normal才能创建成功。'."\n" + .'> - 账号创建完成后，高权限账号拥有该集群中所有数据库的权限。普通账号默认没有权限，需要通过高权限账号手动为普通账号授予指定数据库的权限。详情请参见[为用户授权](~~123662~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => '标签值，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1564657730', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp1r053byu48p****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 1564657730,\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"DBClusterId\\": \\"am-bp1r053byu48p****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1564657730\\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n am-bp1r053byu48p****\\n","errorExample":""}]', + 'title' => '创建账户', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAccount' => [ + 'summary' => '调用DeleteAccount接口删除数据库账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10773', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '- Normal：普通账号。'."\n" + .'- Super：高权限账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"2FED790E-FB61-4721-8C1C-07C627FA5A19","errorExample":""}]', + 'title' => '删除数据库账号', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountDescription' => [ + 'summary' => '调用ModifyAccountDescription接口修改数据库账号的备注信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10839', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '修改账号备注：'."\n" + ."\n" + .'- 以中文、英文字母开头。'."\n" + .'- 可以包含中文、英文字符、数字、”_”、” -”。'."\n" + .'- 不能以`http://`、`https:// `开头。'."\n" + .'- 长度为2-256个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AccDesc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A4442913CEF","errorExample":""}]', + 'title' => '修改数据库账号的备注信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAllAccounts' => [ + 'summary' => '查询指定集群、指定数据库的账号列表信息或某个指定账号的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10784', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'AccountList' => [ + 'description' => '账号列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'User' => [ + 'description' => '账号名。', + 'type' => 'string', + 'example' => 'rdsdt_dts_adb', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"AccountList\\": [\\n {\\n \\"User\\": \\"rdsdt_dts_adb\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n\\n rdsdt_dts_adb\\n","errorExample":""}]', + 'title' => '查询账号信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAccounts' => [ + 'summary' => '查询集群的账号信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10782', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + .'> 此参数不填写时，默认返回所有数据库账号信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + .'> 您可以调用[TagResources](~~179253~~)接口为目标集群创建标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'AnalyticDB_IO_UTIL', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'low_env', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '账号类型，不填写时默认查询所有类型的账号信息。取值说明：'."\n" + .'- **Normal**：普通账号。'."\n" + .'- **Super**：高权限账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'Super', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF', + ], + 'AccountList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBAccount' => [ + 'description' => '账号列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountStatus' => [ + 'description' => '账号状态。取值说明：'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Available**：可用。'."\n" + .'- **Deleting**：删除中。', + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountDescription' => [ + 'description' => '账号描述。', + 'type' => 'string', + 'example' => 'C@test', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + .'> 您可以调用[TagResources](~~179253~~)接口为目标集群创建标签。', + 'type' => 'string', + 'example' => 'AnalyticDB_CPU', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'AccountType' => [ + 'description' => '账号类型，取值说明：'."\n" + .'- **Normal**：普通账号。'."\n" + .'- **Super**：高权限账号。', + 'type' => 'string', + 'example' => 'Super', + ], + 'AccountName' => [ + 'description' => '数据库账号名称。', + 'type' => 'string', + 'example' => 'adb_user1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"AccountList\\": {\\n \\"DBAccount\\": [\\n {\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountDescription\\": \\"C@test\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_CPU\\",\\n \\"Value\\": \\"0\\"\\n }\\n ]\\n },\\n \\"AccountType\\": \\"Super\\",\\n \\"AccountName\\": \\"adb_user1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据库账号信息', + ], + 'DescribeOperatorPermission' => [ + 'summary' => '调用DescribeOperatorPermission接口查询集群服务账号的授权详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10811', + 'abilityTreeNodes' => [ + 'FEATUREadsZDDQS0', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6wjk5xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CreatedTime' => [ + 'description' => '授权生效时间。', + 'type' => 'string', + 'example' => '2019-05-20T05:41:19Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Privileges' => [ + 'description' => '已获得的授权类型：Control|Data。', + 'type' => 'string', + 'example' => 'Control,Data', + ], + 'ExpiredTime' => [ + 'description' => '授权过期时间。', + 'type' => 'string', + 'example' => '2019-05-20T07:41:19Z', + ], + 'DBClusterId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'am-uf6wjk5xxxxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CreatedTime\\": \\"2019-05-20T05:41:19Z\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Privileges\\": \\"Control,Data\\",\\n \\"ExpiredTime\\": \\"2019-05-20T07:41:19Z\\",\\n \\"DBClusterId\\": \\"am-uf6wjk5xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"2019-05-20T05:41:19Z\\n1AD222E9-E606-4A42-BF6D-8A4442913CEF\\nControl,Data\\n2019-05-20T07:41:19Z\\nrm-uf6wjk5xxxxxxxxxx","errorExample":""}]', + 'title' => '查询集群服务账号的授权详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GrantOperatorPermission' => [ + 'summary' => '调用GrantOperatorPermission接口为集群服务账号授权。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsZDDQS0', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1565u55p32****', + ], + ], + [ + 'name' => 'ExpiredTime', + 'in' => 'query', + 'schema' => [ + 'description' => '服务账号权限过期时间。UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-11-30T00:00:00Z', + ], + ], + [ + 'name' => 'Privileges', + 'in' => 'query', + 'schema' => [ + 'description' => '权限名称。取值说明：'."\n" + .'- **Control**：配置权限，查看和修改集群配置。'."\n" + .'- **Data**：数据权限，查看表结构、索引和SQL。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Control', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A438072A-E2E7-5509-9A3F-66293512A820', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RelatedTaskNotFinish', + 'errorMessage' => 'The related task does not finish.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A438072A-E2E7-5509-9A3F-66293512A820\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A438072A-E2E7-5509-9A3F-66293512A820\\n","errorExample":""}]', + 'title' => '为集群服务账号授权', + 'description' => '### 使用说明'."\n" + .'您在使用云原生数据仓库AnalyticDB MySQL版集群过程中需要阿里云技术支持时，如果技术支持过程中需要对您的集群进行操作，您需要授权AnalyticDB MySQL集群的服务账号，技术支持人员才可以通过服务账号提供技术支持服务。在授权有效期结束后，服务账号的权限会被自动回收。', + ], + 'ResetAccountPassword' => [ + 'summary' => '调用ResetAccountPassword接口重置数据库账号的密码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10858', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名密码。'."\n" + ."\n" + .'- 密码由大写字母、小写字母、数字以及特殊符号组成。'."\n" + .'- 特殊符号包含：（!）、（@）、（#）、（$）、（%）、（^）、（&）、（*）（()）、（_）、（+）、（-）、（=）'."\n" + .'- 密码长度为8字符~32个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test_accout1', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '1. Normal：普通账号；'."\n" + .'2. Super：高权限账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1564657730', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 1564657730,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"rm-uf6wjk5xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"1564657730\\n1AD222E9-E606-4A42-BF6D-8A4442913CEF\\nrm-uf6wjk5xxxxxxxxxx","errorExample":""}]', + 'title' => '重置账号密码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RevokeOperatorPermission' => [ + 'summary' => '调用RevokeOperatorPermission接口撤销集群服务账号权限。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10859', + 'abilityTreeNodes' => [ + 'FEATUREadsZDDQS0', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6wjk5xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RelatedTaskNotFinish', + 'errorMessage' => 'The related task does not finish.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A4442913CEF","errorExample":""}]', + 'title' => '撤销集群服务账号权限', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'summary' => '调用ListTagResources查询一个或多个AnalyticDB MySQL集群已绑定的标签列表，或者查询一个或多个标签绑定的AnalyticDB MySQL集群列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsSUMGII', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，您可通过接口[DescribeRegions](~~143074~~)查看可用的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型定义。唯一取值：**cluster**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的Token继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群ID。支持同时传入多个集群ID，N的取值范围为：1~50。'."\n" + .'> ResourceId.N参数和Tag.N.Key参数至少传入一个。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。支持同时传入多个集群ID，N的取值范围为：1~50。'."\n" + .'> ResourceId.N参数和Tag.N.Key参数至少传入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1l20nxxxxxxxxxx', + ], + 'required' => false, + 'example' => 'am-bp1l20nxxxxxxxxxx', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。支持同时传入多个标签键，不允许传入空字符串。N的取值范围为：1~20。'."\n" + ."\n" + .'> ResourceId.N参数和Tag.N.Key参数至少传入一个。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => '标签键对应的标签值。支持同时传入多个标签值，允许传入空字符串。N的取值范围为：1~20。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '184DE106-CB2C-4DD2-B57F-396652E6C8F8', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '查询到的集群和标签的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型，cluster即云原生数据仓库AnalyticDB MySQL集群。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'TagValue' => [ + 'description' => '标签键对应的标签值。', + 'type' => 'string', + 'example' => 'testvalue1', + ], + 'ResourceId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp1l20nxxxxxxxxxx', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'testkey1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec21345\\",\\n \\"RequestId\\": \\"184DE106-CB2C-4DD2-B57F-396652E6C8F8\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"testvalue1\\",\\n \\"ResourceId\\": \\"am-bp1l20nxxxxxxxxxx\\",\\n \\"TagKey\\": \\"testkey1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 212db86sca4384811e0b5e8707ec21345\\n 184DE106-CB2C-4DD2-B57F-396652E6C8F8\\n \\n cluster\\n testvalue1\\n am-bp1l20nxxxxxxxxxx\\n testkey1\\n \\n","errorExample":""}]', + 'title' => '查询标签列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => '为AnalyticDB MySQL集群绑定标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsSUMGII', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，您可通过接口[DescribeRegions](~~143074~~)查看可用的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群类型，取值：**ALIYUN::ADB::CLUSTER**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ALIYUN::ADB::CLUSTER', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '绑定标签的集群ID。若需要为多个集群同时添加标签，请单击**添加**并输入集群ID。'."\n" + ."\n" + .'> - 一次最多为50个集群同时绑定标签。'."\n" + .'> - 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定标签的集群ID。若需要为多个集群同时添加标签，请单击**添加**并输入集群ID。'."\n" + ."\n" + .'> - 一次最多为50个集群同时绑定标签。'."\n" + .'> - 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1gfds6a32s9****', + ], + 'required' => true, + 'example' => 'am-bp1xxx.1', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。若您需要为目标集群一次性添加多个标签，请单击**添加**并输入标签键和对应的标签值。'."\n" + .'> 每次最多添加20对标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => '标签键对应的标签值。若您需要为目标集群一次性添加多个标签，请单击**添加**并输入标签键和对应的标签值。'."\n" + .'> 每次最多添加20对标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '863D51B7-5321-41D8-A0B6-A088B0450EFD', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0450EFD\\"\\n}","errorExample":""},{"type":"xml","example":"863D51B7-5321-41D8-A0B6-A088B0450EFD","errorExample":""}]', + 'title' => '为集群绑定标签', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => '解绑后，如果该标签没有绑定其他任何实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsSUMGII', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值固定为**ALIYUN::ADB::CLUSTER**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ALIYUN::ADB::CLUSTER', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解绑实例上的所有标签，默认值为false，取值：'."\n" + ."\n" + .'- **true**：解绑实例上的所有标签。'."\n" + .'- **false**：不解绑实例上的所有标签。'."\n" + ."\n" + .'> 如果同时传入TagKey和本参数，本参数不生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群ID，N的取值范围：1~50。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-t4n6k19t9p9f3d0j0', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源的标签键，N的取值范围：1~20。', + 'type' => 'array', + 'items' => [ + 'description' => '资源的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'productvalue', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189484043\\"\\n}","type":"json"}]', + 'title' => '为指定的实例列表统一解绑标签', + ], + 'ModifyDBClusterAccessWhiteList' => [ + 'summary' => '创建或修改集群的白名单（包括IP白名单和安全组）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '10846', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的IP白名单，多个IP地址之间以英文逗号（,）隔开，不可重复，最多500个。支持如下两种格式：'."\n" + ."\n" + .'- IP地址形式，例如：10.23.12.24。'."\n" + .'- CIDR形式，例如：10.23.12.24/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。'."\n" + ."\n" + .'> ModifyMode值为Delete时，此参数值可以是空，其他情况下必须有非空值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10.23.12.24', + ], + ], + [ + 'name' => 'DBClusterIPArrayName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的IP白名单分组名称，默认操作**Default**分组。'."\n" + .'IP白名单分组名称以小写字母开头、以数字或小写字母结尾，可包含小写字母、数字及’_’，长度为2~32。'."\n" + ."\n" + .'单个集群最多支持50个白名单分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'default' => 'default', + ], + ], + [ + 'name' => 'DBClusterIPArrayAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单分组属性，默认为空。'."\n" + .'控制台不显示带有**hidden**属性的分组，带有该标签的分组通常是用于访问DTS、DRDS服务的。', + 'type' => 'string', + 'required' => false, + 'example' => 'hidden', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => '修改白名单的方式。取值：'."\n" + ."\n" + .'- Cover：覆盖原IP白名单。'."\n" + .'- Append：增加IP。'."\n" + .'- Delete：删除IP。'."\n" + ."\n" + .'默认值：Cover。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cover', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1564657730', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityIPList.Duplicate', + 'errorMessage' => 'The specified IP address is duplicate.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Malformed', + 'errorMessage' => 'The specified SecurityIPList is incorrectly formatted.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 1564657730,\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"DBClusterId\\": \\"rm-uf6wjk5xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"1564657730\\nD0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\nrm-uf6wjk5xxxxxxxxxx","errorExample":""}]', + 'title' => '创建或修改集群的白名单', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterAccessWhiteList' => [ + 'summary' => '调用DescribeDBClusterAccessWhiteList接口查看集群的IP白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10797', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看指定AnalyticDB MySQL数仓版支持的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IPArray' => [ + 'description' => 'IP白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterIPArrayAttribute' => [ + 'description' => '白名单分组属性，默认为空。'."\n" + ."\n" + .'> 控制台不显示带有**hidden**属性的分组，带有该标签的分组通常是用于访问DTS、DRDS服务的。', + 'type' => 'string', + 'example' => 'hidden', + ], + 'SecurityIPList' => [ + 'description' => 'IP白名单分组下的IP列表，最多1000个，以英文逗号（,）隔开。', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'DBClusterIPArrayName' => [ + 'description' => 'IP白名单分组名称。'."\n" + .'- IP白名单分组名称以小写字母开头、以数字或小写字母结尾，可包含小写字母、数字及’_’，长度为2~32。'."\n" + .'- 单个集群最多支持50个白名单分组。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"IPArray\\": [\\n {\\n \\"DBClusterIPArrayAttribute\\": \\"hidden\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"DBClusterIPArrayName\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n\\n \\n test\\n 127.0.0.1\\n hidden\\n \\n","errorExample":""}]', + 'title' => '查询集群的IP白名单', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterSSL' => [ + 'summary' => '调用DescribeDBClusterSSL接口查询集群的SSL配置情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220651', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~612293~~)接口查看集群所属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '348303D8-6F42-5141-9B00-A6EECA1E37B6', + ], + 'ExpireTime' => [ + 'description' => 'SSL 证书有效期。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2022-10-11T08:16:43Z', + ], + 'ConnectionString' => [ + 'description' => '受SSL保护的连接地址。', + 'type' => 'string', + 'example' => 'am-d7oualxo05x4o5be872***.ads.aliyuncs.com', + ], + 'SSLEnabled' => [ + 'description' => '是否开启SSL。'."\n" + .'取值： '."\n" + .'- true：开启。'."\n" + .'- false：关闭。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"348303D8-6F42-5141-9B00-A6EECA1E37B6\\",\\n \\"ExpireTime\\": \\"2022-10-11T08:16:43Z\\",\\n \\"ConnectionString\\": \\"am-d7oualxo05x4o5be872***.ads.aliyuncs.com\\",\\n \\"SSLEnabled\\": true\\n}","type":"json"}]', + 'title' => '查询ADB实例的SSL配置', + ], + 'ModifyDBClusterSSL' => [ + 'summary' => '调用ModifyDBClusterSSL接口修改集群的SSL链路配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216076', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => [ + 'description' => '开启或关闭SSL，取值：'."\n" + ."\n" + .'- true：开启'."\n" + .'- false: 关闭', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '需要创建或更新服务器证书的内网或外网连接地址。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'am-d7oualxo05x4o5be872***.ads.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '修改ADB实例的SSL配置', + ], + 'ModifyBackupPolicy' => [ + 'summary' => '调用ModifyBackupPolicy接口修改AnalyticDB MySQL版实例的备份策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10842', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '执行全量备份的开始时间，格式为HH:mmZ-HH:mmZ（UTC时间）。'."\n" + ."\n" + .'> 时间范围限制为1小时。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '00:00Z-01:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份周期，多个取值用英文逗号（,）隔开。取值说明：'."\n" + .'- **Monday**：周一。'."\n" + .'- **Tuesday**：周二。'."\n" + .'- **Wednesday**：周三。'."\n" + .'- **Thursday**：周四。'."\n" + .'- **Friday**：周五。'."\n" + .'- **Saturday**：周六。'."\n" + .'- **Sunday**：周日。'."\n" + ."\n" + .'> 为保证数据安全，最少选择两个。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Monday,Wednesday,Friday,Sunday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份保留天数，取值范围为：7~730。'."\n" + .'> 本参数不填写，默认为7天。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'default' => '7', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启日志（实时）备份。取值说明：'."\n" + .'- **Enable**：开启。'."\n" + .'- **Disable**：关闭。'."\n" + .'> 本参数不填写，默认开启。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + ], + ], + [ + 'name' => 'LogBackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '日志（实时）数据备份保留天数，取值范围为：7~730。'."\n" + .'> 本参数不填写，默认为7天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '730', + 'minimum' => '7', + 'example' => '30', + 'default' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter "BackupRetentionPeriod" should be within [7-%s] days.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '修改备份策略设置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyLogBackupPolicy' => [ + 'summary' => '调用ModifyLogBackupPolicy接口修改日志备份设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10852', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm4f7oger****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启日志备份。取值说明：'."\n" + .'- **Enable**：开启。'."\n" + .'- **Disable**：关闭。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Enable', + ], + ], + [ + 'name' => 'LogBackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '数据备份保留天数，取值范围：7~730。'."\n" + .'> 此参数不填写，默认为7天。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'default' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '修改日志备份策略设置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupPolicy' => [ + 'summary' => '调用DescribeBackupPolicy接口查看集群备份设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10790', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => '数据备份周期，多个取值用英文逗号（,）隔开。取值：'."\n" + ."\n" + .'- Monday：周一；'."\n" + .'- Tuesday：周二；'."\n" + .'- Wednesday：周三；'."\n" + .'- Thursday：周四；'."\n" + .'- Friday：周五；'."\n" + .'- Saturday：周六；'."\n" + .'- Sunday：周日。', + 'type' => 'string', + 'example' => 'Tuesday,Friday', + ], + 'LogBackupRetentionPeriod' => [ + 'description' => '日志备份保留天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PreferredBackupTime' => [ + 'description' => '数据备份时间，格式：HH:mmZ-HH:mmZ。', + 'type' => 'string', + 'example' => '15:00Z-16:00Z', + ], + 'EnableBackupLog' => [ + 'description' => '是否开启。'."\n" + ."\n" + .'- true：开启。'."\n" + .'- false：关闭。', + 'type' => 'string', + 'example' => 'true', + ], + 'BackupRetentionPeriod' => [ + 'description' => '数据备份保留天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreferredBackupPeriod\\": \\"Tuesday,Friday\\",\\n \\"LogBackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"EnableBackupLog\\": \\"true\\",\\n \\"BackupRetentionPeriod\\": 7\\n}","errorExample":""},{"type":"xml","example":"Tuesday,Friday\\n7\\n1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n15:00Z-16:00Z\\ntrue\\n7","errorExample":""}]', + 'title' => '查询集群自动备份策略', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackups' => [ + 'summary' => '查看集群的备份列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10791', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域下数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp18934i73vb5****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'required' => false, + 'example' => '32732****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2022-06-01T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需要大于查询开始时间，格式：yyyy-MM-ddTHH:mmZ。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2022-06-02T16:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值：大于0且不超过Integer数据类型最大值的正整数。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'CrossUid', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云主账号，即备份集所属的阿里云主账号。 '."\n" + .'>该参数仅在跨阿里云账号备份时填写。', + 'type' => 'string', + 'required' => false, + 'example' => '195****', + ], + ], + [ + 'name' => 'CrossRole', + 'in' => 'query', + 'schema' => [ + 'description' => '跨阿里云账号主账号角色名，即备份集所属阿里云账号下的RAM角色。 '."\n" + .'>该参数仅在跨阿里云账号备份时填写。', + 'type' => 'string', + 'required' => false, + 'example' => 'role-for-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '备份集列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '300', + ], + 'PageSize' => [ + 'description' => '本页备份集个数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'FreeBackupSize' => [ + 'description' => '备份集免费大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalBackupSize' => [ + 'description' => '总备份集大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64953700', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => '备份集列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份集详情。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp18934i73vb5****', + ], + 'BackupType' => [ + 'description' => '备份类型。取值说明：'."\n" + .'- **FullBackup**：全量备份。'."\n" + .'- **IncrementalBackup**：增量备份。', + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupStartTime' => [ + 'description' => '备份开始时间。', + 'type' => 'string', + 'example' => '2022-06-01T16:00Z', + ], + 'BackupSize' => [ + 'description' => '备份文件大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2167808', + ], + 'BackupEndTime' => [ + 'description' => '备份结束时间。', + 'type' => 'string', + 'example' => '2022-06-02T16:00Z', + ], + 'BackupExpiredTime' => [ + 'description' => '备份集过期时间。', + 'type' => 'string', + 'example' => '2022-07-02T16:00Z', + ], + 'BackupId' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'example' => '32732****', + ], + 'BackupMethod' => [ + 'description' => '备份方法。只支持快照备份（Snapshot）。', + 'type' => 'string', + 'example' => 'Snapshot', + ], + 'BackupStatus' => [ + 'description' => '备份的状态。取值如下：'."\n" + ."\n" + .'- Running：备份正在进行中。'."\n" + .'- Finished：备份已完成。', + 'type' => 'string', + 'example' => 'Finished', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'CrossUser.CheckFailed', + 'errorMessage' => 'The input UID and role is not authorized.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"300\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"FreeBackupSize\\": 0,\\n \\"TotalBackupSize\\": 64953700,\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp18934i73vb5****\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2022-06-01T16:00Z\\",\\n \\"BackupSize\\": 2167808,\\n \\"BackupEndTime\\": \\"2022-06-02T16:00Z\\",\\n \\"BackupExpiredTime\\": \\"2022-07-02T16:00Z\\",\\n \\"BackupId\\": \\"32732****\\",\\n \\"BackupMethod\\": \\"Snapshot\\",\\n \\"BackupStatus\\": \\"Finished\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 300\\n 30\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n 1\\n \\n am-bp18934i73vb5****\\n FullBackup\\n 2022-06-01T16:00Z\\n 2167808\\n 2022-06-02T16:00Z\\n 32732****\\n Snapshot\\n \\n","errorExample":""}]', + 'title' => '查询备份集列表', + ], + 'DescribeDBClusterHealthStatus' => [ + 'summary' => '调用DescribeDBClusterHealthStatus接口查看数仓版集群的健康状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '150514', + 'abilityTreeNodes' => [ + 'FEATUREadsCVPI8C', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1d8lbdj22rx****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看可用地域的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '集群健康状态列表。', + 'type' => 'object', + 'properties' => [ + 'CS' => [ + 'description' => '实例接入节点状态列表。', + 'type' => 'object', + 'properties' => [ + 'ActiveCount' => [ + 'description' => '健康节点个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'UnavailableCount' => [ + 'description' => '不可用节点个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RiskCount' => [ + 'description' => '风险节点个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpectedCount' => [ + 'description' => '接入节点总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Status' => [ + 'description' => '实例接入节点状态，取值说明：'."\n" + .'- **RISK**：风险。'."\n" + .'- **NORMAL**：健康。'."\n" + .'- **UNAVAILABLE**：不可用。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + 'Executor' => [ + 'description' => '计算节点组健康状态列表。', + 'type' => 'object', + 'properties' => [ + 'ActiveCount' => [ + 'description' => '健康计算节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'UnavailableCount' => [ + 'description' => '不可用计算节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RiskCount' => [ + 'description' => '风险计算节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpectedCount' => [ + 'description' => '计算节点组总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Status' => [ + 'description' => '计算节点组健康状态，取值说明：'."\n" + .'- **RISK**：风险。'."\n" + .'- **NORMAL**：健康。'."\n" + .'- **UNAVAILABLE**：不可用。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + 'Worker' => [ + 'description' => '存储节点组健康状态列表。', + 'type' => 'object', + 'properties' => [ + 'ActiveCount' => [ + 'description' => '健康存储节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'UnavailableCount' => [ + 'description' => '不可用存储节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RiskCount' => [ + 'description' => '风险存储节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpectedCount' => [ + 'description' => '存储节点组总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Status' => [ + 'description' => '存储节点组健康状态，取值说明：'."\n" + .'- **RISK**：风险。'."\n" + .'- **NORMAL**：健康。'."\n" + .'- **UNAVAILABLE**：不可用。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + 'InstanceStatus' => [ + 'description' => '集群的健康状态，取值说明：'."\n" + .'- **RISK**：风险。'."\n" + .'- **NORMAL**：健康。'."\n" + .'- **UNAVAILABLE**：不可用。'."\n" + .'>当集群的实例接入节点状态、计算节点组健康状态和存储节点组健康状态，三个健康状态均为**健康**且实例探活成功，则集群的健康状态为**健康**；当三个健康状态中包含**风险**时，则集群的健康状态为**风险**；当三个健康状态中包含**不可用**时，则集群的健康状态为**不可用**。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CS\\": {\\n \\"ActiveCount\\": 2,\\n \\"UnavailableCount\\": 0,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 2,\\n \\"Status\\": \\"NORMAL\\"\\n },\\n \\"Executor\\": {\\n \\"ActiveCount\\": 2,\\n \\"UnavailableCount\\": 0,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 2,\\n \\"Status\\": \\"NORMAL\\"\\n },\\n \\"Worker\\": {\\n \\"ActiveCount\\": 2,\\n \\"UnavailableCount\\": 0,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 2,\\n \\"Status\\": \\"NORMAL\\"\\n },\\n \\"InstanceStatus\\": \\"NORMAL\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2\\n 0\\n 0\\n 2\\n NORMAL\\n \\n \\n 2\\n 0\\n 0\\n 2\\n NORMAL\\n \\n \\n 2\\n 0\\n 0\\n 2\\n NORMAL\\n \\n NORMAL\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEA\\n","errorExample":""}]', + 'title' => '查询集群健康检查状态', + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => '调用DescribeDBClusterPerformance接口查看目标集群的性能数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10800', + 'abilityTreeNodes' => [ + 'FEATUREadsCVPI8C', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL版集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-8vbf80pjcz*****', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的性能指标名称（监控项Key），多个值之间用英文逗号（,）分隔。支持查询的指标详情请参见[监控项概览](~~2863211~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'AnalyticDB_CPU', + 'default' => 'AnalyticDB_CPU_Usage_Percentage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-05-03T15:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + ."\n" + .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过两天。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-05-03T15:01Z', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所在的地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourcePools', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '查询结束时间。格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-05-03T15:01:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-05-03T15:00:00Z', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-8vbf80pjcz*****', + ], + 'Performances' => [ + 'description' => '集群性能指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '性能指标名称。', + 'type' => 'string', + 'example' => 'AnalyticDB_CPU', + ], + 'Unit' => [ + 'description' => '数据单位。', + 'type' => 'string', + 'example' => '%', + ], + 'Series' => [ + 'description' => '性能数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '性能指标数值详情。', + 'type' => 'array', + 'items' => [ + 'description' => '不同时间点下的性能值详情。', + 'type' => 'string', + 'example' => '[ "2021-05-03T15:00:12.72Z", "0.1250" ], [ "2021-05-03T15:00:42.739Z", "0.3125" ]', + ], + ], + 'Name' => [ + 'description' => '性能指标名称（监控指标Value Name）。指标详情请参见[监控项概览](~~2863211~~)。', + 'type' => 'string', + 'example' => 'worker_avg_cpu_used', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'instance_name: "amv-8vbf80pjcz*****"', + ], + 'TranslateKey' => [ + 'description' => '获取对应指标的英文。', + 'type' => 'string', + 'example' => 'elastic_executor_avg_cpu_use', + ], + ], + ], + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有校验RAM失败后，字段才会返回。', + 'type' => 'string', + 'example' => '{'."\n" + .' "AuthAction": "xxx",'."\n" + .' "AuthPrincipalDisplayName": "sampleName",'."\n" + .' "AuthPrincipalOwnerId": "111111111111111111",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthResource": "xxx",'."\n" + .' "NoPermissionType": "xxx",'."\n" + .' "PolicyType": "xxx"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-05-03T15:01:00Z\\",\\n \\"RequestId\\": \\"25B56BC7-4978-40B3-9E48-4B7067******\\",\\n \\"StartTime\\": \\"2021-05-03T15:00:00Z\\",\\n \\"DBClusterId\\": \\"am-8vbf80pjcz*****\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_CPU\\",\\n \\"Unit\\": \\"%\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n \\"[ \\\\\\"2021-05-03T15:00:12.72Z\\\\\\", \\\\\\"0.1250\\\\\\" ], [ \\\\\\"2021-05-03T15:00:42.739Z\\\\\\", \\\\\\"0.3125\\\\\\" ]\\"\\n ],\\n \\"Name\\": \\"worker_avg_cpu_used\\",\\n \\"Tags\\": \\"instance_name: \\\\\\"amv-8vbf80pjcz*****\\\\\\"\\",\\n \\"TranslateKey\\": \\"elastic_executor_avg_cpu_use\\"\\n }\\n ]\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"sampleName\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"111111111111111111\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthResource\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"xxx\\\\\\"\\\\n}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25B56BC7-4978-40B3-9E48-4B7067******\\n 2021-05-03T15:01:00Z\\n am-bp**************\\n 2021-05-03T15:00:00Z\\n \\n \\n \\n <0>2021-05-03T15:00:12.72Z\\n <1>0.1875\\n \\n \\n <0>2021-05-03T15:00:42.739Z\\n <1>0.1250\\n \\n worker_avg_cpu_used\\n \\n \\n \\n <0>2021-05-03T15:00:12.72Z\\n <1>0.1250\\n \\n \\n <0>2021-05-03T15:00:42.739Z\\n <1>0.3125\\n \\n executor_avg_cpu_used\\n \\n %\\n AnalyticDB_CPU\\n \\n","errorExample":""}]', + 'title' => '查看集群性能数据', + 'description' => '根据性能参数查看某个集群、某时间段范围内的性能监控数据。采集粒度为30秒。支持对慢SQL进行查询，提供SQL查询时长、扫描行数、扫描量等监控内容。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterResourcePoolPerformance' => [ + 'summary' => '查询弹性模式集群版（新版）ADB集群的资源池监控信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-****************', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池数据监控指标。允许同时输入多个指标进行查询，多个指标间用英文逗号（,）分隔。支持监控如下指标：'."\n" + .'- **AnalyticDB\\_RP_CPU** ：CPU平均使用率，单位：%。'."\n" + .'- **AnalyticDB\\_RP_RT**：查询响应时间（RT），单位：毫秒（ms）。'."\n" + .'- **AnalyticDB\\_RP_QPS**：每秒查询率（QPS），单位：数值。'."\n" + .'- **AnalyticDB\\_RP_WaitTime**：查询等待时间，单位：毫秒（ms）。'."\n" + .'- **AnalyticDB\\_RP_OriginalNode**：资源池基础节点数。'."\n" + .'- **AnalyticDB\\_RP_ActualNode**：资源池分时弹性实际弹出的节点数（即执行扩容计划时实际增加的节点数）。'."\n" + .'- **AnalyticDB\\_RP_PlanNode**：资源池分时弹性计划弹出的节点数。'."\n" + .'- **AnalyticDB\\_RP_TotalNode**：资源池拥有的总节点数，总节点数=基础节点数+分时弹性计划中实际生效的节点数。'."\n" + ."\n" + .'> - 若该参数留空，默认返回所有指标的监控数据详情。'."\n" + .'> - 更多关于资源池弹性计划的信息，请参见[资源弹性扩容](~~189507~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'AnalyticDB_RP_CPU', + ], + ], + [ + 'name' => 'ResourcePools', + 'in' => 'query', + 'schema' => [ + 'description' => '目标资源池名称。允许同时输入多个资源池名称进行查询，多个名称间用英文逗号（,）分隔。'."\n" + ."\n" + .'> * 输入的资源池名称不区分大小写，例如`USER_DEFAULT`与`user_default`表示的是同一个资源池。'."\n" + .'> * 若该参数留空，将返回`USER_DEFAULT`即默认资源池的监控信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'TEST_POOL', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池数据监控开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'> 仅支持查看最近2天的资源池监控信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-10T07:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池数据监控结束时间，结束时间需晚于开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-10T07:01Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '资源池数据监控结束时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-06-10T07:01:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', + ], + 'StartTime' => [ + 'description' => '资源池数据监控开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-06-10T07:00:00', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-****************', + ], + 'Performances' => [ + 'description' => '以监控指标为维度的数据详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源池数据监控指标。', + 'type' => 'string', + 'example' => 'AnalyticDB_RP_CPU', + ], + 'Unit' => [ + 'description' => '监控指标的单位。', + 'type' => 'string', + 'example' => '%', + ], + 'ResourcePoolPerformances' => [ + 'description' => '以资源池为维度的监控数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'ResourcePoolName' => [ + 'description' => '资源池名称。', + 'type' => 'string', + 'example' => 'test_pool', + ], + 'ResourcePoolSeries' => [ + 'description' => '资源池监控数据的序列列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '监控指标数值。', + 'type' => 'array', + 'items' => [ + 'description' => '不同时间点下的资源池监控项数值。', + 'type' => 'string', + 'example' => '["2021-06-10T07:00:22.601Z","0.0000"],["2021-06-10T07:00:52.62Z","0.0312"]', + ], + ], + 'Name' => [ + 'description' => '监控指标名称。', + 'type' => 'string', + 'example' => 'cpu', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-06-10T07:01:00Z\\",\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"StartTime\\": \\"2021-06-10T07:00:00\\",\\n \\"DBClusterId\\": \\"am-****************\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_RP_CPU\\",\\n \\"Unit\\": \\"%\\",\\n \\"ResourcePoolPerformances\\": [\\n {\\n \\"ResourcePoolName\\": \\"test_pool\\",\\n \\"ResourcePoolSeries\\": [\\n {\\n \\"Values\\": [\\n \\"[\\\\\\"2021-06-10T07:00:22.601Z\\\\\\",\\\\\\"0.0000\\\\\\"],[\\\\\\"2021-06-10T07:00:52.62Z\\\\\\",\\\\\\"0.0312\\\\\\"]\\"\\n ],\\n \\"Name\\": \\"cpu\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C7EDB8E4-9769-4233-88C7-DCA4C9******\\n 2021-06-10T07:01:00Z\\n 2021-06-10T07:00:00Z\\n \\n \\n \\n \\n <0>2021-06-10T07:00:22.601Z\\n <1>0.0000\\n \\n \\n <0>2021-06-10T07:00:52.62Z\\n <1>0.0312\\n \\n cpu\\n \\n test_pool\\n \\n %\\n AnalyticDB_RP_CPU\\n \\n","errorExample":""}]', + 'title' => '查询集群资源池监控信息', + 'description' => '> 您还可以在控制台上以图表的形式查看AnalyticDB MySQL版弹性模式集群版（新版）资源池监控信息。更多详细信息，请参见[查看监控信息](~~188721~~)。', + ], + 'DescribeInclinedTables' => [ + 'summary' => '调用DescribeInclinedTables接口查看表监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10807', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-k2jofo4pi5zhd****', + ], + ], + [ + 'name' => 'TableType', + 'in' => 'query', + 'schema' => [ + 'description' => '表类型，取值说明：'."\n" + .'- **FactTable**：分区表。'."\n" + .'- **DimensionTable**：维度表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FactTable', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定字段排序，json格式：JSON数组，有序，按顺序输入排列字段和升降序类型：'."\n" + ."\n" + .'如：'."\n" + ."\n" + .'```'."\n" + .'['."\n" + ."\n" + .' {'."\n" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\n" + .' }'."\n" + ."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'其中Field表示需要排序的字段名，目前仅支持对"Name" 字段排序。'."\n" + .'Type表示排序类型 Desc为降序，Asc为升序。'."\n" + ."\n" + .'均不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Field":"Name", "Type":"Asc" } ]', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- 30；'."\n" + .'- 50；'."\n" + .'- 100；'."\n" + ."\n" + .'默认值：30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-zhangjiakou', + 'default' => 'cn-zhangjiakou', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '15', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => '表列表。', + 'type' => 'object', + 'properties' => [ + 'Table' => [ + 'description' => '数据库表列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列类型。', + 'type' => 'string', + 'example' => 'executor', + ], + 'Schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'adm_analyze', + ], + 'Size' => [ + 'description' => '表大小，行数。', + 'type' => 'string', + 'example' => '2416527', + ], + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'ff', + ], + 'IsIncline' => [ + 'description' => '是否倾斜。', + 'type' => 'string', + 'example' => 'true', + ], + 'TotalSize' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '65', + ], + 'SpaceRatio' => [ + 'description' => '空间比率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '89', + ], + 'RowCount' => [ + 'description' => '表行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2565', + ], + ], + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => '主键字段过多', + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到多个表存在主键过多的问题', + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalFailure', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"15\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Table\\": [\\n {\\n \\"Type\\": \\"executor\\",\\n \\"Schema\\": \\"adm_analyze\\",\\n \\"Size\\": \\"2416527\\",\\n \\"Name\\": \\"ff\\",\\n \\"IsIncline\\": \\"true\\",\\n \\"TotalSize\\": 65,\\n \\"SpaceRatio\\": 89,\\n \\"RowCount\\": 2565\\n }\\n ]\\n },\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"主键字段过多\\",\\n \\"Message\\": \\"检测到多个表存在主键过多的问题\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看表监控', + ], + 'ModifyMaintenanceAction' => [ + 'summary' => '调用ModifyMaintenanceAction接口修改运维事件的执行时间。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929XXXX', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '目标待处理运维事件的ID。支持输入多个ID来批量修改切换时间，多个ID间用英文逗号（,）隔开。'."\n" + ."\n" + .'> * 您可以调用[DescribeMaintenanceAction](~~271738~~)接口查看目标待处理运维事件的详情，包括ID。'."\n" + .'> * 仅待处理运维事件支持修改切换时间，历史运维事件不支持修改切换时间。关于待处理运维事件和历史运维事件的状态详情，请参见[DescribeMaintenanceAction](~~271738~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '11111', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '后台将在指定时间点执行目标待处理运维事件所对应的操作。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-07-09T22:00:00Z', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标待处理运维事件所在地域的地域ID。'."\n" + .'> * 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '目标运维事件ID。', + 'type' => 'string', + 'example' => '11111', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7856CBE7-5BD0-4EE1-AC62-749392******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + [ + 'errorCode' => 'TaskModifyError', + 'errorMessage' => 'Part of the tasks cannot be modified.', + ], + [ + 'errorCode' => 'SwitchTimeAfterDeadline', + 'errorMessage' => 'The switch time should be earlier than deadline.', + ], + [ + 'errorCode' => 'StartTimeBeforeNow', + 'errorMessage' => 'The start time should not be earlier than the current time.', + ], + ], + 403 => [ + [ + 'errorCode' => 'IncorrectTaskStatus', + 'errorMessage' => 'Certain task\'s status does not support this operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Ids\\": \\"11111\\",\\n \\"RequestId\\": \\"7856CBE7-5BD0-4EE1-AC62-749392******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 11111\\n 7856CBE7-5BD0-4EE1-AC62-749392******\\n","errorExample":""}]', + 'title' => '修改维护动作', + ], + 'DescribeMaintenanceAction' => [ + 'summary' => '调用DescribeMaintenanceAction接口查询运维事件的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。取值如下：'."\n" + .'* 运维事件所在地域的地域ID，如`cn-hangzhou`。您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。'."\n" + .'* 您也可以输入`all`查看当前账号下所有地域下的所有运维事件，当`Region`设置为`all`时，`TaskType`也必须设置为`all`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '运维事件的类型，取值如下：'."\n" + .'* **rds_apsaradb_upgrade**：数据库软件升级。'."\n" + .'* **all**：查看当前账号下所有地域下的所有运维事件，当`Region`设置为`all`时，`TaskType`也必须设置为`all`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds_apsaradb_upgrade', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回待处理或历史运维事件的详情，取值如下：'."\n" + .'* **0**：返回待处理运维事件的详情。'."\n" + .'* **1**：返回历史运维事件的详情。'."\n" + ."\n" + .'若该参数留空，默认返回待处理运维事件的详情。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为**30**（默认值）、**50**或**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '运维事件所在地域的地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E774C8A9-8819-4A09-9E91-07C078******', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Items' => [ + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '事件状态。'."\n" + .'- 若您设置`IsHistory`为**0**，则返回待处理运维事件状态的详情，取值范围如下：'."\n" + .' - **WAITING_MODIFY**：等待用户设置运维事件开始时间。'."\n" + .' - **WAITING**：运维事件正在等待处理。'."\n" + .' - **PROCESSING**：运维事件正在处理中（不支持修改处于该状态下事件的切换时间）。'."\n" + .'- 若您设置`IsHistory`为**1**，则返回历史运维事件状态的详情，取值范围如下：'."\n" + .' - **SUCCESS**：事件结束且执行成功。'."\n" + .' - **FAILED**：事件结束但执行失败。'."\n" + .' - **CANCEL**：事件已取消。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Deadline' => [ + 'description' => '运维事件执行时间可调整范围的最晚时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2021-07-04T15:59:59Z', + ], + 'PrepareInterval' => [ + 'description' => '运维事件切换之前所需的准备时间，格式为`HH:mm:ss`。', + 'type' => 'string', + 'example' => '02:00:00', + ], + 'DBType' => [ + 'description' => '数据库的引擎类型。', + 'type' => 'string', + 'example' => 'analyticdb', + ], + 'StartTime' => [ + 'description' => '后台执行该运维事件的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2021-07-03T04:00:00Z', + ], + 'TaskType' => [ + 'description' => '运维事件的类型。', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本号。', + 'type' => 'string', + 'example' => '3.0', + ], + 'DBClusterId' => [ + 'description' => '运维事件所涉及集群的集群ID。', + 'type' => 'string', + 'example' => 'am-****************', + ], + 'ModifiedTime' => [ + 'description' => '修改运维事件切换时间的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2021-07-03T06:33:00Z', + ], + 'Region' => [ + 'description' => '运维事件所在地域的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResultInfo' => [ + 'description' => '运维事件的执行结果。'."\n" + .'> 仅当`Status`（状态）取值为**FAILED**（运维事件结束但执行失败）或**CANCEL**（事件已取消）时，返回该参数。', + 'type' => 'string', + 'example' => 'autoCancel', + ], + 'CreatedTime' => [ + 'description' => '运维事件的创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2021-06-30T02:44:27Z', + ], + 'Id' => [ + 'description' => '运维事件的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11111', + ], + 'SwitchTime' => [ + 'description' => '运维事件预计的切换时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2021-07-03T06:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"E774C8A9-8819-4A09-9E91-07C078******\\",\\n \\"PageSize\\": 30,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Deadline\\": \\"2021-07-04T15:59:59Z\\",\\n \\"PrepareInterval\\": \\"02:00:00\\",\\n \\"DBType\\": \\"analyticdb\\",\\n \\"StartTime\\": \\"2021-07-03T04:00:00Z\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"DBVersion\\": \\"3.0\\",\\n \\"DBClusterId\\": \\"am-****************\\",\\n \\"ModifiedTime\\": \\"2021-07-03T06:33:00Z\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResultInfo\\": \\"autoCancel\\",\\n \\"CreatedTime\\": \\"2021-06-30T02:44:27Z\\",\\n \\"Id\\": 11111,\\n \\"SwitchTime\\": \\"2021-07-03T06:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n E774C8A9-8819-4A09-9E91-07C078******\\n 30\\n 1\\n \\n SUCCESS\\n 2021-06-30T02:44:27Z\\n 2021-07-04T15:59:59Z\\n 2021-07-03T04:00:00Z\\n am-****************\\n analyticdb\\n 3.0\\n 2021-07-03T06:33:00Z\\n rds_apsaradb_upgrade\\n 02:00:00\\n cn-hangzhou\\n 11111\\n 2021-07-03T06:00:00Z\\n \\n \\n CANCEL\\n 2021-06-25T06:32:45Z\\n 2021-06-29T15:59:59Z\\n 2021-06-26T16:10:00Z\\n am-****************\\n analyticdb\\n 3.0\\n 2021-06-26T18:40:00Z\\n rds_apsaradb_upgrade\\n 02:00:00\\n cn-hangzhou\\n 22222\\n autoCancel\\n 2021-06-26T18:10:00Z\\n \\n","errorExample":""}]', + 'title' => '查询运维事件的详情', + ], + 'DescribeDiagnosisTasks' => [ + 'summary' => '获取指定查询ID和Stage ID的分布式子任务执行详情信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162538', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~129857~~)接口查看账号下AnalyticDB MySQL数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看指定AnalyticDB MySQL数仓版支持的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。'."\n" + .'> 您可以调用[DescribeProcessList](~~190092~~)接口查看目标SQL的任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '202011191048151921681492420315100****', + ], + ], + [ + 'name' => 'StageId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定`ProcessId`对应查询的某个Stage ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Stage[26]', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定字段对任务进行升序或降序排列。参数值需为JSON字符串类型，例如：`[{"Field":"CreateTime", "Type":"desc"}]`'."\n" + ."\n" + .'> * `Field`表示需要排序的字段名，支持的字段为：`State`、`CreateTime`、`DBName`、`ProcessID`、`UpdateTime`、`JobName`和`ProcessRows`。'."\n" + .'> * `Type`表示排序类型，取值范围为`Desc`（降序）或`Asc`（升序），取值不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"StartTime", "Type": "desc" }]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- 30（默认值）。'."\n" + .'- 50。'."\n" + .'- 100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的异步导入或导出任务的状态，取值说明如下：'."\n" + .'* **RUNNING**：任务进行中。'."\n" + .'* **FINISHED**：任务执行成功。'."\n" + .'* **FAILED**：任务执行失败。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'FAILED' => 'FAILED', + 'RUNNING' => 'RUNNING', + 'FINISHED' => 'FINISHED', + ], + 'example' => 'RUNNING', + ], + ], + [ + 'name' => 'Host', + 'in' => 'query', + 'schema' => [ + 'description' => '发起查询的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '任务列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', + ], + 'TaskList' => [ + 'description' => '子任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子任务详情。', + 'type' => 'object', + 'properties' => [ + 'ScanCost' => [ + 'description' => '带数据源的任务的扫描数据耗时。单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OutputDataSize' => [ + 'description' => '任务的输出数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'InputDataSize' => [ + 'description' => '任务的输入数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'State' => [ + 'description' => '任务最终执行状态：'."\n" + ."\n" + .'- FINISHED：完成。'."\n" + .'- CANCELED：取消。'."\n" + .'- ABORTED：中止。'."\n" + .'- FAILED：失败。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'OperatorCost' => [ + 'description' => '任务在某个节点的算子总耗时，为多线程累加值，可用于判断计算是否存在长尾。单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'OutputRows' => [ + 'description' => '任务的输出数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105', + ], + 'ScanDataSize' => [ + 'description' => '任务的扫描数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ElapsedTime' => [ + 'description' => '任务从创建到结束的时长。单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '456', + ], + 'ScanRows' => [ + 'description' => '带数据源的任务的扫描数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PeakMemory' => [ + 'description' => '任务的峰值内存，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '22568****', + ], + 'InputRows' => [ + 'description' => '任务的输入数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105', + ], + 'TaskCreateTime' => [ + 'description' => '任务创建时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-12-12 00:00:12', + ], + 'TaskEndTime' => [ + 'description' => '任务实际结束的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-12-22 00:00:00', + ], + 'TaskHost' => [ + 'description' => '任务机器的IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Drivers' => [ + 'description' => '任务执行的并行度。', + 'type' => 'string', + 'example' => '16', + ], + 'QueuedTime' => [ + 'description' => '任务执行前的排队时间，单位：毫秒（ms）。', + 'type' => 'string', + 'example' => '12', + ], + 'ComputeTimeRatio' => [ + 'description' => '任务所有算子的累加耗时除以任务的并行度后，和ElapsedTime的比值，可用于判断任务的是否为真正耗时的任务。如果比值较大，说明该任务大部分时间在实际执行计算任务；如果比值较小，说明该任务大部分时间在等待被调度或者因其他原因被阻塞。', + 'type' => 'string', + 'example' => '0.89', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '某个Stage总的任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '33', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\",\\n \\"TaskList\\": [\\n {\\n \\"ScanCost\\": 0,\\n \\"OutputDataSize\\": 123,\\n \\"InputDataSize\\": 123,\\n \\"State\\": \\"FINISHED\\",\\n \\"OperatorCost\\": 3,\\n \\"OutputRows\\": 105,\\n \\"ScanDataSize\\": 123,\\n \\"ElapsedTime\\": 456,\\n \\"ScanRows\\": 0,\\n \\"PeakMemory\\": 234,\\n \\"TaskId\\": \\"22568****\\",\\n \\"InputRows\\": 105,\\n \\"TaskCreateTime\\": 0,\\n \\"TaskEndTime\\": 0,\\n \\"TaskHost\\": \\"192.168.XX.XX\\",\\n \\"Drivers\\": \\"16\\",\\n \\"QueuedTime\\": \\"12\\",\\n \\"ComputeTimeRatio\\": \\"0.89\\"\\n }\\n ],\\n \\"TotalCount\\": 33\\n}","errorExample":""},{"type":"xml","example":"\\n F0983B43-B2EC-536A-8791-142B5CF1E9B6\\n \\n 0\\n 123\\n 123\\n FINISHED\\n 3\\n 105\\n 123\\n 456\\n 0\\n 234\\n 22568****\\n 105\\n 192.168.xx.xx\\n 16\\n 12\\n 0.89\\n \\n 33\\n","errorExample":""}]', + 'title' => 'Stage的子任务执行详情', + ], + 'DescribeDiagnosisRecords' => [ + 'summary' => '查看目标AnalyticDB MySQL版集群中符合指定检索条件的SQL语句摘要信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '71847', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为Unix时间戳，单位：毫秒。'."\n" + .'> 仅支持查看14天内的数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1632931200000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式为Unix时间戳，单位：毫秒。'."\n" + ."\n" + .'> * 查询结束时间需晚于查询开始时间。'."\n" + .'> * 开始时间与结束时间的间隔不能超过24小时。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1633017540000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => '指定SQL的查询条件，格式为JSON字符串，包含`Type`、`Value`、`Min`或`Max`等字段。其中`Type` 表示查询维度（当前仅支持3个取值：`maxCost`、`status`和`cost`），`Value`、`Min`或`Max`表示该维度下的查询范围。具体支持的取值范围如下：'."\n" + .'- ` {"Type":"maxCost","Value":"100"}`：表示查看执行耗时最长的前100条SQL详情，当前`Value`的取值仅支持设置为100。'."\n" + .'- `{"Type":"status","Value":"finished"}`：表示查看已完成的SQL详情（**包含执行成功和失败的SQL**）。您也可以将`Value`设置为`running`或`failed`来查询正在执行或执行失败的SQL详情。'."\n" + .'- `{"Type":"cost","Min":"10","Max":"200"}`：表示查看执行耗时为10毫秒~200毫秒的SQL详情，您也可以自定义执行耗时的最大值与最小值，单位：毫秒。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"Type":"status","Value":"finished"}', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'select', + ], + ], + [ + 'name' => 'MinPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的最小峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MaxPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的最大峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '89000000', + ], + ], + [ + 'name' => 'MinScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的最小扫描量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MaxScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的最大扫描量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '104428198', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句所属的资源组。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_default', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '执行SQL语句的用户名。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => [ + 'description' => '执行SQL语句的数据库。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源地址。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => '59.82.xx.xx', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定字段对SQL语句进行排序，格式为JSON，是一个有序JSON数组，按输入数组的顺序进行复合排序，包含`Field`和`Type`两个字段，例如`[{"Field":"StartTime", "Type": "desc" }]`。其中：'."\n" + ."\n" + .'- `Field`表示需要排序的字段名，支持如下字段：'."\n" + .' - `StartTime`：执行开始时间。'."\n" + .' - `Status`：执行状态。'."\n" + .' - `UserName`：用户名称。'."\n" + .' - `Cost`：执行耗时。'."\n" + .' - `PeakMemory`：峰值内存。'."\n" + .' - `ScanSize`：扫描数据量。'."\n" + .' - `Database`：数据库名称。'."\n" + .' - `ClientIp`：访问源地址.'."\n" + .' - `ResourceGroup`：资源组。'."\n" + .' - `QueueTime`：排队耗时。'."\n" + .' - `OutputRows`：输出行数。'."\n" + .' - `OutputDataSize`：输出数据量。'."\n" + .' - `ResourceCostRank`：SQL内部算子的耗时排名（仅当`QueryCondition`取值为`{"Type":"status","Value":"running"}`时，支持使用该字段）。'."\n" + ."\n" + .'- `Type`表示排序类型，支持如下取值（取值均不区分大小写）：'."\n" + .' - `Desc`：降序。'."\n" + .' - `Asc`：升序。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"StartTime", "Type": "desc" }]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为**30**（默认值）、**50**或**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PatternId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL Pattern的ID。'."\n" + ."\n" + .'> 您可以调用[DescribeSQLPatterns](~~321868~~)接口查看指定时间内目标AnalyticDB MySQL集群下所有的SQL Pattern列表信息，包括SQL Pattern的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5575924945138******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Querys' => [ + 'description' => 'SQL语句详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'SQL' => [ + 'description' => 'SQL语句详情。'."\n" + .'> 出于性能考虑，当前SQL语句最长支持显示5120个字符，超出限制的SQL语句会被截断。您可以调用[DownloadDiagnosisRecords](~~308212~~)接口下载符合指定条件的SQL语句的摘要信息，包括完整的SQL语句。', + 'type' => 'string', + 'example' => 'SELECT count(*)\\nFROM nation', + ], + 'SQLTruncatedThreshold' => [ + 'description' => 'SQL语句的截断阈值，固定为5120个字符。超过该长度的SQL语句会被截断。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5120', + ], + 'Status' => [ + 'description' => 'SQL语句的状态，取值为：'."\n" + .'- **running**：执行中。'."\n" + .'- **finished**：已完成。'."\n" + .'- **failed**：执行失败。', + 'type' => 'string', + 'example' => 'finished', + ], + 'OutputDataSize' => [ + 'description' => '返回数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'Cost' => [ + 'description' => '查询的总耗时。单位：毫秒。'."\n" + .'> 该耗时指标是`QueuedTime`、`TotalPlanningTime`和`ExecutionTime`三个耗时指标的累加值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OutputRows' => [ + 'description' => '返回行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RcHost' => [ + 'description' => '执行SQL语句的AnalyticDB MySQL前端节点IP和端口信息。', + 'type' => 'string', + 'example' => '10.0.xx.xx:3004', + ], + 'ScanSize' => [ + 'description' => '扫描数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'ProcessId' => [ + 'description' => '查询ID。', + 'type' => 'string', + 'example' => '2021093000414401000000023503151******', + ], + 'StartTime' => [ + 'description' => 'SQL语句的执行开始时间，格式为Unix时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1632933704000', + ], + 'SQLTruncated' => [ + 'description' => '查询结果的长度是否超过阈值（即是否被截断），取值如下：'."\n" + .'- **true**：查询结果的长度超过阈值。'."\n" + .'- **false**：查询结果的长度未超过阈值。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Database' => [ + 'description' => '执行SQL语句的数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'ScanRows' => [ + 'description' => '扫描行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ResourceCostRank' => [ + 'description' => 'SQL语句内部算子的耗时排名。'."\n" + .'> 仅状态为执行中，即`Status`取值为`running`的SQL语句支持返回该字段。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClientIp' => [ + 'description' => '访问源地址。', + 'type' => 'string', + 'example' => '59.82.xx.xx', + ], + 'PeakMemory' => [ + 'description' => '峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16648', + ], + 'QueueTime' => [ + 'description' => '排队耗时，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ResourceGroup' => [ + 'description' => 'SQL语句所属的资源池。', + 'type' => 'string', + 'example' => 'user_default', + ], + 'UserName' => [ + 'description' => '执行SQL语句的用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'ExecutionTime' => [ + 'description' => '查询执行的耗时，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'TotalPlanningTime' => [ + 'description' => '生成执行计划的耗时，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'EtlWriteRows' => [ + 'description' => 'ETL任务写表的行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalStages' => [ + 'description' => '查询生成的总Stage数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'QueryProperties' => [ + 'description' => '属性键值描述。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '查询属性名称。', + 'type' => 'string', + 'example' => 'ff', + ], + 'Value' => [ + 'description' => '查询属性值。', + 'type' => 'string', + 'example' => '40', + ], + ], + ], + ], + 'PatternId' => [ + 'description' => 'SQL Pattern的ID。'."\n" + .'> 您可以调用[DescribePatternPerformance](~~612503~~)接口查看指定时间内该SQLPattern执行的详细指标。', + 'type' => 'string', + 'example' => '-5575924945138******', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '109462AF-B5FA-3D5A-9377-B27E5B******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Querys\\": [\\n {\\n \\"SQL\\": \\"SELECT count(*)\\\\\\\\nFROM nation\\",\\n \\"SQLTruncatedThreshold\\": 5120,\\n \\"Status\\": \\"finished\\",\\n \\"OutputDataSize\\": 9,\\n \\"Cost\\": 10,\\n \\"OutputRows\\": 1,\\n \\"RcHost\\": \\"10.0.xx.xx:3004\\",\\n \\"ScanSize\\": 9,\\n \\"ProcessId\\": \\"2021093000414401000000023503151******\\",\\n \\"StartTime\\": 1632933704000,\\n \\"SQLTruncated\\": false,\\n \\"Database\\": \\"adb_demo\\",\\n \\"ScanRows\\": 1,\\n \\"ResourceCostRank\\": 1,\\n \\"ClientIp\\": \\"59.82.xx.xx\\",\\n \\"PeakMemory\\": 16648,\\n \\"QueueTime\\": 0,\\n \\"ResourceGroup\\": \\"user_default\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"ExecutionTime\\": 6,\\n \\"TotalPlanningTime\\": 4,\\n \\"EtlWriteRows\\": 0,\\n \\"TotalStages\\": 2,\\n \\"QueryProperties\\": [\\n {\\n \\"Name\\": \\"ff\\",\\n \\"Value\\": \\"40\\"\\n }\\n ],\\n \\"PatternId\\": \\"-5575924945138******\\"\\n }\\n ],\\n \\"RequestId\\": \\"109462AF-B5FA-3D5A-9377-B27E5B******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 30\\n 1\\n \\n SELECT count(*)\\\\nFROM nation\\n 5120\\n finished\\n 9\\n 10\\n 1\\n 10.0.xx.xx:3004\\n 9\\n 2021093000414401000000023503151******\\n 1632933704000\\n false\\n adb_demo\\n 1\\n 1\\n 59.82.xx.xx\\n 16648\\n 0\\n user_default\\n test_user\\n 6\\n 4\\n 0\\n 2\\n \\n 109462AF-B5FA-3D5A-9377-B27E5B******\\n","errorExample":""}]', + 'title' => '查询诊断记录', + ], + 'DescribeDiagnosisDimensions' => [ + 'summary' => '查看符合指定检索条件的SQL在资源组、数据库名、用户名以及访问源地址等维度下的去重统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72136', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bt6u59zcmd945****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为Unix时间戳，单位：毫秒。'."\n" + .'> 最多仅支持查看14天前的数据，查询超过14天前的数据返回结果为空。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1625220210000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式为Unix时间戳，单位：毫秒。'."\n" + ."\n" + .'> * 查询结束时间需晚于查询开始时间。'."\n" + .'> * 开始时间与结束时间的间隔不能超过24小时。', + 'type' => 'string', + 'required' => true, + 'example' => '1625220213000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL查询的条件，格式为JSON字符串，包含`Type`、`Value`、`Min`或`Max`等字段。其中`Type` 表示查询维度（当前仅支持3个取值：`maxCost`、`status`和`cost`）；`Value`、`Min`或`Max`表示该维度下的查询范围。取值说明：'."\n" + .'- ` {"Type":"maxCost","Value":"100"}`：表示查看执行耗时最长的前100条SQL详情，当前`Value`的取值仅支持设置为100。'."\n" + .'- `{"Type":"status","Value":"finished"}`：表示查看已完成的SQL详情（**包含执行成功和失败的SQL**）。您也可以将`Value`设置为`running`或`failed`来查询正在执行或执行失败的SQL详情。'."\n" + .'- `{"Type":"cost","Min":"10","Max":"200"}`：表示查看执行耗时为10毫秒~200毫秒的SQL详情，您也可以自定义执行耗时的最大值与最小值，单位：毫秒。', + 'type' => 'string', + 'required' => true, + 'example' => '{"Type":"maxCost","Value":"100"}', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'ClientIps' => [ + 'description' => '访问源地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '访问源地址。', + 'type' => 'string', + 'example' => '106.11.xx.xx', + ], + ], + 'ResourceGroups' => [ + 'description' => '资源组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'user_default', + ], + ], + 'UserNames' => [ + 'description' => '用户名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + ], + 'Databases' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'tpch_1g', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E0B56BCD-1BED-30EC-8CAF-1D1E5F******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClientIps\\": [\\n \\"106.11.xx.xx\\"\\n ],\\n \\"ResourceGroups\\": [\\n \\"user_default\\"\\n ],\\n \\"UserNames\\": [\\n \\"test_user\\"\\n ],\\n \\"Databases\\": [\\n \\"tpch_1g\\"\\n ],\\n \\"RequestId\\": \\"E0B56BCD-1BED-30EC-8CAF-1D1E5F******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n [\\"106.11.xx.xx\\",\\"106.11.xx.xx\\"]\\n [\\"user_default\\"]\\n [\\"test_user\\"]\\n [\\"tpch_1g\\"]\\n E0B56BCD-1BED-30EC-8CAF-1D1E5F******\\n","errorExample":""}]', + 'title' => '查询诊断维度', + ], + 'DescribeDownloadRecords' => [ + 'summary' => '查看目标AnalyticDB MySQL版集群中最近5次的SQL查询下载任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72138', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-****************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => '下载列表详情。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态，取值为：'."\n" + .'- **running**：正在下载。'."\n" + .'- **finished**：已完成。'."\n" + .'- **failed**：下载失败。', + 'type' => 'string', + 'example' => 'finished', + ], + 'DownloadId' => [ + 'description' => '下载任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '69', + ], + 'ExceptionMsg' => [ + 'description' => '下载任务失败时返回的异常信息。', + 'type' => 'string', + 'example' => 'The query result is empty.', + ], + 'Url' => [ + 'description' => '文件下载地址。', + 'type' => 'string', + 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******"', + ], + 'FileName' => [ + 'description' => '下载文件名。', + 'type' => 'string', + 'example' => '20210806094635-20210806095135', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '987F51BE-C4CB-332A-B159-63CE87******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Records\\": [\\n {\\n \\"Status\\": \\"finished\\",\\n \\"DownloadId\\": 69,\\n \\"ExceptionMsg\\": \\"The query result is empty.\\",\\n \\"Url\\": \\"https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******\\\\\\"\\",\\n \\"FileName\\": \\"20210806094635-20210806095135\\"\\n }\\n ],\\n \\"RequestId\\": \\"987F51BE-C4CB-332A-B159-63CE87******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 987F51BE-C4CB-332A-B159-63CE87******\\n \\n failed\\n 20210806094635-20210806095135.xlsx\\n The query result is empty.\\n \\n 73\\n \\n \\n finished\\n 20210805104301-20210805164302.xlsx\\n \\n https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******\\n 72\\n \\n \\n finished\\n 20210805104301-20210805164301.xlsx\\n \\n https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164301.xlsx?Expires=1943513847&OSSAccessKeyId=*********&Signature=******\\n 71\\n \\n \\n finished\\n 20210804234858-20210805114858.xlsx\\n \\n https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210804234858-20210805114858.xlsx?Expires=1943495349&OSSAccessKeyId=*********&Signature=******\\n 70\\n \\n \\n finished\\n 20210702180330-20210702180333.xlsx\\n \\n https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210702180330-20210702180333.xlsx?Expires=1941607637&OSSAccessKeyId=*********&Signature=******\\n 69\\n \\n","errorExample":""}]', + 'title' => '查询下载记录', + ], + 'DownloadDiagnosisRecords' => [ + 'summary' => '下载目标AnalyticDB MySQL版集群中符合指定条件的查询SQL的摘要信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72137', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为Unix时间戳，单位：毫秒。'."\n" + .'> 最多仅支持查看14天前的数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1625220210000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式为Unix时间戳，单位：毫秒。'."\n" + ."\n" + .'> * 查询结束时间需晚于查询开始时间。'."\n" + .'> * 开始时间与结束时间的间隔不能超过24小时。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1625220213000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => '指定SQL查询的条件，格式为JSON字符串，包含`Type`、`Value`、`Min`或`Max`等字段。其中`Type` 表示查询维度（当前仅支持`maxCost`、`status`和`cost`3个取值）；`Value`、`Min`或`Max`表示该维度下的查询范围。具体支持的取值范围如下：'."\n" + .'- ` {"Type":"maxCost","Value":"100"}`：表示查看执行耗时最长的前100条SQL详情，当前`Value`的取值仅支持设置为100。'."\n" + .'- `{"Type":"status","Value":"finished"}`：表示查看已完成的SQL详情（**包含执行成功和失败的SQL**）。您也可以将`Value`设置为`running`或`failed`来查询正在执行或执行失败的SQL详情。'."\n" + .'- `{"Type":"cost","Min":"10","Max":"200"}`：表示查看执行耗时为10毫秒~200毫秒的SQL详情，您也可以自定义执行耗时的最大值与最小值，单位：毫秒。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"Type":"status","Value":"finished"}', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'select', + ], + ], + [ + 'name' => 'MinPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL的最小峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '88000000', + ], + ], + [ + 'name' => 'MaxPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL的最大峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '88000000', + ], + ], + [ + 'name' => 'MinScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL的最小扫描量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000', + ], + ], + [ + 'name' => 'MaxScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL的最大扫描量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '110000000', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL所属的资源组。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_default', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '执行目标SQL的用户名。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => [ + 'description' => '执行目标SQL的数据库。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源地址。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => '106.11.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'DownloadId' => [ + 'description' => '下载ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '68', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D4ACF4E0-2952-3A87-9A2C-474058******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DownloadId\\": 68,\\n \\"RequestId\\": \\"D4ACF4E0-2952-3A87-9A2C-474058******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D4ACF4E0-2952-3A87-9A2C-474058******\\n 68\\n","errorExample":""}]', + 'title' => '下载诊断记录', + ], + 'DescribeDiagnosisSQLInfo' => [ + 'summary' => '查看某个SQL的执行详情，包括执行计划、运行信息、资源使用、自诊断结果等。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72141', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下AnalyticDB MySQL数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL支持的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '查询ID。'."\n" + .'> 您可以调用[DescribeDiagnosisRecords](~~308207~~)接口查看指定的AnalyticDB MySQL集群中SQL摘要信息，包括查询ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021070216432217201616806503453******', + ], + ], + [ + 'name' => 'ProcessStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的执行开始时间，格式为Unix时间戳，单位为毫秒（ms）。'."\n" + .'> 您可以调用[DescribeDiagnosisRecords](~~308207~~)接口查看指定的AnalyticDB MySQL集群中SQL摘要信息，包括SQL语句的执行开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1625215402000', + ], + ], + [ + 'name' => 'ProcessState', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的状态，取值如下：'."\n" + .'- **running**：执行中。'."\n" + .'- **finished**：已完成。'."\n" + .'- **failed**：执行失败。'."\n" + .'> 您可以调用[DescribeDiagnosisRecords](~~308207~~)接口查看指定的AnalyticDB MySQL集群中SQL摘要信息，包括SQL语句的状态信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'running', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日语。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProcessRcHost', + 'in' => 'query', + 'schema' => [ + 'description' => '执行SQL语句的AnalyticDB MySQL前端节点IP和端口信息。'."\n" + .'> 您可以调用[DescribeDiagnosisRecords](~~308207~~)接口查看指定的AnalyticDB MySQL集群中SQL摘要信息，包括前端节点IP和端口信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '192.45.***.***:3145', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'DiagnosisSQLInfo' => [ + 'description' => 'SQL的执行详情，包括详细的SQL语句、统计信息、执行计划和算子信息等。', + 'type' => 'string', + 'example' => '{ "DiagnosisSQLInfo": { "hasSharedStage": false, "resourceGroup": "user_default", "cost": 274, "queuedTime": 0, "outputDataSize": 9, "scheduled": true, "query": "/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE \'PROMO%\' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate >= DATE \'1995-09-01\' AND l_shipdate < DATE \'1995-09-01\' + INTERVAL \'1\' MONTH", "outputRows": 1, "userName": "test_user", "parentId": 0, "maxOutputRows": 200000, "scanSize": 8247470, "peakMemory": 13188295, "startTime": 1626330527632, "state": "FINISHED", "endTime": 1626330527905, "writeTableRows": 0, "scanRows": 351966 } }', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1', + ], + 'StageInfos' => [ + 'description' => '查询的分阶段执行信息。', + 'type' => 'array', + 'items' => [ + 'description' => '查询的分阶段执行信息。', + 'type' => 'object', + 'properties' => [ + 'InputRows' => [ + 'description' => 'Stage总的输入行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'InputDataSize' => [ + 'description' => 'Stage总的输入数据量，单位为Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'OutputRows' => [ + 'description' => 'Stage总的输出行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '231', + ], + 'OutputDataSize' => [ + 'description' => 'Stage总的输出数据量，单位为Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12344', + ], + 'PeakMemory' => [ + 'description' => 'Stage总的峰值内存，单位为Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3421', + ], + 'OperatorCost' => [ + 'description' => 'Stage的算子累积耗时，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'StageId' => [ + 'description' => 'StageID。', + 'type' => 'string', + 'example' => 'Stage[26]', + ], + 'State' => [ + 'description' => 'Stage状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'FAILED' => 'FAILED', + 'RUNNING' => 'RUNNING', + 'FINISHED' => 'FINISHED', + ], + 'example' => 'RUNNING', + ], + 'Progress' => [ + 'description' => 'Stage的执行进度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.3', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DiagnosisSQLInfo\\": \\"{ \\\\\\"DiagnosisSQLInfo\\\\\\": { \\\\\\"hasSharedStage\\\\\\": false, \\\\\\"resourceGroup\\\\\\": \\\\\\"user_default\\\\\\", \\\\\\"cost\\\\\\": 274, \\\\\\"queuedTime\\\\\\": 0, \\\\\\"outputDataSize\\\\\\": 9, \\\\\\"scheduled\\\\\\": true, \\\\\\"query\\\\\\": \\\\\\"/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE \'PROMO%\' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate >= DATE \'1995-09-01\' AND l_shipdate < DATE \'1995-09-01\' + INTERVAL \'1\' MONTH\\\\\\", \\\\\\"outputRows\\\\\\": 1, \\\\\\"userName\\\\\\": \\\\\\"test_user\\\\\\", \\\\\\"parentId\\\\\\": 0, \\\\\\"maxOutputRows\\\\\\": 200000, \\\\\\"scanSize\\\\\\": 8247470, \\\\\\"peakMemory\\\\\\": 13188295, \\\\\\"startTime\\\\\\": 1626330527632, \\\\\\"state\\\\\\": \\\\\\"FINISHED\\\\\\", \\\\\\"endTime\\\\\\": 1626330527905, \\\\\\"writeTableRows\\\\\\": 0, \\\\\\"scanRows\\\\\\": 351966 } }\\",\\n \\"RequestId\\": \\"1\\",\\n \\"StageInfos\\": [\\n {\\n \\"InputRows\\": 123,\\n \\"InputDataSize\\": 2341,\\n \\"OutputRows\\": 231,\\n \\"OutputDataSize\\": 12344,\\n \\"PeakMemory\\": 3421,\\n \\"OperatorCost\\": 2341,\\n \\"StageId\\": \\"Stage[26]\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"Progress\\": 0.3\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n { \\"DiagnosisSQLInfo\\": { \\"hasSharedStage\\": false, \\"resourceGroup\\": \\"user_default\\", \\"cost\\": 274, \\"queuedTime\\": 0, \\"outputDataSize\\": 9, \\"scheduled\\": true, \\"query\\": \\"/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE \'PROMO%\' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate &gt;= DATE \'1995-09-01\' AND l_shipdate &lt; DATE \'1995-09-01\' + INTERVAL \'1\' MONTH\\", \\"outputRows\\": 1, \\"userName\\": \\"test_user\\", \\"parentId\\": 0, \\"maxOutputRows\\": 200000, \\"scanSize\\": 8247470, \\"peakMemory\\": 13188295, \\"startTime\\": 1626330527632, \\"state\\": \\"FINISHED\\", \\"endTime\\": 1626330527905, \\"writeTableRows\\": 0, \\"scanRows\\": 351966 } }\\n 1\\n \\n 123\\n 2341\\n 231\\n 12344\\n 3421\\n 2341\\n Stage[26]\\n RUNNING\\n 0.3\\n \\n","errorExample":""}]', + 'title' => '查询诊断SQL信息', + ], + 'DescribeDiagnosisMonitorPerformance' => [ + 'summary' => '用于获取用户选定时间范围内查询的执行开始时间信息和结束时间信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72135', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp108q1py5r78****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为Unix时间戳，单位为毫秒。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1671684348000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为Unix时间戳，单位为毫秒。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1671687948000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看指定数仓版支持的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => '指定SQL的查询条件，格式为JSON字符串，包含`Type`、`Value`、`Min`或`Max`等字段。其中`Type` 表示查询维度（当前仅支持3个取值：`maxCost`、`status`和`cost`），`Value`、`Min`或`Max`表示该维度下的查询范围。具体支持的取值范围如下：'."\n" + .'- ` {"Type":"maxCost","Value":"100"}`：表示查看执行耗时最长的前100条SQL详情，当前`Value`的取值仅支持设置为100。'."\n" + .'- `{"Type":"status","Value":"finished"}`：表示查看已完成的SQL详情（**包含执行成功和失败的SQL**）。您也可以将`Value`设置为`running`或`failed`来查询正在执行或执行失败的SQL详情。'."\n" + .'- `{"Type":"cost","Min":"10","Max":"200"}`：表示查看执行耗时为10毫秒~200毫秒的SQL详情，您也可以自定义执行耗时的最大值与最小值，单位：毫秒。', + 'type' => 'string', + 'required' => true, + 'example' => '{\\"Type\\":\\"maxCost\\",\\"Value\\":\\"100\\"}', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformancesThreshold' => [ + 'description' => '绘制甘特图的查询条数阈值，默认为10000条。'."\n" + ."\n" + .'> 即使实际的查询条数多于10000条，也只会使用10000条查询绘制甘特图。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'PerformancesTruncated' => [ + 'description' => '当前返回的查询是否为全部查询。返回值说明：'."\n" + ."\n" + .'- true：当前返回的查询条数是全部查询。'."\n" + .'- false：后台限制了返回条数，即当前返回的查询不是全部查询。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8', + ], + 'Performances' => [ + 'description' => '绘制甘特图的数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '甘特图性能数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'SQL语句的状态，取值为：'."\n" + .'- **running**：执行中。'."\n" + .'- **finished**：已完成。'."\n" + .'- **failed**：执行失败。', + 'type' => 'string', + 'example' => 'running', + ], + 'ProcessId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '202210311015270330101470300315153****', + ], + 'StartTime' => [ + 'description' => '目标SQL语句的执行开始时间，格式为Unix时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1669011260000', + ], + 'Cost' => [ + 'description' => '查询的总耗时。单位：毫秒。'."\n" + .'> 该耗时指标是`QueuedTime`、`TotalPlanningTime`和`ExecutionTime`三个耗时指标的累加值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '252', + ], + 'ScanRows' => [ + 'description' => '扫描行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'PeakMemory' => [ + 'description' => '查询的峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RcHost' => [ + 'description' => '执行SQL语句的AnalyticDB MySQL前端节点IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'ScanSize' => [ + 'description' => '扫描数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'UserName' => [ + 'description' => '提交查询使用的用户名。', + 'type' => 'string', + 'example' => 'rpt', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformancesThreshold\\": 10000,\\n \\"PerformancesTruncated\\": false,\\n \\"RequestId\\": \\"0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8\\",\\n \\"Performances\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"ProcessId\\": \\"202210311015270330101470300315153****\\",\\n \\"StartTime\\": 1669011260000,\\n \\"Cost\\": 252,\\n \\"ScanRows\\": 2345,\\n \\"PeakMemory\\": 123,\\n \\"RcHost\\": \\"192.168.XX.XX\\",\\n \\"ScanSize\\": 123,\\n \\"UserName\\": \\"rpt\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 10000\\n false\\n 0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8\\n \\n running\\n 202210311015270330101470300315153****\\n 1669011260000\\n 252\\n 2345\\n 123\\n 192.168.XX.XX\\n 123\\n rpt\\n \\n","errorExample":""}]', + 'title' => '查询智能运维的监控信息', + ], + 'DescribeSQLPatterns' => [ + 'summary' => '调用DescribeSQLPatterns接口查看指定日期内AnalyticDB MySQL版集群下的SQL Pattern列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '90989', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 仅支持查看最近14天的数据。例如：当前时间为2021-11-22T12:00:00Z，最早可以查询到2021-11-09T12:00:00Z的数据。'."\n" + .'> - 查询开始时间和查询结束时间的间隔不能大于24小时。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-30T00:10:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 查询结束时间需晚于查询开始时间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-30T00:15:00Z', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL关键字。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"AverageQueryTime","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。取值说明：'."\n" + .' - `PatternCreationTime`：查询时间范围内，Pattern的最早提交时间。'."\n" + .' - `AverageQueryTime`：查询时间范围内，Pattern的平均总耗时。'."\n" + .' - `MaxQueryTime`：查询时间范围内，Pattern的最大总耗时。'."\n" + .' - `AverageExecutionTime`: 查询时间范围内，Pattern的平均执行耗时。'."\n" + .' - `MaxExecutionTime`: 查询时间范围内，Pattern的最大执行耗时。'."\n" + .' - `AveragePeakMemory`: 查询时间范围内，Pattern的平均峰值内存。'."\n" + .' - `MaxPeakMemory`: 查询时间范围内，Pattern的最大峰值内存。'."\n" + .' - `AverageScanSize`: 查询时间范围内，Pattern的平均数据读取量。'."\n" + .' - `MaxScanSize`: 查询时间范围内，Pattern的最大数据读取量。'."\n" + .' - `QueryCount`: 查询时间范围内，Pattern的执行次数。'."\n" + .' - `FailedCount`: 查询时间范围内，Pattern的失败次数。'."\n" + ."\n" + .'- `Type`表示排序方式。取值说明（取值不区分大小写）：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => '[{"Field":"AverageQueryTime","Type":"Asc"}]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。'."\n" + .'> 本参数不填写，默认为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值说明：'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**'."\n" + ."\n" + .'> 本参数不填写，默认为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'zh', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PatternDetails' => [ + 'description' => 'SQL Pattern的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'SQLPattern' => [ + 'description' => 'SQL Pattern的具体语句。', + 'type' => 'string', + 'example' => 'SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)', + ], + 'PatternId' => [ + 'description' => 'SQL Pattern的ID。', + 'type' => 'string', + 'example' => '5575924945138******', + ], + 'User' => [ + 'description' => '提交Pattern相关的SQL数据库用户名。', + 'type' => 'string', + 'example' => 'reporter', + ], + 'AccessIp' => [ + 'description' => '提交Pattern相关的SQL客户端IP地址。', + 'type' => 'string', + 'example' => '192.168.xx.xx', + ], + 'Tables' => [ + 'description' => 'SQL Pattern扫描的数据库表名。', + 'type' => 'string', + 'example' => 'tpch.orders', + ], + 'PatternCreationTime' => [ + 'description' => '查询时间范围内，Pattern的最早提交时间。单位：毫秒。', + 'type' => 'string', + 'example' => '2021-11-12 03:06:00', + ], + 'AverageQueryTime' => [ + 'description' => '查询时间范围内，Pattern的平均总耗时。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'MaxQueryTime' => [ + 'description' => '查询时间范围内，Pattern的最大总耗时。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'AverageExecutionTime' => [ + 'description' => '查询时间范围内，Pattern的平均执行耗时。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234.78', + ], + 'MaxExecutionTime' => [ + 'description' => '查询时间范围内，Pattern的最大执行耗时。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2142', + ], + 'AveragePeakMemory' => [ + 'description' => '查询时间范围内，Pattern的平均峰值内存。单位：Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234.22', + ], + 'MaxPeakMemory' => [ + 'description' => '查询时间范围内，Pattern的最大峰值内存。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234149', + ], + 'AverageScanSize' => [ + 'description' => '查询时间范围内，Pattern的平均扫描量。单位：Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234149.23', + ], + 'MaxScanSize' => [ + 'description' => '查询时间范围内，Pattern的最大扫描量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234149', + ], + 'QueryCount' => [ + 'description' => '查询时间范围内，Pattern的执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '345', + ], + 'FailedCount' => [ + 'description' => '查询时间范围内，Pattern的失败次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'Blockable' => [ + 'description' => '能否拦截当前SQL Pattern的运行。取值说明：'."\n" + .'* **true**：支持拦截。'."\n" + .'* **false**：不支持拦截。'."\n" + .'> 目前AnalyticDB MySQL版仅支持Select和Insert相关语句的拦截。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'QueryTimeSum' => [ + 'description' => '耗时总量。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'QueryTimePercentage' => [ + 'description' => '单个Pattern在查询时间范围内的耗时总量，在所有Pattern中的占比。单位：%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'PeakMemorySum' => [ + 'description' => '峰值内存总量，单位：Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'PeakMemoryPercentage' => [ + 'description' => '峰值内存总量占比。单位：%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'ScanSizeSum' => [ + 'description' => '数据扫描总量。单位：Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'ScanSizePercentage' => [ + 'description' => '数据扫描总量占比。单位：%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '80', + ], + 'AverageOperatorCost' => [ + 'description' => '平均CPU Cost。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'MaxOperatorCost' => [ + 'description' => '最大CPU Cost。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'OperatorCostSum' => [ + 'description' => 'CPU Cost总量。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'OperatorCostPercentage' => [ + 'description' => 'CPU Cost总量占比。单位：%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20', + ], + 'AverageScanCost' => [ + 'description' => '平均表扫描CPU Cost。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'MaxScanCost' => [ + 'description' => '最大表扫描CPU Cost。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'ScanCostSum' => [ + 'description' => '数据扫描Cost总量。单位：Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'ScanCostPercentage' => [ + 'description' => '数据扫描Cost总量占比。单位：%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"PatternDetails\\": [\\n {\\n \\"SQLPattern\\": \\"SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)\\",\\n \\"PatternId\\": \\"5575924945138******\\",\\n \\"User\\": \\"reporter\\",\\n \\"AccessIp\\": \\"192.168.xx.xx\\",\\n \\"Tables\\": \\"tpch.orders\\",\\n \\"PatternCreationTime\\": \\"2021-11-12 03:06:00\\",\\n \\"AverageQueryTime\\": 4,\\n \\"MaxQueryTime\\": 2341,\\n \\"AverageExecutionTime\\": 234.78,\\n \\"MaxExecutionTime\\": 2142,\\n \\"AveragePeakMemory\\": 234.22,\\n \\"MaxPeakMemory\\": 234149,\\n \\"AverageScanSize\\": 234149.23,\\n \\"MaxScanSize\\": 234149,\\n \\"QueryCount\\": 345,\\n \\"FailedCount\\": 234,\\n \\"Blockable\\": true,\\n \\"QueryTimeSum\\": 5,\\n \\"QueryTimePercentage\\": 10,\\n \\"PeakMemorySum\\": 5,\\n \\"PeakMemoryPercentage\\": 10,\\n \\"ScanSizeSum\\": 5,\\n \\"ScanSizePercentage\\": 80,\\n \\"AverageOperatorCost\\": 5,\\n \\"MaxOperatorCost\\": 5,\\n \\"OperatorCostSum\\": 5,\\n \\"OperatorCostPercentage\\": 20,\\n \\"AverageScanCost\\": 5,\\n \\"MaxScanCost\\": 5,\\n \\"ScanCostSum\\": 5,\\n \\"ScanCostPercentage\\": 5\\n }\\n ],\\n \\"RequestId\\": \\"6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 30\\n 1\\n \\n SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)\\n 5575924945138******\\n reporter\\n 192.168.xx.xx\\n tpch.orders\\n 2021-11-12 03:06:00\\n 4\\n 2341\\n 234.78\\n 2142\\n 234.22\\n 234149\\n 234149.23\\n 234149\\n 345\\n 234\\n true\\n \\n 6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******\\n","errorExample":""}]', + 'title' => '查询SQL模式列表', + 'description' => '- 中心的公网接入地址：`adb.aliyuncs.com`。'."\n" + .'- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribePatternPerformance' => [ + 'summary' => '调用DescribePatternPerformance接口查看指定时间段内SQL Pattern的各指标（如查询时间、平均内存消耗）详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91807', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-****************', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 仅支持查看最近14天内的数据。例如：当前日期为北京时间11月22日，最早可以查询到北京时间11月9日（UTC时间：2021-11-08T16:00:00Z)的数据，若查询时间早于11月9日（UTC时间：2021-11-08T16:00:00Z)，返回值为空。'."\n" + .'> - 查询开始时间和查询结束时间的间隔不能大于24小时。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-18T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 查询结束时间需晚于查询开始时间。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-18T18:05:00Z', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PatternId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL Pattern的ID。'."\n" + .'> 您可以调用[DescribeSQLPatterns](~~321868~~)接口查看指定时间内目标AnalyticDB MySQL集群下所有的SQL Pattern列表信息，包括SQL Pattern的ID。', + 'type' => 'string', + 'required' => true, + 'example' => '3847585356974******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-18T18:05Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '210f47011634026610213529******', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-18T00:00Z', + ], + 'Performances' => [ + 'description' => '性能指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '查询的性能指标项。取值说明：'."\n" + .'- **AnalyticDB_PatternQueryCount**：Pattern相关查询的总次数。'."\n" + .'- **AnalyticDB_PatternQueryTime**：Pattern相关查询的总耗时。'."\n" + .'- **AnalyticDB_PatternExecutionTime**：Pattern相关查询的执行耗时。'."\n" + .'- **AnalyticDB_PatternPeakMemory**：Pattern相关查询的峰值内存。'."\n" + .'- **AnalyticDB_PatternScanSize**：Pattern相关查询的数据读取量。', + 'type' => 'string', + 'example' => 'AnalyticDB_PatternQueryCount', + ], + 'Unit' => [ + 'description' => '性能指标项对应的单位。取值说明：'."\n" + .'- 当性能指标项为查询时间相关（即`Key`值为`AnalyticDB_PatternQueryTime`或`AnalyticDB_PatternExecutionTime`）时，该返回值为**ms**。'."\n" + .'- 当性能指标项为峰值内存相关（即`Key`值为`AnalyticDB_PatternPeakMemory`）时，该返回值为**MB**。'."\n" + .'- 当性能指标项为数据读取量（即`Key`值为`AnalyticDB_PatternScanSize`）时，该返回值为**MB**。'."\n" + .'- 当性能指标项为查询次数（即`Key`值为`AnalyticDB_PatternQueryCount`）时，该返回值为空。', + 'type' => 'string', + 'example' => 'ms', + ], + 'Series' => [ + 'description' => '性能指标项下各性能值的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '性能值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '性能值。', + 'type' => 'string', + 'example' => '[ "2021-11-18 13:38:00", "224" ]', + ], + ], + 'Name' => [ + 'description' => '性能值名称。取值说明：'."\n" + .'- 当`Key`值为`AnalyticDB_PatternQueryCount`时，该参数返回 `pattern_query_count`，即当前Pattern相关SQL的执行次数。'."\n" + .'- 当`Key`值为`AnalyticDB_PatternQueryTime`时，该参数返回：'."\n" + .' - `average_query_time`，即当前Pattern相关SQL的平均总耗时。'."\n" + .' - `max_query_time`，即当前Pattern相关SQL的最大总耗时。'."\n" + .'- 当`Key`值为`AnalyticDB_PatternExecutionTime`时，该参数返回：'."\n" + .' - `average_execution_time`，即当前Pattern相关SQL的平均执行耗时。'."\n" + .' - `max_execution_time`，即当前Pattern相关SQL的最大执行耗时。'."\n" + .'- 当`Key`值为`AnalyticDB_PatternPeakMemory`时，该参数返回：'."\n" + .' - `average_peak_memory`，即当前Pattern相关SQL的平均峰值内存。'."\n" + .' - `max_peak_memory`，即当前Pattern相关SQL的最大峰值内存。'."\n" + .'- 当`Key`值为`AnalyticDB_PatternScanSize`时，该参数返回：'."\n" + .' - `average_scan_size`，即当前Pattern相关SQL的平均读取数据量。'."\n" + .' - `max_scan_size`，即当前Pattern相关SQL的最大数据读取量。'."\n", + 'type' => 'string', + 'example' => 'max_query_time', + ], + ], + ], + ], + ], + ], + ], + 'AccessIp' => [ + 'description' => '提交Pattern相关的SQL客户端IP地址。', + 'type' => 'string', + 'example' => '172.16.14.*', + ], + 'FailedCount' => [ + 'description' => '查询时间范围内，Pattern的失败次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueryCount' => [ + 'description' => '指定时间范围内，Pattern的执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35018', + ], + 'SQLPattern' => [ + 'description' => 'SQL Pattern的具体语句。', + 'type' => 'string', + 'example' => 'SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?', + ], + 'Tables' => [ + 'description' => 'SQL Pattern查询涉及的表信息。', + 'type' => 'string', + 'example' => 'tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation', + ], + 'User' => [ + 'description' => '执行 SQL 语句的用户名。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-11-18T18:05Z\\",\\n \\"RequestId\\": \\"210f47011634026610213529******\\",\\n \\"StartTime\\": \\"2021-11-18T00:00Z\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_PatternQueryCount\\",\\n \\"Unit\\": \\"ms\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n \\"[ \\\\\\"2021-11-18 13:38:00\\\\\\", \\\\\\"224\\\\\\" ]\\"\\n ],\\n \\"Name\\": \\"max_query_time\\"\\n }\\n ]\\n }\\n ],\\n \\"AccessIp\\": \\"172.16.14.*\\",\\n \\"FailedCount\\": 0,\\n \\"QueryCount\\": 35018,\\n \\"SQLPattern\\": \\"SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?\\",\\n \\"Tables\\": \\"tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation\\",\\n \\"User\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2021-11-18T18:05Z\\n 210f47011634026610213529******\\n 2021-11-18T00:00Z\\n \\n AnalyticDB_PatternQueryCount\\n ms\\n \\n [ \\"2021-11-18 13:38:00\\", \\"224\\" ]\\n max_query_time\\n \\n \\n","errorExample":""}]', + 'title' => '查询模式性能', + ], + 'EnableAdviceService' => [ + 'summary' => '用EnableAdviceService来开启建议服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '74019', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1q10xxzq2z4****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看可用地域的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E1745C03-7CCE-55CF-932E-08121AAFA6AF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"E1745C03-7CCE-55CF-932E-08121AAFA6AF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n E1745C03-7CCE-55CF-932E-08121AAFA6AF\\n","errorExample":""}]', + 'title' => '开通建议服务', + ], + 'ApplyAdviceById' => [ + 'summary' => '调用ApplyAdviceById接口应用一条优化建议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '73711', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => '地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~143074~~)查看可用的地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AdviceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceId', + 'description' => '建议ID。', + 'type' => 'string', + 'required' => false, + 'example' => '0baf1f52-53df-487f-8292-99a03716****', + ], + ], + [ + 'name' => 'AdviceDate', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceDate', + 'description' => '建议生成的日期。格式：yyyyMMdd（UTC时间）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20221101', + ], + ], + [ + 'name' => 'ApplyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'BuildImmediately', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'Execution Status', + 'description' => '应用建议执行结果。取值说明：'."\n" + .'- 请求正常，返回**SUCCESS**。 '."\n" + .'- 请求异常，返回具体异常错误信息。', + 'type' => 'string', + 'enumValueTitles' => [ + 'SUCCESS' => 'SUCCESS', + '报错信息' => '报错信息', + ], + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5DC10091-348D-12B1-906D-AB49D658012E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"5DC10091-348D-12B1-906D-AB49D658012E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n SUCCESS\\n 5DC10091-348D-12B1-906D-AB49D658012E\\n","errorExample":""}]', + 'title' => '应用优化建议', + ], + 'BatchApplyAdviceByIdList' => [ + 'summary' => '用BatchApplyAdviceByIdList接口批量应用多条优化建议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '138165', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => '地域ID，通过[DescribeRegions](~~143074~~)查看可用的地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AdviceIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '待批量应用的建议ID列表，多个建议ID之间用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'c2589ff3-e86c-4f19-80c8-2aeb7dd9****,53414470-ebf4-4a53-a312-8a1ad8fd****,6e8dce84-fec8-4b0b-9c04-b0cea12c****,b3b9703d-55ca-47e0-96dd-6a4a9dbf****', + ], + ], + [ + 'name' => 'AdviceDate', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceDate', + 'description' => '建议生成的日期。格式：yyyyMMdd（UTC时间）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20221115', + ], + ], + [ + 'name' => 'ApplyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'BuildImmediately', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'Execution Status', + 'description' => '批量应用建议执行结果。取值说明：'."\n" + .'- 请求正常，返回**SUCCESS**。 '."\n" + .'- 请求异常，返回具体异常错误信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '86F92D26-B774-5FA1-8E53-82CBEEEBB012', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"86F92D26-B774-5FA1-8E53-82CBEEEBB012\\"\\n}","errorExample":""},{"type":"xml","example":"\\n SUCCESS\\n 86F92D26-B774-5FA1-8E53-82CBEEEBB012\\n","errorExample":""}]', + 'title' => '批量应用优化建议', + ], + 'DescribeAdviceServiceEnabled' => [ + 'summary' => '用DescribeAdviceServiceEnabled来查询建议服务是否开启。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '73783', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-2ze0vp0j6t3to****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'Message', + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => '[Advisor] Advisor feature is not available for instance: am-2ze0vp0j6t3to****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', + ], + 'Result' => [ + 'title' => 'Advice Service Enabled', + 'description' => '建议服务是否开启。取值说明：'."\n" + .'- 开启，返回**True**。 '."\n" + .'- 关闭，返回**False**。', + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"[Advisor] Advisor feature is not available for instance: am-2ze0vp0j6t3to****\\",\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n [Advisor] Advisor feature is not available for instance: am-2ze0vp0j6t3to****\\n E031AABF-BD56-5966-A063-4283EF18DB45\\n false\\n","errorExample":""}]', + 'title' => '查询建议服务是否开启', + ], + 'DescribeAppliedAdvices' => [ + 'summary' => '调用DescribeAppliedAdvices接口来显示已采纳的优化建议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '73895', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。'."\n" + .'> 您可通过接口[DescribeRegions](~~143074~~)查看可用的地域ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'StartTime', + 'description' => '查询建议的开始日期，格式为yyyyMMdd（UTC时间）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20220811', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'EndTime', + 'description' => '查询建议的结束日期，格式为yyyyMMdd（UTC时间）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20220824', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => 'Lang', + 'description' => '设置建议的显示语言，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'AdviceType', + 'in' => 'query', + 'schema' => [ + 'description' => '建议的类型，取值说明：'."\n" + .'- **INDEX**：索引优化。'."\n" + .'- **TIERING**：冷热数据优化。', + 'type' => 'string', + 'required' => false, + 'example' => 'INDEX', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，支持根据表名模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'you_table_name', + ], + ], + [ + 'name' => 'SchemaTableName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名和表名。格式为**数据库.表**。', + 'type' => 'string', + 'required' => false, + 'example' => 'tpch.lineitem', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"SchemaName","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `SchemaName`：数据库名。'."\n" + .' - `TableName`：表名。'."\n" + .' - `JobStatus`：表Build任务状态。'."\n" + .' - `SubmitTime`：建议下发的时间。'."\n" + .' - `Benefit`：预期优化收益。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照优化建议下发的时间降序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"Benefit","Type":"Desc"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'title' => 'Items', + 'description' => '详情。', + 'type' => 'array', + 'items' => [ + 'description' => '建议列表。', + 'type' => 'object', + 'properties' => [ + 'AdviceId' => [ + 'title' => 'AdviceId', + 'description' => '建议ID。', + 'type' => 'string', + 'example' => '7417db9c-914d-43f3-a123-4d0e448f****', + ], + 'SubmitTime' => [ + 'title' => 'SubmitTime', + 'description' => '建议下发的时间，格式：yyMMddHHmm（UTC时间）。', + 'type' => 'string', + 'example' => '2208131600', + ], + 'SubmitStatus' => [ + 'title' => 'SubmitStatus', + 'description' => '建议的下发状态。'."\n" + .'取值说明：'."\n" + .'- **SUCCEED**：成功。'."\n" + .'- **FAILED**：失败。', + 'type' => 'string', + 'example' => 'SUCCEED', + ], + 'SQL' => [ + 'title' => 'SQL', + 'description' => '应用建议的SQL语句。', + 'type' => 'string', + 'example' => 'alter table `schema1`.`table1` drop key col1_1_idx', + ], + 'RollbackSQL' => [ + 'title' => 'RollbackSQL', + 'description' => '回滚建议的SQL语句。', + 'type' => 'string', + 'example' => 'alter table `schema1`.`table1` add key col1_1_idx(col1)', + ], + 'JobStatus' => [ + 'title' => 'JobStatus', + 'description' => '执行建议的任务的状态。'."\n" + .'取值说明：'."\n" + .'- **SUCCEED**：成功。'."\n" + .'- **FAILED**：失败。', + 'type' => 'string', + 'example' => 'SUCCEED', + ], + 'Benefit' => [ + 'title' => 'Benefit', + 'description' => '建议的收益。', + 'type' => 'string', + 'example' => '节省0.4 GB的存储空间', + ], + 'BuildSQL' => [ + 'title' => 'Benefit', + 'description' => '执行Build任务的SQL语句。', + 'type' => 'string', + 'example' => 'build table `schema1`.`table1`', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '返回的建议总数，取值为：大于等于0且不超过Integer数据类型的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'IndexFields' => [ + 'type' => 'string', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84489769-3065-5A28-A4CB-977CD426F1C3', + ], + 'TotalCount' => [ + 'description' => '返回的结果总数，取值为：大于等于0且不超过Integer数据类型的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SchemaTableNames' => [ + 'description' => '数据库名和表名的字符串拼接列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库名和表名的字符串拼接。', + 'type' => 'string', + 'example' => '['."\n" + .' "tpch.lineitem",'."\n" + .' "tpch.partsupp",'."\n" + .' "tpch.orders"'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"AdviceId\\": \\"7417db9c-914d-43f3-a123-4d0e448f****\\",\\n \\"SubmitTime\\": \\"2208131600\\",\\n \\"SubmitStatus\\": \\"SUCCEED\\",\\n \\"SQL\\": \\"alter table `schema1`.`table1` drop key col1_1_idx\\",\\n \\"RollbackSQL\\": \\"alter table `schema1`.`table1` add key col1_1_idx(col1)\\",\\n \\"JobStatus\\": \\"SUCCEED\\",\\n \\"Benefit\\": \\"节省0.4 GB的存储空间\\",\\n \\"BuildSQL\\": \\"build table `schema1`.`table1`\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test\\",\\n \\"IndexFields\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"84489769-3065-5A28-A4CB-977CD426F1C3\\",\\n \\"TotalCount\\": 1,\\n \\"SchemaTableNames\\": [\\n \\"[\\\\n \\\\\\"tpch.lineitem\\\\\\",\\\\n \\\\\\"tpch.partsupp\\\\\\",\\\\n \\\\\\"tpch.orders\\\\\\"\\\\n]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 7417db9c-914d-43f3-a123-4d0e448f****\\n 2022-08-20T16:00:00Z\\n SUCCEED\\n alter table `schema1`.`table1` drop key col1_1_idx\\n alter table `schema1`.`table1` add key col1_1_idx(col1)\\n SUCCEED\\n 节省0.4GB空间\\n build table `schema1`.`table1`\\n 1\\n 30\\n 1\\n \\n 1\\n 30\\n 84489769-3065-5A28-A4CB-977CD426F1C3\\n 1\\n","errorExample":""}]', + 'title' => '显示已采纳的优化', + ], + 'DescribeAvailableAdvices' => [ + 'summary' => '用DescribeAvailableAdvices来显示可用优化建议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '73942', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp198m028ih55****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看可用地域的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AdviceDate', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceDate', + 'description' => '建议的生成日期，格式为yyyyMMdd（UTC时间）。'."\n" + ."\n" + .'> 数据是每天凌晨分析后生成，因此要填T-1以上的时间才查询得到数据。譬如当前是20240627，那么应该传20240626或者更早的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20221124', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => 'Lang', + 'description' => '设置建议的显示语言，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => true, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'AdviceType', + 'in' => 'query', + 'schema' => [ + 'description' => '建议的类型，取值说明：'."\n" + .'- **INDEX**：索引优化。'."\n" + .'- **TIERING**：冷热数据优化。', + 'type' => 'string', + 'required' => false, + 'example' => 'Index', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，支持根据表名模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'you_table_name', + ], + ], + [ + 'name' => 'SchemaTableName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名和表名的字符串拼接。', + 'type' => 'string', + 'required' => false, + 'example' => 'tpch.lineitem', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"SchemaName","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `SchemaName`：数据库名。'."\n" + .' - `TableName`：表名。'."\n" + .' - `Benefit`：预期优化收益。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照”预期优化收益“降序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"Benefit","Type":"Desc"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'title' => 'Items', + 'description' => '详情。', + 'type' => 'array', + 'items' => [ + 'description' => '建议列表。', + 'type' => 'object', + 'properties' => [ + 'AdviceId' => [ + 'title' => 'AdviceId', + 'description' => '建议ID。', + 'type' => 'string', + 'example' => 'dcd04135-0925-4aed-a5a7-e7d92cb1****', + ], + 'AdviceDate' => [ + 'title' => 'AdviceDate', + 'description' => '建议生成的时间，格式：yyyyMMdd（UTC时间）。', + 'type' => 'string', + 'example' => '20221124', + ], + 'AdviceType' => [ + 'title' => 'AdviceType', + 'description' => '建议的类型，取值说明：'."\n" + .'- **Index**：索引优化。'."\n" + .'- **Tiering**：冷热数据优化。', + 'type' => 'string', + 'example' => 'Index', + ], + 'SQL' => [ + 'title' => 'SQL', + 'description' => '应用建议的SQL语句。', + 'type' => 'string', + 'example' => 'alter table `schema1`.`table1` drop key col1_1_idx', + ], + 'Reason' => [ + 'title' => 'Reason', + 'description' => '生成优化建议的原因。', + 'type' => 'string', + 'example' => '15天未使用，历史使用统计概率小于1%', + ], + 'Benefit' => [ + 'title' => 'Benefit', + 'description' => '建议的收益。', + 'type' => 'string', + 'example' => '节省0.4 GB的存储空间。', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '返回的建议总数，取值为：大于等于0且不超过Integer数据类型的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test_table', + ], + 'IndexFields' => [ + 'type' => 'string', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '96A55627-28E9-5E47-B8F6-D786BE551349', + ], + 'TotalCount' => [ + 'description' => '返回的结果总数，取值为：大于等于0且不超过Integer数据类型的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'SchemaTableNames' => [ + 'description' => '数据库名和表名的字符串拼接列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库名和表名的字符串拼接。', + 'type' => 'string', + 'example' => '['."\n" + .' "tpch.lineitem",'."\n" + .' "tpch.partsupp",'."\n" + .' "tpch.orders"'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.PageSize', + 'errorMessage' => 'The PageSize parameter is required.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"AdviceId\\": \\"dcd04135-0925-4aed-a5a7-e7d92cb1****\\",\\n \\"AdviceDate\\": \\"20221124\\",\\n \\"AdviceType\\": \\"Index\\",\\n \\"SQL\\": \\"alter table `schema1`.`table1` drop key col1_1_idx\\",\\n \\"Reason\\": \\"15天未使用，历史使用统计概率小于1%\\",\\n \\"Benefit\\": \\"节省0.4 GB的存储空间。\\",\\n \\"TotalCount\\": 30,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"IndexFields\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"96A55627-28E9-5E47-B8F6-D786BE551349\\",\\n \\"TotalCount\\": 30,\\n \\"SchemaTableNames\\": [\\n \\"[\\\\n \\\\\\"tpch.lineitem\\\\\\",\\\\n \\\\\\"tpch.partsupp\\\\\\",\\\\n \\\\\\"tpch.orders\\\\\\"\\\\n]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n dcd04135-0925-4aed-a5a7-e7d92cb1****\\n 20221124\\n Index\\n alter table `schema1`.`table1` drop key col1_1_idx\\n 15天未使用，历史使用统计概率小于1%\\n 节省0.4GB空间\\n 30\\n 30\\n 1\\n \\n 1\\n 30\\n 96A55627-28E9-5E47-B8F6-D786BE551349\\n 30\\n","errorExample":""}]', + 'title' => '显示可用优化建议', + ], + 'DisableAdviceService' => [ + 'summary' => '用DisableAdviceService来关闭建议服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '73983', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf67culrr26q2****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~143074~~)查看可用地域的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '57EC6CCA-A582-572C-A33D-F61845CBC03C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"57EC6CCA-A582-572C-A33D-F61845CBC03C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n 57EC6CCA-A582-572C-A33D-F61845CBC03C\\n","errorExample":""}]', + 'title' => '关闭建议服务', + ], + 'DescribeDBClusterSpaceSummary' => [ + 'summary' => '查看实例的空间概览信息，包括总数据量、热数据量、冷数据量、数据增长量等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '211904', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1u8c0mgfg58****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看数仓版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => '总数据量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：总数据量 = 热数据总量 + 冷数据总量。', + 'type' => 'string', + 'example' => '8388608', + ], + 'HotData' => [ + 'description' => '热数据。', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => '热数据总量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：热数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4194304', + ], + 'DataSize' => [ + 'description' => '表记录数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'IndexSize' => [ + 'description' => '普通索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => '主键索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'OtherSize' => [ + 'description' => '其他，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + ], + ], + 'ColdData' => [ + 'description' => '冷数据。', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => '冷数据总量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：冷数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4194304', + ], + 'DataSize' => [ + 'description' => '表记录数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'IndexSize' => [ + 'description' => '普通索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => '主键索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'OtherSize' => [ + 'description' => '其他，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + ], + ], + 'DataGrowth' => [ + 'description' => '数据增长量。', + 'type' => 'object', + 'properties' => [ + 'DayGrowth' => [ + 'description' => '近1天增长量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：近1天增长量 = 当前总数据量 - 1天前总数据量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'WeekGrowth' => [ + 'description' => '近7天日均增长量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：近7天日均增长量 = (当前总数据量 - 7天前总数据量) / 7。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25B56BC7-4978-40B3-9E48-4B7067******\\",\\n \\"Data\\": {\\n \\"TotalSize\\": \\"8388608\\",\\n \\"HotData\\": {\\n \\"TotalSize\\": 4194304,\\n \\"DataSize\\": 1048576,\\n \\"IndexSize\\": 1048576,\\n \\"PrimaryKeyIndexSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n },\\n \\"ColdData\\": {\\n \\"TotalSize\\": 4194304,\\n \\"DataSize\\": 1048576,\\n \\"IndexSize\\": 1048576,\\n \\"PrimaryKeyIndexSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n },\\n \\"DataGrowth\\": {\\n \\"DayGrowth\\": 1048576,\\n \\"WeekGrowth\\": 1048576\\n }\\n }\\n}","type":"json"}]', + 'title' => '查看集群的空间概览', + ], + 'DescribeTableStatistics' => [ + 'summary' => '查询目标AnalyticDB MySQL集群中的表信息统计详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16754', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp183qgrwywa6****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0的正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定字段进行排序，格式为JSON，是一个有序JSON数组，按输入数组的顺序进行复合排序，包含`Field`和`Type`两个字段，例如`[{ "Field":"TableName", "Type":"Asc" }]`。其中：'."\n" + .'* `Field`表示需要排序的字段名。支持排序的字段包括：TableName、ColdDataSize、DataSize、PrimaryKeyIndexSize、RowCount、IndexSize、SchemaName、PartitionCount。'."\n" + .'* `Type`表示排序类型，支持如下取值（取值均不区分大小写）：'."\n" + .' * **Desc**：降序。'."\n" + .' * **Asc**：升序。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Field":"TableName", "Type":"Asc" } ]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，支持根据表名模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'you_table_name', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cust_pay_instruction', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '信息列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4C4433FF-5D3A-4C3E-A19C-6D93B2******', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-****************', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TableStatisticRecords' => [ + 'description' => '表统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_schema', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test_table', + ], + 'RowCount' => [ + 'description' => '表行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'DataSize' => [ + 'description' => '表记录数据量，单位：Byte。'."\n" + ."\n" + .'> 表记录数据量，不包含普通索引、主键索引的数据。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15592', + ], + 'IndexSize' => [ + 'description' => '普通索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3076', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => '主键索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16340', + ], + 'PartitionCount' => [ + 'description' => '分区数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ColdDataSize' => [ + 'description' => '冷数据总量，单位：Byte。'."\n" + .'> 仅内核版本为3.1.3.4或以上集群才会返回该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SpaceRatio' => [ + 'description' => '表空间占比，单位：%。'."\n" + ."\n" + .'> 计算公式为：表空间占比 = 表总数据量 / 实例总数据量 * 100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '66.23', + ], + 'TotalSize' => [ + 'description' => '总数据量，单位：Byte。'."\n" + ."\n" + .'> 总数据量的计算，以下2个公式都成立。计算公式1：总数据量 = 热数据量 + 冷数据量，计算公式2：总数据量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1577', + ], + 'HotDataSize' => [ + 'description' => '热数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'OtherSize' => [ + 'description' => '其他，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + ], + ], + ], + ], + ], + 'SchemaNames' => [ + 'description' => '数据库名称列表。', + 'type' => 'string', + 'example' => '[\'adb_external_tpch_10gb\', \'dw_bccb\', \'dw_fm\', \'dw_test\', \'dw_yph\']', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"4C4433FF-5D3A-4C3E-A19C-6D93B2******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-****************\\",\\n \\"Items\\": {\\n \\"TableStatisticRecords\\": [\\n {\\n \\"SchemaName\\": \\"test_schema\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"RowCount\\": 3,\\n \\"DataSize\\": 15592,\\n \\"IndexSize\\": 3076,\\n \\"PrimaryKeyIndexSize\\": 16340,\\n \\"PartitionCount\\": 1,\\n \\"ColdDataSize\\": 0,\\n \\"SpaceRatio\\": 66.23,\\n \\"TotalSize\\": 1577,\\n \\"HotDataSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n }\\n ]\\n },\\n \\"SchemaNames\\": \\"[\'adb_external_tpch_10gb\', \'dw_bccb\', \'dw_fm\', \'dw_test\', \'dw_yph\']\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 4C4433FF-5D3A-4C3E-A19C-6D93B2******\\n 30\\n 1\\n am-****************\\n \\n \\n test_table\\n 0\\n 15592\\n 16340\\n 3076\\n 3\\n 1\\n test_schema\\n \\n \\n","errorExample":""}]', + 'title' => '查询表统计信息', + 'description' => '> 更多关于表信息统计的详情，请参见[监控信息](~~188721~~)。', + ], + 'DescribeExcessivePrimaryKeys' => [ + 'summary' => '查看集群存在主键过多的表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209775', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~129857~~)接口查看账号下数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1u8c0mgfg58****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定数仓版集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-09-30T00:10Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2023-05-15T07:15Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型最大值的正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置建议的显示语言，取值说明：'."\n" + .'- **zh（默认值）**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"TableSchema","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `TableSchema`：表所属的数据库名。'."\n" + .' - `TableName`：表名。'."\n" + .' - `AccessCount`：表被访问的次数。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照目标表所属的数据库升序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"TableName","Type":"Desc"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回的结果总数，取值为：大于等于0且不超过Integer数据类型的最大值，默认值为0。', + 'type' => 'string', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'example' => 'am-bp11q28kvl688****', + ], + 'Tables' => [ + 'description' => '表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果列表', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'ColumnCount' => [ + 'description' => '总列数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '26', + ], + 'PrimaryKeyCount' => [ + 'description' => '主键字段个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PrimaryKeyColumns' => [ + 'description' => '主键字段列表。', + 'type' => 'string', + 'example' => 'id,date', + ], + 'SpaceRatio' => [ + 'description' => '表空间占比，单位：%。'."\n" + ."\n" + .'> 计算公式为：表空间占比 = (表总数据量 / 实例总数据量) * 100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20', + ], + 'TotalSize' => [ + 'description' => '冷数据总量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：冷数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1073741824', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => '主键索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名。', + 'type' => 'string', + 'example' => '主键字段过多', + ], + 'Message' => [ + 'description' => '检测结果。', + 'type' => 'string', + 'example' => '检测到表存在主键过多的情况', + ], + 'Status' => [ + 'description' => '检测结果状态程度。', + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNING'."\n" + .'CRITICAL', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1906102576997697",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "202515810214480629",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .' }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"ColumnCount\\": 26,\\n \\"PrimaryKeyCount\\": 1,\\n \\"PrimaryKeyColumns\\": \\"id,date\\",\\n \\"SpaceRatio\\": 20,\\n \\"TotalSize\\": 1073741824,\\n \\"PrimaryKeyIndexSize\\": 2345\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"主键字段过多\\",\\n \\"Message\\": \\"检测到表存在主键过多的情况\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1906102576997697\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"202515810214480629\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => '检测主键过多表', + ], + 'DescribeTableAccessCount' => [ + 'summary' => '查看指定日期内AnalyticDB MySQL版集群下目标表或所有表的被访问次数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72143', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标表名。'."\n" + .'> 若该参数留空，则会返回当前日期内目标集群下所有表的使用频次数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'CUSTOMER', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的日期，格式为yyyy-MM-dd（UTC时间）。'."\n" + .'> 仅支持查看30天内的数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-08-30', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"TableSchema","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `TableSchema`：表所属的数据库名。'."\n" + .' - `TableName`：表名。'."\n" + .' - `AccessCount`：表被访问的次数。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照目标表所属的数据库升序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"TableSchema","Type":"Asc"}]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为任意正整数。默认为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C242707A-01D1-54DA-A5F6-671557******', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '表使用详情。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'ReportDate' => [ + 'description' => '表使用日期。', + 'type' => 'string', + 'example' => '2021-08-30', + ], + 'TableSchema' => [ + 'description' => '表所属的数据库。', + 'type' => 'string', + 'example' => 'tpch', + ], + 'AccessCount' => [ + 'description' => '表被访问的次数。', + 'type' => 'string', + 'example' => '6', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'CUSTOMER', + ], + 'InstanceName' => [ + 'description' => '表所属集群的集群ID。', + 'type' => 'string', + 'example' => 'am-bp1r053byu48p****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C242707A-01D1-54DA-A5F6-671557******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"ReportDate\\": \\"2021-08-30\\",\\n \\"TableSchema\\": \\"tpch\\",\\n \\"AccessCount\\": \\"6\\",\\n \\"TableName\\": \\"CUSTOMER\\",\\n \\"InstanceName\\": \\"am-bp1r053byu48p****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C242707A-01D1-54DA-A5F6-671557******\\n 1\\n 30\\n 1\\n \\n 2021-08-30\\n tpch\\n 6\\n CUSTOMER\\n am-bp1r053byu48p****\\n \\n","errorExample":""}]', + 'title' => '查询表访问统计信息', + ], + 'DescribeSqlPattern' => [ + 'summary' => '查看指定日期内AnalyticDB MySQL版集群下的SQL模板详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72142', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的日期，格式为yyyy-MM-dd（UTC时间）。'."\n" + .'> 仅支持查看30天内的数据。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-08-30', + 'default' => '2021-08-30', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"Pattern","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `Pattern`：SQL Pattern。'."\n" + .' - `AccessIP`：客户端IP。'."\n" + .' - `User`：用户名。'."\n" + .' - `QueryCount`：查询总数。'."\n" + .' - `AvgPeakMemory`：平均峰值内存，单位：KB。'."\n" + .' - `MaxPeakMemory`：最大峰值内存，单位：KB。'."\n" + .' - `AvgCpuTime`：平均计算耗时，单位：ms。'."\n" + .' - `MaxCpuTime`：最大计算耗时，单位：ms。'."\n" + .' - `AvgStageCount`：平均Stage个数。'."\n" + .' - `MaxStageCount`：最大Stage个数。'."\n" + .' - `AvgTaskCount`：平均Task个数。'."\n" + .' - `MaxTaskCount`：最大Task个数。'."\n" + .' - `AvgScanSize`：平均扫描量，单位：KB。'."\n" + .' - `MaxScanSize`：最大扫描量，单位：KB。'."\n" + ."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> - 若不设置参数，默认按照`Pattern`字段升序排列。'."\n" + .'> - 若需要按照`AccessIP`字段排序，则`Type`参数必须设置为`accessip`；若需要按照`User`字段排序，则`Type`参数必须留空或设置为`user`。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"Field":"Pattern","Type":"Asc"}]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SqlPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '需要包含的SQL Pattern的关键字。'."\n" + .'> 若该参数不填，默认返回目标集群在`StartTime`参数所设日期内的所有SQL Pattern详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定维度来聚合SQL Pattern。支持如下取值：'."\n" + .' - `user`：按用户维度聚合。'."\n" + .' - `accessip`：按访问IP来源聚合。'."\n" + ."\n" + .'> 若该参数不填，默认按照 `user`维度聚合。', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为任意正整数。默认为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'SQL Pattern详情。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'AvgStageCount' => [ + 'description' => '平均Stage个数。', + 'type' => 'string', + 'example' => '2', + ], + 'MaxCpuTime' => [ + 'description' => '最大计算耗时，单位：ms。', + 'type' => 'string', + 'example' => '17', + ], + 'AccessIP' => [ + 'description' => '客户端IP。'."\n" + .'> 仅当`Type`参数设置为`accessip`时，支持返回该参数。', + 'type' => 'string', + 'example' => '100.104.***.***', + ], + 'AvgScanSize' => [ + 'description' => '平均扫描量，单位：KB。', + 'type' => 'string', + 'example' => '0', + ], + 'MaxScanSize' => [ + 'description' => '最大扫描量，单位：KB。', + 'type' => 'string', + 'example' => '0', + ], + 'MaxPeakMemory' => [ + 'description' => '最大峰值内存，单位：KB。', + 'type' => 'string', + 'example' => '480096', + ], + 'AvgCpuTime' => [ + 'description' => '平均计算耗时，单位：ms。', + 'type' => 'string', + 'example' => '1.0625', + ], + 'User' => [ + 'description' => '用户名。'."\n" + .'> 仅当`Type`参数留空或设置为`user`时，支持返回该参数。', + 'type' => 'string', + 'example' => 'test_acc', + ], + 'AvgPeakMemory' => [ + 'description' => '平均峰值内存，单位：KB。', + 'type' => 'string', + 'example' => '240048', + ], + 'MaxStageCount' => [ + 'description' => '最大Stage个数。', + 'type' => 'string', + 'example' => '2', + ], + 'MaxTaskCount' => [ + 'description' => '最大Task个数。', + 'type' => 'string', + 'example' => '2', + ], + 'InstanceName' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp1r053byu48p****', + ], + 'QueryCount' => [ + 'description' => '查询总数。', + 'type' => 'string', + 'example' => '16', + ], + 'ReportDate' => [ + 'description' => '查询日期。', + 'type' => 'string', + 'example' => '2021-08-30', + ], + 'Pattern' => [ + 'description' => 'SQL Pattern。', + 'type' => 'string', + 'example' => 'SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1', + ], + 'AvgTaskCount' => [ + 'description' => '平均Task个数。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B6F2D1B4-2C9F-5622-B424-5E7965******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"AvgStageCount\\": \\"2\\",\\n \\"MaxCpuTime\\": \\"17\\",\\n \\"AccessIP\\": \\"100.104.***.***\\",\\n \\"AvgScanSize\\": \\"0\\",\\n \\"MaxScanSize\\": \\"0\\",\\n \\"MaxPeakMemory\\": \\"480096\\",\\n \\"AvgCpuTime\\": \\"1.0625\\",\\n \\"User\\": \\"test_acc\\",\\n \\"AvgPeakMemory\\": \\"240048\\",\\n \\"MaxStageCount\\": \\"2\\",\\n \\"MaxTaskCount\\": \\"2\\",\\n \\"InstanceName\\": \\"am-bp1r053byu48p****\\",\\n \\"QueryCount\\": \\"16\\",\\n \\"ReportDate\\": \\"2021-08-30\\",\\n \\"Pattern\\": \\"SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1\\",\\n \\"AvgTaskCount\\": \\"2\\"\\n }\\n ],\\n \\"RequestId\\": \\"B6F2D1B4-2C9F-5622-B424-5E7965******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 30\\n 1\\n 1\\n \\n 2\\n 17\\n 100.104.***.***\\n 0\\n 0\\n 480096\\n 1.0625\\n test_acc\\n 240048\\n 2\\n 2\\n am-bp1r053byu48p****\\n 16\\n 2021-08-30\\n SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1\\n 2\\n \\n B6F2D1B4-2C9F-5622-B424-5E7965******\\n","errorExample":""}]', + 'title' => '查询SQL模式', + ], + 'CheckServiceLinkedRole' => [ + 'summary' => '检查服务关联角色是否已经创建。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10762', + 'abilityTreeNodes' => [ + 'FEATUREads11TSMW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看指定数仓版支持的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ads.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BA0F6761-7A8C-59F8-9624-FB56788C0EDF', + ], + 'HasServiceLinkedRole' => [ + 'description' => '是否存在服务关联角色。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA0F6761-7A8C-59F8-9624-FB56788C0EDF\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]', + 'title' => '校验服务关联角色', + ], + 'CreateServiceLinkedRole' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '10771', + 'abilityTreeNodes' => [ + 'FEATUREads11TSMW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ads.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '051D7910-3547-5316-AB48-02BE2090B148', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"051D7910-3547-5316-AB48-02BE2090B148\\"\\n}","type":"json"}]', + 'title' => '创建服务关联角色', + 'summary' => '创建服务关联角色。', + ], + 'DescribeKmsKeys' => [ + 'summary' => '查询用户KMS密钥列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用 [DescribeRegions](~~612393~~) 接口查看集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8F91F25F-8BCF-59E3-AF67-3806DB41FD09', + ], + 'KmsKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'KmsKey' => [ + 'description' => 'KMS的key列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'KMS的密钥对象。', + 'type' => 'object', + 'properties' => [ + 'KeyAlias' => [ + 'description' => '密钥别名。', + 'type' => 'string', + 'example' => 'mykey', + ], + 'KeyId' => [ + 'description' => '密钥ID。', + 'type' => 'string', + 'example' => '2e81355b-f8e7-4090-8082-a8f8124a621c', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F91F25F-8BCF-59E3-AF67-3806DB41FD09\\",\\n \\"KmsKeys\\": {\\n \\"KmsKey\\": [\\n {\\n \\"KeyAlias\\": \\"mykey\\",\\n \\"KeyId\\": \\"2e81355b-f8e7-4090-8082-a8f8124a621c\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询用户KMS密钥列表', + ], + 'DescribeLogHubAttribute' => [ + 'summary' => '查询SLS链路详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1nz6smy07szs58p', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dcsz-af-data', + ], + ], + [ + 'name' => 'DeliverName', + 'in' => 'query', + 'schema' => [ + 'description' => '投递名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sz_sls2adb_kxdpz_af_data', + ], + ], + [ + 'name' => 'LogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'game2-sms-log', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8A564B7F-8C00-43C0-8EC5-919FBB70573', + ], + 'LoghubInfo' => [ + 'description' => '日志采集信息。', + 'type' => 'object', + 'properties' => [ + 'Delay' => [ + 'description' => '同步延迟时间，同步任务最新更新时间与当前系统时间的延迟，单位：秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '361', + ], + 'TableName' => [ + 'description' => '数据表名称。', + 'type' => 'string', + 'example' => 'test2', + ], + 'LogHubStores' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogHubStore' => [ + 'description' => '日志库名称。', + 'type' => 'array', + 'items' => [ + 'description' => '日志库对象。', + 'type' => 'object', + 'properties' => [ + 'LogKey' => [ + 'description' => '日志关键字。', + 'type' => 'string', + 'example' => 'taskid', + ], + 'FieldKey' => [ + 'description' => '关键字对应的值。', + 'type' => 'string', + 'example' => '255311', + ], + ], + ], + ], + ], + ], + 'ProjectName' => [ + 'description' => '日志项目名称。', + 'type' => 'string', + 'example' => 'test-adb', + ], + 'DBType' => [ + 'description' => '实例类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'SchemaName' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => 'cbd_bi', + ], + 'SyncStatus' => [ + 'description' => '同步状态。', + 'type' => 'string', + 'example' => 'processing', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'DeliverName' => [ + 'description' => '投递名称。', + 'type' => 'string', + 'example' => 'loghub-web-login-new', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-8vbs48m7553du1gz2', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description', + ], + 'FilterDirtyData' => [ + 'description' => '是否过滤脏数据。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LogStoreName' => [ + 'description' => '日志服务LogStore的名字。', + 'type' => 'string', + 'example' => 'device_login', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'aaa', + ], + 'DeliverTime' => [ + 'description' => '投递时间。', + 'type' => 'string', + 'example' => '2024-12-06\'T\'10:15\'Z\'', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8A564B7F-8C00-43C0-8EC5-919FBB70573\\",\\n \\"LoghubInfo\\": {\\n \\"Delay\\": 361,\\n \\"TableName\\": \\"test2\\",\\n \\"LogHubStores\\": {\\n \\"LogHubStore\\": [\\n {\\n \\"LogKey\\": \\"taskid\\",\\n \\"FieldKey\\": \\"255311\\"\\n }\\n ]\\n },\\n \\"ProjectName\\": \\"test-adb\\",\\n \\"DBType\\": \\"rds\\",\\n \\"SchemaName\\": \\"cbd_bi\\",\\n \\"SyncStatus\\": \\"processing\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"DeliverName\\": \\"loghub-web-login-new\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBClusterId\\": \\"am-8vbs48m7553du1gz2\\",\\n \\"Description\\": \\"description\\",\\n \\"FilterDirtyData\\": true,\\n \\"LogStoreName\\": \\"device_login\\",\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"UserName\\": \\"aaa\\",\\n \\"DeliverTime\\": \\"2024-12-06\'T\'10:15\'Z\'\\"\\n }\\n}","type":"json"}]', + 'title' => '查询SLS链路详情', + ], + 'DescribeLogStoreKeys' => [ + 'summary' => '查询日志库中的关键字。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'nbgame-point', + ], + ], + [ + 'name' => 'LogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志服务SLS日志库LogStore的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-hcl2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3BB185E9-BB54-1727-B876-13243E4C0EB5', + ], + 'LogStoreKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogStoreKey' => [ + 'description' => '日志服务keys列表。', + 'type' => 'array', + 'items' => [ + 'description' => '日志服务keys列表。', + 'type' => 'string', + 'example' => 'testKey', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingProjectName', + 'errorMessage' => 'ProjectName is mandatory for this action.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3BB185E9-BB54-1727-B876-13243E4C0EB5\\",\\n \\"LogStoreKeys\\": {\\n \\"LogStoreKey\\": [\\n \\"testKey\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询日志库中的关键字', + ], + 'DescribeLoghubDetail' => [ + 'summary' => '查询日志采集详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sls-hz-php-ad', + ], + ], + [ + 'name' => 'ExportName', + 'in' => 'query', + 'schema' => [ + 'description' => 'SLS投递名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'wap_log_full_to_adb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'LoghubInfo' => [ + 'description' => '日志采集信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test2', + ], + 'LogHubStores' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogHubStore' => [ + 'description' => '日志关键字。', + 'type' => 'array', + 'items' => [ + 'description' => '日志关键字。', + 'type' => 'object', + 'properties' => [ + 'LogKey' => [ + 'description' => '日志关键字。', + 'type' => 'string', + 'example' => 'put_request', + ], + 'FieldKey' => [ + 'description' => '关键字对应的值。', + 'type' => 'string', + 'example' => 'channel_id', + ], + ], + ], + ], + ], + ], + 'ProjectName' => [ + 'description' => '日志项目名称。', + 'type' => 'string', + 'example' => 'test-adb', + ], + 'SchemaName' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => 'cbd_bi', + ], + 'DBType' => [ + 'description' => '实例类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'DeliverName' => [ + 'description' => '投递名称。', + 'type' => 'string', + 'example' => 'hub-pay-callback-ykt', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-8vbs48m7553du1gz2', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'aaa', + ], + 'FilterDirtyData' => [ + 'description' => '是否过滤脏数据。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'LogStoreName' => [ + 'description' => '日志服务SLS日志库LogStore的名称。', + 'type' => 'string', + 'example' => 'device_login', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test', + ], + 'DeliverTime' => [ + 'description' => '投递时间。', + 'type' => 'string', + 'example' => '2024-12-06\'T\'10:15\'Z\'', + ], + 'DomainUrl' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'am-bp1p38m2c26s7hpk690650.ads.aliyuncs.com', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"LoghubInfo\\": {\\n \\"TableName\\": \\"test2\\",\\n \\"LogHubStores\\": {\\n \\"LogHubStore\\": [\\n {\\n \\"LogKey\\": \\"put_request\\",\\n \\"FieldKey\\": \\"channel_id\\"\\n }\\n ]\\n },\\n \\"ProjectName\\": \\"test-adb\\",\\n \\"SchemaName\\": \\"cbd_bi\\",\\n \\"DBType\\": \\"rds\\",\\n \\"DeliverName\\": \\"hub-pay-callback-ykt\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"DBClusterId\\": \\"am-8vbs48m7553du1gz2\\",\\n \\"Description\\": \\"aaa\\",\\n \\"FilterDirtyData\\": true,\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"LogStoreName\\": \\"device_login\\",\\n \\"UserName\\": \\"test\\",\\n \\"DeliverTime\\": \\"2024-12-06\'T\'10:15\'Z\'\\",\\n \\"DomainUrl\\": \\"am-bp1p38m2c26s7hpk690650.ads.aliyuncs.com\\"\\n }\\n}","type":"json"}]', + 'title' => '查询日志采集详情', + ], + 'DescribeRdsAnalysisResourceQuotas' => [ + 'summary' => '查询RDS分析实例配额。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'RdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '同步源RDS实例ID。仅MySQL分析实例会返回该参数。更多详情，请参见[MySQL分析实例简介](~~154779~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'rm-2ze09tofcv39h7165', + ], + ], + [ + 'name' => 'NodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'E32', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '实例系列。', + 'type' => 'string', + 'required' => false, + 'example' => 'mixed_storage', + ], + ], + [ + 'name' => 'NodeCount', + 'in' => 'query', + 'schema' => [ + 'description' => '节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => '实例模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'flexible', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A31D7FA-1826-5843-8807-D2F715E70CB0', + ], + 'DBNodeClassList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeClass' => [ + 'description' => '实例节点规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例节点列表对象。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '真实值。', + 'type' => 'string', + 'example' => 'E32', + ], + 'Text' => [ + 'description' => '展示值。', + 'type' => 'string', + 'example' => 'E32', + ], + ], + ], + ], + ], + ], + 'EngineVersionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EngineVersion' => [ + 'description' => '实例版本。', + 'type' => 'array', + 'items' => [ + 'description' => '实例版本对象。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '真实值。', + 'type' => 'string', + 'example' => '3.0', + ], + 'Text' => [ + 'description' => '展示值。', + 'type' => 'string', + 'example' => '3.0', + ], + ], + ], + ], + ], + ], + 'ModeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Mode' => [ + 'description' => '实例模式列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例模式。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '真实值。', + 'type' => 'string', + 'example' => 'flexible', + ], + 'Text' => [ + 'description' => '展示值。', + 'type' => 'string', + 'example' => 'flexible', + ], + ], + ], + ], + ], + ], + 'StorageTypeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StorageType' => [ + 'description' => '实例存储类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例存储类型。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '真实值。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Text' => [ + 'description' => '展示值。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + ], + ], + ], + ], + ], + 'DBNodeStorageList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeStorage' => [ + 'description' => '实例节点存储空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例节点存储空间。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '真实值。', + 'type' => 'string', + 'example' => '100', + ], + 'Text' => [ + 'description' => '展示值。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + 'DBNodeCategoryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeCategory' => [ + 'description' => '实例系列。', + 'type' => 'array', + 'items' => [ + 'description' => '实例系列。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '真实值。', + 'type' => 'string', + 'example' => 'mixed_storage', + ], + 'Text' => [ + 'description' => '展示值。', + 'type' => 'string', + 'example' => 'mixed_storage', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A31D7FA-1826-5843-8807-D2F715E70CB0\\",\\n \\"DBNodeClassList\\": {\\n \\"DBNodeClass\\": [\\n {\\n \\"Value\\": \\"E32\\",\\n \\"Text\\": \\"E32\\"\\n }\\n ]\\n },\\n \\"EngineVersionList\\": {\\n \\"EngineVersion\\": [\\n {\\n \\"Value\\": \\"3.0\\",\\n \\"Text\\": \\"3.0\\"\\n }\\n ]\\n },\\n \\"ModeList\\": {\\n \\"Mode\\": [\\n {\\n \\"Value\\": \\"flexible\\",\\n \\"Text\\": \\"flexible\\"\\n }\\n ]\\n },\\n \\"StorageTypeList\\": {\\n \\"StorageType\\": [\\n {\\n \\"Value\\": \\"cloud_essd\\",\\n \\"Text\\": \\"cloud_essd\\"\\n }\\n ]\\n },\\n \\"DBNodeStorageList\\": {\\n \\"DBNodeStorage\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"Text\\": \\"100\\"\\n }\\n ]\\n },\\n \\"DBNodeCategoryList\\": {\\n \\"DBNodeCategory\\": [\\n {\\n \\"Value\\": \\"mixed_storage\\",\\n \\"Text\\": \\"mixed_storage\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询RDS分析实例配额', + ], + 'DescribeRegionsMixed' => [ + 'summary' => '查询地域信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10816', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2E9450FF-F8AD-54C6-B3C3-009FBD7C0700', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '可用地域的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '地域信息列表。', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '集群版本。', + 'type' => 'string', + 'enumValueTitles' => [ + '2.0' => '2.0', + '3.0' => '3.0', + ], + 'example' => '3.0', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2E9450FF-F8AD-54C6-B3C3-009FBD7C0700\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"Version\\": \\"3.0\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询地域信息', + ], + 'DescribeSyncAvailableDBClusterList' => [ + 'summary' => '查询同步链路可用的实例列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsB77AUE', + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Target' => 'Target', + 'Source' => 'Source', + ], + 'example' => 'Source', + ], + ], + [ + 'name' => 'SourceDBCluster', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '源实例键值对列表。', + 'type' => 'array', + 'items' => [ + 'description' => '源实例对象结构。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '源实例类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'rds' => 'rds', + 'sls' => 'sls', + 'polardb' => 'polardb', + ], + 'example' => 'rds', + ], + 'ClusterIds' => [ + 'description' => '集群ID列表，可以是多个，需要用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1l3yh04y7us147n', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'SyncPlatform', + 'in' => 'query', + 'schema' => [ + 'description' => '同步平台。', + 'type' => 'string', + 'required' => false, + 'example' => 'ADB-CDC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FBD1DD96-AD1D-516C-9D9A-60BA081F66EE', + ], + 'SyncAvailableDBClusters' => [ + 'description' => '可用的集群列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用的集群列表。', + 'type' => 'object', + 'properties' => [ + 'TableNumber' => [ + 'description' => '表数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'DBClusterId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'rm-bp1l3yh04y7us147n', + ], + 'DBClusterDescription' => [ + 'description' => '集群的描述信息。', + 'type' => 'string', + 'example' => 'DB1', + ], + 'DBType' => [ + 'description' => '实例类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'StorageSize' => [ + 'description' => '存储空间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBD1DD96-AD1D-516C-9D9A-60BA081F66EE\\",\\n \\"SyncAvailableDBClusters\\": [\\n {\\n \\"TableNumber\\": 100,\\n \\"DBClusterId\\": \\"rm-bp1l3yh04y7us147n\\",\\n \\"DBClusterDescription\\": \\"DB1\\",\\n \\"DBType\\": \\"rds\\",\\n \\"StorageSize\\": 1000\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询同步可用的实例列表', + ], + 'DescribeSyncJobList' => [ + 'summary' => '查询集群同步作业列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsB77AUE', + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-8vb39udfi356l9psq', + ], + ], + [ + 'name' => 'SourceDBType', + 'in' => 'query', + 'schema' => [ + 'description' => '源端数据库类型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + 'rds' => 'rds', + 'sls' => 'sls', + 'polardb' => 'polardb', + ], + 'example' => 'sls', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SourceDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '源端实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-t4n766v2llx852n81', + ], + ], + [ + 'name' => 'SourceDBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '源端实例描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'GetSourceDetail', + 'in' => 'query', + 'schema' => [ + 'description' => '是否获取源端详细信息。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '482B8BAE-6EC0-5C0E-B2AF-FD42A3FC5B67', + ], + 'PageNumber' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'am-j6c22lubl8d9l3989', + ], + 'SyncJobs' => [ + 'description' => '同步作业列表。', + 'type' => 'array', + 'items' => [ + 'description' => '同步作业列表。', + 'type' => 'object', + 'properties' => [ + 'SourceStorageSize' => [ + 'description' => '源端实例存储空间大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SourceDBClusterId' => [ + 'description' => '源端实例ID。', + 'type' => 'string', + 'example' => 'pc-t4n766v2llx852n81', + ], + 'JobId' => [ + 'description' => '同步任务ID。', + 'type' => 'string', + 'example' => 'dts-xxxxx', + ], + 'SourceDBType' => [ + 'description' => '源端实例数据库类型。', + 'type' => 'string', + 'example' => 'polardb', + ], + 'SourceDBClusterDescription' => [ + 'description' => '源端实例描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SourceTableNumber' => [ + 'description' => '源端实例表数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SyncPlatform' => [ + 'description' => '同步平台。', + 'type' => 'string', + 'example' => 'ADB-CDC', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"482B8BAE-6EC0-5C0E-B2AF-FD42A3FC5B67\\",\\n \\"PageNumber\\": 1,\\n \\"DBClusterId\\": 0,\\n \\"SyncJobs\\": [\\n {\\n \\"SourceStorageSize\\": 100,\\n \\"SourceDBClusterId\\": \\"pc-t4n766v2llx852n81\\",\\n \\"JobId\\": \\"dts-xxxxx\\",\\n \\"SourceDBType\\": \\"polardb\\",\\n \\"SourceDBClusterDescription\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SourceTableNumber\\": 100,\\n \\"SyncPlatform\\": \\"ADB-CDC\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群同步作业列表', + ], + 'DescribeVSwitchs' => [ + 'summary' => '查询可组网的信息，内网按vswitch进行组网。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络（VPC）的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze1lz7nk4pn4zwy1j7pm', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定湖仓版集群的可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1B892DA2-9ABC-5CC0-AD73-405479C3FA53', + ], + 'VSwitches' => [ + 'description' => '交换机的详细信息。', + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'description' => '交换机的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机数据结构体。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '交换机的状态，取值：'."\n" + .'**Pending**：配置中。'."\n" + .'**Available**：可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'IsDefault' => [ + 'description' => '是否为默认交换机，取值：'."\n" + .'**true**：是默认交换机。'."\n" + .'**false**：不是默认交换机。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VSwitchId' => [ + 'description' => '交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-25bcdxs7pv1****', + ], + 'CidrBlock' => [ + 'description' => '交换机的IPv4网段。', + 'type' => 'string', + 'example' => '172.16.0.0/24', + ], + 'RegionNo' => [ + 'description' => '交换机所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => '交换机的创建时间。', + 'type' => 'string', + 'example' => '2022-01-18T12:43:57Z', + ], + 'AliUid' => [ + 'description' => '用户id。', + 'type' => 'string', + 'example' => '195813423043****', + ], + 'GmtModified' => [ + 'description' => '交换机的修改时间。', + 'type' => 'string', + 'example' => '2022-01-22T12:43:57Z', + ], + 'Bid' => [ + 'description' => '用户渠道ID。', + 'type' => 'string', + 'example' => '26842', + ], + 'IzNo' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'VSwitchName' => [ + 'description' => '交换机的名称。', + 'type' => 'string', + 'example' => 'VSW-测试-杭州-I', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B892DA2-9ABC-5CC0-AD73-405479C3FA53\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": true,\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\",\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2022-01-18T12:43:57Z\\",\\n \\"AliUid\\": \\"195813423043****\\",\\n \\"GmtModified\\": \\"2022-01-22T12:43:57Z\\",\\n \\"Bid\\": \\"26842\\",\\n \\"IzNo\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchName\\": \\"VSW-测试-杭州-I\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询可组网信息', + ], + 'DescribeVpcs' => [ + 'summary' => '获取指定地域内可用的VPC。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp13h7uzhulpuxvnp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Vpcs' => [ + 'description' => 'VPC的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Vpc' => [ + 'description' => 'VPC的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '单个VPC的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'VPC的状态，取值：'."\n" + ."\n" + .'- Pending：配置中。'."\n" + .'- Available：可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VpcName' => [ + 'description' => 'VPC的名称。', + 'type' => 'string', + 'example' => 'vpc1', + ], + 'VpcId' => [ + 'description' => 'VPC的ID。', + 'type' => 'string', + 'example' => 'vpc-uf6m0r5pihw1r79od6990', + ], + 'IsDefault' => [ + 'description' => '是否是该地域的默认VPC，取值：'."\n" + ."\n" + .'- true：是该地域的默认VPC。'."\n" + .'- false：不是该地域的默认VPC。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CidrBlock' => [ + 'description' => 'vpc的ipv4网段。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'RegionNo' => [ + 'description' => 'vpc所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => 'VPC的创建时间。', + 'type' => 'string', + 'example' => '1693217052000', + ], + 'AliUid' => [ + 'description' => '阿里云账户id。', + 'type' => 'string', + 'example' => '1431771514176727', + ], + 'VSwitchs' => [ + 'description' => '交换机的ID。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机的ID。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'VPC的状态，取值：'."\n" + ."\n" + .'- Pending：配置中。'."\n" + .'- Available：可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => '交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-8vbxk6ij0yz16bu4l3ijj', + ], + 'IsDefault' => [ + 'description' => '是否为默认交换机，取值：'."\n" + .'**true**：是默认交换机。'."\n" + .'**false**：不是默认交换机。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CidrBlock' => [ + 'description' => '交换机的IPv4网段。', + 'type' => 'string', + 'example' => '172.17.0.0/24', + ], + 'GmtCreate' => [ + 'description' => '交换机的创建时间。', + 'type' => 'string', + 'example' => '1549012834000', + ], + 'GmtModified' => [ + 'description' => '交换机的修改时间。', + 'type' => 'string', + 'example' => '1731031910000', + ], + 'IzNo' => [ + 'description' => '交换机所属的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'VSwitchName' => [ + 'description' => '交换机的名称。', + 'type' => 'string', + 'example' => 'vs1', + ], + ], + ], + ], + 'GmtModified' => [ + 'description' => 'VPC的修改时间。', + 'type' => 'string', + 'example' => '1724639118000', + ], + 'Bid' => [ + 'description' => '用户渠道ID。', + 'type' => 'string', + 'example' => '26842', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '78BDC895-F7C0-5961-92BE-F1C3D12B4BB5', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"vpc1\\",\\n \\"VpcId\\": \\"vpc-uf6m0r5pihw1r79od6990\\",\\n \\"IsDefault\\": false,\\n \\"CidrBlock\\": \\"192.168.0.0/16\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"1693217052000\\",\\n \\"AliUid\\": \\"1431771514176727\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-8vbxk6ij0yz16bu4l3ijj\\",\\n \\"IsDefault\\": false,\\n \\"CidrBlock\\": \\"172.17.0.0/24\\",\\n \\"GmtCreate\\": \\"1549012834000\\",\\n \\"GmtModified\\": \\"1731031910000\\",\\n \\"IzNo\\": \\"cn-hangzhou-j\\",\\n \\"VSwitchName\\": \\"vs1\\"\\n }\\n ],\\n \\"GmtModified\\": \\"1724639118000\\",\\n \\"Bid\\": \\"26842\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"78BDC895-F7C0-5961-92BE-F1C3D12B4BB5\\"\\n}","type":"json"}]', + 'title' => '获取指定地域内可用的VPC', + ], + 'ModifyLogHubStatus' => [ + 'summary' => '修改SLS链路状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6j8370er80m6wf3', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-adb', + ], + ], + [ + 'name' => 'DeliverName', + 'in' => 'query', + 'schema' => [ + 'description' => '投递名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'loghub-mnp-report', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'SLS状态。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Delete' => 'Delete', + 'Pause' => 'Pause', + 'Restart' => 'Restart', + ], + 'example' => 'Pause', + ], + ], + [ + 'name' => 'LogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志服务SLS日志库LogStore的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay-notify-wx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AA1F421-395B-5BC4-BDDC-762C508A952B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AA1F421-395B-5BC4-BDDC-762C508A952B\\"\\n}","type":"json"}]', + 'title' => '修改SLS链路状态', + ], + 'ModifySyncJob' => [ + 'summary' => '修改同步任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsB77AUE', + 'FEATUREadsH8FO36', + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp12bh6z59nh8497f', + ], + ], + [ + 'name' => 'SourceDBCluster', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '源实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '源实例信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '源端数据库类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'rds' => 'rds', + 'sls' => 'sls', + 'polardb' => 'polardb', + ], + 'example' => 'sls', + ], + 'OperateType' => [ + 'description' => '操作类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Create' => 'Create', + 'Modify' => 'Modify', + ], + 'example' => 'Create', + ], + 'ClusterIds' => [ + 'description' => '集群ID列表，可以是多个，需要用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-2zepqn129i9s3l2z3,rm-2zea4dj583129ksp6', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + 'JobId' => [ + 'description' => '同步任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dts-xxxxxx', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'SyncPlatform', + 'in' => 'query', + 'schema' => [ + 'description' => '同步链路。', + 'type' => 'string', + 'required' => false, + 'example' => 'ADB-CDC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5AD3D9DF-614F-5B97-9522-A2406A432012', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.InvalidSourceDBCluster', + 'errorMessage' => 'The operation is not permitted due to pc-wz9li839to71d2659 not synchronizing with this ADB cluster', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5AD3D9DF-614F-5B97-9522-A2406A432012\\"\\n}","type":"json"}]', + 'title' => '修改同步任务', + ], + 'OperateLogHub' => [ + 'summary' => '修改LogHub投递规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'Create', + 'in' => 'query', + 'schema' => [ + 'description' => '是否创建。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~129857~~)接口查看账号下AnalyticDB MySQL数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6rtqaj25491628z', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-adb', + ], + ], + [ + 'name' => 'LogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志服务SLS日志库LogStore的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'beta-game-mjxb-ham-pool-export', + ], + ], + [ + 'name' => 'DeliverName', + 'in' => 'query', + 'schema' => [ + 'description' => '投递名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xhxsblz_limited_gift_pay', + ], + ], + [ + 'name' => 'DeliverTime', + 'in' => 'query', + 'schema' => [ + 'description' => '投递时间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2024-10-24\'T\'13:10\'Z\'', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '描述。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'wddata', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据表名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rest_action_latest', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'admin', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '密码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ads_123', + ], + ], + [ + 'name' => 'FilterDirtyData', + 'in' => 'query', + 'schema' => [ + 'description' => '是否过滤脏数据。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'Provider', + 'in' => 'query', + 'schema' => [ + 'description' => '渠道。', + 'type' => 'string', + 'required' => false, + 'example' => 'SLS', + ], + ], + [ + 'name' => 'LogHubStores', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '字段对应关系数组。', + 'type' => 'array', + 'items' => [ + 'description' => '字段对应关系。', + 'type' => 'object', + 'properties' => [ + 'LogKey' => [ + 'description' => '日志关键字。', + 'type' => 'string', + 'required' => true, + 'example' => 'testKey', + ], + 'FieldKey' => [ + 'description' => '关键字对应的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'testValue', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '71B41FF9-1275-5F75-973D-8BC3C60236E6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvokeSLSException', + 'errorMessage' => 'An exception occured while invoke SLS Service.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"71B41FF9-1275-5F75-973D-8BC3C60236E6\\"\\n}","type":"json"}]', + 'title' => '创建日志任务', + ], + 'CancelActiveOperationTasks' => [ + 'summary' => '取消运维事件。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '149993', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-xxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '642F3512-C628-5D0C-8815-F6670CEA00D4', + ], + 'Ids' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-xxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"642F3512-C628-5D0C-8815-F6670CEA00D4\\",\\n \\"Ids\\": \\"am-xxxxxxxx\\"\\n}","type":"json"}]', + 'title' => '取消运维事件', + ], + 'DescribeHistoryEventsStat' => [ + 'summary' => '查询时间中心的历史事件。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149605', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => '产品ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb', + ], + ], + [ + 'name' => 'ArchiveStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '事件状态。取值说明：'."\n" + ."\n" + .'- Archived：已归档'."\n" + ."\n" + .'- UnArchived：未归档'."\n" + ."\n" + .'- All：所有', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-02T11:31:03Z'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BA0F6761-7A8C-59F8-9624-FB56788C0EDF', + ], + 'Items' => [ + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件列表。', + 'type' => 'object', + 'properties' => [ + 'EventCategory' => [ + 'description' => '系统事件分类。取值说明：'."\n" + ."\n" + .'- Exception：异常事件'."\n" + ."\n" + .'- Optimize：优化事件'."\n" + ."\n" + .'- Notification：通知事件'."\n" + ."\n" + .'- Maintenance：计划内运维事件', + 'type' => 'string', + 'example' => 'Exception', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA0F6761-7A8C-59F8-9624-FB56788C0EDF\\",\\n \\"Items\\": [\\n {\\n \\"EventCategory\\": \\"Exception\\",\\n \\"TotalCount\\": 2\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询统计历史事件', + ], + 'ModifyActiveOperationMaintainConf' => [ + 'summary' => '修改运维事件时间配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'CycleType', + 'in' => 'query', + 'schema' => [ + 'description' => '循环模式：Week，周。', + 'type' => 'string', + 'required' => false, + 'example' => 'Week', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '周选择 ：1-7。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3,4,5,6,7', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '02:00:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '02:00:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启：'."\n" + ."\n" + .'- 1：开启'."\n" + ."\n" + .'- 0：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0A156332-D2AC-5C98-8872-9779EA1CC022', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A156332-D2AC-5C98-8872-9779EA1CC022\\"\\n}","type":"json"}]', + 'title' => '修改运维事件时间配置', + ], + 'DescribeActiveOperationTasks' => [ + 'summary' => '获取运维事件。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '地域信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，all代表查询该用户下所有的任务，固定取值为all。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数, 默认每页25条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '25', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于0，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => '产品ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ads', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'analyticdb', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，取值：'."\n" + ."\n" + .'- -1：选择全部待执行和执行中的任务'."\n" + ."\n" + .'- 3：待执行'."\n" + ."\n" + .'- 4：执行中', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'InsName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-2ze307ym37t762hnl', + ], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许修改时间，取值：'."\n" + ."\n" + .'- -1：允许修改全部运维事件的时间'."\n" + ."\n" + .'- 0：不允许'."\n" + ."\n" + .'- 1：允许', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许取消，取值：'."\n" + ."\n" + .'- -1：允许取消全部运维事件'."\n" + ."\n" + .'- 0：不允许'."\n" + ."\n" + .'- 1：允许', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '变更级别，默认all：'."\n" + ."\n" + .'- all：选择全部异常修复和系统运维的级别'."\n" + ."\n" + .'- S0：异常修复'."\n" + ."\n" + .'- S1：系统运维', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Items' => [ + 'description' => '参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态 ：'."\n" + ."\n" + .'- 3：待执行'."\n" + ."\n" + .'- 4：执行中', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ChangeLevelEn' => [ + 'description' => '变动等级英文。', + 'type' => 'string', + 'example' => 'Risk repairment', + ], + 'TaskType' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'InsName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'am-2ze307ym37t762hnl', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ImpactZh' => [ + 'description' => '影响中文。', + 'type' => 'string', + 'example' => '实例闪断,小版本号更新', + ], + 'CreatedTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'SwitchTime' => [ + 'description' => '切换时间。', + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'ChangeLevelZh' => [ + 'description' => '变动等级中文。', + 'type' => 'string', + 'example' => '系统维护', + ], + 'Deadline' => [ + 'description' => '截止时间。', + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'PrepareInterval' => [ + 'description' => '准备间隔。', + 'type' => 'string', + 'example' => '03:00:00', + ], + 'Impact' => [ + 'description' => '影响。', + 'type' => 'string', + 'example' => 'TransientDisconnectionAndMinorVersionUpgrade', + ], + 'TaskTypeZh' => [ + 'description' => '任务类型中文。', + 'type' => 'string', + 'example' => '小版本升级', + ], + 'CurrentAVZ' => [ + 'description' => '当前AVZ。', + 'type' => 'string', + 'example' => 'cn-beijing-k', + ], + 'AllowChange' => [ + 'description' => '是否允许修改'."\n" + ."\n" + .'- 0：否'."\n" + ."\n" + .'- 1：是', + 'type' => 'string', + 'example' => '0', + ], + 'DbVersion' => [ + 'description' => '数据库版本。', + 'type' => 'string', + 'example' => '3.0', + ], + 'ImpactEn' => [ + 'description' => '影响英文。', + 'type' => 'string', + 'example' => 'Transient instance disconnection, minor version upgrade', + ], + 'InsComment' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'ModifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'AllowCancel' => [ + 'description' => '是否允许取消'."\n" + ."\n" + .'- 0：否'."\n" + ."\n" + .'- 1：是', + 'type' => 'string', + 'example' => '1', + ], + 'DbType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'analyticdb', + ], + 'ChangeLevel' => [ + 'description' => '变动等级。', + 'type' => 'string', + 'example' => 'all', + ], + 'TaskTypeEn' => [ + 'description' => '任务类型英文。', + 'type' => 'string', + 'example' => 'Minor version update', + ], + 'ResultInfo' => [ + 'description' => '结果信息。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2389899', + ], + 'SubInsNames' => [ + 'description' => '子实例列表项。', + 'type' => 'array', + 'items' => [ + 'description' => '子实例ID。', + 'type' => 'string', + 'example' => 'am-xxxxxx', + ], + ], + 'TaskParams' => [ + 'description' => '任务参数。', + 'type' => 'string', + 'example' => '{\\"outer_user_params\\":{\\"TargetMinorVersion\\":\\"3.2.2.6\\",\\"detailCode\\":\\"OldKernelVersionUpgrade\\",\\"cancelCode\\":\\"OutOfNewFeatureAndStability\\"},\\"params\\":{},\\"internal_params\\":{\\"instanceInfo\\":[],\\"destHostInfo\\":[]}}', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"PageNumber\\": 12,\\n \\"PageSize\\": 10,\\n \\"TotalRecordCount\\": 20,\\n \\"Items\\": [\\n {\\n \\"Status\\": 3,\\n \\"ChangeLevelEn\\": \\"Risk repairment\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"InsName\\": \\"am-2ze307ym37t762hnl\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ImpactZh\\": \\"实例闪断,小版本号更新\\",\\n \\"CreatedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"SwitchTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"ChangeLevelZh\\": \\"系统维护\\",\\n \\"Deadline\\": \\"2021-06-15T16:00:00Z\\",\\n \\"PrepareInterval\\": \\"03:00:00\\",\\n \\"Impact\\": \\"TransientDisconnectionAndMinorVersionUpgrade\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\",\\n \\"CurrentAVZ\\": \\"cn-beijing-k\\",\\n \\"AllowChange\\": \\"0\\",\\n \\"DbVersion\\": \\"3.0\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection, minor version upgrade\\",\\n \\"InsComment\\": \\"xxx\\",\\n \\"StartTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"ModifiedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"AllowCancel\\": \\"1\\",\\n \\"DbType\\": \\"analyticdb\\",\\n \\"ChangeLevel\\": \\"all\\",\\n \\"TaskTypeEn\\": \\"Minor version update\\",\\n \\"ResultInfo\\": \\"xxx\\",\\n \\"Id\\": 2389899,\\n \\"SubInsNames\\": [\\n \\"am-xxxxxx\\"\\n ],\\n \\"TaskParams\\": \\"{\\\\\\\\\\\\\\"outer_user_params\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"TargetMinorVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"3.2.2.6\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"detailCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"OldKernelVersionUpgrade\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cancelCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"OutOfNewFeatureAndStability\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"params\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"internal_params\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"instanceInfo\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"destHostInfo\\\\\\\\\\\\\\":[]}}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取运维事件', + ], + 'DescribeActiveOperationMaintainConf' => [ + 'summary' => '查询主动运维配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '149987', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzuemxkbvwqq', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-xxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '92B3D2F0-B5E3-5592-9A6F-D0A6C34ACBA9', + ], + 'HasConfig' => [ + 'description' => '是否已配置：'."\n" + ."\n" + .'- 1：已经配置；'."\n" + .'- 0：未配置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Config' => [ + 'description' => '实例配置信息。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'CycleType' => [ + 'description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', + 'type' => 'string', + 'example' => 'Month', + ], + 'Status' => [ + 'description' => '配置是否生效。'."\n" + ."\n" + .'- 1 生效'."\n" + .'- 2 无效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ModifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2023-05-12T12:34:40Z', + ], + 'MaintainStartTime' => [ + 'description' => '运维开始时间。', + 'type' => 'string', + 'example' => '18:00:00Z', + ], + 'MaintainEndTime' => [ + 'description' => '运维结束时间。', + 'type' => 'string', + 'example' => '20:00:00Z'."\n", + ], + 'CycleTime' => [ + 'description' => '循环时间。', + 'type' => 'string', + 'example' => '0', + ], + 'CreatedTime' => [ + 'description' => '创建运维任务配置的时间点，格式为yyyy-mm-ddThh:mm:ssZ （utc时间）。', + 'type' => 'string', + 'example' => '2023-06-08T02:23:13Z', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"92B3D2F0-B5E3-5592-9A6F-D0A6C34ACBA9\\",\\n \\"HasConfig\\": 1,\\n \\"Config\\": {\\n \\"CycleType\\": \\"Month\\",\\n \\"Status\\": 2,\\n \\"ModifiedTime\\": \\"2023-05-12T12:34:40Z\\",\\n \\"MaintainStartTime\\": \\"18:00:00Z\\",\\n \\"MaintainEndTime\\": \\"20:00:00Z\\\\n\\",\\n \\"CycleTime\\": \\"0\\",\\n \\"CreatedTime\\": \\"2023-06-08T02:23:13Z\\"\\n }\\n}","type":"json"}]', + 'title' => '查询主动运维配置', + ], + 'ModifyActiveOperationTasks' => [ + 'summary' => '修改运维事件执行时间。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '运维事件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1482487', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始切换时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-08-15T12:00:00Z', + ], + ], + [ + 'name' => 'ImmediateStart', + 'in' => 'query', + 'schema' => [ + 'description' => '是否立即执行：'."\n" + ."\n" + .'- 1：立即执行'."\n" + ."\n" + .'- 0：指定时间执行', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '运维事件ID列表， 以英文逗号隔开。', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8B709A33-5E8D-511F-A225-AFC0B6AAAD76', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"1\\",\\n \\"RequestId\\": \\"8B709A33-5E8D-511F-A225-AFC0B6AAAD76\\"\\n}","type":"json"}]', + 'title' => '修改运维事件执行时间', + ], + 'DescribeControllerDetection' => [ + 'summary' => '接入层诊断结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191870', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-xxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-05-03T15:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'> 查询结束时间需晚于查询开始时间。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-06-23T02:21Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '检测结果记录数，由检测项的实际检测结果决定。', + 'type' => 'string', + 'example' => '8', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D9856CFD-10DC-50AF-AE29-07C30FC57B86', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-xxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项及检测结果对象。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到接入节点存在CPU增高。', + ], + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => 'CPU增高检测', + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNING'."\n" + .'CRITICAL', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"8\\",\\n \\"RequestId\\": \\"D9856CFD-10DC-50AF-AE29-07C30FC57B86\\",\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Message\\": \\"检测到接入节点存在CPU增高。\\",\\n \\"Name\\": \\"CPU增高检测\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询控制器检测', + ], + 'DescribeWorkerDetection' => [ + 'summary' => '查询存储层诊断结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190701', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-xxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'> 仅支持查看最近15天内的数据。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2011-06-01T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需要大于查询开始时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-04-25T02:04Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '144', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '37A6F56E-B970-50AF-AF33-C71E57AB2C8E', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-xxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => '指标检测', + ], + 'Results' => [ + 'description' => '检测结果。', + 'type' => 'object', + 'properties' => [ + 'SkewedTables' => [ + 'description' => '表倾斜检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果。', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'kp_ods', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'train_data_test', + ], + 'DDL' => [ + 'description' => '建表语句。', + 'type' => 'string', + 'example' => 'create table(id varchar)', + ], + 'PartitionCount' => [ + 'description' => '分区数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TotalDataSize' => [ + 'description' => '表总数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'TotalRowCount' => [ + 'description' => '表总行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2335', + ], + 'TotalPkSize' => [ + 'description' => '主键数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TotalRemoteDataSize' => [ + 'description' => '总的冷数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23456', + ], + 'TotalLocalDataSize' => [ + 'description' => '本地数据量，单位Byte。', + 'type' => 'string', + 'example' => '211', + ], + 'ShardSkewedRows' => [ + 'description' => '表倾斜行数。', + 'type' => 'string', + 'example' => '345', + ], + ], + ], + ], + 'PartitionedTables' => [ + 'description' => '分区表不合理检测结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '分区表不合理检测结果。', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'kp_ods', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'lake_count', + ], + 'DDL' => [ + 'description' => '建表语句。', + 'type' => 'string', + 'example' => 'create table user(id varchar)', + ], + 'PartitionCount' => [ + 'description' => '分区数。', + 'type' => 'string', + 'example' => '4', + ], + 'PartitionIds' => [ + 'description' => '不合理分区ID。', + 'type' => 'string', + 'example' => '[2025,2026]', + ], + 'TotalDataSize' => [ + 'description' => '1234', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[2024,2025]', + ], + ], + ], + ], + 'TopAccessTables' => [ + 'description' => '表访问检测结果结合。', + 'type' => 'array', + 'items' => [ + 'description' => '表访问检测结果。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '检测指标名。', + 'type' => 'string', + 'example' => '表访问次数', + ], + 'SearchResults' => [ + 'description' => '检测结果结合。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'adb_lake_logs_pgsql', + ], + 'MaxScanCost' => [ + 'description' => '最大扫描耗时，单位ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'AvgScanCost' => [ + 'description' => '平均扫描耗时，单位ms。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234', + ], + 'MaxScanSize' => [ + 'description' => '最大扫描数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'AvgScanSize' => [ + 'description' => '平均扫描量，单位：Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234', + ], + 'AccessCount' => [ + 'description' => '表被访问的次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '345', + ], + ], + ], + ], + ], + ], + ], + 'OperatorDetails' => [ + 'description' => '异常算子详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '异常算子详情。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '检测指标名。', + 'type' => 'string', + 'example' => '峰值内存', + ], + 'SearchResults' => [ + 'description' => '检测结果集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '返回SQL查询ID，便于用户诊断。', + 'type' => 'string', + 'example' => '2024072416154919216812815303453136244', + ], + 'StageId' => [ + 'description' => 'StageID。', + 'type' => 'string', + 'example' => 'Stage[7]', + ], + 'OperatorName' => [ + 'description' => '算子名。', + 'type' => 'string', + 'example' => 'TableScan', + ], + 'PeakMemory' => [ + 'description' => '峰值内存，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'OperatorCost' => [ + 'description' => '算在CPU Cost，单位ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'InputRows' => [ + 'description' => '算子输入行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'OutputRows' => [ + 'description' => '算子输出行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '345', + ], + 'InputSize' => [ + 'description' => '算子输入数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'OutputSize' => [ + 'description' => '算子输出数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '323', + ], + 'OperatorInfo' => [ + 'description' => '算子属性信息。', + 'type' => 'string', + 'example' => '聚合函数：count', + ], + ], + ], + ], + ], + ], + ], + 'OperatorAgg' => [ + 'description' => '算子聚合结果检测结果结合。', + 'type' => 'array', + 'items' => [ + 'description' => '算子聚合结果检测结果。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '检测指标名。', + 'type' => 'string', + 'example' => 'OperatorCost', + ], + 'SearchResults' => [ + 'description' => '检测结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果。', + 'type' => 'object', + 'properties' => [ + 'OperatorName' => [ + 'description' => '算子名。', + 'type' => 'string', + 'example' => 'StageOutput', + ], + 'MaxValue' => [ + 'description' => '检测指标最大值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'TotalValue' => [ + 'description' => '指标累加值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3333', + ], + 'AvgValue' => [ + 'description' => '指标平均值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234', + ], + 'OperatorCount' => [ + 'description' => '算子出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '345', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到存在多个指标异常算子', + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"144\\",\\n \\"RequestId\\": \\"37A6F56E-B970-50AF-AF33-C71E57AB2C8E\\",\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"指标检测\\",\\n \\"Results\\": {\\n \\"SkewedTables\\": [\\n {\\n \\"SchemaName\\": \\"kp_ods\\",\\n \\"TableName\\": \\"train_data_test\\",\\n \\"DDL\\": \\"create table(id varchar)\\",\\n \\"PartitionCount\\": 3,\\n \\"TotalDataSize\\": 2345,\\n \\"TotalRowCount\\": 2335,\\n \\"TotalPkSize\\": 1234,\\n \\"TotalRemoteDataSize\\": 23456,\\n \\"TotalLocalDataSize\\": \\"211\\",\\n \\"ShardSkewedRows\\": \\"345\\"\\n }\\n ],\\n \\"PartitionedTables\\": [\\n {\\n \\"SchemaName\\": \\"kp_ods\\",\\n \\"TableName\\": \\"lake_count\\",\\n \\"DDL\\": \\"create table user(id varchar)\\",\\n \\"PartitionCount\\": \\"4\\",\\n \\"PartitionIds\\": \\"[2025,2026]\\",\\n \\"TotalDataSize\\": 0\\n }\\n ],\\n \\"TopAccessTables\\": [\\n {\\n \\"MetricName\\": \\"表访问次数\\",\\n \\"SearchResults\\": [\\n {\\n \\"TableName\\": \\"adb_lake_logs_pgsql\\",\\n \\"MaxScanCost\\": 2345,\\n \\"AvgScanCost\\": 234,\\n \\"MaxScanSize\\": 234,\\n \\"AvgScanSize\\": 234,\\n \\"AccessCount\\": 345\\n }\\n ]\\n }\\n ],\\n \\"OperatorDetails\\": [\\n {\\n \\"MetricName\\": \\"峰值内存\\",\\n \\"SearchResults\\": [\\n {\\n \\"ProcessId\\": \\"2024072416154919216812815303453136244\\",\\n \\"StageId\\": \\"Stage[7]\\",\\n \\"OperatorName\\": \\"TableScan\\",\\n \\"PeakMemory\\": 234,\\n \\"OperatorCost\\": 235,\\n \\"InputRows\\": 235,\\n \\"OutputRows\\": 345,\\n \\"InputSize\\": 2345,\\n \\"OutputSize\\": 323,\\n \\"OperatorInfo\\": \\"聚合函数：count\\"\\n }\\n ]\\n }\\n ],\\n \\"OperatorAgg\\": [\\n {\\n \\"MetricName\\": \\"OperatorCost\\",\\n \\"SearchResults\\": [\\n {\\n \\"OperatorName\\": \\"StageOutput\\",\\n \\"MaxValue\\": 3,\\n \\"TotalValue\\": 3333,\\n \\"AvgValue\\": 234,\\n \\"OperatorCount\\": 345\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"检测到存在多个指标异常算子\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '存储节点检测', + ], + 'DescribeAbnormalPatternDetection' => [ + 'summary' => '对指定时间范围内，执行指标异常的Pattern进行检测。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191995', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-xxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2011-06-01T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。使用UTC时间，格式为yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-05-18T06:30Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '300', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36B66482-A215-5F04-A42E-859983D89D7B', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-xxxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => 'Cost，PeakMemory', + ], + 'Results' => [ + 'description' => '检测结果。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果信息。', + 'type' => 'object', + 'properties' => [ + 'PatternId' => [ + 'description' => 'SQL Pattern的ID。', + 'type' => 'string', + 'example' => '5495577090378760322', + ], + 'SQLPattern' => [ + 'description' => 'SQL Pattern的具体语句。', + 'type' => 'string', + 'example' => 'SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?', + ], + 'Detail' => [ + 'description' => '当前Pattern的检测报告详情。', + 'type' => 'string', + 'example' => '{}', + ], + 'RelatedMetrics' => [ + 'description' => 'Pattern相关指标。', + 'type' => 'string', + 'example' => '最大查询耗时:1.43s'."\n" + .'最大峰值内存:20.73MB'."\n" + .'最大表读取数据量:10.12MB', + ], + 'User' => [ + 'description' => '提交查询Pattern的用户名。', + 'type' => 'string', + 'example' => 'test', + ], + 'AccessIp' => [ + 'description' => '提交Pattern的相关SQL客户端IP地址。', + 'type' => 'string', + 'example' => '11.81.238.102', + ], + 'Tables' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'ad_marketing_engine.prod_dws_oe_promotion_daily_trend_report', + ], + 'QueryCount' => [ + 'description' => '查询时间范围内，Pattern的执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72', + ], + 'FailedCount' => [ + 'description' => '查询时间范围内，Pattern的失败次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '63', + ], + ], + ], + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNNING'."\n" + .'CRITICAL', + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到2个totalTime指标异常Pattern，可能导致CPU使用率增高，或者查询变慢，影响系统稳定性，请到监控页面使用一键诊断查看详情，并进行优化', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"300\\",\\n \\"RequestId\\": \\"36B66482-A215-5F04-A42E-859983D89D7B\\",\\n \\"DBClusterId\\": \\"am-xxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"Cost，PeakMemory\\",\\n \\"Results\\": [\\n {\\n \\"PatternId\\": \\"5495577090378760322\\",\\n \\"SQLPattern\\": \\"SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?\\",\\n \\"Detail\\": \\"{}\\",\\n \\"RelatedMetrics\\": \\"最大查询耗时:1.43s\\\\n最大峰值内存:20.73MB\\\\n最大表读取数据量:10.12MB\\",\\n \\"User\\": \\"test\\",\\n \\"AccessIp\\": \\"11.81.238.102\\",\\n \\"Tables\\": \\"ad_marketing_engine.prod_dws_oe_promotion_daily_trend_report\\",\\n \\"QueryCount\\": 72,\\n \\"FailedCount\\": 63\\n }\\n ],\\n \\"Status\\": \\"NORMAL\\\\nWARNNING\\\\nCRITICAL\\",\\n \\"Message\\": \\"检测到2个totalTime指标异常Pattern，可能导致CPU使用率增高，或者查询变慢，影响系统稳定性，请到监控页面使用一键诊断查看详情，并进行优化\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询异常模式检测', + ], + 'DescribeBadSqlDetection' => [ + 'summary' => '查看一段时间范围内影响实例稳定的BadSQL。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190267', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查询账号下所有集群的信息详情。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定AnalyticDB MySQL数仓版集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-05-18T06:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需要大于查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-09-30T00:15Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh（默认值）**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '32C6E870-81E5-5E2A-BE7D-F9623F090DAB', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-xxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项。', + 'type' => 'string', + 'example' => 'PeakMemory'."\n" + .'OperatorCost'."\n" + .'ScanSize', + ], + 'Results' => [ + 'description' => '检测项的检测结果。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果对象。', + 'type' => 'object', + 'properties' => [ + 'Cost' => [ + 'description' => '查询的总耗时。单位：毫秒。'."\n" + .'> 该耗时指标是`QueuedTime`、`TotalPlanningTime`和`ExecutionTime`三个耗时指标的累加值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37', + ], + 'PeakMemory' => [ + 'description' => '查询的峰值内存。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'OperatorCost' => [ + 'description' => '该阶段内部总的算子耗时，等同于该阶段的CPU Time，可用于判断查询哪些部分消耗了较多的计算资源。单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'ScanSize' => [ + 'description' => '扫描数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'OutputDataSize' => [ + 'description' => '返回数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProcessId' => [ + 'description' => '查询ID。', + 'type' => 'string', + 'example' => '2023120808405202104101604703151654257', + ], + 'TotalStages' => [ + 'description' => '查询生成的总Stage数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'DiagnosisResults' => [ + 'description' => 'BadSQL查询诊断结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '诊断码。', + 'type' => 'string', + 'example' => 'FILTER_NOT_PUSHDOWN', + ], + 'Detail' => [ + 'description' => '查询诊断结果详情。', + 'type' => 'string', + 'example' => '查询消耗了较多的内存资源，请进行查询内存调优', + ], + 'StageId' => [ + 'description' => 'StageID。', + 'type' => 'string', + 'example' => 'Stage[1]', + ], + 'OperatorId' => [ + 'description' => '算子ID。', + 'type' => 'string', + 'example' => 'Join[234]', + ], + ], + ], + ], + 'SQL' => [ + 'description' => 'SQL语句详情。'."\n" + .'> 出于性能考虑，当前SQL语句最长支持显示5120个字符，超出限制的SQL语句会被截断。您可以调用[DownloadDiagnosisRecords](~~308212~~)接口下载符合指定条件的SQL语句的摘要信息，包括完整的SQL语句。', + 'type' => 'string', + 'example' => 'select * from user', + ], + 'PatternId' => [ + 'description' => 'SQL Pattern的ID。', + 'type' => 'string', + 'example' => '-5978869478527645300', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-05-05T02:13Z', + ], + ], + ], + ], + 'Status' => [ + 'description' => '检测结果状态。', + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNNING'."\n" + .'CRITICAL', + ], + 'Message' => [ + 'description' => '诊断结果信息。', + 'type' => 'string', + 'example' => '检测到多条BadSQL，请进行优化', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"5\\",\\n \\"RequestId\\": \\"32C6E870-81E5-5E2A-BE7D-F9623F090DAB\\",\\n \\"DBClusterId\\": \\"am-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"PeakMemory\\\\nOperatorCost\\\\nScanSize\\",\\n \\"Results\\": [\\n {\\n \\"Cost\\": 37,\\n \\"PeakMemory\\": 1234,\\n \\"OperatorCost\\": 12345,\\n \\"ScanSize\\": 1234,\\n \\"OutputDataSize\\": 1234,\\n \\"ProcessId\\": \\"2023120808405202104101604703151654257\\",\\n \\"TotalStages\\": 123,\\n \\"DiagnosisResults\\": [\\n {\\n \\"Code\\": \\"FILTER_NOT_PUSHDOWN\\",\\n \\"Detail\\": \\"查询消耗了较多的内存资源，请进行查询内存调优\\",\\n \\"StageId\\": \\"Stage[1]\\",\\n \\"OperatorId\\": \\"Join[234]\\"\\n }\\n ],\\n \\"SQL\\": \\"select * from user\\",\\n \\"PatternId\\": \\"-5978869478527645300\\",\\n \\"StartTime\\": \\"2024-05-05T02:13Z\\"\\n }\\n ],\\n \\"Status\\": \\"NORMAL\\\\nWARNNING\\\\nCRITICAL\\",\\n \\"Message\\": \\"检测到多条BadSQL，请进行优化\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '查看BadSQL', + ], + 'DescribeExecutorDetection' => [ + 'summary' => '查询计算层诊断结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190614', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口可以查看集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-xxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-10-31T02:06Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，UTC时间，格式为：yyyy-MM-ddTHH:mmZ。'."\n" + ."\n" + .'> - 查询结束时间需晚于查询开始时间。'."\n" + .'> - 查询开始时间与查询结束时间的间隔不能超过24小时。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-05-27T16:00Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B20BA053-27A1-5FDF-B063-6D6146720DF6', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-xxxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果对象。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => 'CPU增高检测', + ], + 'Results' => [ + 'description' => '检测结果集合。', + 'type' => 'object', + 'properties' => [ + 'OperatorDetails' => [ + 'description' => '指标异常算子明细列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '检测指标名。', + 'type' => 'string', + 'example' => 'PeakMemory', + ], + 'SearchResults' => [ + 'description' => '指标异常算子明细列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指标异常算子。', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '返回SQL查询ID，便于用户诊断。', + 'type' => 'string', + 'example' => '202405061006230110150170540315119xxxx', + ], + 'StageId' => [ + 'description' => 'StageID。', + 'type' => 'string', + 'example' => 'Stage[7]', + ], + 'OperatorName' => [ + 'description' => '算子名。', + 'type' => 'string', + 'example' => 'TableScan', + ], + 'PeakMemory' => [ + 'description' => '算子峰值内存。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2334', + ], + 'OperatorCost' => [ + 'description' => '该阶段内部总的算子耗时，等同于该阶段的CPU Time，可用于判断查询哪些部分消耗了较多的计算资源。单位为毫秒（ms）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2354', + ], + 'InputRows' => [ + 'description' => '算子输入行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'OutputRows' => [ + 'description' => '算子输出行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2354', + ], + 'InputSize' => [ + 'description' => '算子的输入数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'OutputSize' => [ + 'description' => '算子的输出数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'OperatorInfo' => [ + 'description' => '算子属性信息。', + 'type' => 'string', + 'example' => 'Group By字段：uid', + ], + ], + ], + ], + ], + ], + ], + 'OperatorAgg' => [ + 'description' => '算子指标聚合检测结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '算子指标决和检测结果。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '检测指标名。', + 'type' => 'string', + 'example' => 'PeakMemory', + ], + 'SearchResults' => [ + 'description' => '聚合结果检测结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '聚合结果检测结果。', + 'type' => 'object', + 'properties' => [ + 'OperatorName' => [ + 'description' => '算子名。', + 'type' => 'string', + 'example' => 'Aggregation', + ], + 'MaxValue' => [ + 'description' => '算子指标最大值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2335', + ], + 'TotalValue' => [ + 'description' => '算子指标累加值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'AvgValue' => [ + 'description' => '算子指标平均值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '235.5', + ], + 'OperatorCount' => [ + 'description' => '算子出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到Aggregation算子消耗内存资源较多', + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"20\\",\\n \\"RequestId\\": \\"B20BA053-27A1-5FDF-B063-6D6146720DF6\\",\\n \\"DBClusterId\\": \\"am-xxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"CPU增高检测\\",\\n \\"Results\\": {\\n \\"OperatorDetails\\": [\\n {\\n \\"MetricName\\": \\"PeakMemory\\",\\n \\"SearchResults\\": [\\n {\\n \\"ProcessId\\": \\"202405061006230110150170540315119xxxx\\",\\n \\"StageId\\": \\"Stage[7]\\",\\n \\"OperatorName\\": \\"TableScan\\",\\n \\"PeakMemory\\": 2334,\\n \\"OperatorCost\\": 2354,\\n \\"InputRows\\": 123,\\n \\"OutputRows\\": 2354,\\n \\"InputSize\\": 2345,\\n \\"OutputSize\\": 2345,\\n \\"OperatorInfo\\": \\"Group By字段：uid\\"\\n }\\n ]\\n }\\n ],\\n \\"OperatorAgg\\": [\\n {\\n \\"MetricName\\": \\"PeakMemory\\",\\n \\"SearchResults\\": [\\n {\\n \\"OperatorName\\": \\"Aggregation\\",\\n \\"MaxValue\\": 2335,\\n \\"TotalValue\\": 234,\\n \\"AvgValue\\": 235.5,\\n \\"OperatorCount\\": 5\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"检测到Aggregation算子消耗内存资源较多\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '计算节点检测', + ], + 'ModifyDBClusterVip' => [ + 'summary' => '修改集群访问的VIP。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads3N2V5J', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-2ze8mbuai97*****', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络VPC ID。'."\n" + ."\n" + .'> - **VPC**所在地域与集群属于同一地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-bp1at5ze0t5u3xtqn****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。'."\n" + .'> - 传入的新虚拟交换机必须与集群属于同一个可用区。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp1aadw9k19x6cis9****', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-2ze8mbuai974s4y2500000169.ads.aliyuncs.com', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-****-4A42-BF6D-8A4442913CEF', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '1564657730', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'adb::2019-03-15::DescribeTaskInfo', + 'callbackInterval' => 60000, + 'maxCallbackTimes' => 10, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-****-4A42-BF6D-8A4442913CEF\\",\\n \\"TaskId\\": \\"1564657730\\"\\n}","type":"json"}]', + 'title' => '修改集群访问VIP', + ], + 'GetCreateTableSQL' => [ + 'summary' => '查询某个表的建表语句。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212741', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL数仓版（3.0）集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看AnalyticDB MySQL湖仓版（3.0）集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'SQL' => [ + 'description' => 'SQL语句。', + 'type' => 'string', + 'example' => 'create table ('."\n" + .' id varchar(32)'."\n" + .');', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1906102576997697",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "202515810214480629",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .' }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"SQL\\": \\"create table (\\\\n id varchar(32)\\\\n);\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1906102576997697\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"202515810214480629\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => '查询某个表的建表语句', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeInclinedNodes' => [ + 'summary' => '查询所有存储节点的磁盘水位。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215312', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-ufxxxxxxxxxx3q1x1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日语。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8C1A419E-5A79-51A9-B533-FCCB98AD8FD5', + ], + 'Items' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '存储节点信息。', + 'type' => 'object', + 'properties' => [ + 'Node' => [ + 'description' => '存储节点编号。', + 'type' => 'string', + 'example' => 'Node1', + ], + 'DiskUsageRatio' => [ + 'description' => '存储节点磁盘水位，单位%。', + 'type' => 'string', + 'example' => '90.5', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C1A419E-5A79-51A9-B533-FCCB98AD8FD5\\",\\n \\"Items\\": [\\n {\\n \\"Node\\": \\"Node1\\",\\n \\"DiskUsageRatio\\": \\"90.5\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询存储节点磁盘水位', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeOversizeNonPartitionTableInfos' => [ + 'summary' => '调用DescribeOversizeNonPartitionTableInfos接口查询空间占用过大且没有进行分区的表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209781', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-8vb46cpn2aaxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-09-06T03:06:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-05-03T15:01:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日语。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JOSN字符串，例如`[{"Field":"SchemaName","Type":"Desc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `SchemaName`：表所属的数据库名。'."\n" + .' - `RowCount`：表名。'."\n" + .' - `IndexSize`：普通索引数据量。'."\n" + .' - `PrimaryKeySize`：主键索引数据量。'."\n" + .' - `DataSize`：表记录数据量。'."\n" + .' - `LocalDataSize`：热数据量。'."\n" + .' - `RemoteDataSize`：冷数据量。'."\n" + .' - `SpaceRatio`：空间占比。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照目标表的总数据量倒序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"Field\\":\\"SchemaName\\",\\"Type\\":\\"Asc\\"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '21', + ], + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F67B5AC5-6CDE-5187-9E25-B1EEE9AC4D91', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-8vb46cpn2aaxxxxxx', + ], + 'Tables' => [ + 'description' => '表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表信息。', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RowCount' => [ + 'description' => '表行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3294', + ], + 'IndexSize' => [ + 'description' => '普通索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1073741824', + ], + 'DataSize' => [ + 'description' => '表记录数据量，单位：Byte。'."\n" + ."\n" + .'> 表记录数据量，不包含普通索引、主键索引的数据。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21474836480', + ], + 'LocalDataSize' => [ + 'description' => '热数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24696061952', + ], + 'PrimaryKeySize' => [ + 'description' => '主键索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2147483648', + ], + 'RemoteDataSize' => [ + 'description' => '冷数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SpaceRatio' => [ + 'description' => '表空间占比，单位：%。'."\n" + ."\n" + .'> 计算公式为：表空间占比 = (表总数据量 / 实例总数据量) * 100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '23', + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => '非分区表过大检测', + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到表存在分区不合理的情况', + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"21\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"RequestId\\": \\"F67B5AC5-6CDE-5187-9E25-B1EEE9AC4D91\\",\\n \\"DBClusterId\\": \\"am-8vb46cpn2aaxxxxxx\\",\\n \\"Tables\\": [\\n {\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test\\",\\n \\"RowCount\\": 3294,\\n \\"IndexSize\\": 1073741824,\\n \\"DataSize\\": 21474836480,\\n \\"LocalDataSize\\": 24696061952,\\n \\"PrimaryKeySize\\": 2147483648,\\n \\"RemoteDataSize\\": 0,\\n \\"SpaceRatio\\": 23\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"非分区表过大检测\\",\\n \\"Message\\": \\"检测到表存在分区不合理的情况\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询过大的非分区表', + ], + 'ModifyDBClusterShardNumber' => [ + 'summary' => '修改实例分片数目', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237895', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL数仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'NewShardNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '目标分片(Shard)数目', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '256', + ], + ], + [ + 'name' => 'SwitchTimeMode', + 'in' => 'query', + 'schema' => [ + 'description' => '修改参数的执行时间，取值：'."\n" + .'* **Immediate**：默认值，立即执行。'."\n" + .'* **MaintainTime**：实例可运维时间段内执行。可调用ModifyDBInstanceMaintainTime接口修改可运维时间段。'."\n" + .'* **ScheduleTime**：手动指定执行时间。传入该值需要同时传入**SwitchTime**参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'Immediate', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '后台将在指定时间点执行目标待处理运维事件所对应的操作。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-07-09T22:00:00Z', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求, 默认为 false。取值范围：'."\n" + .'- true：发送检查请求，检查实例是否满足修改分片数目前置条件和传入目标分片数目的合法性，并**不会**执行修改分片操作。'."\n" + .'- false（默认）：发送正常请求，通过检查后触发后台任务更改集群分片数目。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25B56BC7-4978-40B3-9E48-4B7067******\\"\\n}","type":"json"}]', + 'title' => '修改实例分片数目', + ], + 'DeleteBackups' => [ + 'summary' => '手动删除备份集。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '245779', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB for MySQL集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'BackupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的备份集ID，多个备份集ID以英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '766,767', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '771C5FAA-530F-52F7-B84D-EBAD4561D590', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771C5FAA-530F-52F7-B84D-EBAD4561D590\\"\\n}","type":"json"}]', + 'title' => '删除备份集', + 'description' => '- 删除备份集是异步操作，前端显示会有延迟，需要等待约10-20分钟才会生效。'."\n" + .'- 单次最大允许删除100个备份集。如果要删超过100个备份集，请分2次调用。'."\n" + .'- 为保证数据安全性，系统会强制保留1个有效备份集。当要删除仅有的备份集时，接口会禁止。', + ], + 'DescribeDBClusterShardNumber' => [ + 'summary' => '获取实例分片(Shard)数目。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248197', + 'abilityTreeNodes' => [ + 'FEATUREadsULBR2S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数仓版集群ID。'."\n" + .'您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBE843D8-964D-5EA3-9D31-822125611B6E', + ], + 'ShardNumber' => [ + 'description' => '实例分片数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128', + ], + 'AvailableShardNumberList' => [ + 'description' => '支持的全部分片数列表，包含当前分片数及可修改到的目标分片数。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的全部分片数列表，包含当前分片数及可修改到的目标分片数。', + 'type' => 'object', + 'properties' => [ + 'ShardNumber' => [ + 'description' => '分片数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128', + ], + ], + ], + ], + 'AvailableShardNumbers' => [ + 'description' => '支持修改到的目标分片数，不包含当前分片数。', + 'type' => 'array', + 'items' => [ + 'description' => '分片数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '['."\n" + .' 128,'."\n" + .' 256,'."\n" + .' 512'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBE843D8-964D-5EA3-9D31-822125611B6E\\",\\n \\"ShardNumber\\": 128,\\n \\"AvailableShardNumberList\\": [\\n {\\n \\"ShardNumber\\": 128\\n }\\n ],\\n \\"AvailableShardNumbers\\": [\\n 0\\n ]\\n}","type":"json"}]', + 'title' => '获取实例分片数目', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'adb.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'adb.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'adb.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'adb.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'adb.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'adb.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'adb.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'adb.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'adb.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'adb.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'adb.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'adb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'adb.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'adb.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'adb.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'adb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'adb.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'adb.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'adb.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'adb.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'adb.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'adb.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'adb.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'adb.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'adb.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'adb.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'adb.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'adb.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'adb.cn-north-2-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'adb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'adb.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/adb/2021-12-01/api-docs.php b/data/zh_cn/adb/2021-12-01/api-docs.php new file mode 100644 index 0000000..228c1f1 --- /dev/null +++ b/data/zh_cn/adb/2021-12-01/api-docs.php @@ -0,0 +1,45804 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'adb', + 'version' => '2021-12-01', + ], + 'directories' => [ + [ + 'id' => 181281, + 'title' => '地域管理', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 181282, + 'title' => '集群管理', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusters', + 'CreateDBCluster', + 'ModifyDBCluster', + 'DeleteDBCluster', + 'DescribeDBClusterAttribute', + 'DescribeKernelVersion', + 'UpgradeKernelVersion', + 'DescribeDBClusterStatus', + 'ModifyDBClusterDescription', + 'DescribeClusterAccessWhiteList', + 'ModifyClusterAccessWhiteList', + 'ModifyClickhouseEngine', + ], + ], + [ + 'id' => 181284, + 'title' => '资源组管理', + 'type' => 'directory', + 'children' => [ + 'DescribeResourceGroupSpec', + 'CreateDBResourceGroup', + 'DescribeDBResourceGroup', + 'ModifyDBResourceGroup', + 'DeleteDBResourceGroup', + 'BindDBResourceGroupWithUser', + 'UnbindDBResourceGroupWithUser', + 'DescribeComputeResourceUsage', + 'DescribeUserQuota', + ], + ], + [ + 'id' => 181285, + 'title' => '资源弹性计划', + 'type' => 'directory', + 'children' => [ + 'CreateElasticPlan', + 'DescribeElasticPlans', + 'ModifyElasticPlan', + 'EnableElasticPlan', + 'DisableElasticPlan', + 'DeleteElasticPlan', + 'DescribeElasticPlanJobs', + 'DescribeElasticPlanAttribute', + 'DescribeElasticPlanSpecifications', + ], + ], + [ + 'id' => 181295, + 'title' => 'SQL审计', + 'type' => 'directory', + 'children' => [ + 'DescribeAuditLogRecords', + 'ModifyAuditLogConfig', + 'DescribeSparkAuditLogRecords', + ], + ], + [ + 'id' => 196276, + 'title' => '网络管理', + 'type' => 'directory', + 'children' => [ + 'DescribeClusterNetInfo', + 'AllocateClusterPublicConnection', + 'ReleaseClusterPublicConnection', + 'AttachUserENI', + 'DetachUserENI', + 'ModifyUserEniVswitchOptions', + 'ModifyDBClusterVip', + 'ModifyDBClusterSSL', + 'DescribeDBClusterSSL', + 'DownloadInstanceCACertificate', + ], + ], + [ + 'id' => 181296, + 'title' => '账号管理', + 'type' => 'directory', + 'children' => [ + 'DescribeAccounts', + 'CreateAccount', + 'DeleteAccount', + 'ModifyAccountDescription', + 'ResetAccountPassword', + 'CheckBindRamUser', + 'BindAccount', + 'UnbindAccount', + 'ModifyAccountPrivileges', + 'DescribeAccountPrivileges', + 'DescribeEnabledPrivileges', + 'DescribeAccountAllPrivileges', + 'DescribeAccountPrivilegeObjects', + 'DescribeOperatorPermission', + 'RevokeOperatorPermission', + 'GrantOperatorPermission', + ], + ], + [ + 'id' => 196277, + 'title' => '备份恢复', + 'type' => 'directory', + 'children' => [ + 'DescribeBackupPolicy', + 'ModifyBackupPolicy', + 'DescribeBackups', + 'CreateBackup', + 'DeleteBackups', + ], + ], + [ + 'id' => 181298, + 'title' => '监控信息', + 'type' => 'directory', + 'children' => [ + 'DescribeHistoryTasks', + 'DescribeHistoryTasksStat', + 'DescribeExecutorDetection', + 'DescribeWorkerDetection', + 'DescribeControllerDetection', + 'DescribeBadSqlDetection', + 'DescribeAbnormalPatternDetection', + 'DescribeInclinedNodes', + 'DescribeDBClusterHealthStatus', + 'DescribeDBClusterPerformance', + 'DescribeClusterResourceUsage', + 'DescribeClusterResourceDetail', + 'DescribeStorageResourceUsage', + 'DescribeJobResourceUsage', + 'DescribePerformanceViews', + 'CreatePerformanceView', + 'ModifyPerformanceView', + 'DescribePerformanceViewAttribute', + 'DeletePerformanceView', + 'ExistRunningSQLEngine', + ], + ], + [ + 'id' => 181300, + 'title' => 'Spark开发', + 'type' => 'directory', + 'children' => [ + 'ExecuteSparkWarehouseBatchSQL', + 'CancelSparkWarehouseBatchSQL', + 'ListSparkWarehouseBatchSQL', + 'GetSparkWarehouseBatchSQL', + 'StartSparkReplSession', + 'GetSparkReplStatement', + 'ExecuteSparkReplStatement', + 'CancelSparkReplStatement', + 'GetSparkReplSession', + 'DescribeSparkAppType', + 'PreloadSparkAppMetrics', + 'GetSparkAppMetrics', + 'ListSparkLogAnalyzeTasks', + 'SubmitSparkLogAnalyzeTask', + 'KillSparkLogAnalyzeTask', + 'GetSparkLogAnalyzeTask', + 'SetSparkAppLogRootPath', + 'GetSparkConfigLogPath', + 'StartSparkSQLEngine', + 'KillSparkSQLEngine', + 'GetSparkSQLEngineState', + 'DescribeSparkCodeOutput', + 'DescribeSparkCodeLog', + 'DescribeSparkCodeWebUi', + 'ListSparkTemplateFileIds', + 'GetSparkAppWebUiAddress', + 'ListSparkAppAttempts', + 'CreateSparkTemplate', + 'DeleteSparkTemplate', + 'GetSparkTemplateFolderTree', + 'GetSparkTemplateFullTree', + 'GetSparkTemplateFileContent', + 'UpdateSparkTemplateFile', + 'DeleteSparkTemplateFile', + 'GetSparkAppAttemptLog', + 'ListSparkApps', + 'GetSparkAppInfo', + 'GetSparkAppState', + 'GetSparkAppLog', + 'SubmitSparkApp', + 'KillSparkApp', + 'CreateOssSubDirectory', + ], + ], + [ + 'id' => 181301, + 'title' => '数据管理', + 'type' => 'directory', + 'children' => [ + 'DescribeViewJobs', + 'DescribeTableDetail', + 'GetCreateTableSQL', + 'DescribeTableStatistics', + 'DescribeAdbMySqlTableMeta', + 'DescribeAdbMySqlIndexes', + 'DescribeMvRecommendSubTasks', + 'DescribeMVRecommendResults', + 'DescribeMvRecommendTasks', + 'CreateMaterializedViewRecommend', + 'ModifyMaterializedView', + 'ModifyMaterializedViewRecommend', + 'DeleteMaterializedViewRecommend', + 'DescribeInclinedTables', + 'DescribeAdbMySqlColumns', + 'DescribeAdbMySqlTables', + 'DescribeAdbMySqlSchemas', + 'DescribeTableAccessCount', + 'GetViewDDL', + 'GetViewObjects', + 'GetDatabaseObjects', + 'GetTable', + 'GetTableColumns', + 'GetTableDDL', + 'GetTableObjects', + 'CheckSampleDataSet', + 'DescribeSchemas', + 'DescribeAllDataSource', + 'DescribeTables', + 'DescribeColumns', + 'LoadSampleDataSet', + ], + ], + [ + 'id' => 181302, + 'title' => '诊断优化', + 'type' => 'directory', + 'children' => [ + 'GetADBSparkNecessaryRAMPermissions', + 'KillProcess', + 'DescribeAdviceServiceEnabled', + 'DescribeSparkSQLDiagnosisList', + 'DescribeSparkSQLDiagnosisAttribute', + 'DescribeOversizeNonPartitionTableInfos', + 'DescribeTablePartitionDiagnose', + 'DescribeSparkAppDiagnosisInfo', + 'EnableAdviceService', + 'DescribeAppliedAdvices', + 'DisableAdviceService', + 'BatchApplyAdviceByIdList', + 'ApplyAdviceById', + 'DescribeAvailableAdvices', + 'DescribeDiagnosisSQLInfo', + 'DescribeDiagnosisDimensions', + 'DownloadDiagnosisRecords', + 'DescribeDiagnosisRecords', + 'DescribeDownloadRecords', + 'DescribeSqlPattern', + 'DescribeSQLPatterns', + 'DescribePatternPerformance', + ], + ], + [ + 'id' => 190405, + 'title' => '空间分析', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterSpaceSummary', + 'DescribeExcessivePrimaryKeys', + ], + ], + [ + 'id' => 181303, + 'title' => '运维管理', + 'type' => 'directory', + 'children' => [ + 'ModifyDBClusterMaintainTime', + 'ModifyDBClusterResourceGroup', + 'ListTagResources', + 'DescribeAutoRenewalAttribute', + 'ModifyAutoRenewalAttribute', + ], + ], + [ + 'id' => 186177, + 'title' => '数据管道', + 'type' => 'directory', + 'children' => [ + 'DescribeApsResourceGroups', + 'DescribeApsJobDetail', + 'CreateApsWebhook', + 'DeleteApsWebhook', + 'UpdateApsWebhook', + 'ListApsWebhook', + 'CreateApsKafkaHudiJob', + 'ListApsLifecycleStrategy', + 'GetApsManagedDatabases', + 'CreateApsSlsADBJob', + 'ListApsOptimizationTasks', + 'ListApsOptimizationStrategy', + 'DescribeAPSADBInstances', + 'ModifyApsSlsADBJob', + 'DescribeApsMigrationWorkloads', + 'DescribeApsHiveWorkload', + 'CreateApsCopyWorkload', + 'DescribeApsDatasource', + 'CreateAPSJob', + 'StartApsJob', + 'SuspendApsJob', + 'ModifyApsJob', + 'DeleteApsJob', + 'CreateApsDatasoure', + 'ModifyApsDatasoure', + 'ModifyApsWorkloadName', + 'DescribeApsDatasources', + 'CreateApsHiveJob', + 'DescribeApsProgress', + 'DeleteApsDatasoure', + 'DescribeApsJobs', + 'DescribeApsActionLogs', + ], + ], + [ + 'id' => 361662, + 'title' => '湖存储', + 'type' => 'directory', + 'children' => [ + 'UpdateLakeStorage', + 'ListLakeStorages', + 'GetLakeStorage', + 'CreateLakeStorage', + 'DeleteLakeStorage', + 'ModifyLakeCacheSize', + 'DescribeLakeCacheSize', + ], + ], + [ + 'id' => 199647, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DescribeCompactionServiceSwitch', + 'ModifyEssdCacheConfig', + 'DescribeEssdCacheConfig', + 'ModifyCompactionServiceSwitch', + 'SubmitResultExportJob', + 'ListResultExportJobHistory', + 'DescribeSQLWebSocketDomain', + 'ConfigureResultExport', + 'DescribeResultExportConfig', + 'ModifySqlTemplatePosition', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'Adb4MysqlSparkDiagnosisInfo' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'DiagnosisType' => [ + 'title' => '诊断信息类型', + 'type' => 'string', + 'example' => 'APPLICATION', + ], + 'DiagnosisCode' => [ + 'title' => '诊断Code', + 'type' => 'string', + ], + 'DiagnosisCodeLabel' => [ + 'title' => '诊断原因', + 'type' => 'string', + ], + 'DiagnosisMsg' => [ + 'title' => '诊断建议', + 'type' => 'string', + ], + ], + ], + 'ColDetailModel' => [ + 'title' => '列元数据信息', + 'description' => '列元数据信息。', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '逻辑列名', + 'description' => '逻辑列名。', + 'type' => 'string', + 'example' => 'example', + ], + 'Type' => [ + 'title' => '数据类型', + 'description' => '数据类型。', + 'type' => 'string', + 'example' => 'string', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述。', + 'type' => 'string', + 'example' => 'description', + ], + 'SchemaName' => [ + 'title' => '逻辑库名', + 'description' => '逻辑库名。', + 'type' => 'string', + 'example' => 'schemaName', + ], + 'TableName' => [ + 'title' => '逻辑表名', + 'description' => '逻辑表名。', + 'type' => 'string', + 'example' => 'tableName', + ], + 'CreateTime' => [ + 'title' => '创建时间(UTC)', + 'description' => '创建时间(UTC)。', + 'type' => 'string', + 'example' => '2023-01-05\'T\'13:17:55\'Z\'', + ], + 'UpdateTime' => [ + 'title' => '更新时间(UTC)', + 'description' => '更新时间(UTC)。', + 'type' => 'string', + 'example' => '2023-01-05\'T\'13:17:55\'Z\'', + ], + 'PartitionKey' => [ + 'title' => '是否是分区键', + 'description' => '是否是分区键。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Nullable' => [ + 'title' => '是否可以为null', + 'description' => '是否可以为null。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PrimaryKey' => [ + 'title' => '是否是主键', + 'description' => '是否是主键。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DistributeKey' => [ + 'title' => '是否是分布键', + 'description' => '是否是分布键。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'CstoreIndexModel' => [ + 'title' => 'A short description of struct', + 'description' => '索引元信息。', + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => [ + 'title' => 'databaseName', + 'description' => '逻辑库名。', + 'type' => 'string', + 'example' => 'exampleDatabase', + ], + 'PhysicalTableName' => [ + 'title' => 'physicalTableName', + 'description' => '物理表名。', + 'type' => 'string', + 'example' => 'physicalDatabase', + ], + 'IndexName' => [ + 'title' => 'indexName', + 'description' => '索引名。', + 'type' => 'string', + 'example' => 'indexName', + ], + 'IndexType' => [ + 'title' => 'indexType', + 'description' => '索引类型。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'IndexColumns' => [ + 'title' => 'indexColumns', + 'description' => '索引列。', + 'type' => 'array', + 'items' => [ + 'description' => '索引列信息。', + '$ref' => '#/components/schemas/FieldSchemaModel', + ], + ], + 'ColumnOrds' => [ + 'title' => 'columnOrds', + 'description' => '索引列顺序。', + 'type' => 'array', + 'items' => [ + 'description' => 'Clustered索引每个列的排序方式与索引列（IndexColumns）一致。', + 'type' => 'string', + 'example' => 'ASC/DESC', + ], + ], + 'Options' => [ + 'title' => 'options', + 'description' => '属性。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'ANN/FULLTEXT的属性信息。', + 'type' => 'string', + 'example' => 'key:value', + ], + ], + 'CreateTime' => [ + 'title' => 'createTime', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'UpdateTime' => [ + 'title' => 'updateTime', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + ], + ], + 'DatabaseSummaryModel' => [ + 'title' => '数据库概要元数据信息', + 'description' => '数据库概要信息。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'title' => '所有者', + 'description' => '所有者。', + 'type' => 'string', + 'example' => 'abc', + ], + 'SchemaName' => [ + 'title' => '逻辑库名', + 'description' => '逻辑库名。', + 'type' => 'string', + 'example' => 'testSchema', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述。', + 'type' => 'string', + 'example' => 'description', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'CreatedBySource' => [ + 'type' => 'string', + ], + 'CreatedByUser' => [ + 'type' => 'string', + ], + 'DbType' => [ + 'type' => 'string', + ], + 'Location' => [ + 'type' => 'string', + ], + ], + ], + 'Detail' => [ + 'title' => 'A short description of struct', + 'description' => 'Spark应用的详细信息。', + 'type' => 'object', + 'properties' => [ + 'DurationInMillis' => [ + 'title' => '执行时间(毫秒)', + 'description' => 'Spark应用执行耗时，单位毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'LogRootPath' => [ + 'title' => '日志文件存储地址', + 'description' => '日志文件存储路径。', + 'type' => 'string', + 'example' => 'oss:///logs/driver', + ], + 'DBClusterId' => [ + 'title' => '执行的集群ID', + 'description' => '执行Spark应用的集群ID。', + 'type' => 'string', + 'example' => 'amv-bp11q28kvl688****', + ], + 'Data' => [ + 'title' => '用户配置内容', + 'description' => 'Spark应用的配置内容。', + 'type' => 'string', + 'example' => '{ "name": "SparkPi", "file": "local:///tmp/spark-examples.jar", "className": "org.apache.spark.examples.SparkPi", "args": [ "1000000" ], "conf": { "spark.driver.resourceSpec": "small", "spark.executor.instances": 1, "spark.executor.resourceSpec": "small" } }', + ], + 'EstimateExecutionCpuTimeInSeconds' => [ + 'title' => '估算作业执行消耗CPU时间', + 'description' => '执行Spark应用消耗CPU的时长，单位毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'LastUpdatedTimeInMillis' => [ + 'title' => '最后一次更新状态的时间戳', + 'description' => '最近一次更新Spark应用的时间，Unix时间戳，单位毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1651213645200', + ], + 'RunningStartTimeInMillis' => [ + 'title' => '作业开始运行的时间戳', + 'description' => '作业开始运行的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '36000', + ], + 'LastAttemptId' => [ + 'title' => '如配置了重试, 此为最后一次重试的作业ID', + 'description' => 'Spark应用最近一次重试的ID。', + 'type' => 'string', + 'example' => 's202204291426hzpre60****-0003', + ], + 'TerminatedTimeInMillis' => [ + 'title' => '终止执行的时间戳', + 'description' => 'Spark应用终止执行的时间，Unix时间戳，单位毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1651213645300', + ], + 'ResourceProvisioningDurationInMillis' => [ + 'title' => ' 应用资源拉起时间耗时', + 'description' => ' 应用资源拉起时间耗时', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '36000', + ], + 'ExecutionDurationInMillis' => [ + 'title' => '执行时间耗时', + 'description' => '执行时间耗时', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '36000', + ], + 'WebUiAddress' => [ + 'title' => 'Spark WEB UI地址', + 'description' => 'Web UI地址。', + 'type' => 'string', + 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', + ], + 'SubmittedTimeInMillis' => [ + 'title' => '用户提交到平台的时间戳', + 'description' => 'Spark应用的提交时间，Unix时间戳，单位毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1651213645000', + ], + 'StartedTimeInMillis' => [ + 'title' => '开始创建应用的时间戳', + 'description' => 'Spark应用的创建时间，Unix时间戳，单位毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1651213645010', + ], + 'AppType' => [ + 'title' => 'Spark App类型', + 'description' => 'Spark App类型', + 'type' => 'string', + 'example' => 'BATCH', + ], + 'ResourceGroupName' => [ + 'title' => '资源组名称', + 'description' => 'Job型资源组名称。', + 'type' => 'string', + 'example' => 'spark-rg', + ], + ], + ], + 'FieldSchemaModel' => [ + 'title' => '列信息', + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'name', + 'description' => '列名。', + 'type' => 'string', + 'example' => 'name', + ], + 'Type' => [ + 'title' => 'type', + 'description' => '列类型。', + 'type' => 'string', + 'example' => 'long', + ], + 'Comment' => [ + 'title' => 'comment', + 'description' => '列描述。', + 'type' => 'string', + 'example' => 'comment', + ], + 'DatabaseName' => [ + 'title' => 'databaseName', + 'description' => '逻辑库名。', + 'type' => 'string', + 'example' => 'databaseName', + ], + 'TableName' => [ + 'title' => 'tableName', + 'description' => '逻辑表名。', + 'type' => 'string', + 'example' => 'tableName', + ], + 'MappedName' => [ + 'title' => 'mappedName', + 'description' => '映射名。', + 'type' => 'string', + 'example' => 'mappedName', + ], + 'DataType' => [ + 'title' => 'dataType', + 'description' => '列数据类型。', + 'type' => 'string', + 'example' => 'long', + ], + 'CreateTime' => [ + 'title' => 'createTime', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'UpdateTime' => [ + 'title' => 'updateTime', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'PkPosition' => [ + 'title' => 'pkPosition', + 'description' => '主键位置。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'IsPartitionKey' => [ + 'title' => 'isPartitionKey', + 'description' => '是否是分区键。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OrdinalPosition' => [ + 'title' => 'ordinalPosition', + 'description' => '列位置。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'ColumnRawName' => [ + 'title' => 'columnRawName', + 'description' => '列原始名。', + 'type' => 'string', + 'example' => 'ColumnRawName', + ], + 'PhysicalColumnName' => [ + 'title' => 'physicalColumnName', + 'description' => '物理列名。', + 'type' => 'string', + 'example' => 'PhysicalColumnName', + ], + 'Nullable' => [ + 'title' => 'nullable', + 'description' => '是否为可空。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AutoIncrement' => [ + 'title' => 'autoIncrement', + 'description' => '是否自增。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Precision' => [ + 'title' => 'precision', + 'description' => '精度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Scale' => [ + 'title' => 'scale', + 'description' => '规模。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Primarykey' => [ + 'title' => 'primarykey', + 'description' => '是否是主键。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DefaultValue' => [ + 'title' => 'defaultValue', + 'description' => '默认值。', + 'type' => 'string', + 'example' => 'default', + ], + 'Tokenizer' => [ + 'title' => 'tokenizer', + 'description' => '令牌。', + 'type' => 'string', + 'example' => 'tokenizer', + ], + 'Encode' => [ + 'title' => 'encode', + 'description' => '加密方式。', + 'type' => 'string', + 'example' => 'encode', + ], + 'Compression' => [ + 'title' => 'compression', + 'description' => '压缩方式。', + 'type' => 'string', + 'example' => 'compression', + ], + 'Delimiter' => [ + 'title' => 'delimiter', + 'description' => '分隔符。', + 'type' => 'string', + 'example' => 'delimiter', + ], + 'ValueType' => [ + 'title' => 'valueType', + 'description' => '值类型。', + 'type' => 'string', + 'example' => 'valueType', + ], + 'CompressFloatUseShort' => [ + 'title' => 'compressFloatUseShort', + 'description' => '是否用short压缩float。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OnUpdate' => [ + 'title' => 'onUpdate', + 'description' => '触发更新条件。', + 'type' => 'string', + 'example' => 'onUpdate', + ], + ], + ], + 'Filters' => [ + 'title' => 'A short description of struct', + 'description' => '筛选信息的过滤器', + 'type' => 'object', + 'properties' => [ + 'AppNameRegex' => [ + 'title' => '用于过滤应用名称的正则表达式', + 'type' => 'string', + ], + 'AppIdRegex' => [ + 'title' => '应用ID的过滤规则', + 'type' => 'string', + ], + 'AppType' => [ + 'title' => '应用的类型', + 'type' => 'string', + ], + 'AppState' => [ + 'title' => '应用处于的状态', + 'type' => 'string', + ], + 'SubmitTimeRange' => [ + 'title' => '应用提交时间范围', + 'type' => 'object', + 'properties' => [ + 'MinTimeInMills' => [ + 'title' => '筛选下限', + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '0', + ], + 'MaxTimeInMills' => [ + 'title' => '筛选上限', + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '0', + ], + ], + ], + 'TermiatedTimeRange' => [ + 'title' => '应用终止时间范围', + 'type' => 'object', + 'properties' => [ + 'MinTimeInMills' => [ + 'title' => '筛选下限', + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '0', + ], + 'MaxTimeInMills' => [ + 'title' => '筛选上限', + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '0', + ], + ], + ], + 'ExecutionTimeRange' => [ + 'title' => '应用执行消耗时间范围', + 'type' => 'object', + 'properties' => [ + 'MinTimeInSeconds' => [ + 'title' => '筛选下限', + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '0', + ], + 'MaxTimeInSeconds' => [ + 'title' => '筛选上限', + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '1', + ], + ], + ], + ], + ], + 'LogAnalyzeResult' => [ + 'title' => 'Spark日志分析结果', + 'description' => 'Spark日志分析结果', + 'type' => 'object', + 'properties' => [ + 'AppErrorCode' => [ + 'title' => '错误码信息', + 'description' => 'Spark日志分析后如果有可分析错误, 此处显示错误类型.', + 'type' => 'string', + 'example' => 'EXCEEDED_QUOTA', + ], + 'AppErrorLog' => [ + 'title' => '错误日志', + 'description' => 'Spark日志分析任务中找到的报错日志', + 'type' => 'string', + 'example' => 'exception: cpu is exceeded limits 12/10', + ], + 'AppErrorAdvice' => [ + 'title' => '针对错误的建议', + 'description' => '针对自动分析出的错误日志, 给出的建议解决方案内容.', + 'type' => 'string', + 'example' => 'Please increase cpu quota for your resource group', + ], + ], + ], + 'OperatorNode' => [ + 'title' => 'A short description of struct', + 'description' => 'spark 算子节点', + 'type' => 'object', + 'properties' => [ + 'nodeName' => [ + 'title' => '算子名称', + 'type' => 'string', + ], + 'id' => [ + 'title' => '算子id', + 'type' => 'integer', + 'format' => 'int32', + ], + 'nodeDepth' => [ + 'title' => '算子所在树的层级', + 'type' => 'integer', + 'format' => 'int32', + ], + 'parentId' => [ + 'title' => '父算子 id', + 'type' => 'integer', + 'format' => 'int32', + ], + 'levelWidth' => [ + 'title' => '算子所在树层级共有多少节点', + 'type' => 'integer', + 'format' => 'int32', + ], + 'nodeWidth' => [ + 'title' => '该节点在对应层级从左到右的 position', + 'type' => 'integer', + 'format' => 'int32', + ], + 'stats' => [ + 'title' => '算子统计信息', + 'type' => 'object', + 'properties' => [ + 'parameters' => [ + 'title' => '算子参数', + 'type' => 'string', + 'required' => false, + ], + 'bytes' => [ + 'title' => '数据量', + 'type' => 'integer', + 'format' => 'int64', + ], + 'outputRows' => [ + 'title' => '输出行数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'timeCost' => [ + 'title' => '运行时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'peakMemory' => [ + 'title' => '消耗内存最大值', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'children' => [ + 'title' => '子算子队列', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/OperatorNode', + ], + ], + ], + ], + 'SerDeInfoModel' => [ + 'title' => 'A short description of struct', + 'description' => '序列化信息元信息。', + 'type' => 'object', + 'properties' => [ + 'SerDeId' => [ + 'title' => 'serDeId', + 'description' => 'ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Name' => [ + 'title' => 'name', + 'description' => '序列化信息名字。', + 'type' => 'string', + 'example' => 'example', + ], + 'Parameters' => [ + 'title' => 'parameters', + 'description' => '序列化反序列化的配置参数。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '参数的值。', + 'type' => 'string', + 'example' => 'key:value', + ], + ], + 'SerializationLib' => [ + 'title' => 'serializationLib', + 'description' => '序列化使用的库。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe', + ], + ], + ], + 'SparkAnalyzeLogTask' => [ + 'title' => 'Spark日志分析任务', + 'description' => 'Spark日志分析任务', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => 'Spark日志分析任务ID', + 'description' => 'Spark日志分析任务ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UserId' => [ + 'title' => '提交任务的用户ID', + 'description' => '提交任务的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13719918xxx', + ], + 'SubmittedTimeInMillis' => [ + 'title' => '提交任务的毫秒时间戳', + 'description' => '提交任务的毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672123543000', + ], + 'TerminatedTimeInMillis' => [ + 'title' => '任务终止的毫秒级时间戳', + 'description' => '任务终止的毫秒级时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672123543000', + ], + 'TaskState' => [ + 'title' => '任务所处状态', + 'description' => '任务所处状态', + 'type' => 'string', + 'example' => 'WAITING', + ], + 'Result' => [ + 'title' => '任务分析结果', + 'description' => '任务分析结果', + '$ref' => '#/components/schemas/LogAnalyzeResult', + ], + 'StartedTimeInMillis' => [ + 'title' => '任务开始的毫秒时间戳', + 'description' => '任务开始的毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672123543000', + ], + 'RuleMatched' => [ + 'title' => '是否命中了规则', + 'description' => '是否命中了规则', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskErrMsg' => [ + 'title' => 'Task失败的错误信息', + 'description' => 'Task失败的错误信息', + 'type' => 'string', + 'example' => 'Driver log not found', + ], + 'DBClusterId' => [ + 'title' => '数据库集群ID', + 'description' => '数据库集群ID', + 'type' => 'string', + 'example' => 'amv-adbxxxxx', + ], + ], + ], + 'SparkAppInfo' => [ + 'title' => 'Spark应用详情', + 'description' => 'Spark应用的执行状态信息。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'title' => 'Spark应用ID', + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 's202207151211hz0c****', + ], + 'AppName' => [ + 'title' => '应用的命名', + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'SparkTest', + ], + 'Priority' => [ + 'title' => '优先级', + 'description' => '优先级', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'State' => [ + 'title' => '状态', + 'description' => 'Spark应用的状态，取值说明：'."\n" + .'- **SUBMITTED**：已提交。'."\n" + .'- **STARTING**：开始启动。'."\n" + .'- **RUNNING**：执行中。'."\n" + .'- **FAILING**：任务失败，清理环境中。'."\n" + .'- **FAILED**：失败。'."\n" + .'- **KILLING**：中止任务，清理环境中。'."\n" + .'- **KILLED**：中止任务。'."\n" + .'- **SUCCEEDING**：任务执行结束，清理环境中。'."\n" + .'- **COMPLETED**：任务执行结束。'."\n" + .'- **FATAL**：意外失败。'."\n" + .'- **UNKNOWN**：未知错误。', + 'type' => 'string', + 'example' => 'SUBMITTED', + ], + 'Message' => [ + 'title' => '附加信息', + 'description' => '告警信息，如任务执行失败或资源不足等，无告警时则返回为空。', + 'type' => 'string', + 'example' => 'WARN: Disk is full.', + ], + 'Detail' => [ + 'title' => '作业详细信息', + 'description' => 'Spark应用的详细信息。', + '$ref' => '#/components/schemas/Detail', + ], + 'DBClusterId' => [ + 'title' => '数据库ID', + 'description' => '数据库ID', + 'type' => 'string', + 'example' => 'amv-23xxxx', + ], + ], + ], + 'SparkAttemptInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'Spark重试的详细信息。', + 'type' => 'object', + 'properties' => [ + 'AttemptId' => [ + 'title' => 'Spark应用重试ID', + 'description' => 'Spark应用的重试ID。', + 'type' => 'string', + 'example' => 's202207151211hz****-0001', + ], + 'Priority' => [ + 'title' => 'Spark应用重试优先级', + 'description' => 'Spark应用重试优先级', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'State' => [ + 'title' => 'Spark应用重试状态', + 'description' => 'Spark应用的状态。取值说明：'."\n" + .'- **SUBMITTED**：已提交。'."\n" + .'- **STARTING**：开始启动。'."\n" + .'- **RUNNING**：执行中。'."\n" + .'- **FAILING**：任务失败，清理环境中。'."\n" + .'- **FAILED**：失败。'."\n" + .'- **KILLING**：中止任务，清理环境中。'."\n" + .'- **KILLED**：中止任务。'."\n" + .'- **SUCCEEDING**：任务执行结束，清理环境中。'."\n" + .'- **COMPLETED**：任务执行结束。'."\n" + .'- **FATAL**：意外失败。'."\n" + .'- **UNKNOWN**：未知错误。', + 'type' => 'string', + 'example' => 'SUBMITTED', + ], + 'Message' => [ + 'title' => '备注', + 'description' => '告警信息，如任务执行失败或资源不足等，无告警时则返回为空。', + 'type' => 'string', + 'example' => 'WARN: Disk is full', + ], + 'Detail' => [ + 'title' => '重试详细信息', + 'description' => 'Spark应用的详细信息。', + '$ref' => '#/components/schemas/Detail', + ], + ], + ], + 'SparkBatchSQL' => [ + 'title' => 'A short description of struct', + 'description' => 'SparkBatchSQL返回结构。', + 'type' => 'object', + 'properties' => [ + 'QueryId' => [ + 'title' => 'Query ID', + 'description' => 'Query ID。', + 'type' => 'string', + 'example' => 'sq172352176****', + ], + 'QueryState' => [ + 'title' => '执行状态', + 'description' => '执行状态，可选值有：'."\n" + .'- FAILED：执行失败。'."\n" + .'- RUNNING：运行中。'."\n" + .'- CANCELED：被取消。'."\n" + .'- PENDING：等待提交到执行引擎。'."\n" + .'- SUBMITTED：已经提交到执行引擎。'."\n" + .'- FINISHED：执行成功。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RUNNING', + ], + 'QuerySubmissionTime' => [ + 'title' => '提交的时间戳', + 'description' => '提交的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723521767000', + ], + 'QueryStartTime' => [ + 'title' => '开始执行的时间戳', + 'description' => '开始执行的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723521767000', + ], + 'QueryEndTime' => [ + 'title' => '结束执行的时间戳', + 'description' => '结束执行的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723521767000', + ], + 'Schema' => [ + 'title' => '执行选择Schema', + 'description' => '执行时选择的数据库名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'Uid' => [ + 'title' => '提交者UID', + 'description' => '阿里云账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2198002412336****', + ], + 'DBClusterId' => [ + 'title' => 'ADB集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp17s73f016****', + ], + 'ResourceGroupName' => [ + 'title' => '资源组名称', + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'spark_rg', + ], + 'Query' => [ + 'title' => '执行语句原文', + 'description' => '执行语句原文。', + 'type' => 'string', + 'example' => 'SELECT * FROM db.tb', + ], + 'Statements' => [ + 'title' => '语句执行结果', + 'description' => '语句执行结果。', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL执行内容状态结构体。', + '$ref' => '#/components/schemas/SparkBatchSQLStatement', + ], + ], + 'ErrMessage' => [ + 'title' => '最后的执行报错信息', + 'description' => '执行报错信息。', + 'type' => 'string', + 'example' => 'schema is not found', + ], + ], + ], + 'SparkBatchSQLStatement' => [ + 'title' => 'Spark Batch SQL Statement结构', + 'description' => 'SparkBatchSQL Statement返回结构', + 'type' => 'object', + 'properties' => [ + 'ResultUri' => [ + 'title' => '结果存储位置', + 'description' => 'SQL执行结果在OSS上的存储位置，当用户没有指定存储位置时，返回结果为空。', + 'type' => 'string', + 'example' => 'oss://yourbucket/result.json', + ], + 'EndTime' => [ + 'title' => '结束执行的时间戳', + 'description' => 'SQL执行结束的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723521767000', + ], + 'AppId' => [ + 'title' => '执行当前SQL的Spark作业ID', + 'description' => '执行这个SQL语句的Spark作业ID。', + 'type' => 'string', + 'example' => 's20240122jsdx****', + ], + 'StatementId' => [ + 'title' => 'Statement Id', + 'description' => 'SQL语句ID。', + 'type' => 'string', + 'example' => 'sq1723521767****-0001', + ], + 'State' => [ + 'title' => '执行状态', + 'description' => '执行状态，可选值有：'."\n" + ."\n" + .'- FAILED：执行失败。'."\n" + .'- RUNNING：运行中。'."\n" + .'- CANCELED：被取消。'."\n" + .'- PENDING：等待提交到执行引擎。'."\n" + .'- FINISHED：执行成功。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RUNNING', + ], + 'StartTime' => [ + 'title' => '开始执行的时间戳', + 'description' => 'SQL开始执行的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723521767000', + ], + 'Error' => [ + 'title' => '执行失败后的报错内容', + 'description' => 'SQL执行报错后的错误信息。', + 'type' => 'string', + 'example' => 'table is not found', + ], + 'Code' => [ + 'title' => '执行代码', + 'description' => 'SQL执行的内容，为用户输入的原始SQL文本。', + 'type' => 'string', + 'example' => 'SELECT 100', + ], + 'Result' => [ + 'title' => '执行结果', + 'description' => 'SQL执行的结果，内容为Spark中`DataFrame Show`语句的返回格式。', + 'type' => 'string', + 'example' => '+---+-----+'."\n" + .'|age| name|'."\n" + .'+---+-----+'."\n" + .'| 14| Tom|'."\n" + .'| 23|Alice|'."\n" + .'+---+-----+', + ], + ], + ], + 'SparkOperatorInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'Spark 算子信息', + 'type' => 'object', + 'properties' => [ + 'OperatorName' => [ + 'title' => '算子名称', + 'type' => 'string', + 'format' => 'byte', + ], + 'MetricValue' => [ + 'title' => 'metrics 值', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'SparkSession' => [ + 'title' => 'A short description of struct', + 'description' => 'spark连接对象', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'title' => 'session id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'State' => [ + 'title' => '状态', + 'type' => 'string', + 'example' => 'idle', + ], + 'AliyunUid' => [ + 'title' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11123123', + ], + 'Active' => [ + 'title' => '是否活跃', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'Statement' => [ + 'title' => 'Spark代码块', + 'description' => 'Spark可执行代码块', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'title' => '会话id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'StatementId' => [ + 'title' => '代码块id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Code' => [ + 'title' => '代码块内容', + 'type' => 'string', + 'example' => 'SELECT * FROM table', + ], + 'CodeState' => [ + 'title' => '代码执行状态', + 'type' => 'string', + 'example' => 'Waiting', + ], + 'Output' => [ + 'title' => '执行结果', + 'type' => 'string', + 'example' => 'Spark is running, the ouput is...', + ], + 'StartTime' => [ + 'title' => '开始执行的毫秒级时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1658977911000', + ], + 'EndTime' => [ + 'title' => '结束执行的毫秒级时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1658987911000', + ], + 'Error' => [ + 'title' => '执行错误信息', + 'type' => 'string', + 'example' => 'Disk is full', + ], + 'CodeType' => [ + 'title' => '代码执行类型', + 'type' => 'string', + 'example' => 'SQL', + ], + 'AliyunUid' => [ + 'title' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111111', + ], + 'ResourceGroup' => [ + 'title' => '资源组名称', + 'type' => 'string', + 'example' => 'rg1', + ], + 'HaveRows' => [ + 'title' => '是否有OSS数据', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TotalCount' => [ + 'title' => '返回行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'StatementInfo' => [ + 'title' => 'A short description of struct', + 'description' => '代码块执行信息', + 'type' => 'object', + 'properties' => [ + 'StatementId' => [ + 'title' => '代码块标识ID', + 'type' => 'string', + ], + 'Code' => [ + 'title' => '代码块内容', + 'type' => 'string', + ], + 'CompletedTimeInMills' => [ + 'title' => '执行完成的时间戳', + 'type' => 'integer', + 'format' => 'int64', + ], + 'Output' => [ + 'title' => '执行结果详细信息', + 'type' => 'string', + ], + 'Process' => [ + 'title' => '执行进度百分比', + 'type' => 'number', + 'format' => 'float', + ], + 'StartedTimeInMills' => [ + 'title' => '开始执行的时间戳', + 'type' => 'integer', + 'format' => 'int64', + ], + 'State' => [ + 'title' => '当前执行状态', + 'type' => 'string', + ], + ], + ], + 'StorageDescriptorModel' => [ + 'title' => 'A short description of struct', + 'description' => '存储描述元信息。', + 'type' => 'object', + 'properties' => [ + 'SdId' => [ + 'title' => 'sdId', + 'description' => '描述信息的存储ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Location' => [ + 'title' => 'location', + 'description' => '存储位置。', + 'type' => 'string', + 'example' => 'oss://**************', + ], + 'InputFormat' => [ + 'title' => 'inputFormat', + 'description' => '输入格式。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat', + ], + 'OutputFormat' => [ + 'title' => 'outputFormat', + 'description' => '输出格式。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat', + ], + 'Compressed' => [ + 'title' => 'compressed', + 'description' => '是否压缩。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'NumBuckets' => [ + 'title' => 'numBuckets', + 'description' => 'Bucket个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SerDeInfo' => [ + 'description' => '序列化反序列化信息。', + '$ref' => '#/components/schemas/SerDeInfoModel', + ], + 'Parameters' => [ + 'title' => 'parameters', + 'description' => '存储配置参数。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '参数的值。', + 'type' => 'string', + 'example' => 'key:value', + ], + ], + 'StoredAsSubDirectories' => [ + 'title' => 'storedAsSubDirectories', + 'description' => '是否以子目录方式存储。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'TableDetailModel' => [ + 'title' => 'table详细信息', + 'description' => '表详细信息。', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'title' => '逻辑库名', + 'description' => '逻辑库名。', + 'type' => 'string', + 'example' => 'schemaName', + ], + 'TableName' => [ + 'title' => '逻辑表名', + 'description' => '逻辑表名。', + 'type' => 'string', + 'example' => 'tableName', + ], + 'TableType' => [ + 'title' => 'table类型', + 'description' => '表类型。', + 'type' => 'string', + 'example' => 'PHYSICAL_SCHEMA_NAME', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'Description' => [ + 'title' => '备注', + 'description' => '描述。', + 'type' => 'string', + 'example' => 'Description', + ], + 'Owner' => [ + 'title' => '所有者', + 'description' => '所有者。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Columns' => [ + 'title' => '列信息', + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列的详细信息。', + '$ref' => '#/components/schemas/ColDetailModel', + ], + ], + 'Catalog' => [ + 'title' => '外部数据源', + 'description' => '外部数据源。', + 'type' => 'string', + 'example' => 'oss', + ], + 'CreatedBySource' => [ + 'type' => 'string', + ], + 'CreatedByUser' => [ + 'type' => 'string', + ], + 'Location' => [ + 'type' => 'string', + ], + 'Parameters' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TableModel' => [ + 'title' => 'A short description of struct', + 'description' => '表元信息。', + 'type' => 'object', + 'properties' => [ + 'TblId' => [ + 'title' => 'tblId', + 'description' => '表编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'DbName' => [ + 'title' => 'dbName', + 'description' => '逻辑库名。', + 'type' => 'string', + 'example' => 'example', + ], + 'TableName' => [ + 'title' => 'tblName', + 'description' => '逻辑表名。', + 'type' => 'string', + 'example' => 'tableName', + ], + 'TableType' => [ + 'title' => 'tblType', + 'description' => '表类型。', + 'type' => 'string', + 'example' => 'external_table', + ], + 'PartitionKeys' => [ + 'title' => 'partitionKeys', + 'description' => '分区键。', + 'type' => 'array', + 'items' => [ + 'description' => '分区列信息。', + '$ref' => '#/components/schemas/FieldSchemaModel', + ], + ], + 'Parameters' => [ + 'title' => 'parameters', + 'description' => '参数。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '参数的值。', + 'type' => 'string', + 'example' => 'key:value', + ], + ], + 'Sd' => [ + 'title' => 'sd', + 'description' => '存储描述信息。', + '$ref' => '#/components/schemas/StorageDescriptorModel', + ], + 'CreateTime' => [ + 'title' => 'createTime', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'ViewOriginalText' => [ + 'title' => 'viewOriginalText', + 'description' => '创建视图时输入的SQL。', + 'type' => 'string', + 'example' => 'ViewOriginalText', + ], + 'ViewExpandedText' => [ + 'title' => 'viewExpandedText', + 'description' => '对创建视图的SQL进行规范化处理后的结果。', + 'type' => 'string', + 'example' => 'ViewExpandedText', + ], + 'Temporary' => [ + 'title' => 'temporary', + 'description' => '是否是临时表。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Comment' => [ + 'title' => 'comment', + 'description' => '描述。', + 'type' => 'string', + 'example' => 'description', + ], + 'Cols' => [ + 'title' => 'cols', + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列详细信息。', + '$ref' => '#/components/schemas/FieldSchemaModel', + ], + ], + 'DistributeColumns' => [ + 'title' => 'distributeColumns', + 'description' => '分布列。', + 'type' => 'array', + 'items' => [ + 'description' => '分布列信息', + '$ref' => '#/components/schemas/FieldSchemaModel', + ], + ], + 'PhysicalTableName' => [ + 'title' => 'physicalTableName', + 'description' => '物理表名。', + 'type' => 'string', + 'example' => 'physicalTableName', + ], + 'PhysicalDatabaseName' => [ + 'title' => 'physicalDatabaseName', + 'description' => '物理库名。', + 'type' => 'string', + 'example' => 'physicalDatabaseName', + ], + 'DistributeType' => [ + 'title' => 'distributeType', + 'description' => '分布类型。', + 'type' => 'string', + 'example' => 'DistributeType', + ], + 'PartitionType' => [ + 'title' => 'partitionType', + 'description' => '分区类型。', + 'type' => 'string', + 'example' => 'PartitionType', + ], + 'PartitionColumn' => [ + 'title' => 'partitionColumn', + 'description' => '分区列信息。', + 'type' => 'string', + 'example' => 'colName', + ], + 'PartitionCount' => [ + 'title' => 'partitionCount', + 'description' => '分区数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'PreviousVersion' => [ + 'title' => 'previousVersion', + 'description' => '先前版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CurrentVersion' => [ + 'title' => 'currentVersion', + 'description' => '现在版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'UpdateTime' => [ + 'title' => 'updateTime', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'TableEngineName' => [ + 'title' => 'tableEngineName', + 'description' => '表引擎名字。', + 'type' => 'string', + 'example' => 'hive', + ], + 'IsAllIndex' => [ + 'title' => 'isAllIndex', + 'description' => '是否是全索引。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'BlockSize' => [ + 'title' => 'blockSize', + 'description' => '块大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64', + ], + 'Compression' => [ + 'title' => 'compression', + 'description' => '压缩方式。', + 'type' => 'string', + 'example' => 'Compression', + ], + 'RawTableName' => [ + 'title' => 'rawTableName', + 'description' => '原始表名。', + 'type' => 'string', + 'example' => 'RawTableName', + ], + 'SubpartitionType' => [ + 'title' => 'subpartitionType', + 'description' => '子分区类型。', + 'type' => 'string', + 'example' => 'SubpartitionColumn', + ], + 'SubpartitionColumn' => [ + 'title' => 'subpartitionColumn', + 'description' => '子分区列信息。', + 'type' => 'string', + 'example' => 'SubpartitionColumn', + ], + 'SubpartitionCount' => [ + 'title' => 'subpartitionCount', + 'description' => '子分区数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64', + ], + 'ArchiveType' => [ + 'title' => 'archiveType', + 'description' => '存档类型。', + 'type' => 'string', + 'example' => 'ArchiveType', + ], + 'MaxColumnId' => [ + 'title' => 'maxColumnId', + 'description' => '最大列编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'MaxColumnId', + ], + 'EnableDfs' => [ + 'title' => 'enableDfs', + 'description' => '是否允许DFS。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'StoragePolicy' => [ + 'title' => 'storagePolicy', + 'description' => '存储策略。', + 'type' => 'string', + 'example' => 'StoragePolicy', + ], + 'HotPartitionCount' => [ + 'title' => 'hotPartitionCount', + 'description' => '热分区数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'IsFulltextDict' => [ + 'title' => 'isFulltextDict', + 'description' => '是否是全文索引字典。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RtIndexAll' => [ + 'title' => 'rtIndexAll', + 'description' => '是否路由所有索引。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RouteColumns' => [ + 'title' => 'routeColumns', + 'description' => '路由列。', + 'type' => 'array', + 'items' => [ + 'description' => '路由列信息。', + '$ref' => '#/components/schemas/FieldSchemaModel', + ], + ], + 'RouteEffectiveColumn' => [ + 'title' => 'routeEffectiveColumn', + 'description' => '路由有效列。', + '$ref' => '#/components/schemas/FieldSchemaModel', + ], + 'RtEngineType' => [ + 'title' => 'rtEngineType', + 'description' => '路由引擎类型。', + 'type' => 'string', + 'example' => 'RtEngineType', + ], + 'RtModeType' => [ + 'title' => 'rtModeType', + 'description' => '路由模式类型。', + 'type' => 'string', + 'example' => 'RtModeType', + ], + 'RouteType' => [ + 'title' => 'routeType', + 'description' => '路由类型。', + 'type' => 'string', + 'example' => 'routeType', + ], + 'DictEncode' => [ + 'title' => 'dictEncode', + 'description' => '是否加密。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'BucketCount' => [ + 'title' => 'bucketCount', + 'description' => 'Bucket个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'Bucket' => [ + 'title' => 'bucket', + 'description' => 'Bucket编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'ViewSecurityMode' => [ + 'title' => 'viewSecurityMode', + 'description' => '视图安全模式。', + 'type' => 'string', + 'example' => 'ViewSecurityMode', + ], + 'Indexes' => [ + 'title' => 'indexes', + 'description' => '索引。', + 'type' => 'array', + 'items' => [ + 'description' => '索引列信息。', + '$ref' => '#/components/schemas/CstoreIndexModel', + ], + ], + 'CreatedBySource' => [ + 'type' => 'string', + ], + 'CreatedByUser' => [ + 'type' => 'string', + ], + ], + ], + 'TableSummaryModel' => [ + 'title' => 'table概要信息', + 'description' => '表或视图的概要数据。', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'title' => 'db逻辑名', + 'description' => '逻辑库名。', + 'type' => 'string', + 'example' => 'schemaName', + ], + 'TableName' => [ + 'title' => 'table逻辑名', + 'description' => '逻辑表名或逻辑视图名。', + 'type' => 'string', + 'example' => 'tableName', + ], + 'TableType' => [ + 'title' => 'table类型', + 'description' => '表或视图类型。', + 'type' => 'string', + 'example' => 'PHYSICAL_SCHEMA_NAME', + ], + 'TableSize' => [ + 'title' => 'table大小', + 'description' => '表大小，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-01-05 13:17:55', + ], + 'SQL' => [ + 'title' => 'view SQL', + 'description' => '创建表或视图的SQL。', + 'type' => 'string', + 'example' => 'create table(a varchar)', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述。', + 'type' => 'string', + 'example' => 'descrtiption', + ], + 'Owner' => [ + 'title' => '所有者', + 'description' => '所有者。', + 'type' => 'string', + 'example' => 'abc', + ], + 'MvDetailModel' => [ + '$ref' => '#/components/schemas/open_struct_MvDetailModel', + ], + 'CreatedBySource' => [ + 'type' => 'string', + ], + 'CreatedByUser' => [ + 'type' => 'string', + ], + ], + ], + 'open_struct_MVRecommendResultModel' => [ + 'description' => '物化视图推荐结果详细信息', + 'type' => 'object', + 'properties' => [ + 'BaseTables' => [ + 'description' => '子查询关联的基表。', + 'type' => 'array', + 'items' => [ + 'description' => '基表详细信息。', + '$ref' => '#/components/schemas/open_struct_MvBaseTableDetailModel', + ], + ], + 'AcceleratedQueriesCount' => [ + 'description' => '成功加速的查询数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'SupportIncrementalRefresh' => [ + 'description' => '当前子查询是否支持增量刷新。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SubqueryId' => [ + 'description' => '子查询ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SavedScanbytes' => [ + 'description' => '当前MV从关联父查询，后验测算出来可以节约扫描的字节数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '321321223', + ], + 'Subquery' => [ + 'description' => '提取出来的公共子查询。', + 'type' => 'string', + 'example' => 'SELECT * FROM demo.tbl', + ], + ], + ], + 'open_struct_MvBaseTableDetailModel' => [ + 'description' => '物化视图基表详细信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'DataVolumn' => [ + 'description' => '数据量。', + 'type' => 'string', + 'example' => '321233', + ], + 'EnableBinlog' => [ + 'description' => '表是否开启binlog。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + 'open_struct_MvDetailModel' => [ + 'description' => '物化视图概要数据。', + 'type' => 'object', + 'properties' => [ + 'FirstRefreshTime' => [ + 'description' => '首次刷新时间。', + 'type' => 'string', + 'example' => '2025-01-01 09:00:00', + ], + 'QueryRewriteEnabled' => [ + 'description' => '当前物化视图是否启用查询改写。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExplicitHit' => [ + 'description' => '最近7天，显式query命中的总次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'IsInactive' => [ + 'description' => '探测到当前物化视图距离第一次创建时间大于30天，且没有被访问过（包括显式查询和隐式查询）。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RemoteSize' => [ + 'description' => '物化视图占用冷数据磁盘空间（单位bytes）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'LocalSize' => [ + 'description' => '物化视图占用热数据磁盘空间（单位bytes）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'RefreshState' => [ + 'description' => '物化视图刷新模型。', + 'type' => 'string', + 'example' => 'FAST', + ], + 'RefreshInterval' => [ + 'description' => '刷新时间间隔。', + 'type' => 'string', + 'example' => '(now() + INTERVAL \'10\' SECOND)', + ], + 'ImplicitHit' => [ + 'description' => '最近7天，隐式query命中的总次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'UpdatedAt' => [ + 'description' => '最近一次刷新的时间。', + 'type' => 'string', + 'example' => '2025-01-01 10:00:00', + ], + 'ResourceGroup' => [ + 'description' => '刷新所依赖的资源组。', + 'type' => 'string', + 'example' => 'user_default', + ], + 'BaseTableInfos' => [ + 'description' => '当前物化视图所有直接父基表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => '库名。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test_tbl', + ], + 'BaseTableIsMv' => [ + 'description' => '基表是否为一个物化视图。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TableEngine' => [ + 'description' => '表引擎。', + 'type' => 'string', + 'example' => 'XUANWU', + ], + ], + ], + ], + 'TableEngine' => [ + 'description' => '表引擎。', + 'type' => 'string', + 'example' => 'XUANWU', + ], + 'BaseTableNames' => [ + 'description' => '当前物化视图所有直接父基表。', + 'type' => 'array', + 'items' => [ + 'description' => '基表的库名和表名。', + 'type' => 'array', + 'items' => [ + 'description' => '库名或表名。', + 'type' => 'string', + 'example' => 't1', + ], + ], + ], + 'EnableDelayAlert' => [ + 'description' => '开启刷新延迟告警。取值如下：'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'false', + ], + 'EnableFailureAlert' => [ + 'description' => '开启刷新任务失败告警。取值如下：'."\n" + ."\n" + .'- true：是。 '."\n" + .'- false：否。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'false', + ], + 'LatencyTolerance' => [ + 'description' => '刷新延迟容忍度（分钟）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'open_struct_MvRecommendSubTaskModel' => [ + 'description' => '物化视图推荐任务执行详情。', + 'type' => 'object', + 'properties' => [ + 'SubQueriesCount' => [ + 'description' => '生成的新增MV建议数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'Status' => [ + 'description' => '当前运行的状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'EndTime' => [ + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2025-10-16 16:56'."\n", + ], + 'StartTime' => [ + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2025-10-16 16:55'."\n", + ], + 'SubtaskId' => [ + 'description' => '任务执行的记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ScanQueriesCount' => [ + 'description' => '扫描的查询数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '55', + ], + 'MinRewriteQueryCount' => [ + 'description' => 'Pattern匹配的最少慢查询个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'MinRewriteQueryPattern' => [ + 'description' => '最小可加速的Pattern数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SlowQueryThreshold' => [ + 'description' => '慢查询阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'open_struct_MvRecommendTaskModel' => [ + 'description' => '物化视图推荐任务详细信息', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'task desc'."\n", + ], + 'CreatedTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-12-12 23:59', + ], + 'LastRunAt' => [ + 'description' => '最近一次运行时间。', + 'type' => 'string', + 'example' => '2024-12-13 00:10', + ], + 'TaskName' => [ + 'description' => '推荐任务名称。', + 'type' => 'string', + 'example' => 'mv_task1', + ], + 'ScanQueriesRange' => [ + 'description' => '扫描的时间范围，单位天，默认取值3。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SchedulingSettings' => [ + 'description' => '任务的例行运行设置。', + 'type' => 'string', + 'example' => 'The 12:30 every day', + ], + 'MinRewriteQueryCount' => [ + 'description' => 'Pattern匹配的最少慢查询个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'MinRewriteQueryPattern' => [ + 'description' => '最小可加速的Pattern数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SlowQueryThreshold' => [ + 'description' => '慢查询阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'open_struct_RefreshJobModel' => [ + 'description' => '刷新任务详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '本次刷新任务的状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'EndTime' => [ + 'description' => '刷新任务结束时间。', + 'type' => 'string', + 'example' => '2025-01-15 10:12:00', + ], + 'RefreshModel' => [ + 'description' => '刷新方式。'."\n" + .'- FAST'."\n" + .'- COMPLETE', + 'type' => 'string', + 'example' => 'FAST', + ], + 'StartTime' => [ + 'description' => '实际开始时间。', + 'type' => 'string', + 'example' => '2025-01-15 10:11:00', + ], + 'RefreshInterval' => [ + 'description' => '刷新时间间隔。', + 'type' => 'string', + 'example' => '30s', + ], + 'Processid' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '2025103010xxxxxxx', + ], + 'ScheduledStartTime' => [ + 'description' => '计划开始时间。', + 'type' => 'string', + 'example' => '2025-01-15 10:11:00'."\n", + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'ResourceGroup' => [ + 'description' => '刷新所依赖的资源组。', + 'type' => 'string', + 'example' => 'user_default', + ], + 'Name' => [ + 'description' => '物化视图名称。', + 'type' => 'string', + 'example' => 'demo_mv', + ], + ], + ], + ], + ], + 'apis' => [ + 'DescribeRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '154593', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '地域名称和可用区名称（即返回数据中LocalName）返回值所使用的语言，取值说明：'."\n" + .'- **zh-CN**：简体中文（默认语言）。'."\n" + .'- **en-US**：英文。'."\n" + .'- **ja**：日文。', + 'type' => 'string', + 'required' => false, + 'example' => 'en-US', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => '地域对应的接入地址。', + 'type' => 'string', + 'example' => 'adb.aliyuncs.com', + ], + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => 'China (Hangzhou)', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区列表。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'VpcEnabled' => [ + 'description' => '目标可用区是否支持VPC，取值说明：'."\n" + .'- **true**：支持。'."\n" + .'- **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LocalName' => [ + 'description' => '可用区名称。', + 'type' => 'string', + 'example' => 'Hangzhou Zone H', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"adb.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"VpcEnabled\\": true,\\n \\"LocalName\\": \\"Hangzhou Zone H\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 421794A3-72A5-5D27-9E8B-A75A4C503E17\\n \\n adb.aliyuncs.com\\n China (Hangzhou)\\n cn-hangzhou\\n \\n cn-hangzhou-h\\n true\\n Hangzhou Zone H\\n \\n \\n","errorExample":""}]', + 'title' => '查询地域和可用区', + 'summary' => '查询AnalyticDB MySQL湖仓版支持的地域和可用区。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeDBClusters' => [ + 'summary' => '查看目标地域下的湖仓版集群列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130697', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '湖仓版集群ID。'."\n" + ."\n" + .'此参数不填写时，默认返回该地域中所有集群的信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。'."\n" + .'- 不能以`http://`或者`https://`开头。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '集群状态，取值说明：'."\n" + .'- **Preparing**：准备中。'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Running**：运行中。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **Restoring**：备份恢复中。'."\n" + .'- **ClassChanging**：变配中。'."\n" + .'- **NetAddressCreating**：创建网络中。'."\n" + .'- **NetAddressDeleting**：删除网络中。'."\n" + .'- **NetAddressModifying**：修改网络中。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + .'此参数不填写时，默认返回集群中所有资源组信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '集群标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '集群的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '集群的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ProductVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '产品版本：'."\n" + .'- **EnterpriseVersion**：企业版。'."\n" + .'- **BasicVersion**：基础版。'."\n" + .'> 选填参数，不填时默认返回全部集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'BasicVersion', + 'enum' => [ + 'EnterpriseVersion', + 'BasicVersion', + ], + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '集群版本'."\n" + .'- **3.0**：数仓版。'."\n" + .'- **5.0**（默认值）：包括湖仓版、企业版和基础版。'."\n" + .'- **All**：所有版本，包括数仓版、湖仓版、企业版和基础版。', + 'type' => 'string', + 'required' => false, + 'example' => '5.0', + 'default' => '5.0', + 'enum' => [ + 'All', + '3.0', + '5.0', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EDBA27-AF3E-5966-9503-FD1557E19167', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '列表详情。', + 'type' => 'array', + 'items' => [ + 'description' => '集群列表。', + 'type' => 'object', + 'properties' => [ + 'Expired' => [ + 'description' => '包年包月集群是否过期。取值说明：'."\n" + .'* **true**：已过期。'."\n" + .'* **false**：未过期。'."\n" + ."\n" + .'> - 如果集群已过期，在一定时间内集群会被锁定甚至释放。建议您进行续费操作，详情请参见[续费说明](~~135246~~)。'."\n" + .'- 按量付费集群不返回此参数。', + 'type' => 'string', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => '集群创建时间。UTC时间，格式为yyyy-mm-ddThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-04-01T09:50:18Z', + ], + 'PayType' => [ + 'description' => '集群付费类型，取值说明：'."\n" + .'* **Postpaid**：按量付费。'."\n" + .'* **Prepaid**：包年包月。', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'Mode' => [ + 'description' => '集群模式。默认返回**flexible**，表示弹性模式集群。', + 'type' => 'string', + 'example' => 'flexible', + ], + 'Port' => [ + 'description' => '集群端口号。', + 'type' => 'string', + 'example' => '3306', + ], + 'LockMode' => [ + 'description' => '集群的锁定状态，取值说明： '."\n" + .'- **Unlock**：未锁定。 '."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'StorageResource' => [ + 'description' => '存储预留资源规格。1 ACU约等于1核4 GB。存储资源用于数据读写，增加该资源能提高集群读写能力。', + 'type' => 'string', + 'example' => '24ACU', + ], + 'DBClusterId' => [ + 'description' => '湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp163885f8q21****', + ], + 'ConnectionString' => [ + 'description' => '集群的公网连接地址。', + 'type' => 'string', + 'example' => 'amv-bp163885f8q21****.ads.aliyuncs.com', + ], + 'DBClusterType' => [ + 'description' => '集群类型。默认返回**Common**，表示常规集群。', + 'type' => 'string', + 'example' => 'Common', + ], + 'CommodityCode' => [ + 'description' => '商品付费类型，取值说明：'."\n" + .'- **ads**：按量付费商品。'."\n" + .'- **ads_pre**：包年包月商品。', + 'type' => 'string', + 'example' => 'ads_pre', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间，UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> * 若集群付费类型为包年包月，则返回实际到期时间。'."\n" + .'* 若集群付费类型为按量付费，则返回为空。'."\n", + 'type' => 'string', + 'example' => '2022-07-01T09:50:18Z', + ], + 'LockReason' => [ + 'description' => '集群锁定原因。'."\n" + .'> 仅当集群被锁定时会返回该参数，固定为**instance_expire**。', + 'type' => 'string', + 'example' => 'instance_expired', + ], + 'VPCId' => [ + 'description' => '专有网络（VPC）ID。', + 'type' => 'string', + 'example' => 'vpc-bp13h7uzhulpuxvnp****', + ], + 'RegionId' => [ + 'description' => '集群所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ComputeResource' => [ + 'description' => '计算预留资源规格。1 ACU约等于1核4 GB。计算资源用于数据计算，增加计算资源能加快查询速度，可以根据集群实际性能按需弹性扩缩。', + 'type' => 'string', + 'example' => '16ACU', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1syh8vvw8yech7n****', + ], + 'DBVersion' => [ + 'description' => '数据库版本，当前仅支持**5.0**版本。', + 'type' => 'string', + 'example' => '5.0', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态，取值说明：'."\n" + .'- **Preparing**：准备中。'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Running**：运行中。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **Restoring**：备份恢复中。'."\n" + .'- **ClassChanging**：变配中。'."\n" + .'- **NetAddressCreating**：创建网络中。'."\n" + .'- **NetAddressDeleting**：删除网络中。'."\n" + .'- **NetAddressModifying**：修改网络中。', + 'type' => 'string', + 'example' => 'Running', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + ], + 'DBClusterNetworkType' => [ + 'description' => '集群网络类型。仅支持**VPC**（专有网络）类型。', + 'type' => 'string', + 'example' => 'VPC', + 'default' => 'VPC', + ], + 'DBClusterDescription' => [ + 'description' => '集群的描述信息。', + 'type' => 'string', + 'example' => 'adb_test', + ], + 'ZoneId' => [ + 'description' => '集群所在的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Engine' => [ + 'description' => '集群引擎，固定为**AnalyticDB**。', + 'type' => 'string', + 'example' => 'AnalyticDB', + ], + 'ReservedACU' => [ + 'description' => '集群剩余可分配计算预留资源。1 ACU约等于1核4 GB。', + 'type' => 'string', + 'example' => '32ACU', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + .'> 您可以调用[TagResources](~~179253~~)接口为目标集群创建标签。', + 'type' => 'string', + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + 'Category' => [ + 'description' => '产品系列，仅在实例为数仓版时该值有意义，取值说明：'."\n" + .'- **BASIC**：预留模式基础版。'."\n" + .'- **CLUSTER**：预留模式集群版。'."\n" + .'- **MIXED_STORAGE**：弹性模式集群版（新版）。'."\n" + .'> 更多关于集群系列的介绍，请参见[产品系列](~~205001~~)。', + 'type' => 'string', + 'example' => 'MIXED_STORAGE', + ], + 'InnerPort' => [ + 'description' => '集群的内网连接端口。', + 'type' => 'string', + 'example' => '3306', + ], + 'VPCCloudInstanceId' => [ + 'description' => '内网连接地址。', + 'type' => 'string', + 'example' => 'am-bp163885f8q21****-controller', + ], + 'InnerIp' => [ + 'description' => '集群内网IP地址。', + 'type' => 'string', + 'example' => '10.1.xx.xx', + ], + 'DtsJobId' => [ + 'description' => 'DTS同步任务ID。仅MySQL分析实例会返回该参数。更多详情，请参见[MySQL分析实例简介](~~154779~~)。'."\n", + 'type' => 'string', + 'example' => 'dtsb1578j90XXXX', + ], + 'ElasticIOResource' => [ + 'description' => '弹性IO资源（Elastic IO Unit，简称EIU），更多详情，请参见[EIU详解](~~189505~~)。'."\n" + .'> 仅弹性模式集群会返回该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RdsInstanceId' => [ + 'description' => '同步源RDS实例ID。仅MySQL分析实例会返回该参数。更多详情，请参见[MySQL分析实例简介](~~154779~~)。', + 'type' => 'string', + 'example' => 'rm-bp11q28kvl688****', + ], + 'ExecutorCount' => [ + 'description' => '弹性模式下集群使用的计算节点数量。', + 'type' => 'string', + 'example' => '1', + ], + 'DBNodeClass' => [ + 'description' => '节点规格，仅在实例为数仓版时该值有意义。', + 'type' => 'string', + 'example' => 'E8', + ], + 'DiskType' => [ + 'description' => '集群的磁盘类型，取值说明：'."\n" + .'- **local_ssd**：本地磁盘。'."\n" + .'- **cloud**：普通云盘。'."\n" + .'- **cloud_ssd**：SSD云盘。'."\n" + .'- **cloud_efficiency**：高效云盘。'."\n" + .'- **cloud_essd**：PL1等级的ESSD云盘。'."\n" + .'- **cloud_essd2**：PL2 等级的ESSD云盘。'."\n" + .'- **cloud_essd3**：PL3 等级的ESSD云盘。'."\n" + .'> 更多关于ESSD云盘的详情，请参见[ESSD云盘规格](~~122389~~)。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'DBNodeStorage' => [ + 'description' => '集群的存储空间，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'DBNodeCount' => [ + 'description' => '节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TaskInfo' => [ + 'description' => '任务进度信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'analyticDBFlexibleScaleOut', + ], + 'Status' => [ + 'description' => '任务状态，取值为：'."\n" + .'- **NOT_RUN**：等待运行。'."\n" + .'- **RUNNING**：运行中。'."\n" + .'- **SUCCEED**：已结束。', + 'type' => 'string', + 'example' => 'RUNNING', + 'enum' => [ + 'RUNNING', + 'SUCCEED', + 'NOT_RUN', + ], + ], + 'Progress' => [ + 'description' => '任务进度，单位：%。', + 'type' => 'string', + 'example' => '10%', + ], + 'StepList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StepList' => [ + 'description' => '任务步骤。', + 'type' => 'array', + 'items' => [ + 'description' => '任务步骤。', + 'type' => 'object', + 'properties' => [ + 'StepName' => [ + 'description' => '步骤名称。', + 'type' => 'string', + 'example' => 'ApplyResource', + ], + 'StepDesc' => [ + 'description' => '步骤描述。', + 'type' => 'string', + 'example' => 'Apply resource', + ], + 'StepStatus' => [ + 'description' => '步骤状态，取值为：'."\n" + .'- **NOT_RUN**：等待运行。'."\n" + .'- **RUNNING**：运行中。'."\n" + .'- **SUCCEED**：已结束。', + 'type' => 'string', + 'example' => 'SUCCEED', + 'enum' => [ + 'RUNNING', + 'SUCCEED', + 'NOT_RUN', + ], + ], + 'StepProgress' => [ + 'description' => '步骤进度，单位：%。', + 'type' => 'string', + 'example' => '50%', + ], + 'StartTime' => [ + 'description' => '步骤开始时间，格式为 YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-03-10T09:28:34Z', + ], + 'EndTime' => [ + 'description' => '步骤结束时间，格式为 YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-03-10T10:28:34Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'ProductForm' => [ + 'description' => '产品形态枚举：'."\n" + .'- **LegacyForm**: 传统形态。'."\n" + .'- **IntegrationForm**：融合形态。', + 'type' => 'string', + 'example' => 'IntegrationForm', + 'enum' => [ + 'IntegrationForm', + 'LegacyForm', + ], + ], + 'ProductVersion' => [ + 'description' => '产品版本。取值为：'."\n" + .'- **BasicVersion**：基础版。'."\n" + .'- **EnterpriseVersion**：企业版。', + 'type' => 'string', + 'example' => 'EnterpriseVersion', + ], + 'ReservedNodeSize' => [ + 'description' => '预留资源单节点规格。', + 'type' => 'string', + 'example' => '8ACU', + ], + 'ReservedNodeCount' => [ + 'description' => '预留资源节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AINodeSpec' => [ + 'type' => 'string', + ], + 'AINodeNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"A5EDBA27-AF3E-5966-9503-FD1557E19167\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2022-04-01T09:50:18Z\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"Mode\\": \\"flexible\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageResource\\": \\"24ACU\\",\\n \\"DBClusterId\\": \\"amv-bp163885f8q21****\\",\\n \\"ConnectionString\\": \\"amv-bp163885f8q21****.ads.aliyuncs.com\\",\\n \\"DBClusterType\\": \\"Common\\",\\n \\"CommodityCode\\": \\"ads_pre\\",\\n \\"ExpireTime\\": \\"2022-07-01T09:50:18Z\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"VPCId\\": \\"vpc-bp13h7uzhulpuxvnp****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ComputeResource\\": \\"16ACU\\",\\n \\"VSwitchId\\": \\"vsw-bp1syh8vvw8yech7n****\\",\\n \\"DBVersion\\": \\"5.0\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"ReservedACU\\": \\"32ACU\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"Category\\": \\"MIXED_STORAGE\\",\\n \\"InnerPort\\": \\"3306\\",\\n \\"VPCCloudInstanceId\\": \\"am-bp163885f8q21****-controller\\",\\n \\"InnerIp\\": \\"10.1.xx.xx\\",\\n \\"DtsJobId\\": \\"dtsb1578j90XXXX\\",\\n \\"ElasticIOResource\\": 2,\\n \\"RdsInstanceId\\": \\"rm-bp11q28kvl688****\\",\\n \\"ExecutorCount\\": \\"1\\",\\n \\"DBNodeClass\\": \\"E8\\",\\n \\"DiskType\\": \\"cloud_essd\\",\\n \\"DBNodeStorage\\": 300,\\n \\"DBNodeCount\\": 2,\\n \\"TaskInfo\\": {\\n \\"Name\\": \\"analyticDBFlexibleScaleOut\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Progress\\": \\"10%\\",\\n \\"StepList\\": {\\n \\"StepList\\": [\\n {\\n \\"StepName\\": \\"ApplyResource\\",\\n \\"StepDesc\\": \\"Apply resource\\",\\n \\"StepStatus\\": \\"SUCCEED\\",\\n \\"StepProgress\\": \\"50%\\",\\n \\"StartTime\\": \\"2024-03-10T09:28:34Z\\",\\n \\"EndTime\\": \\"2024-03-10T10:28:34Z\\"\\n }\\n ]\\n }\\n },\\n \\"ProductForm\\": \\"IntegrationForm\\",\\n \\"ProductVersion\\": \\"EnterpriseVersion\\",\\n \\"ReservedNodeSize\\": \\"8ACU\\",\\n \\"ReservedNodeCount\\": 1,\\n \\"AINodeSpec\\": \\"\\",\\n \\"AINodeNumber\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 30\\n A5EDBA27-AF3E-5966-9503-FD1557E19167\\n 1\\n \\n false\\n 2022-04-01T09:50:18Z\\n Prepaid\\n flexible\\n 3306\\n Unlock\\n 24ACU\\n amv-bp163885f8q21****\\n amv-bp163885f8q21****.ads.aliyuncs.com\\n Common\\n ads_pre\\n 2022-07-01T09:50:18Z\\n instance_expired\\n vpc-bp13h7uzhulpuxvnp****\\n cn-hangzhou\\n 16ACU\\n vsw-bp1syh8vvw8yech7n****\\n 5.0\\n Running\\n rg-acfmyiu4ekp****\\n VPC\\n adb_test\\n cn-hangzhou-h\\n AnalyticDB\\n 32ACU\\n \\n","errorExample":""}]', + 'title' => '查询集群列表', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'CreateDBCluster' => [ + 'summary' => '创建湖仓版集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '130062', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定湖仓版集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定湖仓版集群的可用区ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '湖仓版集群的版本，取值：**5.0**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5.0', + ], + ], + [ + 'name' => 'DBClusterNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群网络类型。仅支持**VPC**（专有网络）类型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。'."\n" + .'- 不能以`http://`或者`https://`开头。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型。取值说明：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月。', + 'type' => 'string', + 'required' => true, + 'example' => 'Prepaid', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '指定包年包月集群为包年或包月类型。取值说明：'."\n" + .'- **Year**：包年类型。'."\n" + .'- **Month**：包月类型。'."\n" + ."\n" + .'>PayType为Prepaid（即包年包月）时，本参数为必填参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定包年包月集群的购买时长。取值说明：'."\n" + .'- 当**Period**为Year时，UsedTime取值范围为：1~3（整数）。'."\n" + .'- 当**Period**为Month时，UsedTime取值范围为：1~9（整数）。'."\n" + ."\n" + .'>PayType为**Prepaid**（即包年包月）时，本参数为必填参数。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-bp1at5ze0t5u3xtqn****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-bp1aadw9k19x6cis9****', + ], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + 'schema' => [ + 'description' => '存储预留资源。取值范围：0ACU～2064ACU，步长：24。1 ACU约等于1核4 GB。'."\n" + .'> 参数填写时，需要带单位。', + 'type' => 'string', + 'required' => false, + 'example' => '24ACU', + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '计算预留资源。取值范围：0ACU～4096ACU，步长：16。1 ACU约等于1核4 GB。'."\n" + .'> 参数填写时，需要带单位。', + 'type' => 'string', + 'required' => false, + 'example' => '16ACU', + ], + ], + [ + 'name' => 'EnableDefaultResourcePool', + 'in' => 'query', + 'schema' => [ + 'description' => '计算预留资源是否全部分配给默认资源组（user_default），取值说明：'."\n" + .'- **true**（默认值）：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => '标签值，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'SourceDbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL数仓版集群的源实例ID，指定该参数时为从数仓版集群恢复湖仓版集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '基于备份集恢复时，使用的备份集的ID。'."\n" + ."\n" + .'> 您可以调用[DescribeBackups](~~612318~~)接口查看集群的备份列表。', + 'type' => 'string', + 'required' => false, + 'example' => '1880808684', + ], + ], + [ + 'name' => 'RestoreToTime', + 'in' => 'query', + 'schema' => [ + 'description' => '基于备份集恢复的时间点。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-09-20T03:13:56Z', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复方式，取值：'."\n" + .'* **backup**：基于备份集恢复，您还需要传入参数**BackupSetId**、**SourceDBClusterId**。'."\n" + .'* **timepoint**：基于时间点恢复，您还需要传入参数**RestoreToTime**、**SourceDBClusterId**。', + 'type' => 'string', + 'required' => false, + 'example' => 'backup', + ], + ], + [ + 'name' => 'ProductForm', + 'in' => 'query', + 'schema' => [ + 'description' => '产品形态。取值为：'."\n" + .'- **IntegrationForm**：融合形态。'."\n" + .'- **LegacyForm**：湖仓版。', + 'type' => 'string', + 'required' => false, + 'example' => 'LegacyForm', + 'default' => 'LegacyForm', + 'enum' => [ + 'IntegrationForm', + 'LegacyForm', + ], + ], + ], + [ + 'name' => 'ReservedNodeSize', + 'in' => 'query', + 'schema' => [ + 'description' => '预留节点规格，单位为ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '8ACU', + 'default' => '8ACU', + ], + ], + [ + 'name' => 'ReservedNodeCount', + 'in' => 'query', + 'schema' => [ + 'description' => '预留节点数。 '."\n" + .'- 企业版默认为3节点，步长为3。'."\n" + .'- 基础版默认为1节点。'."\n" + .'> 仅ProductForm取值为IntegrationForm时，填写该参数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'KmsId', + 'in' => 'query', + 'schema' => [ + 'description' => '用于加密云盘数据的密钥ID。'."\n" + .'> 仅当AnalyticDB MySQL集群开启云盘加密时才会使用该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'e1935511-cf88-1123-a0f8-1be8d251****'."\n", + ], + ], + [ + 'name' => 'DiskEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启云盘加密。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CloneSourceRegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '克隆源实例所在区域，跨域克隆必填，同域克隆可不填。', + 'description' => '源集群所在的地域。'."\n" + .'> 跨地域克隆时该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ProductVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '产品版本。取值为：'."\n" + .'- **BasicVersion**：基础版。'."\n" + .'- **EnterpriseVersion**：企业版。'."\n" + .'> 仅ProductForm取值为IntegrationForm时，填写该参数', + 'type' => 'string', + 'required' => false, + 'example' => 'BasicVersion', + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区ID。'."\n" + .'> 本参数和ZoneId参数传入的值不能相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-h', + ], + ], + [ + 'name' => 'SecondaryVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '备虚拟交换机ID。'."\n" + .'> 本参数和VSwitchId参数传入的值不能相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1aadw9k19x451gx****', + ], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'ResourceGroupId' => [ + 'description' => '默认资源组的ID。', + 'type' => 'string', + 'example' => 'rg-4690g37929****', + ], + 'DBClusterId' => [ + 'description' => 'AnalyticDB MySQL湖仓版（3.0）集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1r053byu48p****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '202353278****', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"ResourceGroupId\\": \\"rg-4690g37929****\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\",\\n \\"OrderId\\": \\"202353278****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n rg-4690g37929****\\n amv-bp1r053byu48p****\\n 202353278****\\n","errorExample":""}]', + 'title' => '创建集群', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyDBCluster' => [ + 'summary' => '对湖仓版集群进行升降配。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '132381', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '湖仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看湖仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定湖仓版集群的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + 'schema' => [ + 'description' => '存储预留资源。取值范围：0ACU～2064ACU，步长：24。1 ACU约等于1核4 GB。'."\n" + .'> 参数填写时，需要带单位。', + 'type' => 'string', + 'required' => false, + 'example' => '24ACU', + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '计算预留资源。取值范围：0ACU～4096ACU，步长：16。1 ACU约等于1核4 GB。'."\n" + .'> 参数填写时，需要带单位。', + 'type' => 'string', + 'required' => false, + 'example' => '16ACU', + ], + ], + [ + 'name' => 'EnableDefaultResourcePool', + 'in' => 'query', + 'schema' => [ + 'description' => '计算预留资源是否全部分配给默认资源组（user_default），取值说明：'."\n" + .'- true（默认值）：是'."\n" + .'- false：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ProductForm', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'LegacyForm', + 'default' => 'LegacyForm', + 'enum' => [ + 'IntegrationForm', + 'LegacyForm', + ], + ], + ], + [ + 'name' => 'ReservedNodeSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'LegacyForm', + ], + ], + [ + 'name' => 'ReservedNodeCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0D6BF3E2-41D8-57F6-9A62-A13A70377952', + ], + 'DBClusterId' => [ + 'description' => '湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1r053byu48p****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2035629****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Cluster.InvalidWorkerState', + 'errorMessage' => 'The state of the worker does not support this operation.', + ], + [ + 'errorCode' => 'ACS.Cluster.ElasticPlanJobsExists', + 'errorMessage' => 'Operation failed. Ongoing elastic plan jobs exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D6BF3E2-41D8-57F6-9A62-A13A70377952\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\",\\n \\"OrderId\\": \\"2035629****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0D6BF3E2-41D8-57F6-9A62-A13A70377952\\n amv-bp1r053byu48p****\\n 2035629****\\n","errorExample":""}]', + 'title' => '集群升降配', + 'description' => '### 注意事项'."\n" + .'- 扩缩容期间，会禁止`submit job`提交异步任务。如果业务依赖相关功能，请根据业务情况选择时段执行扩缩容。'."\n" + .'- 扩缩容操作会对数据进行重分布迁移，迁移时长与数据量成正比，扩缩容期间服务不中断。集群从大规格缩容到小规格时，数据迁移时长通常需要数小时甚至数十小时，数据量大时请谨慎缩容。'."\n" + .'- 如果集群已加载内置数据集，在缩容时请确保集群具有至少24 ACU的存储预留资源，否则内置数据集无法使用。'."\n" + .'- 扩缩容即将结束时，可能会发生连接闪断，建议您在业务低峰期扩缩容，或确保您的应用有自动重连机制。'."\n" + .'- 不支持将湖仓版变配为数仓版。支持将数仓版变配为湖仓版，详情请参见数仓版变配湖仓版。'."\n" + .'- 当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DeleteDBCluster' => [ + 'summary' => '删除集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1r053byu48p****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Cluster.InvalidWorkerState', + 'errorMessage' => 'The state of the worker does not support this operation.', + ], + [ + 'errorCode' => 'ACS.Cluster.ElasticPlanJobsExists', + 'errorMessage' => 'Operation failed. Ongoing elastic plan jobs exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n amv-bp1r053byu48p****\\n","errorExample":""}]', + 'title' => '释放集群', + 'description' => '### 注意事项'."\n" + .'- 仅支持删除按量付费类型的集群。'."\n" + .'- 集群状态为运行中。'."\n" + .'- 当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeDBClusterAttribute' => [ + 'summary' => '查看指定集群的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130313', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口可以查询集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '企业版、基础版集群信息列表。'."\n" + .'湖仓版集群信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群详情。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '集群创建时间。UTC时间，格式为`yyyy-MM-ddThh:mm:ssZ`。', + 'type' => 'string', + 'example' => '2022-07-01T09:50:18Z', + ], + 'Expired' => [ + 'description' => '包年包月集群是否过期。取值说明：'."\n" + .'- **true**：已过期。'."\n" + .'- **false**：未过期。'."\n" + .'> - 如果集群已过期，在一定时间内集群会被锁定甚至释放。建议您进行续费操作，详情请参见[续费说明](~~135248~~)。'."\n" + .'- 按量付费集群不返回此参数。', + 'type' => 'string', + 'example' => 'false', + ], + 'MaintainTime' => [ + 'description' => '集群的可维护时间。UTC时间，格式为`HH:mmZ-HH:mmZ`。'."\n" + .'> 更多关于可维护时间段的信息，请参见[设置可维护时间段](~~122569~~)。', + 'type' => 'string', + 'example' => '04:00Z-05:00Z', + ], + 'PayType' => [ + 'description' => '集群付费类型，取值说明：'."\n" + .'* **Postpaid**：按量付费。'."\n" + .'* **Prepaid**：包年包月。', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + .'> 您可以调用[TagResources](~~179253~~)接口为目标集群创建标签。', + 'type' => 'string', + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + 'Mode' => [ + 'description' => '集群模式。默认返回**flexible**，表示弹性模式集群。', + 'type' => 'string', + 'example' => 'flexible', + ], + 'Port' => [ + 'description' => '集群端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'LockMode' => [ + 'description' => '集群的锁定模式，取值说明：'."\n" + .'- **Unlock**：未锁定。'."\n" + .'- **ManualLock**：手动触发锁定。'."\n" + .'- **LockByExpiration**：集群到期自动锁定。', + 'type' => 'string', + 'example' => 'ManualLock', + ], + 'EngineVersion' => [ + 'description' => '集群引擎版本。', + 'type' => 'string', + 'example' => '3.1.16', + 'default' => '3.1.7.0', + ], + 'StorageResource' => [ + 'description' => '存储预留资源规格。1 ACU约等于1核4 GB。存储资源用于数据读写，增加该资源能提高集群读写能力。', + 'type' => 'string', + 'example' => '24ACU', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。 'string', + 'example' => 'amv-wz9509beptiz****', + ], + 'ConnectionString' => [ + 'description' => '集群的公网连接地址。', + 'type' => 'string', + 'example' => 'amv-wz9509beptiz****.ads.aliyuncs.com', + ], + 'DBClusterType' => [ + 'description' => '集群类型。默认返回**Common**，表示常规集群。', + 'type' => 'string', + 'example' => 'Common', + ], + 'CommodityCode' => [ + 'description' => '商品付费类型，取值说明：'."\n" + .'- **ads**：按量付费商品。'."\n" + .'- **ads_pre**：包年包月商品。', + 'type' => 'string', + 'example' => 'ads_pre', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间。'."\n" + .'- 若集群付费类型为包年包月，则返回实际到期时间。'."\n" + .'- 若集群付费类型为按量付费，则返回为空。', + 'type' => 'string', + 'example' => '2022-10-01T09:50:18Z', + ], + 'LockReason' => [ + 'description' => '集群锁定原因。'."\n" + .'> 仅当集群被锁定时会返回该参数，固定为**instance_expire**。', + 'type' => 'string', + 'example' => 'instance_expire', + ], + 'VPCId' => [ + 'description' => '专有网络（VPC）ID。', + 'type' => 'string', + 'example' => 'vpc-bp13h7uzhulpu****', + ], + 'ComputeResource' => [ + 'description' => '计算预留资源规格。1 ACU约等于1核4 GB。计算资源用于数据计算，增加计算资源能加快查询速度，可以根据集群实际性能按需弹性扩缩。', + 'type' => 'string', + 'example' => '16ACU', + ], + 'RegionId' => [ + 'description' => '集群所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-uf629gydd54ld****', + ], + 'DBVersion' => [ + 'description' => 'AnalyticDB MySQL集群的版本，当前仅支持**5.0**版本。', + 'type' => 'string', + 'example' => '5.0', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态。取值说明：'."\n" + .'- **Preparing**：准备中'."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：删除中'."\n" + .'- **Restoring**：备份恢复中'."\n" + .'- **ClassChanging**：变配中'."\n" + .'- **NetAddressCreating**：创建网络中'."\n" + .'- **NetAddressDeleting**：删除网络中'."\n" + .'- **NetAddressModifying**：修改网络中', + 'type' => 'string', + 'example' => 'Running', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + ], + 'DBClusterNetworkType' => [ + 'description' => '集群网络类型。仅支持**VPC**（专有网络）类型。', + 'type' => 'string', + 'example' => 'VPC', + 'default' => 'VPC', + ], + 'DBClusterDescription' => [ + 'description' => '集群的描述信息。', + 'type' => 'string', + 'example' => 'adb_test', + ], + 'UserENIStatus' => [ + 'description' => '是否已启用ENI（Elastic Network Interface，弹性网卡）网络，取值说明：'."\n" + .'- **true**：已启用。'."\n" + .'- **false**：未启用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ZoneId' => [ + 'description' => '集群所在的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Engine' => [ + 'description' => '集群引擎，固定为**AnalyticDB**。', + 'type' => 'string', + 'example' => 'AnalyticDB', + ], + 'ReservedACU' => [ + 'description' => '集群剩余可分配计算预留资源。1 ACU约等于1核4 GB。', + 'type' => 'string', + 'example' => '24ACU', + ], + 'ComputeResourceTotal' => [ + 'description' => '集群计算总资源量。1 ACU约等于1核4 GB。', + 'type' => 'string', + 'example' => '48ACU', + ], + 'StorageResourceTotal' => [ + 'description' => '集群存储总资源量。1 ACU约等于1核4 GB。', + 'type' => 'string', + 'example' => '24ACU', + ], + 'SupportedFeatures' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '预留参数，不涉及。', + 'example' => '预留参数，不涉及。', + ], + ], + 'ProductForm' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'example' => '预留参数，不涉及。', + 'enum' => [ + 'IntegrationForm', + 'LegacyForm', + ], + ], + 'ReservedNodeSize' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'example' => '预留参数，不涉及。', + ], + 'ReservedNodeCount' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '预留参数，不涉及。', + ], + 'ClickhouseEngineEnabled' => [ + 'description' => 'ClickHouse宽表引擎是否开启。'."\n" + .'- **true**: 已开启Clickhouse宽表引擎。'."\n" + .'- **false**: 未开启Clickhouse宽表引擎。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'AINodeNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ProductVersion' => [ + 'description' => '产品版本。取值为：'."\n" + .'- **BasicVersion**：基础版。'."\n" + .'- **EnterpriseVersion**：企业版。', + 'type' => 'string', + 'example' => 'BasicVersion', + ], + 'KmsId' => [ + 'description' => '用于加密云盘数据的密钥ID。'."\n" + .'> 仅当AnalyticDB MySQL集群开启云盘加密时才会返回该参数。', + 'type' => 'string', + 'example' => 'e1935511-cf88-1123-a0f8-1be8d251****', + ], + 'TaskInfo' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'ScaleUpDBCluster', + ], + 'Status' => [ + 'description' => '任务状态，取值为：'."\n" + .'* NOT_RUN：等待运行。'."\n" + .'* RUNNING：运行中。'."\n" + .'* SUCCEED：已结束。', + 'type' => 'string', + 'example' => 'RUNNING', + 'enum' => [ + 'RUNNING', + 'SUCCEED', + 'NOT_RUN', + ], + ], + 'Progress' => [ + 'description' => '任务进度，单位：%。', + 'type' => 'string', + 'example' => '10', + ], + 'StepList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StepList' => [ + 'description' => '任务步骤。', + 'type' => 'array', + 'items' => [ + 'description' => '任务步骤。', + 'type' => 'object', + 'properties' => [ + 'StepName' => [ + 'description' => '步骤名称。', + 'type' => 'string', + 'example' => 'PrepareResources', + ], + 'StepDesc' => [ + 'description' => '步骤描述。', + 'type' => 'string', + 'example' => 'Prepare resources', + ], + 'StepStatus' => [ + 'description' => '步骤状态，取值为：'."\n" + .'* NOT_RUN：等待运行。'."\n" + .'* RUNNING：运行中。'."\n" + .'* SUCCEED：已结束。', + 'type' => 'string', + 'example' => 'RUNNING', + 'enum' => [ + 'RUNNING', + 'SUCCEED', + 'NOT_RUN', + ], + ], + 'StepProgress' => [ + 'description' => '步骤进度，单位：%。', + 'type' => 'string', + 'example' => '50', + ], + 'StartTime' => [ + 'description' => '步骤开始时间，格式为 YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-03-10T09:28:34Z', + ], + 'EndTime' => [ + 'description' => '步骤结束时间，格式为 YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-03-10T10:28:34Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'UserENIVpcId' => [ + 'description' => 'ENI的VPC信息。', + 'type' => 'string', + 'example' => 'vpc-rj9hnedlfm645uj******', + ], + 'UserENIVSwitchOptions' => [ + 'description' => 'ENI交换机列表。多个交换机中间用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => 'vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******', + ], + 'UserENIZoneOptions' => [ + 'description' => 'ENI可用区信息。多个可用区之间用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => 'cn-hangzhou-k,cn-hangzhou-h', + ], + 'SecondaryZoneId' => [ + 'type' => 'string', + ], + 'SecondaryVSwitchId' => [ + 'type' => 'string', + ], + 'DiskEncryption' => [ + 'type' => 'boolean', + ], + 'ClickhouseEngineCacheSize' => [ + 'description' => 'ClickHouse宽表引擎的缓存大小，单位：GB。若返回-1，则表示未开启宽表引擎。 若返回具体数字，则表示云盘缓存空间大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'AINodeSpec' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\",\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"CreationTime\\": \\"2022-07-01T09:50:18Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"MaintainTime\\": \\"04:00Z-05:00Z\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"Mode\\": \\"flexible\\",\\n \\"Port\\": 3306,\\n \\"LockMode\\": \\"ManualLock\\",\\n \\"EngineVersion\\": \\"3.1.16\\",\\n \\"StorageResource\\": \\"24ACU\\",\\n \\"DBClusterId\\": \\"amv-wz9509beptiz****\\",\\n \\"ConnectionString\\": \\"amv-wz9509beptiz****.ads.aliyuncs.com\\",\\n \\"DBClusterType\\": \\"Common\\",\\n \\"CommodityCode\\": \\"ads_pre\\",\\n \\"ExpireTime\\": \\"2022-10-01T09:50:18Z\\",\\n \\"LockReason\\": \\"instance_expire\\",\\n \\"VPCId\\": \\"vpc-bp13h7uzhulpu****\\",\\n \\"ComputeResource\\": \\"16ACU\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchId\\": \\"vsw-uf629gydd54ld****\\",\\n \\"DBVersion\\": \\"5.0\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"UserENIStatus\\": false,\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"ReservedACU\\": \\"24ACU\\",\\n \\"ComputeResourceTotal\\": \\"48ACU\\",\\n \\"StorageResourceTotal\\": \\"24ACU\\",\\n \\"SupportedFeatures\\": {\\n \\"key\\": \\"预留参数，不涉及。\\"\\n },\\n \\"ProductForm\\": \\"预留参数，不涉及。\\",\\n \\"ReservedNodeSize\\": \\"预留参数，不涉及。\\",\\n \\"ReservedNodeCount\\": 0,\\n \\"ClickhouseEngineEnabled\\": true,\\n \\"AINodeNumber\\": 0,\\n \\"ProductVersion\\": \\"BasicVersion\\",\\n \\"KmsId\\": \\"e1935511-cf88-1123-a0f8-1be8d251****\\",\\n \\"TaskInfo\\": {\\n \\"Name\\": \\"ScaleUpDBCluster\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Progress\\": \\"10\\",\\n \\"StepList\\": {\\n \\"StepList\\": [\\n {\\n \\"StepName\\": \\"PrepareResources\\",\\n \\"StepDesc\\": \\"Prepare resources\\",\\n \\"StepStatus\\": \\"RUNNING\\",\\n \\"StepProgress\\": \\"50\\",\\n \\"StartTime\\": \\"2024-03-10T09:28:34Z\\",\\n \\"EndTime\\": \\"2024-03-10T10:28:34Z\\"\\n }\\n ]\\n }\\n },\\n \\"UserENIVpcId\\": \\"vpc-rj9hnedlfm645uj******\\",\\n \\"UserENIVSwitchOptions\\": \\"vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******\\",\\n \\"UserENIZoneOptions\\": \\"cn-hangzhou-k,cn-hangzhou-h\\",\\n \\"SecondaryZoneId\\": \\"\\",\\n \\"SecondaryVSwitchId\\": \\"\\",\\n \\"DiskEncryption\\": true,\\n \\"ClickhouseEngineCacheSize\\": 100,\\n \\"AINodeSpec\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n \\n 2022-07-01T09:50:18Z\\n false\\n 04:00Z-05:00Z\\n Prepaid\\n flexible\\n 3306\\n ManualLock\\n 3.1.16\\n 24ACU\\n amv-wz9509beptiz****\\n amv-wz9509beptiz****.ads.aliyuncs.com\\n Common\\n ads_pre\\n 2022-10-01T09:50:18Z\\n instance_expire\\n vpc-bp13h7uzhulpu****\\n 16ACU\\n cn-hangzhou\\n vsw-uf629gydd54ld****\\n 5.0\\n Running\\n rg-acfmyiu4ekp****\\n VPC\\n adb_test\\n false\\n cn-hangzhou-h\\n AnalyticDB\\n 24ACU\\n 48ACU\\n 24ACU\\n \\n","errorExample":""}]', + 'title' => '查询集群详细信息', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeKernelVersion' => [ + 'summary' => '调用DescrbeKernelVersion接口查看目标集群的内核版本信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254101', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> * 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2ze918p6qf6h9****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看可用地域的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'KernelVersion' => [ + 'description' => '集群内核版本号，例如：**3.1.8**。', + 'type' => 'string', + 'example' => '3.1.8', + ], + 'ExpireDate' => [ + 'description' => '版本维护到期时间，时间格式为yyyy-MM-DD HH:mm:ss。超过此时间后，系统将不再维护该版本，若有问题，请升级到更高版本。', + 'type' => 'string', + 'example' => '2025-01-12T16:00:00Z', + ], + 'AvailableKernelVersions' => [ + 'description' => '当前版本支持升级到的目标版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当前版本支持升级到的目标版本列表。', + 'type' => 'object', + 'properties' => [ + 'KernelVersion' => [ + 'description' => '集群内核版本号，例如：**3.1.9**。', + 'type' => 'string', + 'example' => '3.1.9', + ], + 'ReleaseDate' => [ + 'description' => '内核版本的发布时间。时间格式为yyyy-MM-DD HH:mm:ss。', + 'type' => 'string', + 'example' => '2024-07-17T16:00:00Z'."\n", + ], + 'ExpireDate' => [ + 'description' => '版本维护到期时间，时间格式为yyyy-MM-DD HH:mm:ss。超过此时间后，系统将不再维护该版本，若有问题，请升级到更高版本。', + 'type' => 'string', + 'example' => '2025-07-17T16:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"KernelVersion\\": \\"3.1.8\\",\\n \\"ExpireDate\\": \\"2025-01-12T16:00:00Z\\",\\n \\"AvailableKernelVersions\\": [\\n {\\n \\"KernelVersion\\": \\"3.1.9\\",\\n \\"ReleaseDate\\": \\"2024-07-17T16:00:00Z\\\\n\\",\\n \\"ExpireDate\\": \\"2025-07-17T16:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群内核版本', + ], + 'UpgradeKernelVersion' => [ + 'summary' => '升级目标AnalyticDB MySQL版集群的内核版本。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~129857~~)接口查看账号下AnalyticDB MySQL数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '需要升级到的目标内核版本。'."\n" + .'> 您可以调用**DescribeKernelVersion**接口查询集群支持的内核版本列表。', + 'type' => 'string', + 'required' => false, + 'example' => '3.1.9', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '执行时间，取值：'."\n" + .'* **0**：立即执行，默认值。'."\n" + .'* **1**：在可维护时间段执行。'."\n" + ."\n" + .'> 您可以调用[ModifyDBClusterMaintainTime](~~612236~~)修改集群的可维护时间段。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A444FFFFFF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A444FFFFFF\\"\\n}","type":"json"}]', + 'title' => '升级集群内核版本', + ], + 'DescribeDBClusterStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '133754', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '集群状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群状态，取值说明：'."\n" + .'- **Preparing**：准备中。'."\n" + ."\n" + .'- **Creating**：创建中。'."\n" + ."\n" + .'- **Restoring**：备份恢复中。'."\n" + ."\n" + .'- **Running**：运行中。'."\n" + ."\n" + .'- **Deleting**：删除中。'."\n" + ."\n" + .'- **ClassChanging**：变配中。'."\n" + ."\n" + .'- **NetAddressCreating**：创建网络中。'."\n" + ."\n" + .'- **NetAddressDeleting**：释放网络中。'."\n" + ."\n" + .'- **NetAddressModifying**：网络地址修改中。'."\n" + ."\n" + .'- **EngineVersionUpgrading**：版本升级中。', + 'type' => 'string', + 'example' => 'Running', + ], + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAU', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": [\\n \\"Running\\"\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAU\\"\\n}","type":"json"}]', + 'title' => '查询集群的状态列表', + 'summary' => '查询集群的状态列表。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyDBClusterDescription' => [ + 'summary' => '修改指定集群的描述信息，方便集群的维护管理。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。'."\n" + ."\n" + .'- 不能以`http://`或者`https`开头；'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'adb_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterDescription.Malformed', + 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\n","errorExample":""}]', + 'title' => '变更集群描述', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeClusterAccessWhiteList' => [ + 'summary' => '查看指定集群的IP白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '370D09FD-442A-5225-AAD3-7362CAE39177', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IPArray' => [ + 'description' => '集群的IP白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群的IP白名单分组列表。', + 'type' => 'object', + 'properties' => [ + 'DBClusterIPArrayAttribute' => [ + 'description' => '白名单分组属性。'."\n" + .'> 控制台不显示带有**hidden**属性的分组，带有该标签的分组通常是用于访问DTS、PolarDB服务的。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'hidden', + ], + 'SecurityIPList' => [ + 'description' => 'IP白名单分组下的IP列表，最多500个，以英文逗号（,）隔开。', + 'type' => 'string', + 'example' => '127.0.xx.xx', + ], + 'DBClusterIPArrayName' => [ + 'description' => 'IP白名单分组名称。'."\n" + ."\n" + .'单个集群最多支持50个白名单分组。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"370D09FD-442A-5225-AAD3-7362CAE39177\\",\\n \\"Items\\": {\\n \\"IPArray\\": [\\n {\\n \\"DBClusterIPArrayAttribute\\": \\"hidden\\",\\n \\"SecurityIPList\\": \\"127.0.xx.xx\\",\\n \\"DBClusterIPArrayName\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 370D09FD-442A-5225-AAD3-7362CAE39177\\n \\n hidden\\n 127.0.xx.xx\\n test\\n \\n","errorExample":""}]', + 'title' => '查询白名单', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyClusterAccessWhiteList' => [ + 'summary' => '修改指定集群的IP白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的IP白名单，多个IP地址之间以英文逗号（,）隔开，不可重复，最多500个。支持如下两种格式：'."\n" + .'- IP地址形式，例如：10.23.xx.xx。'."\n" + .'- CIDR形式，例如：10.23.xx.xx/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10.23.xx.xx', + ], + ], + [ + 'name' => 'DBClusterIPArrayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单分组名称，默认操作Default分组。'."\n" + ."\n" + .'- IP白名单分组名称以小写字母开头、以数字或小写字母结尾，可包含小写字母、数字及下划线（_），长度为2~32个字符。'."\n" + .'- 单个集群最多支持50个白名单分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'default' => 'default', + ], + ], + [ + 'name' => 'DBClusterIPArrayAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单分组属性，默认为空。'."\n" + .'> 控制台不显示带有“hidden”属性的分组，带有该标签的分组通常是用于访问DTS、PolarDB服务的。', + 'type' => 'string', + 'required' => false, + 'example' => 'hidden', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => '修改白名单的方式，取值：'."\n" + .'- **Cover**（默认值）：覆盖原IP白名单。'."\n" + .'- **Append**：追加IP。'."\n" + .'- **Delete**：删除IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cover', + 'default' => 'Cover', + 'enum' => [ + 'Cover', + 'Append', + 'Delete', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1564657730', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '370D09FD-442A-5225-AAD3-7362CAE39177', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp11q28kvl688****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityIPList.Duplicate', + 'errorMessage' => 'The specified IP address is duplicate.', + ], + [ + 'errorCode' => 'InvalidDBClusterIPArrayName.Malformed', + 'errorMessage' => 'The specified parameter DBClusterIPArrayName is not valid.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Malformed', + 'errorMessage' => 'The specified SecurityIPList is incorrectly formatted.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 1564657730,\\n \\"RequestId\\": \\"370D09FD-442A-5225-AAD3-7362CAE39177\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1564657730\\n 370D09FD-442A-5225-AAD3-7362CAE39177\\n amv-bp11q28kvl688****\\n","errorExample":""}]', + 'title' => '修改白名单', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyClickhouseEngine' => [ + 'summary' => '为AnalyticDB MySQL实例开启宽表引擎；如果宽表引擎已开启，则修改宽表引擎的缓存大小。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '208236', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启宽表引擎。'."\n" + .'取值说明：'."\n" + .'- true：开启。'."\n" + .'- false：不开启。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'CacheSize', + 'in' => 'query', + 'schema' => [ + 'description' => '宽表引擎云盘缓存空间大小，单位为GB，默认为100GB，取值范围为[100,1000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D761DA51-12F8-5457-AAA9-F52B9F436D2D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D761DA51-12F8-5457-AAA9-F52B9F436D2D\\"\\n}","type":"json"}]', + 'title' => '开启和修改宽表引擎', + ], + 'DescribeResourceGroupSpec' => [ + 'summary' => '查询资源组规格相关信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235394', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-8vbo40tl1dxxxxxx', + ], + ], + [ + 'name' => 'ResourceGroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组的类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'ai', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'requestId', + 'type' => 'string', + 'example' => '10226189-4391-5B10-97AF-5CA5XXXXXXX', + ], + 'Specs' => [ + 'description' => '规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规格信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '规格名称。', + 'type' => 'string', + 'example' => 'xlarge', + ], + 'AllocateUnits' => [ + 'description' => '该规格支持的分配单元列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分配单元。', + 'type' => 'string', + 'example' => '1', + ], + ], + 'MaxQuantity' => [ + 'description' => '该规格能够使用的最大数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'Type' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'GPU', + 'default' => 'GPU', + 'enum' => [ + 'CPU', + 'GPU', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolType.Malformed', + 'errorMessage' => 'The specified parameter PoolType is not valid.', + ], + ], + 408 => [ + [ + 'errorCode' => 'AcsServerTimeOut', + 'errorMessage' => 'The request has failed due to Adb Cloud Service time out.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10226189-4391-5B10-97AF-5CA5XXXXXXX\\",\\n \\"Specs\\": [\\n {\\n \\"Name\\": \\"xlarge\\",\\n \\"AllocateUnits\\": [\\n \\"1\\"\\n ],\\n \\"MaxQuantity\\": 8,\\n \\"Type\\": \\"GPU\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资源组规格', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'CreateDBResourceGroup' => [ + 'summary' => '为指定的企业版、基础版或湖仓版集群创建资源组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136449', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'- 长度不超过255个字符。'."\n" + .'- 必须以数字、大写字母或小写字母开头。'."\n" + .'- 可包含数字、大写字母、小写字母、中划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组类型，取值：'."\n" + .'- **Interactive**'."\n" + .'- **Job**'."\n" + .'> 关于湖仓版资源组的详细信息，请参见[资源组介绍（湖仓版）](~~428610~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Job', + 'enum' => [], + ], + ], + [ + 'name' => 'MinComputeResource', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '最小计算预留资源，单位为ACU。'."\n" + .'- 当资源组类型为Interactive时，计算预留资源最小为16 ACU。'."\n" + .'- 当资源组类型为Job时，计算预留资源最小为0 ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '0ACU', + ], + ], + [ + 'name' => 'MaxComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '最大计算预留资源，单位为ACU。'."\n" + .'- 当资源组类型为Interactive时，计算预留资源最大为集群当前未分配资源，步长为16 ACU。'."\n" + .'- 当资源组类型为Job时，计算预留资源最大为集群当前未分配资源，步长为8 ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '48ACU', + ], + ], + [ + 'name' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数（不涉及）', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数（不涉及）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '无'."\n", + ], + ], + [ + 'name' => 'MaxClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数（不涉及）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数（不涉及）', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'EnableSpot', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组是否开启竞价实例功能。开启竞价实例后资源单价降低，但是有概率被释放。仅Job型资源组可以开启。取值：'."\n" + .'- **True**：开启竞价实例功能。'."\n" + .'- **False**：关闭竞价实例功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~612393~~)接口查看AnalyticDB MySQL湖仓版（3.0）集群的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '作业投递规则。', + 'type' => 'array', + 'items' => [ + 'description' => '规则信息列表。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '资源组名称。'."\n" + .'- 长度不超过255个字符。'."\n" + .'- 必须以数字、大写字母或小写字母开头。'."\n" + .'- 可包含数字、大写字母、小写字母、中划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_group', + ], + 'QueryTime' => [ + 'description' => '查询执行时间阈值，单位为毫秒（ms）。', + 'type' => 'string', + 'required' => false, + 'example' => '180000'."\n", + ], + 'TargetGroupName' => [ + 'description' => '目标资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'job'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB for MySQL引擎。'."\n" + .'- **SparkWarehouse**：SparkWarehouse引擎。', + 'type' => 'string', + 'required' => false, + 'example' => 'SparkWarehouse', + ], + ], + [ + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '引擎配置。', + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + ], + [ + 'name' => 'AutoStopInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '自动停止时间，单位为分钟（m）。', + 'type' => 'string', + 'required' => false, + 'example' => '5m', + ], + ], + [ + 'name' => 'SpecName', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '预留参数，不涉及。', + ], + ], + [ + 'name' => 'MinGpuQuantity', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '预留参数，不涉及。', + ], + ], + [ + 'name' => 'MaxGpuQuantity', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '预留参数，不涉及。', + ], + ], + [ + 'name' => 'TargetResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '预留参数，不涉及。', + ], + ], + [ + 'name' => 'RayConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Ray配置信息(当资源组为ai资源组且对应引擎为RayCluster时需要填写)', + 'type' => 'object', + 'properties' => [ + 'EnableUserEni' => [ + 'type' => 'boolean', + 'required' => false, + ], + 'HeadSpecType' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'CPU', + 'enum' => [ + 'CPU', + 'GPU', + ], + ], + 'HeadSpec' => [ + 'description' => 'Head节点规格', + 'type' => 'string', + 'required' => false, + 'example' => 'xlarge', + ], + 'HeadAllocateUnit' => [ + 'type' => 'string', + 'required' => false, + ], + 'HeadDiskCapacity' => [ + 'type' => 'string', + 'required' => false, + ], + 'Category' => [ + 'description' => 'Ray集群类型，取值说明：'."\n" + ."\n" + .'- BASIC：基础类型，非高可用'."\n" + ."\n" + .'- HIGH_AVAILABILITY：高可用类型', + 'type' => 'string', + 'required' => false, + 'example' => 'BASIC', + 'enum' => [ + 'BASIC', + 'HIGH_AVAILABILITY', + ], + ], + 'WorkerGroups' => [ + 'description' => 'Ray Worker组配置信息列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Ray Worker组配置信息', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => 'worker组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'AllocateUnit' => [ + 'description' => '分配单元', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'MaxWorkerQuantity' => [ + 'description' => '最大worker数量', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'MinWorkerQuantity' => [ + 'description' => '最新worker数量', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'WorkerDiskCapacity' => [ + 'description' => 'worker节点的磁盘大小', + 'type' => 'string', + 'required' => false, + 'example' => '100G', + ], + 'WorkerSpecName' => [ + 'description' => 'worker节点规格', + 'type' => 'string', + 'required' => false, + 'example' => 'xlarge', + ], + 'WorkerSpecType' => [ + 'description' => 'worker节点资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'GPU', + 'enum' => [ + 'CPU', + 'GPU', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GpuElasticPlan', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'type' => 'boolean', + 'required' => false, + ], + 'Rules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartCronExpression' => [ + 'type' => 'string', + 'required' => false, + ], + 'EndCronExpression' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolType.Malformed', + 'errorMessage' => 'The specified parameter PoolType is not valid.', + ], + [ + 'errorCode' => 'InvalidMinComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MinComputeResource is not valid.', + ], + [ + 'errorCode' => 'InvalidMaxComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MaxComputeResource is not valid.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', + 'errorMessage' => 'The state of this resource group does not support this operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A94B6C02-7BD4-5D67-9776-3AC8317E8DD5\\n","errorExample":""}]', + 'title' => '创建资源组', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeDBResourceGroup' => [ + 'summary' => '查询集群的资源组信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136430', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'> 此参数不填写时，默认返回指定集群的所有资源组信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组类型，取值：'."\n" + .'- **Interactive**'."\n" + .'- **Job**'."\n" + .'> 关于湖仓版资源组的详细信息，请参见[资源组介绍](~~428610~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Job', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用 [DescribeRegions](~~612393~~) 接口查看集群的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD3', + ], + 'GroupsInfo' => [ + 'description' => '资源组信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组信息列表。', + 'type' => 'object', + 'properties' => [ + 'GroupType' => [ + 'description' => '资源组类型，取值：'."\n" + .'- **Interactive**'."\n" + .'- **Job**'."\n" + .'> 关于湖仓版资源组的详细信息，请参见[资源组介绍（湖仓版）](~~428610~~)。', + 'type' => 'string', + 'example' => 'Job', + ], + 'GroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'test1', + ], + 'MinComputeResource' => [ + 'description' => '最小计算预留资源，单位为ACU。'."\n", + 'type' => 'string', + 'example' => '0ACU', + ], + 'MaxComputeResource' => [ + 'description' => '最大计算预留资源，单位为ACU。', + 'type' => 'string', + 'example' => '512ACU', + ], + 'ClusterSizeResource' => [ + 'description' => '预留参数，不涉及', + 'type' => 'string', + 'example' => '预留参数，不涉及', + ], + 'MinClusterCount' => [ + 'description' => '预留参数，不涉及', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '预留参数，不涉及', + ], + 'MaxClusterCount' => [ + 'description' => '预留参数，不涉及', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '预留参数，不涉及', + ], + 'RunningClusterCount' => [ + 'description' => '预留参数，不涉及', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '预留参数，不涉及', + ], + 'ClusterMode' => [ + 'description' => '预留参数，不涉及', + 'type' => 'string', + 'example' => '预留参数，不涉及', + ], + 'ElasticMinComputeResource' => [ + 'description' => '最小计算弹性资源，单位为ACU。', + 'type' => 'string', + 'example' => '16ACU', + ], + 'EnableSpot' => [ + 'description' => '资源组是否开启竞价实例功能。开启竞价实例后资源单价降低，但是有概率被释放。取值：'."\n" + .'- **True**：开启竞价实例功能。'."\n" + .'- **False**：关闭竞价实例功能。'."\n" + ."\n" + .'仅Job型资源组可以为True。', + 'type' => 'string', + 'example' => 'True', + ], + 'GroupUsers' => [ + 'description' => '资源组绑定的RAM用户。', + 'type' => 'string', + 'example' => 'testb,testc', + ], + 'CreateTime' => [ + 'description' => '资源组创建时间，UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-08-29T03:34:30Z', + ], + 'UpdateTime' => [ + 'description' => '更新时间，UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-08-31T03:34:30Z', + ], + 'Status' => [ + 'description' => '资源组状态，取值说明：'."\n" + .'- **creating**：创建中'."\n" + .'- **ok**：创建成功'."\n" + .'- **pendingdelete**：等待删除', + 'type' => 'string', + 'example' => 'ok', + ], + 'Rules' => [ + 'description' => '作业投递规则。', + 'type' => 'array', + 'items' => [ + 'description' => '规则信息列表。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'user_default', + ], + 'QueryTime' => [ + 'description' => '查询执行时间阈值，单位为毫秒（ms）。', + 'type' => 'string', + 'example' => '180000', + ], + 'TargetGroupName' => [ + 'description' => '目标资源组名称。', + 'type' => 'string', + 'example' => 'job', + ], + ], + ], + ], + 'Engine' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + 'required' => true, + ], + 'AutoStopInterval' => [ + 'type' => 'string', + ], + 'SpecName' => [ + 'type' => 'string', + ], + 'TargetResourceGroupName' => [ + 'type' => 'string', + ], + 'MinGpuQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaxGpuQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RayConfig' => [ + 'type' => 'object', + 'properties' => [ + 'EnableUserEni' => [ + 'type' => 'boolean', + ], + 'HeadSpecType' => [ + 'type' => 'string', + ], + 'HeadSpec' => [ + 'type' => 'string', + ], + 'HeadAllocateUnit' => [ + 'type' => 'string', + ], + 'HeadDiskCapacity' => [ + 'type' => 'string', + ], + 'Category' => [ + 'type' => 'string', + 'enum' => [ + 'Basic', + 'HighAvailability', + ], + ], + 'WorkerGroups' => [ + 'title' => 'Ray Worker组列表', + 'description' => 'Ray Worker组列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'title' => 'Ray Worker组名', + 'description' => 'Ray Worker组名', + 'type' => 'string', + 'example' => 'g01', + ], + 'AllocateUnit' => [ + 'title' => '分配单元', + 'description' => '分配单元', + 'type' => 'string', + 'example' => '1', + ], + 'MaxWorkerQuantity' => [ + 'title' => '最大Worker个数', + 'description' => '最大Worker个数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MinWorkerQuantity' => [ + 'title' => '最小Worker个数', + 'description' => '最小Worker个数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WorkerDiskCapacity' => [ + 'title' => '每个Worker磁盘大小', + 'description' => '每个Worker磁盘大小', + 'type' => 'string', + 'example' => '100G', + ], + 'WorkerSpecName' => [ + 'title' => 'Worker资源型号', + 'description' => 'Worker资源型号', + 'type' => 'string', + 'example' => 'large', + ], + 'WorkerSpecType' => [ + 'title' => 'Ray Worker资源类型', + 'description' => 'Ray Worker资源类型', + 'type' => 'string', + 'example' => 'CPU', + 'enum' => [ + 'CPU', + 'GPU', + ], + ], + ], + ], + ], + 'RayClusterAddress' => [ + 'title' => 'Ray Cluster地址', + 'description' => 'Ray Cluster地址', + 'type' => 'string', + 'example' => 'http://ray-cluster-address.example.com', + ], + 'RayDashboardAddress' => [ + 'title' => 'Ray Dashboard地址', + 'description' => 'Ray Dashboard地址', + 'type' => 'string', + 'example' => 'http://ray-dashboard-address.example.com', + ], + 'RayGrafanaAddress' => [ + 'title' => 'Ray Grafana地址', + 'description' => 'Ray Grafana地址', + 'type' => 'string', + 'example' => 'http://ray-grafana-address.example.com', + ], + 'AppConfig' => [ + 'title' => 'Ray应用配置', + 'description' => 'Ray应用配置', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'title' => 'Ray应用名', + 'description' => 'Ray应用名', + 'type' => 'string', + 'example' => 'app01', + ], + 'AppType' => [ + 'title' => 'Ray应用类型', + 'description' => 'Ray应用类型', + 'type' => 'string', + 'example' => 'IsaacLab', + ], + 'ImageSelector' => [ + 'title' => '镜像配置', + 'description' => '镜像配置', + 'type' => 'object', + 'properties' => [ + 'Image' => [ + 'title' => '镜像', + 'description' => '镜像', + 'type' => 'string', + 'example' => 'lab2.10.0-ray2.43.0', + ], + 'InferenceEngine' => [ + 'title' => '推理引擎', + 'description' => '推理引擎', + 'type' => 'string', + 'example' => 'vLLM', + ], + 'LlmModel' => [ + 'title' => 'LLM模型', + 'description' => 'LLM模型', + 'type' => 'string', + 'example' => 'Deepseek-R1', + ], + ], + ], + ], + ], + 'StorageMounts' => [ + 'title' => '挂载存储列表', + 'description' => '挂载存储列表', + 'type' => 'array', + 'items' => [ + 'title' => '挂载存储', + 'description' => '挂载存储', + 'type' => 'object', + 'properties' => [ + 'StorageId' => [ + 'title' => '存储ID', + 'description' => '存储ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MountPath' => [ + 'title' => '挂载路径', + 'description' => '挂载路径', + 'type' => 'string', + 'example' => '/mnt/data01', + ], + ], + ], + ], + ], + ], + 'GpuElasticPlan' => [ + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'type' => 'boolean', + ], + 'Rules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartCronExpression' => [ + 'type' => 'string', + ], + 'EndCronExpression' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'EngineParams' => [ + 'title' => '引擎参数', + 'description' => '引擎参数', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '引擎参数', + 'description' => '引擎参数', + 'type' => 'any', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolType.Malformed', + 'errorMessage' => 'The specified parameter PoolType is not valid.', + ], + [ + 'errorCode' => 'InvalidMinComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MinComputeResource is not valid.', + ], + [ + 'errorCode' => 'InvalidMaxComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MaxComputeResource is not valid.', + ], + ], + 408 => [ + [ + 'errorCode' => 'AcsServerTimeOut', + 'errorMessage' => 'The request has failed due to Adb Cloud Service time out.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD3\\",\\n \\"GroupsInfo\\": [\\n {\\n \\"GroupType\\": \\"Job\\",\\n \\"GroupName\\": \\"test1\\",\\n \\"MinComputeResource\\": \\"0ACU\\",\\n \\"MaxComputeResource\\": \\"512ACU\\",\\n \\"ClusterSizeResource\\": \\"预留参数，不涉及\\",\\n \\"MinClusterCount\\": 0,\\n \\"MaxClusterCount\\": 0,\\n \\"RunningClusterCount\\": 0,\\n \\"ClusterMode\\": \\"预留参数，不涉及\\",\\n \\"ElasticMinComputeResource\\": \\"16ACU\\",\\n \\"EnableSpot\\": \\"True\\",\\n \\"GroupUsers\\": \\"testb,testc\\",\\n \\"CreateTime\\": \\"2022-08-29T03:34:30Z\\",\\n \\"UpdateTime\\": \\"2022-08-31T03:34:30Z\\",\\n \\"Status\\": \\"ok\\",\\n \\"Rules\\": [\\n {\\n \\"GroupName\\": \\"user_default\\",\\n \\"QueryTime\\": \\"180000\\",\\n \\"TargetGroupName\\": \\"job\\"\\n }\\n ],\\n \\"Engine\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"AutoStopInterval\\": \\"\\",\\n \\"SpecName\\": \\"\\",\\n \\"TargetResourceGroupName\\": \\"\\",\\n \\"MinGpuQuantity\\": 0,\\n \\"MaxGpuQuantity\\": 0,\\n \\"RayConfig\\": {\\n \\"EnableUserEni\\": true,\\n \\"HeadSpecType\\": \\"\\",\\n \\"HeadSpec\\": \\"\\",\\n \\"HeadAllocateUnit\\": \\"\\",\\n \\"HeadDiskCapacity\\": \\"\\",\\n \\"Category\\": \\"\\",\\n \\"WorkerGroups\\": [\\n {\\n \\"GroupName\\": \\"g01\\",\\n \\"AllocateUnit\\": \\"1\\",\\n \\"MaxWorkerQuantity\\": 1,\\n \\"MinWorkerQuantity\\": 1,\\n \\"WorkerDiskCapacity\\": \\"100G\\",\\n \\"WorkerSpecName\\": \\"large\\",\\n \\"WorkerSpecType\\": \\"CPU\\"\\n }\\n ],\\n \\"RayClusterAddress\\": \\"http://ray-cluster-address.example.com\\",\\n \\"RayDashboardAddress\\": \\"http://ray-dashboard-address.example.com\\",\\n \\"RayGrafanaAddress\\": \\"http://ray-grafana-address.example.com\\",\\n \\"AppConfig\\": {\\n \\"AppName\\": \\"app01\\",\\n \\"AppType\\": \\"IsaacLab\\",\\n \\"ImageSelector\\": {\\n \\"Image\\": \\"lab2.10.0-ray2.43.0\\",\\n \\"InferenceEngine\\": \\"vLLM\\",\\n \\"LlmModel\\": \\"Deepseek-R1\\"\\n }\\n },\\n \\"StorageMounts\\": [\\n {\\n \\"StorageId\\": 1,\\n \\"MountPath\\": \\"/mnt/data01\\"\\n }\\n ]\\n },\\n \\"GpuElasticPlan\\": {\\n \\"Enabled\\": true,\\n \\"Rules\\": [\\n {\\n \\"StartCronExpression\\": \\"\\",\\n \\"EndCronExpression\\": \\"\\"\\n }\\n ]\\n },\\n \\"EngineParams\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n A94B6C02-7BD4-5D67-9776-3AC8317E8DD3\\n \\n Job\\n test1\\n 0ACU\\n 512ACU\\n 预留参数，不涉及\\n 预留参数，不涉及\\n 16ACU\\n True\\n testb,testc\\n 2022-08-29T03:34:30Z\\n 2022-08-31T03:34:30Z\\n ok\\n \\n \\n","errorExample":""}]', + 'title' => '查询资源组', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyDBResourceGroup' => [ + 'summary' => '变更集群的资源组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136445', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'> 您可以调用[DescribeDBResourceGroup](~~459446~~)接口查看指定集群的资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组类型，取值：'."\n" + .'- **Interactive**'."\n" + .'- **Job**'."\n" + .'> 关于湖仓版资源组的详细信息，请参见[资源组介绍](~~428610~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Interactive', + 'enum' => [], + ], + ], + [ + 'name' => 'MinComputeResource', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '最小计算预留资源。'."\n" + .'- 当资源组类型为Interactive时，计算预留资源最小为16ACU。'."\n" + .'- 当资源组类型为Job时，计算预留资源最小为0ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '0ACU', + ], + ], + [ + 'name' => 'MaxComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '最大计算预留资源。'."\n" + .'- 当资源组类型为Interactive时，计算预留资源最大为集群当前未分配资源，步长为16ACU。'."\n" + .'- 当资源组类型为Job时，计算预留资源最大为集群当前未分配资源，步长为8ACU。', + 'type' => 'string', + 'required' => false, + 'example' => '48ACU', + ], + ], + [ + 'name' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数（不涉及）。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数（不涉及）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '无'."\n", + ], + ], + [ + 'name' => 'MaxClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数（不涉及）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数（不涉及）。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'EnableSpot', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组是否开启竞价实例功能。开启竞价实例后资源单价降低，但是有概率被释放。仅Job型资源组可以开启。取值：'."\n" + .'- **True**：开启竞价实例功能。'."\n" + .'- **False**：关闭竞价实例功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定群的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '作业投递规则。', + 'type' => 'array', + 'items' => [ + 'description' => '规则信息列表。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_default', + ], + 'QueryTime' => [ + 'description' => '查询执行时间阈值，单位为毫秒（ms）。', + 'type' => 'string', + 'required' => false, + 'example' => '180000'."\n", + ], + 'TargetGroupName' => [ + 'description' => '目标资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'job'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '引擎配置。', + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + ], + [ + 'name' => 'AutoStopInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '自动停止时间', + 'type' => 'string', + 'required' => false, + 'example' => '5m', + ], + ], + [ + 'name' => 'SpecName', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '预留参数，不涉及。', + ], + ], + [ + 'name' => 'MinGpuQuantity', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '预留参数，不涉及。', + ], + ], + [ + 'name' => 'MaxGpuQuantity', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '预留参数，不涉及。', + ], + ], + [ + 'name' => 'TargetResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，不涉及。', + 'type' => 'string', + 'required' => false, + 'example' => '预留参数，不涉及。', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组状态。**starting** 表示启动资源组，**stopping**表示停止资源组', + 'type' => 'string', + 'required' => false, + 'example' => 'starting', + ], + ], + [ + 'name' => 'RayConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Ray配置信息(当资源组为ai资源组且对应引擎为RayCluster时需要填写)', + 'type' => 'object', + 'properties' => [ + 'EnableUserEni' => [ + 'type' => 'boolean', + 'required' => false, + ], + 'HeadSpecType' => [ + 'description' => 'Head节点资源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'CPU', + 'default' => 'CPU', + 'enum' => [ + 'CPU', + 'GPU', + ], + ], + 'HeadSpec' => [ + 'description' => 'Head节点规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'xlarge', + ], + 'HeadAllocateUnit' => [ + 'description' => 'Head节点分配单元。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'HeadDiskCapacity' => [ + 'description' => 'Head节点磁盘大小。', + 'type' => 'string', + 'required' => false, + 'example' => '100G', + ], + 'Category' => [ + 'description' => 'Ray集群类型，取值说明：'."\n" + ."\n" + .'- BASIC：基础类型，非高可用'."\n" + ."\n" + .'- HIGH_AVAILABILITY：高可用类型', + 'type' => 'string', + 'required' => false, + 'example' => 'BASIC', + 'enum' => [ + 'BASIC', + 'HIGH_AVAILABILITY', + ], + ], + 'WorkerGroups' => [ + 'description' => 'Ray Worker组配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Ray Worker组配置信息。', + 'type' => 'object', + 'properties' => [ + 'AllocateUnit' => [ + 'description' => '分配单元', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'GroupName' => [ + 'description' => 'Worker组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'MaxWorkerQuantity' => [ + 'description' => '最大Worker数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'MinWorkerQuantity' => [ + 'description' => '最小Worker数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'WorkerDiskCapacity' => [ + 'description' => 'Worker节点的磁盘大小。', + 'type' => 'string', + 'required' => false, + 'example' => '100G', + ], + 'WorkerSpecName' => [ + 'description' => 'Worker节点规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'xlarge', + ], + 'WorkerSpecType' => [ + 'description' => 'Worker节点资源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'GPU', + 'enum' => [ + 'CPU', + 'GPU', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'AppConfig' => [ + 'title' => 'Ray应用配置', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'title' => '应用名称', + 'type' => 'string', + 'required' => false, + 'example' => 'app01', + ], + 'AppType' => [ + 'title' => '应用类型', + 'type' => 'string', + 'required' => false, + 'example' => 'IsaacLab', + ], + 'ImageSelector' => [ + 'title' => '镜像配置', + 'type' => 'object', + 'properties' => [ + 'Image' => [ + 'title' => '镜像名', + 'type' => 'string', + 'required' => false, + 'example' => 'lab2.10.0-ray2.43.0', + ], + 'InferenceEngine' => [ + 'title' => '推理引擎', + 'type' => 'string', + 'required' => false, + 'example' => 'vLLM', + ], + 'LlmModel' => [ + 'title' => 'LLM模型', + 'type' => 'string', + 'required' => false, + 'example' => 'Deepseek-R1', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'StorageMounts' => [ + 'title' => '存储挂载列表', + 'type' => 'array', + 'items' => [ + 'title' => '存储挂载', + 'type' => 'object', + 'properties' => [ + 'StorageId' => [ + 'title' => '存储ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'MountPath' => [ + 'title' => '挂载路径', + 'type' => 'string', + 'required' => false, + 'example' => '/mnt/data01', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GpuElasticPlan', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'type' => 'boolean', + 'required' => false, + ], + 'Rules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartCronExpression' => [ + 'type' => 'string', + 'required' => false, + ], + 'EndCronExpression' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '805F14E1-0186-520E-A6D5-30188D94E8DA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolType.Malformed', + 'errorMessage' => 'The specified parameter PoolType is not valid.', + ], + [ + 'errorCode' => 'InvalidMinComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MinComputeResource is not valid.', + ], + [ + 'errorCode' => 'InvalidMaxComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MaxComputeResource is not valid.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.ElasticPlanExists', + 'errorMessage' => 'This resource group does not support this operation. Elastic plans that have been enabled already exist.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', + 'errorMessage' => 'The state of this resource group does not support this operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"805F14E1-0186-520E-A6D5-30188D94E8DA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 805F14E1-0186-520E-A6D5-30188D94E8DA\\n","errorExample":""}]', + 'title' => '修改资源组', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DeleteDBResourceGroup' => [ + 'summary' => '调用CreateDBResourceGroup接口删除指定集群的资源组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136447', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'> 您可以调用[DescribeDBResourceGroup](~~612410~~)接口查看指定集群的资源组信息，包括资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.ElasticPlanExists', + 'errorMessage' => 'This resource group does not support this operation. Elastic plans that have been enabled already exist.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', + 'errorMessage' => 'The state of this resource group does not support this operation.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.OngoingJobExists', + 'errorMessage' => 'Resource group has ongoing job(s).', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A94B6C02-7BD4-5D67-9776-3AC8317E8DD3\\n","errorExample":""}]', + 'title' => '删除资源组', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'BindDBResourceGroupWithUser' => [ + 'summary' => '绑定资源组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test'."\n", + ], + ], + [ + 'name' => 'GroupUser', + 'in' => 'query', + 'schema' => [ + 'description' => '需要绑定的数据库账号。既可以绑定数据库普通账号，也可以绑定数据库高权限账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'accout'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '将资源组与数据库用户进行绑定', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'UnbindDBResourceGroupWithUser' => [ + 'summary' => '为AnalyticDB MySQL集群的资源组解绑数据库账号。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'GroupUser', + 'in' => 'query', + 'schema' => [ + 'description' => '解绑的数据库账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '解绑资源组和用户', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeComputeResourceUsage' => [ + 'summary' => '查询集群资源组计算资源使用情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-02-04T03:45:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-02-05T03:45:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse', + 'description' => 'PlainResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-clusterxxx', + ], + 'ResourceGroupType' => [ + 'description' => '资源组的类型。', + 'type' => 'string', + 'example' => 'interative', + ], + 'ResourceGroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'StartTime' => [ + 'description' => '查询开始时间，格式为：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2023-04-24T07:00:00Z', + ], + 'EndTime' => [ + 'description' => '查询结束时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2023-06-07T02:37:00Z', + ], + 'AcuInfo' => [ + 'description' => '集群ACU资源使用情况。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '对应指标项取值的状态，取值说明：'."\n" + .'- `TotalAcuNumber`：总ACU资源数。'."\n" + .'- `ReservedAcuNumber`：预留资源ACU数。'."\n" + .'- `ReservedAcuUsageNumber`：已使用的预留资源ACU数。', + 'type' => 'string', + 'example' => 'TotalAcuNumber', + ], + 'Values' => [ + 'description' => '对应指标项在各时间点取值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对应指标项在各时间点的具体取值。', + 'type' => 'string', + 'example' => '16.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAW\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"DBClusterId\\": \\"amv-clusterxxx\\",\\n \\"ResourceGroupType\\": \\"interative\\",\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"StartTime\\": \\"2023-04-24T07:00:00Z\\",\\n \\"EndTime\\": \\"2023-06-07T02:37:00Z\\",\\n \\"AcuInfo\\": [\\n {\\n \\"Name\\": \\"TotalAcuNumber\\",\\n \\"Values\\": [\\n \\"16.0\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询资源组计算资源使用情况', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeUserQuota' => [ + 'summary' => '查询可用配额。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1qjt3o18d8****', + 'enum' => [], + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定集群的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0322C7FB-4584-5D2A-BF7F-F9036E940C35', + ], + 'ElasticACU' => [ + 'description' => '可用弹性ACU。', + 'type' => 'string', + 'example' => '512 ACU', + ], + 'ResourceGroupCount' => [ + 'description' => '可用资源组数目。', + 'type' => 'string', + 'example' => '10', + ], + 'ReserverdCompteACU' => [ + 'description' => '可用预留计算资源。', + 'type' => 'string', + 'example' => '48 ACU', + ], + 'ReserverdStorageACU' => [ + 'description' => '可用存储计算资源。', + 'type' => 'string', + 'example' => '24 ACU', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0322C7FB-4584-5D2A-BF7F-F9036E940C35\\",\\n \\"ElasticACU\\": \\"512 ACU\\",\\n \\"ResourceGroupCount\\": \\"10\\",\\n \\"ReserverdCompteACU\\": \\"48 ACU\\",\\n \\"ReserverdStorageACU\\": \\"24 ACU\\"\\n}","type":"json"}]', + 'title' => '查询用户可用配额', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'CreateElasticPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。'."\n" + .'> 弹性计划名称的长度为2～30个字符，以字母开头，且只能由字母、数字和下划线组成。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + ."\n" + .'>- 如果需要创建弹性资源类型为Interactive资源组的弹性计划（即计算资源类型的弹性计划），必须指定资源组名称。如果需要创建弹性资源类型为查询存储加速服务（EIU）的弹性计划，无需指定资源组名称。'."\n" + .'- 调用[DescribeDBResourceGroup](~~459446~~)接口可以查看指定集群的资源组名称。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'> 格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-01T12:01:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'> 格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-01T12:01:00Z', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '创建后是否立即启用弹性计划。'."\n" + .'取值说明：'."\n" + .'- true：立即启用。'."\n" + .'- false：不启用。'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cron表达式，表示弹性计划的变配周期和变配时间。'."\n" + ."\n" + .'>Type参数取值为EXECUTOR时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '0 20 14 * * ?', + ], + ], + [ + 'name' => 'TargetSize', + 'in' => 'query', + 'schema' => [ + 'description' => '目标规格。'."\n" + .'> - 只有弹性资源类型为**存储加速服务弹性计划**并且启用了**存储加速服务(EIU)按比例默认弹性**，可以不填写该参数。其它情况下，该参数为必填项。'."\n" + .'> - 调用[DescribeElasticPlanSpecifications](~~601278~~)接口可以查看弹性计划支持的弹性变配规格。', + 'type' => 'string', + 'required' => false, + 'example' => '32ACU', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划类型。'."\n" + .'取值说明：'."\n" + .'- EXECUTOR：Interactive资源组，即计算资源类型。'."\n" + .'- WORKER：存储加速服务（EIU）。', + 'type' => 'string', + 'required' => true, + 'example' => 'EXECUTOR', + ], + ], + [ + 'name' => 'AutoScale', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用**存储加速服务(EIU)按比例默认弹性**。'."\n" + .'取值说明：'."\n" + .'- true：启用。启用后，存储资源会跟随计算资源的弹性伸缩而伸缩，且不支持填写目标规格和Cron表达式。'."\n" + .'- false：不启用。'."\n" + .'>- Type为WORKER时，本参数必填。Type为EXECUTOR时，本参数不填。'."\n" + .'> - 整个集群只支持启用一个存储加速服务(EIU)按比例默认弹性的存储弹性计划，启用了此类型的弹性计划以后，无法再启用其他的存储弹性计划。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口查看集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse', + 'description' => 'BaseResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidEndTime', + 'errorMessage' => 'The end time should be later than current time.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.WorkerNotFound', + 'errorMessage' => 'Worker not found.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.AutoWorkerPlanExists', + 'errorMessage' => 'Failed to enable the elastic plan. The instance already has an active elastic plan.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.WorkerPlanExists', + 'errorMessage' => 'Failed to enable the elastic plan. At least one active elastic plan already exists.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidStartTimeInterval', + 'errorMessage' => 'The start time of this elastic plan is too closed to another one.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidTodayPlan', + 'errorMessage' => 'Failed to enable this elastic plan. Today\'s schedule time is missed and you should prepare at least %s minutes for us to prepare resource.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidTargetSize', + 'errorMessage' => 'Invalid target size.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidStartTime', + 'errorMessage' => 'Invalid start time.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + 'title' => '创建弹性计划', + 'summary' => '创建集群的弹性计划。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeElasticPlans' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。'."\n" + .'> 不填写弹性计划名称将查询所有弹性计划。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'> - 不填写表示查询所有资源组的弹性计划，包括Interactive资源组类型和存储加速服务（EIU）。'."\n" + .'>- 调用[DescribeDBResourceGroup](~~459446~~)接口可以查看集群的资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '创建后是否启用弹性计划。'."\n" + .'取值说明：'."\n" + .'- **true**：启用。'."\n" + .'- **false**：不启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~612397~~)接口可以查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划类型。 取值说明：'."\n" + ."\n" + .'- **EXECUTOR**：Interactive资源组，即计算资源类型。'."\n" + .'- **WORKER**：存储加速服务（EIU）。', + 'type' => 'string', + 'required' => false, + 'example' => 'EXECUTOR', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginationResponse>', + 'description' => 'PaginationResponse>', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总计划数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ElasticPlans' => [ + 'description' => '弹性计划列表。', + 'type' => 'array', + 'items' => [ + 'description' => '弹性计划。', + 'type' => 'object', + 'properties' => [ + 'ElasticPlanName' => [ + 'description' => '弹性计划名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'description' => '弹性计划类型。'."\n" + .'取值说明：'."\n" + .'- **EXECUTORE**：Interactive资源组类型，即计算资源类型。'."\n" + .'- **WORKER**：存储加速服务（EIU）。', + 'type' => 'string', + 'example' => 'EXECUTOR', + ], + 'Enabled' => [ + 'description' => '创建后是否立即启用弹性计划。'."\n" + .'取值说明：'."\n" + .'- **true**：立即启用。'."\n" + .'- **false**：不启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourceGroupName' => [ + 'description' => '资源组名称。'."\n" + .'> 调用[DescribeDBResourceGroup](~~459446~~)接口可以查看集群的资源组名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TargetSize' => [ + 'description' => '目标规格。', + 'type' => 'string', + 'example' => '32ACU', + ], + 'NextScheduleTime' => [ + 'description' => '下次调度时间。'."\n" + ."\n" + .'> 格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-01-01T12:01:00Z', + ], + 'AutoScale' => [ + 'description' => '是否**开启存储加速服务(EIU)按比例默认弹性**。'."\n" + .'取值说明：'."\n" + .'- **true**：开启。'."\n" + .'- **false**：不开启。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 15,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"ElasticPlans\\": [\\n {\\n \\"ElasticPlanName\\": \\"test\\",\\n \\"Type\\": \\"EXECUTOR\\",\\n \\"Enabled\\": true,\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"TargetSize\\": \\"32ACU\\",\\n \\"NextScheduleTime\\": \\"2022-01-01T12:01:00Z\\",\\n \\"AutoScale\\": false\\n }\\n ],\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 15\\n 1\\n 10\\n \\n test\\n EXECUTOR\\n true\\n test\\n 32ACU\\n 2022-01-01T12:01:00Z\\n false\\n \\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + 'title' => '查询弹性计划列表', + 'summary' => '根据查询条件查询集群的弹性计划。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyElasticPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。'."\n" + .'> 调用[DescribeElasticPlans](~~601334~~)接口可以查看指定集群的弹性计划名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'> 格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-01T12:01:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'> 格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-01T12:01:00Z', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cron表达式，表示弹性计划的变配周期和变配时间。', + 'type' => 'string', + 'required' => false, + 'example' => '0 20 14 * * ?', + ], + ], + [ + 'name' => 'TargetSize', + 'in' => 'query', + 'schema' => [ + 'description' => '目标规格。'."\n" + .'> - 只有弹性资源类型为**存储加速服务弹性计划**并且启用了**存储加速服务(EIU)按比例默认弹性**，可以不填写该参数。其它情况下，该参数为必填项。'."\n" + .'- 调用[DescribeElasticPlanSpecifications](~~601278~~)接口可以查看弹性计划支持的弹性变配规格。', + 'type' => 'string', + 'required' => false, + 'example' => '32ACU', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~129857~~)接口可以查看目标地域下集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse', + 'description' => 'BaseResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + 'title' => '修改弹性计划', + 'summary' => '修改集群的弹性计划。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'EnableElasticPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。'."\n" + .'> 调用[DescribeElasticPlans](~~601334~~)接口可以查看集群的弹性计划名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口可以查看集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse', + 'description' => 'BaseResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.ElasticPlan.AutoWorkerPlanExists', + 'errorMessage' => 'Failed to enable the elastic plan. The instance already has an active elastic plan.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.WorkerPlanExists', + 'errorMessage' => 'Failed to enable the elastic plan. At least one active elastic plan already exists.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidStartTimeInterval', + 'errorMessage' => 'The start time of this elastic plan is too closed to another one.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidEndTime', + 'errorMessage' => 'The end time should be later than current time.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidTodayPlan', + 'errorMessage' => 'Failed to enable this elastic plan. Today\'s schedule time is missed and you should prepare at least %s minutes for us to prepare resource.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidTargetSize', + 'errorMessage' => 'Invalid target size.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidStartTime', + 'errorMessage' => 'Invalid start time.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + 'title' => '启用弹性计划', + 'summary' => '启用集群的弹性计划。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DisableElasticPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。'."\n" + .'> 调用[DescribeElasticPlans](~~601334~~)接口可以查看集群的弹性计划名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口可以查看集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse', + 'description' => 'BaseResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + 'title' => '停用弹性计划', + 'summary' => '停用集群的弹性计划。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DeleteElasticPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。'."\n" + .'> 调用[DescribeElasticPlans](~~601334~~)接口可以查看集群的弹性计划名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~129857~~)接口可以查看目标地域下所有集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse', + 'description' => 'BaseResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + 'title' => '删除弹性计划', + 'summary' => '删除集群的弹性计划。', + 'description' => '- 删除弹性计划前，需先停用该计划。'."\n" + .'- 当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeElasticPlanJobs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。'."\n" + .'> - 不填写弹性计划名称将查询所有弹性计划。'."\n" + .'- 调用[DescribeElasticPlans](~~601334~~)接口查看集群的弹性计划名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'> - 不填写表示查询所有资源组的弹性计划，包括Interactive资源组类型和存储加速服务（EIU）。'."\n" + .'- 调用[DescribeDBResourceGroup](~~459446~~)接口可以查看集群的资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '作业状态。'."\n" + .'取值说明：'."\n" + .'- RUNNING：运行中。'."\n" + .'- SUCCESSFUL：运行成功。'."\n" + .'- FAILED：运行失败。'."\n" + .'> 不填写将查询所有状态的弹性计划。', + 'type' => 'string', + 'required' => false, + 'example' => 'SUCCESSFUL', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。'."\n" + .'格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-01T12:01:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~129857~~)接口可以查看集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginationResponse>', + 'description' => 'PaginationResponse>', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总作业数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Jobs' => [ + 'description' => '作业列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ElasticPlanName' => [ + 'description' => '弹性计划名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'description' => '作业状态。'."\n" + .'取值说明：'."\n" + .'- RUNNING：运行中。'."\n" + .'- SUCCESSFUL：运行成功。'."\n" + .'- FAILED：运行失败。', + 'type' => 'string', + 'example' => 'SUCCESSFUL', + ], + 'Type' => [ + 'description' => '弹性计划作业类型。'."\n" + .'取值说明：'."\n" + .'- EXECUTORE：Interactive资源组类型，即计算资源类型。'."\n" + .'- WORKER：存储加速服务（EIU）。', + 'type' => 'string', + 'example' => 'EXECUTOR', + ], + 'ResourceGroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'StartTime' => [ + 'description' => '作业开始时间。'."\n" + .'> 格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-01-01T11:01:00Z', + ], + 'EndTime' => [ + 'description' => '作业结束时间。'."\n" + ."\n" + .'> 格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-01-01T12:01:00Z', + ], + 'TargetSize' => [ + 'description' => '目标规格。', + 'type' => 'string', + 'example' => '32ACU', + ], + 'TotalAcu' => [ + 'description' => '总资源。'."\n" + .'> - Type取值为EXECUTOR时，本参数表示所属资源组的总计算资源。'."\n" + .'> - Type取值为WORKER时，本参数表示整个集群的总存储资源。', + 'type' => 'string', + 'example' => '32ACU', + ], + 'ReserveAcu' => [ + 'description' => '预留资源。'."\n" + .'> - Type取值为EXECUTOR时，本参数表示当前资源组的预留资源。'."\n" + .'> - Type取值为WORKER时，本参数表示当前集群的总预留存储资源。', + 'type' => 'string', + 'example' => '16ACU', + ], + 'ElasticAcu' => [ + 'description' => '弹性资源。'."\n" + .'> - Type取值为EXECUTOR时，本参数表示当前资源组的弹性资源。'."\n" + .'> - Type取值为WORKER时，本参数表示当前集群的总存储弹性资源。', + 'type' => 'string', + 'example' => '16ACU', + ], + 'InstanceSize' => [ + 'description' => '实例数量。'."\n" + .'> - Type取值为EXECUTOR时，本参数表示当前计算节点数量。'."\n" + .'> - Type取值为WORKER时，本参数表示当前集群的存储副本集数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。 ', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 15,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Jobs\\": [\\n {\\n \\"ElasticPlanName\\": \\"test\\",\\n \\"Status\\": \\"SUCCESSFUL\\",\\n \\"Type\\": \\"EXECUTOR\\",\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"StartTime\\": \\"2022-01-01T11:01:00Z\\",\\n \\"EndTime\\": \\"2022-01-01T12:01:00Z\\",\\n \\"TargetSize\\": \\"32ACU\\",\\n \\"TotalAcu\\": \\"32ACU\\",\\n \\"ReserveAcu\\": \\"16ACU\\",\\n \\"ElasticAcu\\": \\"16ACU\\",\\n \\"InstanceSize\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 15\\n 1\\n 10\\n \\n test\\n SUCCESSFUL\\n EXECUTOR\\n test\\n 2022-01-01T11:01:00Z\\n 2022-01-01T12:01:00Z\\n 32ACU\\n 32ACU\\n 16ACU\\n 16ACU\\n 1\\n \\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + 'title' => '查询弹性计划作业列表', + 'summary' => '查询集群的弹性计划作业。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeElasticPlanAttribute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划名称。'."\n" + .'> 调用[DescribeElasticPlans](~~601334~~)接口查看集群的弹性计划名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口可以查看集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse', + 'description' => 'PlainResponse', + 'type' => 'object', + 'properties' => [ + 'ElasticPlan' => [ + 'description' => '弹性计划。', + 'type' => 'object', + 'properties' => [ + 'ElasticPlanName' => [ + 'description' => '弹性计划名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'description' => '弹性计划类型。', + 'type' => 'string', + 'example' => 'EXECUTOR', + ], + 'Enabled' => [ + 'description' => '是否启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourceGroupName' => [ + 'description' => '所属资源组名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TargetSize' => [ + 'description' => '目标规格。', + 'type' => 'string', + 'example' => '32ACU', + ], + 'StartTime' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'> 格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-01-01T12:01:00Z', + ], + 'EndTime' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'> 格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2025-01-01T12:01:00Z', + ], + 'CronExpression' => [ + 'description' => 'Cron表达式，表示弹性计划的变配周期和变配时间。', + 'type' => 'string', + 'example' => '0 20 14 * * ?', + ], + 'AutoScale' => [ + 'description' => '是否启用**存储加速服务(EIU)按比例默认弹性**。'."\n" + .'取值说明：'."\n" + .'true：启用。启用后，存储资源会跟随计算资源的弹性伸缩而伸缩。'."\n" + .'false：不启用。'."\n" + .'>整个集群只支持启用一个存储加速服务(EIU)按比例默认弹性的存储弹性计划，启用了此类型的弹性计划以后，无法再启用其他的存储弹性计划。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。 ', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.NotFound', + 'errorMessage' => 'The elastic plan is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ElasticPlan\\": {\\n \\"ElasticPlanName\\": \\"test\\",\\n \\"Type\\": \\"EXECUTOR\\",\\n \\"Enabled\\": true,\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"TargetSize\\": \\"32ACU\\",\\n \\"StartTime\\": \\"2022-01-01T12:01:00Z\\",\\n \\"EndTime\\": \\"2025-01-01T12:01:00Z\\",\\n \\"CronExpression\\": \\"0 20 14 * * ?\\",\\n \\"AutoScale\\": false\\n },\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n test\\n EXECUTOR\\n true\\n test\\n 32ACU\\n 2022-01-01T12:01:00Z\\n 2025-01-01T12:01:00Z\\n 0 20 14 * * ?\\n false\\n \\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + 'title' => '查询弹性计划详情', + 'summary' => '查询集群的弹性计划详情。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeElasticPlanSpecifications' => [ + 'summary' => '查询集群的不同类型弹性计划支持的规格列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性计划类型。 取值说明：'."\n" + ."\n" + .'- EXECUTOR：Interactive资源组，即计算资源类型。'."\n" + .'- WORKER：存储加速服务（EIU）。', + 'type' => 'string', + 'required' => true, + 'example' => 'EXECUTOR', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + ."\n" + .'>- 查询Interactive资源组的弹性计划（即计算资源类型的弹性计划）支持的规格时，必须指定资源组名称。查询存储加速服务（EIU）的弹性计划支持的规格时，无需指定资源组名称。'."\n" + .'- 调用[DescribeDBResourceGroup](~~459446~~)接口可以查看指定集群的资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口可以查看集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginationResponse>', + 'description' => 'PaginationResponse>', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总规格数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Specifications' => [ + 'description' => '支持的规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的规格。', + 'type' => 'string', + 'example' => '16ACU', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"Specifications\\": [\\n \\"16ACU\\"\\n ],\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 10\\n 1\\n 5\\n 16ACU\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + 'title' => '查询弹性计划支持的规格列表', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeAuditLogRecords' => [ + 'summary' => '查询集群的SQL审计日志。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132363', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-t4nj8619bz2w3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，UTC时间，格式为：yyyy-MM-ddTHH:mmZ。'."\n" + .'> 仅当SQL审计状态为开启时，才能查询到SQL审计日志，且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计，再次打开时，仅能查询到再次打开后的SQL审计日志。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-08-12T04:17Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，UTC时间，格式为：yyyy-MM-ddTHH:mmZ。'."\n" + .'> - 查询结束时间需晚于查询开始时间。'."\n" + .'> - 查询开始时间与查询结束时间的间隔不能超过24小时。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-08-12T17:08Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '执行目标SQL的数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '可设置一个字符串类型的值，使用该值作为关键词对返回结果进行搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb', + ], + ], + [ + 'name' => 'SqlType', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL类型，取值：'."\n" + .'- **DELETE**'."\n" + .'- **SELECT**'."\n" + .'- **UPDATE**'."\n" + .'- **INSERT INTO SELECT**'."\n" + .'- **ALTER**'."\n" + .'- **DROP**'."\n" + .'- **CREATE**'."\n" + ."\n" + .'> 每次仅允许传入一种类型查询，若该参数为空，默认查询所有类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'Succeed', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL是否执行成功，取值说明：'."\n" + .'* **true**：执行成功。'."\n" + .'* **false**：执行失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'HostAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '执行目标SQL的客户端IP地址和端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '100.104.XX.XX:43908', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '按SQL执行时间进行正序或倒序排序，取值说明：'."\n" + .'* **asc**：正序。'."\n" + .'* **desc**：倒序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '执行目标SQL的用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定字段进行排序，格式为JSON，是一个有序JSON数组，按输入数组的顺序进行复合排序，包含`Field`和`Type`两个字段，例如`[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]`。其中：'."\n" + .'* `Field`表示需要排序的字段名，支持如下取值：'."\n" + .' * **HostAddress**：连接数据库的客户端地址。'."\n" + .' * **UserName**：用户名。'."\n" + .' * **ExecutionStartTime**：目标SQL的执行开始时间。'."\n" + .' * **QueryTime**：目标SQL执行时长。'."\n" + .' * **PeakMemoryUsage**：执行目标SQL语句时的峰值内存。'."\n" + .' * **ScanRows**：带数据源的任务的扫描数据行数。'."\n" + .' * **ScanSize**：扫描的数据量。'."\n" + .' * **ScanTime**：扫描数据总耗时。'."\n" + .' * **PlanningTime**：执行计划生成耗时。'."\n" + .' * **WallTime**：查询中的所有算子在各个节点CPU Time的累加值。'."\n" + .' * **ProcessID**：进程ID。'."\n" + ."\n" + .'* `Type`表示排序类型，支持如下取值：'."\n" + .' * **Desc**：降序。'."\n" + .' * **Asc**：升序。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **10**（默认值）'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProxyUser', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '6974', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8A564B7F-8C00-43C0-8EC5-919FBB70573', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-t4nj8619bz2w3****', + ], + 'Items' => [ + 'description' => '列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL记录列表。', + 'type' => 'object', + 'properties' => [ + 'HostAddress' => [ + 'description' => '执行目标SQL的客户端IP地址和端口号。', + 'type' => 'string', + 'example' => '100.104.XX.XX:43908', + ], + 'Succeed' => [ + 'description' => '目标SQL是否执行成功。取值说明：'."\n" + .'- **true**：执行成功。'."\n" + .'- **false**：执行失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'SQLText' => [ + 'description' => 'SQL语句详情。', + 'type' => 'string', + 'example' => 'SELECT * FROM adb_hdfs_import_source', + ], + 'TotalTime' => [ + 'description' => '目标SQL的执行时长，单位：毫秒（ms）。', + 'type' => 'string', + 'example' => '216', + ], + 'ConnId' => [ + 'description' => '通信ID。', + 'type' => 'string', + 'example' => '14356****', + ], + 'DBName' => [ + 'description' => '执行目标SQL的数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'SQLType' => [ + 'description' => '目标SQL的类型。', + 'type' => 'string', + 'example' => 'SELECT', + ], + 'ExecuteTime' => [ + 'description' => '目标SQL的执行开始时间，本地时间，格式为：yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2022-08-12 10:10:00', + ], + 'ExecuteTimestamp' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ProcessID' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '202106081752021720161662490345362390', + ], + 'User' => [ + 'description' => '执行目标SQL的用户名。', + 'type' => 'string', + 'example' => 'test', + ], + 'HasDiagnosticInfo' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"6974\\",\\n \\"PageSize\\": \\"10\\",\\n \\"RequestId\\": \\"8A564B7F-8C00-43C0-8EC5-919FBB70573\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"amv-t4nj8619bz2w3****\\",\\n \\"Items\\": [\\n {\\n \\"HostAddress\\": \\"100.104.XX.XX:43908\\",\\n \\"Succeed\\": \\"true\\",\\n \\"SQLText\\": \\"SELECT * FROM adb_hdfs_import_source\\",\\n \\"TotalTime\\": \\"216\\",\\n \\"ConnId\\": \\"14356****\\",\\n \\"DBName\\": \\"adb_demo\\",\\n \\"SQLType\\": \\"SELECT\\",\\n \\"ExecuteTime\\": \\"2022-08-12 10:10:00\\",\\n \\"ExecuteTimestamp\\": 0,\\n \\"ProcessID\\": \\"202106081752021720161662490345362390\\",\\n \\"User\\": \\"test\\",\\n \\"HasDiagnosticInfo\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 6974\\n 10\\n 8A564B7F-8C00-43C0-8EC5-919FBB70573\\n 1\\n amv-t4nj8619bz2w3****\\n \\n 100.104.XX.XX:43908\\n true\\n SELECT * FROM adb_hdfs_import_source\\n 216\\n 14356****\\n adb_demo\\n SELECT\\n 2022-08-12 10:10:00\\n 202106081752021720161662490345362390\\n test\\n \\n","errorExample":""}]', + 'title' => '查询SQL审计日志', + 'description' => '- 仅当SQL审计状态为开启时，才能查询到SQL审计日志，且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计，再次打开时，仅能查询到再次打开后的SQL审计日志。SQL审计日志不记录**INSERT INTO VALUES**、**REPLACE INTO VALUES**和**UPSERT INTO VALUES**操作。'."\n" + .'- 当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyAuditLogConfig' => [ + 'summary' => '修改集群的SQL审计日志设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132366', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-t4nj8619bz2w3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AuditLogStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '修改SQL审计日志的状态。取值说明：'."\n" + .'- **on**：开启SQL审计。'."\n" + .'- **off**：关闭SQL审计。'."\n" + ."\n" + .'> SQL审计功能关闭后，SQL审计日志会被清空。请先查询和导出SQL审计日志，再关闭SQL审计功能。具体操作，请参见[DescribeAuditLogRecords](~~612426~~)。当再次打开审计日志，审计日志将从最近一次打开审计日志的时间开始展示。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'on', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => '计算引擎类型。取值说明：'."\n" + ."\n" + .'- XIHE（**默认值**）：羲和计算引擎。'."\n" + .'- SPARK：Spark计算引擎。', + 'type' => 'string', + 'required' => false, + 'example' => 'XIHE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CDC59E56-BD07-56CA-A05F-B7907DE5C862', + ], + 'UpdateSucceed' => [ + 'description' => '是否已更新SQL审计的开启状态。取值说明：'."\n" + .'- **true**：状态已更新。'."\n" + .'- **false**：状态更新失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CDC59E56-BD07-56CA-A05F-B7907DE5C862\\",\\n \\"UpdateSucceed\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n CDC59E56-BD07-56CA-A05F-B7907DE5C862\\n true\\n","errorExample":""}]', + 'title' => '修改SQL审计日志设置', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeSparkAuditLogRecords' => [ + 'summary' => '查询Spark Interactive资源组的SQL审计日志。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235459', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> - 您可以调用[DescribeDBClusters](~~454250~~)接口可以查询集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1j7******78j8i', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~612293~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'> 建议查询开始时间设置为30天内的任意时间点。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2025-09-25T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需要大于查询开始时间，且与查询开始时间间隔小于1天。'."\n" + .'格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2025-09-25T01:00Z', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL执行用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定字段对SQL语句进行排序，格式为JSON，是一个有序JSON数组，按输入数组的顺序进行复合排序，包含`Field`和`Type`两个字段，例如`[{"Field":"TotalTime", "Type": "desc" }]`。其中：'."\n" + ."\n" + .'- `Field`表示需要排序的字段名，支持如下字段：'."\n" + .' - `ResourceGroupName`：资源组名称。'."\n" + .' - `Status`：SQL执行状态。'."\n" + .' - `User`：SQL执行用户名。'."\n" + .' - `ExecuteTime`：SQL执行开始时间。'."\n" + .' - `TotalTime`：SQL执行时长。'."\n" + .' - `ProcessId`：查询ID。'."\n" + .' - `ClientIp`：访问源地址。'."\n" + .' - `StatementSource`：查询发起来源。'."\n" + ."\n" + .'- `Type`表示排序类型，支持如下取值（取值均不区分大小写）：'."\n" + .' - `Desc`：降序。'."\n" + .' - `Asc`：升序。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"Field\\":\\"ExecuteTime\\",\\"Type\\":\\"Desc\\"}]', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProxyUser', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'> 您可以调用[DescribeDBResourceGroup](~~612410~~)接口查看集群的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_job', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL执行状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cancel' => '已取消。', + 'finish' => '执行成功。', + 'error' => '执行失败。', + 'timeout' => '执行超时。', + ], + 'example' => 'finish', + ], + ], + [ + 'name' => 'StatementId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Statement ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'fbd22066-1c03-xxxx-aa16-6ae28288****', + ], + ], + [ + 'name' => 'TotalTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL执行时长，单位：毫秒（ms）。', + 'type' => 'string', + 'required' => false, + 'example' => '3000', + ], + ], + [ + 'name' => 'SQLText', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句中的关键词。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_table_name', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '查询ID。', + 'type' => 'string', + 'required' => false, + 'example' => '999f2439-6b10-xxxx-a5d3-daf3b35c****', + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'StatementSource', + 'in' => 'query', + 'schema' => [ + 'description' => '查询发起来源。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SQL_EDITOR' => 'SQL_EDITOR', + 'JDBC' => 'JDBC', + ], + 'example' => 'SQL_EDITOR', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D5867CF-423F-559F-BBB1-199A289E****', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1j7******78j8i', + ], + 'Items' => [ + 'description' => 'SQL记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'SQLText' => [ + 'description' => 'SQL语句详情。', + 'type' => 'string', + 'example' => 'SELECT * FROM adb_hdfs_import_source', + ], + 'TotalTime' => [ + 'description' => 'SQL执行时长，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40000', + ], + 'ExecuteTime' => [ + 'description' => 'SQL执行开始时间，UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-01-23T16:05:08Z', + ], + 'User' => [ + 'description' => 'SQL执行用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'StatementId' => [ + 'description' => 'Statement ID。', + 'type' => 'string', + 'example' => 'fbd22066-1c03-xxxx-aa16-6ae28288****', + ], + 'Status' => [ + 'description' => 'SQL执行状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'cancel' => '已取消。', + 'finish' => '执行成功。', + 'error' => '执行失败。', + 'timeout' => '执行超时。', + ], + 'example' => 'finish', + ], + 'ResourceGroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'test_job', + ], + 'AppId' => [ + 'description' => 'Spark应用ID。', + 'type' => 'string', + 'example' => 's202411061011hzc5d6476000****', + ], + 'InnerQueryId' => [ + 'description' => 'Spark 应用内部 query 执行 ID。', + 'type' => 'string', + 'example' => '1', + ], + 'IsDiagnosable' => [ + 'description' => '是否可诊断。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ClientIp' => [ + 'description' => '访问源地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'ProcessId' => [ + 'description' => '查询ID。', + 'type' => 'string', + 'example' => '999f2439-6b10-xxxx-a5d3-daf3b35c****', + ], + 'StatementSource' => [ + 'description' => '查询发起来源。', + 'type' => 'string', + 'enumValueTitles' => [ + 'SQL_EDITOR' => 'SQL_EDITOR', + 'JDBC' => 'JDBC', + ], + 'example' => 'SQL_EDITOR', + ], + 'ErrorMsg' => [ + 'description' => 'SQL执行错误信息。', + 'type' => 'string', + 'example' => 'notFoundIp', + ], + 'ErrorTrace' => [ + 'description' => 'SQL执行错误堆栈。', + 'type' => 'string', + 'example' => 'notFoundIpException', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有Ram校验失败才会返回此字段', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"100\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"2D5867CF-423F-559F-BBB1-199A289E****\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"amv-bp1j7******78j8i\\",\\n \\"Items\\": [\\n {\\n \\"SQLText\\": \\"SELECT * FROM adb_hdfs_import_source\\",\\n \\"TotalTime\\": 40000,\\n \\"ExecuteTime\\": \\"2022-01-23T16:05:08Z\\",\\n \\"User\\": \\"test_user\\",\\n \\"StatementId\\": \\"fbd22066-1c03-xxxx-aa16-6ae28288****\\",\\n \\"Status\\": \\"finish\\",\\n \\"ResourceGroupName\\": \\"test_job\\",\\n \\"AppId\\": \\"s202411061011hzc5d6476000****\\",\\n \\"InnerQueryId\\": \\"1\\",\\n \\"IsDiagnosable\\": true,\\n \\"ClientIp\\": \\"192.168.XX.XX\\",\\n \\"ProcessId\\": \\"999f2439-6b10-xxxx-a5d3-daf3b35c****\\",\\n \\"StatementSource\\": \\"SQL_EDITOR\\",\\n \\"ErrorMsg\\": \\"notFoundIp\\",\\n \\"ErrorTrace\\": \\"notFoundIpException\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '查询Spark Interactive资源组的SQL审计日志。', + 'description' => '仅当SQL审计状态为开启时，才能查询到SQL审计日志，且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计，再次打开时，仅能查询到再次打开后的SQL审计日志。'."\n" + ."\n" + .'>本接口只能查询到，通过**Spark Interactive型资源组**执行的SQL审计日志。>', + ], + 'DescribeClusterNetInfo' => [ + 'summary' => '调用DescribeDBClusterNetInfo接口查询指定集群的网络信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '133667', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-wz9dqvn0o7****', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB for MySQL引擎。'."\n" + .'- **Clickhouse**：宽表引擎。', + 'type' => 'string', + 'required' => false, + 'example' => 'Clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterNetworkType' => [ + 'description' => '集群网络类型，当前仅支持专有网络，取值固定为**VPC**。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '69A29B65-CD0C-52B1-BE42-8B454569747F', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Address' => [ + 'description' => '详情。', + 'type' => 'array', + 'items' => [ + 'description' => '集群列表。', + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '交换机ID。'."\n" + .'> 当NetType取值为Public时，交换机ID返回为空。', + 'type' => 'string', + 'example' => 'vsw-bp1syh8vvw8yec****', + ], + 'ConnectionString' => [ + 'description' => '集群的网络连接地址。'."\n" + .'- 当网络类型为VPC时，ConnectionString为VPC地址。'."\n" + .'- 当网络类型为Public时，ConnectionString为公网地址。', + 'type' => 'string', + 'example' => 'amv-wz9dqvn0o7****.ads.aliyuncs.com', + ], + 'NetType' => [ + 'description' => '网络类型。取值说明：'."\n" + .'- **Public**：公网。'."\n" + .'- **VPC**：VPC网络。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => '端口号。固定为**3306**。', + 'type' => 'string', + 'example' => '3306', + ], + 'VPCId' => [ + 'description' => 'VPC ID。'."\n" + .'> 当NetType取值为Public时，VPC ID返回为空。', + 'type' => 'string', + 'example' => 'vpc-8vbhucmd5b****', + ], + 'IPAddress' => [ + 'description' => 'IP地址。'."\n" + .'- 当网络类型为VPC时，IPAddress为私网IP地址。'."\n" + .'- 当网络类型为Public时，IPAddress为连接数据库的客户端IP地址。', + 'type' => 'string', + 'example' => '192.168.xx.xx', + ], + 'ConnectionStringPrefix' => [ + 'description' => '网络地址的前缀。'."\n" + .'- 当网络类型为VPC时，ConnectionStringPrefix为VPC地址的前辍。'."\n" + .'- 当网络类型为Public时，ConnectionStringPrefix为数据库公网连接地址的前缀。', + 'type' => 'string', + 'example' => 'amv-wz9dqvn0o7****', + ], + 'Ports' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ports' => [ + 'description' => '端口列表。', + 'type' => 'array', + 'items' => [ + 'description' => '端口详情', + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => '对外服务端口。', + 'type' => 'string', + 'example' => '3306', + ], + 'Protocol' => [ + 'description' => '协议类型。取值：'."\n" + ."\n" + .' - **tcp**：传输控制协议。'."\n" + .' - **http**：超文本传输协议。'."\n" + .' - **https**：超文本传输安全协议。'."\n" + .'- **mysql**：MySQL协议。', + 'type' => 'string', + 'example' => 'mysql', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClusterNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"69A29B65-CD0C-52B1-BE42-8B454569747F\\",\\n \\"Items\\": {\\n \\"Address\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-bp1syh8vvw8yec****\\",\\n \\"ConnectionString\\": \\"amv-wz9dqvn0o7****.ads.aliyuncs.com\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-8vbhucmd5b****\\",\\n \\"IPAddress\\": \\"192.168.xx.xx\\",\\n \\"ConnectionStringPrefix\\": \\"amv-wz9dqvn0o7****\\",\\n \\"Ports\\": {\\n \\"ports\\": [\\n {\\n \\"Port\\": \\"3306\\",\\n \\"Protocol\\": \\"mysql\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n VPC\\n 69A29B65-CD0C-52B1-BE42-8B454569747F\\n \\n vsw-bp1syh8vvw8yec****\\n amv-wz9dqvn0o7****.ads.aliyuncs.com\\n VPC\\n 3306\\n vpc-8vbhucmd5b****\\n 192.168.xx.xx\\n amv-wz9dqvn0o7****\\n \\n","errorExample":""}]', + 'title' => '查询网络信息', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'AllocateClusterPublicConnection' => [ + 'summary' => '为集群申请公网连接地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131191', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1z5d2q71is2****', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '定义公网连接地址的前缀。'."\n" + .'- 以小写字母开头，可包含小写字母、数字和中划线（-）；'."\n" + .'- 长度不超过30个字符。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test12', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB for MySQL引擎。'."\n" + .'- **Clickhouse**：宽表引擎。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AnalyticDB' => 'AnalyticDB', + 'Clickhouse' => 'Clickhouse', + ], + 'example' => 'Clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '868EF07F-D0B2-5043-B092-0C14CD00B65A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidConnectionStringPrefix.Malformed', + 'errorMessage' => 'The specified connection string is invalid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"868EF07F-D0B2-5043-B092-0C14CD00B65A\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 868EF07F-D0B2-5043-B092-0C14CD00B65A\\n","errorExample":""}]', + 'title' => '申请公网地址', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ReleaseClusterPublicConnection' => [ + 'summary' => '释放指定集群的公网连接地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131192', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB for MySQL引擎。'."\n" + .'- **Clickhouse**：宽表引擎。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AnalyticDB' => 'AnalyticDB', + 'Clickhouse' => 'Clickhouse', + ], + 'example' => 'Clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A94B6C02-7BD4-5D67-9776-3AC8317E8DD5\\n","errorExample":""}]', + 'title' => '释放公网地址', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'AttachUserENI' => [ + 'summary' => '为集群创建VPC弹性网卡。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsPOF80W', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '打通用户ENI', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DetachUserENI' => [ + 'summary' => '解绑用户弹性网卡', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsPOF80W', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '关闭用户ENI', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyUserEniVswitchOptions' => [ + 'summary' => '修改ENI交换机。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads3N2V5J', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定集群的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'VSwitchOptions', + 'in' => 'formData', + 'schema' => [ + 'description' => '可选交换机列表。 交换机需要与ENI所属同一个VPC和可用区内，最多可填3个交换机，交换机之间用英文逗号（,）分隔。'."\n" + .'> * 所填写的交换机列表将覆盖已有ENI交换机列表。'."\n" + .'> * 您可以调用[DescribeDBClusterAttribute](~~612399~~)接口查看指定集群的ENI网络信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改用户ENI交换机列表', + ], + 'ModifyDBClusterVip' => [ + 'summary' => '修改集群访问的VIP。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212368', + 'abilityTreeNodes' => [ + 'FEATUREads3N2V5J', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下AnalyticDB MySQL湖仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2ze8mbuai97*****', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络VPC ID。'."\n" + ."\n" + .'> - **VPC**所在地域与集群属于同一地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-bp1at5ze0t5u3xtqn****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。'."\n" + .'> - 传入的新虚拟交换机必须与集群属于同一个可用区。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-bp1aadw9k19x6cis9****', + ], + ], + [ + 'name' => 'ConnectString', + 'in' => 'query', + 'schema' => [ + 'description' => '连接串地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-2ze8mbuai974s4y2500000169.ads.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-****-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Cluster.InvalidState', + 'errorMessage' => 'The state of the cluster does not support this operation.', + ], + [ + 'errorCode' => 'InvalidConnectionString.Malformed', + 'errorMessage' => 'The specified parameter "ConnectionString" is not valid.', + ], + [ + 'errorCode' => 'InvalidConnectionString.UnSupported', + 'errorMessage' => 'The specified parameter "ConnectionString" Only support vpc address.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'ACS.UnsupportedAvailableZone', + 'errorMessage' => 'The specified available zone is not supported.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ACS.ServerError', + 'errorMessage' => 'ADB Cloud Service failed to process your request.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-****-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '修改集群访问VIP', + ], + 'ModifyDBClusterSSL' => [ + 'summary' => '修改集群的SSL链路配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216076', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-************', + ], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启SSL链路加密功能，取值：'."\n" + ."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '需要创建或更新服务器证书的内网或外网连接地址。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'amv-***********.ads.aliyuncs.com', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '修改ADB实例的SSL配置', + ], + 'DescribeDBClusterSSL' => [ + 'summary' => '查询集群的SSL配置情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220651', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~612393~~)接口查看集群所属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '348303D8-6F42-5141-9B00-A6EECA1E37B6', + ], + 'ExpireTime' => [ + 'description' => 'SSL 证书有效期。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2022-10-11T08:16:43Z', + ], + 'ConnectionString' => [ + 'description' => '受SSL保护的连接地址。', + 'type' => 'string', + 'example' => 'amv-*********.ads.aliyuncs.com', + ], + 'SSLEnabled' => [ + 'description' => '是否开启SSL。'."\n" + .'取值： '."\n" + .'- true：开启。'."\n" + .'- false：关闭。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"348303D8-6F42-5141-9B00-A6EECA1E37B6\\",\\n \\"ExpireTime\\": \\"2022-10-11T08:16:43Z\\",\\n \\"ConnectionString\\": \\"amv-*********.ads.aliyuncs.com\\",\\n \\"SSLEnabled\\": true\\n}","type":"json"}]', + 'title' => '查询ADB实例的SSL配置', + 'description' => '>目前该功能处于内测阶段，控制台界面展示及API调用接口尚未稳定，可能持续变化。>', + ], + 'DownloadInstanceCACertificate' => [ + 'summary' => '获取CA证书下载OSS路径，用于连接宽表引擎。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208235', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9842849v6****', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB for MySQL引擎。'."\n" + .'- **Clickhouse**：宽表引擎。', + 'type' => 'string', + 'required' => false, + 'example' => 'Clickhouse', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF', + ], + 'DownloadUrl' => [ + 'description' => '证书下载路径。', + 'type' => 'string', + 'example' => 'https://***/ca.crt', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"DownloadUrl\\": \\"https://***/ca.crt\\"\\n}","type":"json"}]', + 'title' => '获取证书下载地址', + ], + 'DescribeAccounts' => [ + 'summary' => '查询集群的数据库账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131026', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + .'> 此参数不填写时，默认返回所有数据库账号信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB MySQL引擎'."\n" + .'- **Clickhouse**：宽表引擎', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '数据库账号列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF', + ], + 'AccountList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBAccount' => [ + 'description' => '数据库账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详细信息。', + 'type' => 'object', + 'properties' => [ + 'AccountName' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'example' => 'test_accout', + ], + 'AccountStatus' => [ + 'description' => '账号状态。取值说明：'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Available**：可用。'."\n" + .'- **Deleting**：删除中。', + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountDescription' => [ + 'description' => '账号描述。', + 'type' => 'string', + 'example' => '测试数据库账号', + ], + 'RamUsers' => [ + 'description' => 'RAM用户的账号ID。', + 'type' => 'string', + 'example' => '1958134230****', + ], + 'AccountType' => [ + 'description' => '账号类型，取值说明：'."\n" + .'- **Normal**：普通账号。'."\n" + .'- **Super**：高权限账号。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Engine' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**：AnalyticDB MySQL引擎。'."\n" + .'- **Clickhouse**：宽表引擎。', + 'type' => 'string', + 'example' => 'Clickhouse', + ], + 'RamUserList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RamUserList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.Sql.CannotConnect', + 'errorMessage' => 'Cannot connect instance which type is %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"AccountList\\": {\\n \\"DBAccount\\": [\\n {\\n \\"AccountName\\": \\"test_accout\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountDescription\\": \\"测试数据库账号\\",\\n \\"RamUsers\\": \\"1958134230****\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"Engine\\": \\"Clickhouse\\",\\n \\"RamUserList\\": {\\n \\"RamUserList\\": [\\n \\"\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\n \\n test_accout\\n Available\\n 测试数据库账号\\n 1958134230****\\n Normal\\n \\n","errorExample":""}]', + 'title' => '查询数据库账号', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'CreateAccount' => [ + 'summary' => '为集群创建数据库账号。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130688', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名称，需符合如下要求：'."\n" + .'- 以小写字母开头，以小写字母或数字结尾。'."\n" + .'- 由小写字母、数字或下划线（_）组成。'."\n" + .'- 长度为2~16个字符。'."\n" + .'- 不能使用预留的用户名，如root、admin和opsadmin。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号密码。'."\n" + .'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- 特殊符号包含：`!@#$%^&*()_+-=`'."\n" + .'- 密码长度为8~32个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'Test_accout1', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '账号描述。'."\n" + .'- 不能以`http://`或者`https://`开头。'."\n" + .'- 长度不超过256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '数据库连接测试账号', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '账号类型。取值说明：'."\n" + .'- **Normal**：普通账号。'."\n" + .'- **Super**：高权限账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'Normal', + 'enum' => [ + 'Super', + 'Normal', + ], + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB MySQL引擎。'."\n" + .'- **Clickhouse**：宽表引擎。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Clickhouse', + ], + ], + [ + 'name' => 'RamUserList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter AccountPassword is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'The specified parameter AccountDescription is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountType.Malformed', + 'errorMessage' => 'The specified parameter AccountType is not valid.', + ], + [ + 'errorCode' => 'ACS.Sql.CannotConnect', + 'errorMessage' => 'Cannot connect instance which type is %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n","errorExample":""}]', + 'title' => '创建数据库账号', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DeleteAccount' => [ + 'summary' => '删除集群的数据库账号。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130690', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名称。'."\n" + .'> 您可以调用[DescribeAccounts](~~612430~~)接口查看指定集群的数据库账号信息，包括账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB MySQL引擎。'."\n" + .'- **Clickhouse**：宽表引擎。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n","errorExample":""}]', + 'title' => '删除数据库账号', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyAccountDescription' => [ + 'summary' => '修改目标集群的数据库账号的备注信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130693', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + .'> 您可以调用[DescribeAccounts](~~612430~~)接口查看指定集群的数据库账号信息，包括数据库账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '账号描述。'."\n" + .'- 不能以`http://`、`https:// `开头。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'AccDesc', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB MySQL引擎。'."\n" + .'- **Clickhouse**：宽表引擎。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'The specified parameter AccountDescription is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '修改数据库账号的备注信息', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ResetAccountPassword' => [ + 'summary' => '重置指定集群的数据库账号密码。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130691', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + .'> 您可以调用[DescribeAccounts](~~612430~~)接口查看指定集群的数据库账号信息，包括数据库账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号密码。'."\n" + .'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- 特殊符号包含：`!@#$%^&*()_+-=`'."\n" + .'- 密码长度为8~32个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'Test_accout1', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '账号描述。'."\n" + .'- 不能以`http://`和`https://` 开头。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'AccDesc', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：'."\n" + ."\n" + .'- **AnalyticDB**（默认）：AnalyticDB MySQL引擎。'."\n" + .'- **Clickhouse**：宽表引擎。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter AccountPassword is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.Sql.CannotConnect', + 'errorMessage' => 'Cannot connect instance which type is %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + 'title' => '重置数据库账号的密码', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'CheckBindRamUser' => [ + 'summary' => '检查当前调用接口的RAM用户，是否已绑定集群数据库账号。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查询集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-wz9842849v6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应模式。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FB9DCA3-DA56-5B43-A9A0-68E3D0E6AA84', + ], + 'Result' => [ + 'description' => '任务返回结果。取值说明：'."\n" + .'- **true**：当前RAM用户已绑定数据库账号。'."\n" + .'- **false**：当前RAM用户未绑定数据库账号。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FB9DCA3-DA56-5B43-A9A0-68E3D0E6AA84\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 2FB9DCA3-DA56-5B43-A9A0-68E3D0E6AA84\\n true\\n","errorExample":""}]', + 'title' => '查询当前RAM用户是否绑定数据库账号', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'BindAccount' => [ + 'summary' => '绑定RAM用户与集群的数据库普通账号。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz99d9nh532****', + ], + ], + [ + 'name' => 'RamUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'RAM用户的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1444832459****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库普通账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'RamUserList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DFF27323-3868-5F8A-917D-5D1D06B6BC0D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.Account.NotExist', + 'errorMessage' => 'The account is not found.', + ], + [ + 'errorCode' => 'ACS.Account.UserHasBind', + 'errorMessage' => 'The user has been associated with another database account %s.', + ], + [ + 'errorCode' => 'ACS.User.DatabaseAccountHasBind', + 'errorMessage' => 'The database account has been bound to %s.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DFF27323-3868-5F8A-917D-5D1D06B6BC0D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DFF27323-3868-5F8A-917D-5D1D06B6BC0D\\n","errorExample":""}]', + 'title' => '绑定RAM用户与数据库账号', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'UnbindAccount' => [ + 'summary' => '解绑RAM用户与集群的数据库普通账号。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz99d9nh5****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + .'> 您可以调用[DescribeAccounts](~~612430~~)接口查看指定集群的数据库账号信息，包括数据库账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_accout', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '93E85E5C-C805-5837-8713-05B69A504EE5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93E85E5C-C805-5837-8713-05B69A504EE5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 93E85E5C-C805-5837-8713-05B69A504EE5\\n","errorExample":""}]', + 'title' => '解绑RAM用户与数据库账号', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyAccountPrivileges' => [ + 'summary' => '修改某一数据库账户的权限。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '159109', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1k5p066e1a****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'account1', + ], + ], + [ + 'name' => 'AccountPrivileges', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '授予的权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限详情。', + 'type' => 'object', + 'properties' => [ + 'PrivilegeObject' => [ + 'description' => '权限对象，为库表列的三元组。', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => '授权的数据库，当为库、表和列权限级别时此参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'tsdb1', + ], + 'Table' => [ + 'description' => '授权的表，当为表和列权限级别时此参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'table1', + ], + 'Column' => [ + 'description' => '授权的列，当为列权限级别时此参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'column1', + ], + ], + 'required' => false, + ], + 'Privileges' => [ + 'description' => '授予的权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限，来自接口`DescribeEnabledPrivileges`。', + 'type' => 'string', + 'required' => false, + 'example' => 'select', + ], + 'required' => false, + ], + 'PrivilegeType' => [ + 'description' => '权限级别，来自接口`DescribeEnabledPrivileges`。', + 'type' => 'string', + 'required' => false, + 'example' => 'Global', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '9DD88DE7-824F-1082-AA57-575AFC6517A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Privilege.ModifyFailed', + 'errorMessage' => 'Failed to modify the account privilege. Make sure that bound account have sufficient database privileges.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.Parameter.Malformed', + 'errorMessage' => 'The following required parameters are not specified: %s', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.User.NotBindDatabaseAccount', + 'errorMessage' => 'The user has not been associated with a database account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DD88DE7-824F-1082-AA57-575AFC6517A8\\"\\n}","type":"json"}]', + 'title' => ' 修改数据库账户的权限', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeAccountPrivileges' => [ + 'summary' => '获取给定数据库账号在某个级别拥有的权限。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '159083', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1k5p066e1a****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查看权限的数据库账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'account1', + ], + ], + [ + 'name' => 'PrivilegeType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查看的权限级别，来自接口`DescribeEnabledPrivileges`。', + 'type' => 'string', + 'required' => false, + 'example' => 'Global', + 'default' => 'Database', + ], + ], + [ + 'name' => 'DatabasePrivilegeObject', + 'in' => 'query', + 'schema' => [ + 'description' => '根据数据库名称进行筛选。只有当权限级别为库、表、列时才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'db1', + ], + ], + [ + 'name' => 'TablePrivilegeObject', + 'in' => 'query', + 'schema' => [ + 'description' => '根据表名称进行筛选。可以和库名称一起进行联合筛选，只有当权限级别是表和列时该参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'table1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页号，从1开始，默认值1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页含有的条目数量，默认每页20条。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ColumnPrivilegeObject', + 'in' => 'query', + 'schema' => [ + 'description' => '根据列名称进行筛选，只有当权限级别是列时该参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'col1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DA32480A-E3E5-1BE7-BA98-724551DC04C8', + ], + 'Data' => [ + 'description' => '权限详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限详情。', + 'type' => 'object', + 'properties' => [ + 'PrivilegeType' => [ + 'description' => '权限级别，可以是全局`Global`、库`Databae`、表`Table`和列`Column`，来自接口`DescribeEnabledPrivileges`。', + 'type' => 'string', + 'example' => 'Column', + ], + 'PrivilegeObject' => [ + 'description' => '权限对象，为库表列的三元组，以及额外的描述信息。', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'db1', + ], + 'Table' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'tabl1', + ], + 'Column' => [ + 'description' => '列名称。', + 'type' => 'string', + 'example' => 'column1', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'a test column', + ], + ], + ], + 'Privileges' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限名，来自接口`DescribeEnabledPrivileges`。', + 'type' => 'string', + 'example' => 'insert,select', + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '用户在该权限级别拥有的权限总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '页号，和入参的页号一致。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小，和入参的页大小一致。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Account.NotExist', + 'errorMessage' => 'The account is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.User.NotBindDatabaseAccount', + 'errorMessage' => 'The user has not been associated with a database account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA32480A-E3E5-1BE7-BA98-724551DC04C8\\",\\n \\"Data\\": [\\n {\\n \\"PrivilegeType\\": \\"Column\\",\\n \\"PrivilegeObject\\": {\\n \\"Database\\": \\"db1\\",\\n \\"Table\\": \\"tabl1\\",\\n \\"Column\\": \\"column1\\",\\n \\"Description\\": \\"a test column\\"\\n },\\n \\"Privileges\\": [\\n \\"insert,select\\"\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","errorExample":""},{"type":"xml","example":"\\n DA32480A-E3E5-1BE7-BA98-724551DC04C8\\n \\n Column\\n \\n db1\\n tabl1
\\n column1\\n a test column\\n \\n insert,select\\n \\n 100\\n 1\\n 20\\n","errorExample":""}]', + 'title' => '查询数据库账号的权限', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~).', + ], + 'DescribeEnabledPrivileges' => [ + 'summary' => '获取支持的权限级别和权限列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '159129', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp14t95lun0w****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名称。'."\n" + .'> 您可以调用[DescribeAccounts](~~612430~~)接口查看指定集群的数据库账号信息，包括账号名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_accout', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '246F42E0-A475-15FF-96D2-8DC47FC2F289', + ], + 'Data' => [ + 'description' => '支持的权限级别和权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限级别以及在该级别支持的权限。', + 'type' => 'object', + 'properties' => [ + 'Scope' => [ + 'description' => '权限级别。', + 'type' => 'string', + 'required' => true, + 'example' => 'Global', + ], + 'Description' => [ + 'description' => '对权限级别的描述。', + 'type' => 'string', + 'required' => true, + 'example' => '全局权限', + ], + 'Privileges' => [ + 'description' => '支持的权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限详情，包含权限名和描述。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '权限名。', + 'type' => 'string', + 'example' => 'select', + ], + 'Description' => [ + 'description' => '权限描述。', + 'type' => 'string', + 'example' => '查询数据', + ], + ], + ], + 'required' => true, + ], + ], + 'required' => true, + ], + 'required' => false, + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"246F42E0-A475-15FF-96D2-8DC47FC2F289\\",\\n \\"Data\\": [\\n {\\n \\"Scope\\": \\"Global\\",\\n \\"Description\\": \\"全局权限\\",\\n \\"Privileges\\": [\\n {\\n \\"Key\\": \\"select\\",\\n \\"Description\\": \\"查询数据\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 246F42E0-A475-15FF-96D2-8DC47FC2F289\\n \\n Global\\n 全局\\n \\n select\\n 查询\\n \\n \\n","errorExample":""}]', + 'title' => '查询支持的权限级别和权限列表', + 'description' => '- 中心的公网接入地址：`adb.aliyuncs.com`。'."\n" + .'- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeAccountAllPrivileges' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '162785', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp14t95lun0w****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的数据库账户名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'account1', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '当请求的返回结果被截断时，可以将返回结果中的`Marker`填入到该字段以获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'EXAMPLE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse', + 'description' => 'BaseResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3BB185E9-BB54-1727-B876-13243E4C0EB5', + ], + 'Data' => [ + 'description' => '权限详情。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限详情。', + 'type' => 'object', + 'properties' => [ + 'PrivilegeType' => [ + 'description' => '权限级别，来自接口`DescribeEnabledPrivileges`。', + 'type' => 'string', + 'example' => 'Global', + ], + 'PrivilegeObject' => [ + 'description' => '权限对象，为库、表和列的三元组，为Global权限级别时全为空。', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'tdb1', + ], + 'Table' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'table1', + ], + 'Column' => [ + 'description' => '列名称。', + 'type' => 'string', + 'example' => 'id', + ], + 'Description' => [ + 'description' => '对权限对象的描述。', + 'type' => 'string', + 'example' => 'id of table', + ], + ], + ], + 'Privileges' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限名称，与接口`DescribeEnabledPrivileges`返回的权限名一致。'."\n", + 'type' => 'string', + 'example' => 'select', + ], + ], + ], + ], + ], + 'Marker' => [ + 'description' => '当返回的字段`Truncated`为`true`时，继续调用该接口时传入该字段的值以获取接下来的内容。', + 'type' => 'string', + 'example' => '0573e74fd1ccb01739993a691e876074db6e1b6ad79f54115f0e98528432ba6a523cfec5780ade5189299cc3396f6ff7', + ], + 'Truncated' => [ + 'description' => '当返回的内容被截断时，该字段的值为`true`。此时需要继续调用该接口获取接下来的内容，直到该字段的值为`false`。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Account.NotExist', + 'errorMessage' => 'The account is not found.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.User.NotBindDatabaseAccount', + 'errorMessage' => 'The user has not been associated with a database account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3BB185E9-BB54-1727-B876-13243E4C0EB5\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"PrivilegeType\\": \\"Global\\",\\n \\"PrivilegeObject\\": {\\n \\"Database\\": \\"tdb1\\",\\n \\"Table\\": \\"table1\\",\\n \\"Column\\": \\"id\\",\\n \\"Description\\": \\"id of table\\"\\n },\\n \\"Privileges\\": [\\n \\"select\\"\\n ]\\n }\\n ],\\n \\"Marker\\": \\"0573e74fd1ccb01739993a691e876074db6e1b6ad79f54115f0e98528432ba6a523cfec5780ade5189299cc3396f6ff7\\",\\n \\"Truncated\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 3BB185E9-BB54-1727-B876-13243E4C0EB5\\n \\n \\n Global\\n \\n \\n 0573e74fd1ccb01739993a691e876074db6e1b6ad79f54115f0e98528432ba6a523cfec5780ade5189299cc3396f6ff7\\n true\\n \\n","errorExample":""}]', + 'title' => '查询数据库账号的所有权限', + 'summary' => '获取给定账号拥有的所有权限，包括全局、库、表、列级别。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeAccountPrivilegeObjects' => [ + 'summary' => '获取给定账号可见的库表列。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '160215', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ch-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1k3wdmt139****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'PrivilegeType', + 'in' => 'query', + 'schema' => [ + 'description' => '权限级别，只能传入库（Database)）、表（Table）、列（Column）级别，不能传入全局（Global）级别。', + 'type' => 'string', + 'required' => false, + 'example' => 'Column', + 'default' => 'Database', + ], + ], + [ + 'name' => 'DatabasePrivilegeObject', + 'in' => 'query', + 'schema' => [ + 'description' => '根据给定的数据库名称进行筛选。', + 'type' => 'string', + 'required' => false, + 'example' => 'database1', + ], + ], + [ + 'name' => 'TablePrivilegeObject', + 'in' => 'query', + 'schema' => [ + 'description' => '根据给定的表名称进行筛选。', + 'type' => 'string', + 'required' => false, + 'example' => 'table1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页号，从1开始，默认值1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页含有条目的最大数量，默认为20。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ColumnPrivilegeObject', + 'in' => 'query', + 'schema' => [ + 'description' => '根据给定的列名进行筛选。', + 'type' => 'string', + 'required' => false, + 'example' => 'col1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34B2AD29-682F-1C14-B3AA-9EF1A96084B8', + ], + 'Data' => [ + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限对象，为库、表、列的三元组。', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => '数据库名称，当权限级别是库、表、列时返回该字段。', + 'type' => 'string', + 'example' => 'tdb1', + ], + 'Table' => [ + 'description' => '表名称，当权限级别是表和列时返回该字段。', + 'type' => 'string', + 'example' => 'table1', + ], + 'Column' => [ + 'description' => '列名称，当权限界别是列时返回该字段。', + 'type' => 'string', + 'example' => 'column1', + ], + 'Description' => [ + 'description' => '创建表/列时指定的描述。只有当权限级别为库和表时才有值，分别代表库和表的描述。', + 'type' => 'string', + 'example' => 'a test db', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '查询得到的结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23', + ], + 'PageNumber' => [ + 'description' => '页号，和传入的值一致。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小，和传入的值一致。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Account.NotExist', + 'errorMessage' => 'The account is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.User.NotBindDatabaseAccount', + 'errorMessage' => 'The user has not been associated with a database account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34B2AD29-682F-1C14-B3AA-9EF1A96084B8\\",\\n \\"Data\\": [\\n {\\n \\"Database\\": \\"tdb1\\",\\n \\"Table\\": \\"table1\\",\\n \\"Column\\": \\"column1\\",\\n \\"Description\\": \\"a test db\\"\\n }\\n ],\\n \\"TotalCount\\": 23,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","errorExample":""},{"type":"xml","example":"\\n 34B2AD29-682F-1C14-B3AA-9EF1A96084B8\\n \\n tdb1\\n table1
\\n column1\\n a test db\\n \\n 23\\n 1\\n 20\\n","errorExample":""}]', + 'title' => '查询数据库账号可见的库表列', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeOperatorPermission' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '214554', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf6wjk5xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CreatedTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-02-25T03:35:02Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Privileges' => [ + 'description' => '授权详情。', + 'type' => 'string', + 'example' => 'Control,Data', + ], + 'ExpiredTime' => [ + 'description' => '授权过期时间。', + 'type' => 'string', + 'example' => '2024-01-10T02:19:00Z', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-uf6wjk5xxxxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CreatedTime\\": \\"2024-02-25T03:35:02Z\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Privileges\\": \\"Control,Data\\",\\n \\"ExpiredTime\\": \\"2024-01-10T02:19:00Z\\",\\n \\"DBClusterId\\": \\"amv-uf6wjk5xxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => '查询服务账号授权情况', + 'summary' => '查询服务账号授权情况。', + ], + 'RevokeOperatorPermission' => [ + 'summary' => '取消服务账号的授权。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214578', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1mfe9qmsw1dzyg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RelatedTaskNotFinish', + 'errorMessage' => 'The related task does not finish.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '取消授权服务账号', + ], + 'GrantOperatorPermission' => [ + 'summary' => '用户授予服务账号权限，供值班定位问题。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214575', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1565u55p32****', + ], + ], + [ + 'name' => 'ExpiredTime', + 'in' => 'query', + 'schema' => [ + 'description' => '服务账号权限过期时间。UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-11-30T00:00:00Z', + ], + ], + [ + 'name' => 'Privileges', + 'in' => 'query', + 'schema' => [ + 'description' => '权限名称。取值说明：'."\n" + .'- **Control**：配置权限，查看和修改集群配置。'."\n" + .'- **Data**：数据权限，查看表结构、索引和SQL。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Control' => 'Control', + 'Data' => 'Data', + ], + 'example' => 'Control', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A438072A-E2E7-5509-9A3F-66293512A820', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RelatedTaskNotFinish', + 'errorMessage' => 'The related task does not finish.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A438072A-E2E7-5509-9A3F-66293512A820\\"\\n}","type":"json"}]', + 'title' => '授予服务账号权限', + ], + 'DescribeBackupPolicy' => [ + 'summary' => '查看集群备份设置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6s7oa710rbu0x3b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => '数据备份周期，多个取值用英文逗号（,）隔开。取值：'."\n" + ."\n" + .'- Monday：周一；'."\n" + .'- Tuesday：周二；'."\n" + .'- Wednesday：周三；'."\n" + .'- Thursday：周四；'."\n" + .'- Friday：周五；'."\n" + .'- Saturday：周六；'."\n" + .'- Sunday：周日。', + 'type' => 'string', + 'example' => 'Wednesday,Saturday', + ], + 'LogBackupRetentionPeriod' => [ + 'description' => '日志备份保留天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PreferredBackupTime' => [ + 'description' => '数据备份时间，格式：HH:mmZ-HH:mmZ。', + 'type' => 'string', + 'example' => '15:00Z-16:00Z', + ], + 'EnableBackupLog' => [ + 'description' => '是否开启日志（实时）备份。取值说明：'."\n" + .'- **Enable**：开启。'."\n" + .'- **Disable**：关闭。', + 'type' => 'string', + 'example' => 'true', + ], + 'BackupRetentionPeriod' => [ + 'description' => '数据备份保留天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Wednesday,Saturday\\",\\n \\"LogBackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"EnableBackupLog\\": \\"true\\",\\n \\"BackupRetentionPeriod\\": 7\\n}","type":"json"}]', + 'title' => '查询集群自动备份策略', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyBackupPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '155194', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '执行全量备份的开始时间，格式为HH:mmZ-HH:mmZ（UTC时间）。'."\n" + ."\n" + .'> 时间范围限制为1小时。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '18:00Z-19:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份周期，多个取值用英文逗号（,）隔开。取值说明：'."\n" + .'- **Monday**：周一。'."\n" + .'- **Tuesday**：周二。'."\n" + .'- **Wednesday**：周三。'."\n" + .'- **Thursday**：周四。'."\n" + .'- **Friday**：周五。'."\n" + .'- **Saturday**：周六。'."\n" + .'- **Sunday**：周日。'."\n" + ."\n" + .'> 为保证数据安全，最少选择两个。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Monday,Wednesday,Friday,Sunday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份保留天数，取值范围为：7~730。'."\n" + .'> 本参数不填写，默认为7天。', + 'type' => 'string', + 'required' => false, + 'example' => '7', + 'default' => '7', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启日志（实时）备份。取值说明：'."\n" + .'- **Enable**：开启。'."\n" + .'- **Disable**：关闭。'."\n" + .'> 本参数不填写，默认开启。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + ], + ], + [ + 'name' => 'LogBackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '日志（实时）数据备份保留天数，取值范围为：7~730。'."\n" + .'> 本参数不填写，默认为7天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '730', + 'minimum' => '7', + 'example' => '7', + 'default' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupTime.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupPeriod.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter "BackupRetentionPeriod" should be within [7-%s] days.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '修改集群备份策略', + 'summary' => '修改集群的备份策略。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeBackups' => [ + 'summary' => '查询实例备份集', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155193', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp18934i73vb5****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1679758862', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2011-06-01T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需要大于查询开始时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-02-20T02:30Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- 30；'."\n" + .'- 50；'."\n" + .'- 100'."\n" + ."\n" + .'默认值：30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值：大于0且不超过Integer数据类型最大值的正整数。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Remote', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅查询跨地域备份。取值为true时，仅查询跨地域备份。取值为false时，仅查询本地备份。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '300', + ], + 'PageSize' => [ + 'description' => '本页备份集个数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CE17270B-F8F8-5A31-9DB4-DADDFDAD7940', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'FreeBackupSize' => [ + 'description' => '备份集免费大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalBackupSize' => [ + 'description' => '总备份集大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64953700', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => '备份集列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'am-bp11q28kvl688****', + ], + 'BackupType' => [ + 'description' => '备份类型。取值说明：'."\n" + .'- **FullBackup**：全量备份。'."\n" + .'- **IncrementalBackup**：增量备份。', + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupStartTime' => [ + 'description' => '备份开始时间。', + 'type' => 'string', + 'example' => '2022-06-01T16:00Z', + ], + 'BackupSize' => [ + 'description' => '备份文件大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2167808', + ], + 'BackupEndTime' => [ + 'description' => '备份结束时间。', + 'type' => 'string', + 'example' => '2022-06-02T16:00Z', + ], + 'BackupExpiredTime' => [ + 'description' => '备份集过期时间。', + 'type' => 'string', + 'example' => '2022-07-02T16:00Z'."\n", + ], + 'BackupId' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'example' => '32732****', + ], + 'BackupMethod' => [ + 'description' => '备份方法。只支持快照备份（Snapshot）。', + 'type' => 'string', + 'example' => 'Snapshot', + ], + 'BackupRegion' => [ + 'description' => '跨地域备份所在地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ParentBackupId' => [ + 'description' => '跨地域备份所关联的本地备份集ID', + 'type' => 'string', + 'example' => '32733****', + ], + 'BackupStatus' => [ + 'description' => '备份的状态。取值如下：'."\n" + ."\n" + .'- Running：备份正在进行中。'."\n" + .'- Finished：备份已完成。', + 'type' => 'string', + 'example' => 'Finished', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"300\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"CE17270B-F8F8-5A31-9DB4-DADDFDAD7940\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"FreeBackupSize\\": 0,\\n \\"TotalBackupSize\\": 64953700,\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2022-06-01T16:00Z\\",\\n \\"BackupSize\\": 2167808,\\n \\"BackupEndTime\\": \\"2022-06-02T16:00Z\\",\\n \\"BackupExpiredTime\\": \\"2022-07-02T16:00Z\\\\n\\",\\n \\"BackupId\\": \\"32732****\\",\\n \\"BackupMethod\\": \\"Snapshot\\",\\n \\"BackupRegion\\": \\"cn-hangzhou\\",\\n \\"ParentBackupId\\": \\"32733****\\",\\n \\"BackupStatus\\": \\"Finished\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询备份集列表', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'CreateBackup' => [ + 'summary' => '立即创建一个备份集。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '246050', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9or2xawpnc****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在Region ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '421794A3-72A5-5D27-9E8B-A75A4C50****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C50****\\"\\n}","type":"json"}]', + 'title' => '立即创建一个临时备份', + 'description' => '**请确保在使用该接口前，已充分了解云原生数据仓库ADB MySQL产品的收费方式和[价格](https://www.aliyun.com/price/product#/ads/detail/ads_pre'."\n" + .')。** 临时备份与常规备份，在价格、备份集的保留周期上是一致的。', + ], + 'DeleteBackups' => [ + 'summary' => '手动删除备份集。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '246050', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB for MySQL集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'BackupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的备份集ID，多个备份集ID以英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '763,764', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '771C5FAA-530F-52F7-B84D-EBAD4561D590', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771C5FAA-530F-52F7-B84D-EBAD4561D590\\"\\n}","type":"json"}]', + 'title' => '删除备份集', + 'description' => '- 单次最大允许删除100个备份集。如果要删超过100个备份集，请分2次调用。'."\n" + .'- 为保证数据安全性，系统会强制保留1个有效备份集。当要删除仅有的备份集时，接口会禁止。', + ], + 'DescribeHistoryTasks' => [ + 'summary' => '获取历史任务记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254755', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：10~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的页码。取值范围：正整数。 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，当前固定为 Instance。', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，取值说明：'."\n" + ."\n" + .'- **Scheduled**：等待执行。'."\n" + ."\n" + .'- **Running**：执行中。'."\n" + ."\n" + .'- **Succeed**：执行成功。'."\n" + ."\n" + .'- **Failed**：执行失败。'."\n" + ."\n" + .'- **Cancelling**：正在终止。'."\n" + ."\n" + .'- **Canceled**：已终止。'."\n" + ."\n" + .'- **Waiting**：等待预设时间。'."\n" + ."\n" + .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', + 'type' => 'string', + 'required' => false, + 'example' => 'Scheduled', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。多个集群ID用英文逗号（,）分隔。最多填写30个集群ID。若不填写，则默认查询该地域下所有集群的历史任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-********', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。多个任务ID用英文逗号（,）分隔。最多填写30个任务ID。若不填写，则默认查询所有集群的历史任务。', + 'type' => 'string', + 'required' => false, + 'example' => 't-83br18hloy3faf****', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，用于查询特定类型任务情况，如有多个用英文逗号（,）分隔，最多支持 30 个，默认为空，表示不限制。', + 'type' => 'string', + 'required' => false, + 'example' => 'autotest_dispatch_cases', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-03-02T11:31:03Z', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '查询结果的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E51713A3-BB45-5616-AB15-170B704F8F01', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务对象。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'- **Scheduled**：等待执行。'."\n" + ."\n" + .'- **Running**：执行中。'."\n" + ."\n" + .'- **Succeed**：执行成功。'."\n" + ."\n" + .'- **Failed**：执行失败。'."\n" + ."\n" + .'- **Cancelling**：正在终止。'."\n" + ."\n" + .'- **Canceled**：已终止。'."\n" + ."\n" + .'- **Waiting**：等待预设时间。', + 'type' => 'string', + 'example' => 'Running', + ], + 'TaskId' => [ + 'description' => '任务 ID。', + 'type' => 'string', + 'example' => 't-83br18hloy3faf****', + ], + 'CurrentStepName' => [ + 'description' => '当前执行的步骤名，如果为空代表任务未开始。', + 'type' => 'string', + 'example' => 'exec_task', + ], + 'StartTime' => [ + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2022-02-03T11:31:03Z', + ], + 'EndTime' => [ + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2022-02-03T12:06:17Z', + ], + 'TaskType' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'autotest_dispatch_cases', + ], + 'RemainTime' => [ + 'description' => '预估剩余执行时间，单位为秒（s）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'Progress' => [ + 'description' => '当前进度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '79.0', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceType' => [ + 'description' => '实例类型。', + 'type' => 'string', + 'example' => 'Instance', + ], + 'InstanceId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-********', + ], + 'InstanceName' => [ + 'description' => '实例名。', + 'type' => 'string', + 'example' => 'test', + ], + 'DbType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'analyticdb', + ], + 'Product' => [ + 'description' => '产品。', + 'type' => 'string', + 'example' => 'ads', + 'default' => 'ADB', + ], + 'TaskDetail' => [ + 'description' => '任务详情。', + 'type' => 'string', + 'example' => '{\\"callerUid\\":\\"test\\"}', + ], + 'ActionInfo' => [ + 'description' => '允许的操作信息，具体使用时是根据 currentStepName+status 在此信息中匹配操作 Action，如果未匹配到 Action，代表任务当前状态不支持操作。', + 'type' => 'string', + 'example' => '{\\"steps\\":[{\\"action_info\\":{\\"Waiting\\":[\\"modifySwitchTime\\"]},\\"step_name\\":\\"exec_task\\"}]}', + ], + 'Uid' => [ + 'description' => '资源所属用户 ID。', + 'type' => 'string', + 'example' => '141345906006****', + ], + 'CallerSource' => [ + 'description' => '请求用户 ID，callerSource 为 User 时代表用户 UID。', + 'type' => 'string', + 'example' => '141345906006****', + ], + 'CallerUid' => [ + 'description' => '请求来源，取值说明：'."\n" + ."\n" + .'- **System**：系统。'."\n" + ."\n" + .'- **User**：用户。', + 'type' => 'string', + 'example' => 'User', + ], + 'ReasonCode' => [ + 'description' => '当前任务发起的原因。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有Ram校验失败才会返回此字段。', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => [ + 'description' => '鉴权Action。', + 'type' => 'string', + 'example' => 'test', + ], + 'AuthPrincipalDisplayName' => [ + 'description' => '授权主体显示名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'AuthPrincipalOwnerId' => [ + 'description' => '鉴权主体的主账号ID。', + 'type' => 'string', + 'example' => '141345906006****', + ], + 'AuthPrincipalType' => [ + 'description' => '授权主体类型。', + 'type' => 'string', + 'example' => 'test', + ], + 'EncodedDiagnosticMessage' => [ + 'description' => '编码诊断信息。', + 'type' => 'string', + 'example' => 'AQFmy+hZZsvoWTQ2NTJFQUFBLUIyNjktMzk5NS05MEZCLUMxMzgwNDUwMDA2Ng==', + ], + 'NoPermissionType' => [ + 'description' => '权限策略拒绝的类型，取值如下：'."\n" + .'- **ImplicitDeny**：资源持有者未配置相关权限策略给当前用户，缺省拒绝未授权的操作。'."\n" + .'- **ExplicitDeny**：资源持有者配置的RAM策略明确拒绝了当前用户访问对应的资源。', + 'type' => 'string', + 'example' => 'ImplicitDeny', + ], + 'PolicyType' => [ + 'description' => '引起无权限的策略类型，取值如下:'."\n" + .'- **ControlPolicy** ：管控策略。'."\n" + .'- **SessionPolicy**：临时Token额外添加的一个权限策略。'."\n" + .'- **AssumeRolePolicy**：RAM角色的授信策略。'."\n" + .'- **AccountLevelIdentityBasedPolicy**：账号授权范围的主体策略，包含自定义策略和系统策略。'."\n" + .'- **ResourceGroupLevelIdentityBasedPolicy**：资源组授权范围的主体策略，包含自定义策略和系统策略。', + 'type' => 'string', + 'example' => 'ControlPolicy', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"E51713A3-BB45-5616-AB15-170B704F8F01\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"TaskId\\": \\"t-83br18hloy3faf****\\",\\n \\"CurrentStepName\\": \\"exec_task\\",\\n \\"StartTime\\": \\"2022-02-03T11:31:03Z\\",\\n \\"EndTime\\": \\"2022-02-03T12:06:17Z\\",\\n \\"TaskType\\": \\"autotest_dispatch_cases\\",\\n \\"RemainTime\\": 1000,\\n \\"Progress\\": 79,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceType\\": \\"Instance\\",\\n \\"InstanceId\\": \\"amv-********\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"DbType\\": \\"analyticdb\\",\\n \\"Product\\": \\"ads\\",\\n \\"TaskDetail\\": \\"{\\\\\\\\\\\\\\"callerUid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}\\",\\n \\"ActionInfo\\": \\"{\\\\\\\\\\\\\\"steps\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"action_info\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Waiting\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"modifySwitchTime\\\\\\\\\\\\\\"]},\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec_task\\\\\\\\\\\\\\"}]}\\",\\n \\"Uid\\": \\"141345906006****\\",\\n \\"CallerSource\\": \\"141345906006****\\",\\n \\"CallerUid\\": \\"User\\",\\n \\"ReasonCode\\": \\"test\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"test\\",\\n \\"AuthPrincipalDisplayName\\": \\"test\\",\\n \\"AuthPrincipalOwnerId\\": \\"141345906006****\\",\\n \\"AuthPrincipalType\\": \\"test\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFmy+hZZsvoWTQ2NTJFQUFBLUIyNjktMzk5NS05MEZCLUMxMzgwNDUwMDA2Ng==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"ControlPolicy\\"\\n }\\n}","type":"json"}]', + 'title' => '查询历史运维任务', + 'description' => '仅支持查看30天内的任务。', + ], + 'DescribeHistoryTasksStat' => [ + 'summary' => '任务中心任务统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254776', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，取值说明：'."\n" + ."\n" + .'- **Scheduled**：等待执行。'."\n" + ."\n" + .'- **Running**：执行中。'."\n" + ."\n" + .'- **Succeed**：执行成功。'."\n" + ."\n" + .'- **Failed**：执行失败。'."\n" + ."\n" + .'- **Cancelling**：正在终止。'."\n" + ."\n" + .'- **Canceled**：已终止。'."\n" + ."\n" + .'- **Waiting**：等待预设时间。'."\n" + ."\n" + .'如有多个状态则用英文逗号分隔，默认为空，表示全选。', + 'type' => 'string', + 'required' => false, + 'example' => 'Scheduled', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-********', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务 ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1564657730', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '查询开始时间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-05-08T07:04:17Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '表示查询任务开始时间在此时间之前的任务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-02-24T10:01:37Z', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最小值，用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最大值，用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmy*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'description' => '任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'- **Scheduled**：等待执行。'."\n" + ."\n" + .'- **Running**：执行中。'."\n" + ."\n" + .'- **Succeed**：执行成功。'."\n" + ."\n" + .'- **Failed**：执行失败。'."\n" + ."\n" + .'- **Cancelling**：正在终止。'."\n" + ."\n" + .'- **Canceled**：已终止。'."\n" + ."\n" + .'- **Waiting**：等待预设时间。', + 'type' => 'string', + 'example' => 'Scheduled', + ], + 'TotalCount' => [ + 'description' => '任务总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + ."\n" + .'- 请求正常，返回OK。'."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => [ + 'description' => '鉴权Action。', + 'type' => 'string', + 'example' => 'test', + ], + 'AuthPrincipalDisplayName' => [ + 'description' => '授权主体显示名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'AuthPrincipalOwnerId' => [ + 'description' => '鉴权主体的主账号ID。', + 'type' => 'string', + 'example' => '141345906006****', + ], + 'AuthPrincipalType' => [ + 'description' => '授权主体类型。', + 'type' => 'string', + 'example' => 'test', + ], + 'EncodedDiagnosticMessage' => [ + 'description' => '编码诊断信息。', + 'type' => 'string', + 'example' => 'test'."\n", + ], + 'NoPermissionType' => [ + 'description' => '权限策略拒绝的类型，取值如下：'."\n" + .'- **ImplicitDeny**：资源持有者未配置相关权限策略给当前用户，缺省拒绝未授权的操作。'."\n" + .'- **ExplicitDeny**：资源持有者配置的RAM策略明确拒绝了当前用户访问对应的资源。', + 'type' => 'string', + 'example' => 'ImplicitDeny', + ], + 'PolicyType' => [ + 'description' => '引起无权限的策略类型，取值如下:'."\n" + .'- **ControlPolicy** ：管控策略。'."\n" + .'- **SessionPolicy**：临时Token额外添加的一个权限策略。'."\n" + .'- **AssumeRolePolicy**：RAM角色的授信策略。'."\n" + .'- **AccountLevelIdentityBasedPolicy**：账号授权范围的主体策略，包含自定义策略和系统策略。'."\n" + .'- **ResourceGroupLevelIdentityBasedPolicy**：资源组授权范围的主体策略，包含自定义策略和系统策略。', + 'type' => 'string', + 'example' => 'ControlPolicy', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Scheduled\\",\\n \\"TotalCount\\": 20\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"test\\",\\n \\"AuthPrincipalDisplayName\\": \\"test\\",\\n \\"AuthPrincipalOwnerId\\": \\"141345906006****\\",\\n \\"AuthPrincipalType\\": \\"test\\",\\n \\"EncodedDiagnosticMessage\\": \\"test\\\\n\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"ControlPolicy\\"\\n }\\n}","type":"json"}]', + 'title' => '统计历史任务', + ], + 'DescribeExecutorDetection' => [ + 'summary' => '查看计算层诊断结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194344', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2024-10-31T02:06Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-27T16:00Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '566', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9DFF5F54-162B-5860-80A5-411FF550B347', + ], + 'DBClusterId' => [ + 'description' => '数仓版集群ID。', + 'type' => 'string', + 'example' => 'am-xxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => '指标检测', + ], + 'Results' => [ + 'description' => '检测结果集合。', + 'type' => 'object', + 'properties' => [ + 'OperatorDetails' => [ + 'description' => '异常算子检测结果集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '检测指标名。', + 'type' => 'string', + 'example' => 'PeakMemory', + ], + 'SearchResults' => [ + 'description' => '异常算子检测结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '2024080110010002102500023803151627972', + ], + 'StageId' => [ + 'description' => 'StageID。', + 'type' => 'string', + 'example' => 'Stage[3]', + ], + 'OperatorName' => [ + 'description' => '算子名。', + 'type' => 'string', + 'example' => 'Join', + ], + 'PeakMemory' => [ + 'description' => '峰值内存消耗，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'OperatorCost' => [ + 'description' => '该阶段内部总的算子耗时，等同于该阶段的CPU Time，可用于判断查询哪些部分消耗了较多的计算资源。单位为毫秒（ms）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '123', + ], + 'InputRows' => [ + 'description' => '算子的输入数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'OutputRows' => [ + 'description' => '算子的输出数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'InputSize' => [ + 'description' => '算子的输入数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '345', + ], + 'OutputSize' => [ + 'description' => '算子的输出数据量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'OperatorInfo' => [ + 'description' => '算子属性信息。', + 'type' => 'string', + 'example' => 'Group By字段：uid', + ], + ], + ], + ], + ], + ], + ], + 'OperatorAgg' => [ + 'description' => '算子指标聚合检测结果集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '检测指标名。', + 'type' => 'string', + 'example' => 'OperatorCost', + ], + 'SearchResults' => [ + 'description' => '聚合结果检测结果集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperatorName' => [ + 'description' => '算子名。', + 'type' => 'string', + 'example' => 'Window', + ], + 'MaxValue' => [ + 'description' => '指标最大值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'TotalValue' => [ + 'description' => '指标累加值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '345', + ], + 'AvgValue' => [ + 'description' => '指标平均值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234', + ], + 'OperatorCount' => [ + 'description' => '算子出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到Aggregation算子消耗内存资源较多'."\n", + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"566\\",\\n \\"RequestId\\": \\"9DFF5F54-162B-5860-80A5-411FF550B347\\",\\n \\"DBClusterId\\": \\"am-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"指标检测\\",\\n \\"Results\\": {\\n \\"OperatorDetails\\": [\\n {\\n \\"MetricName\\": \\"PeakMemory\\",\\n \\"SearchResults\\": [\\n {\\n \\"ProcessId\\": \\"2024080110010002102500023803151627972\\",\\n \\"StageId\\": \\"Stage[3]\\",\\n \\"OperatorName\\": \\"Join\\",\\n \\"PeakMemory\\": 234,\\n \\"OperatorCost\\": 123,\\n \\"InputRows\\": 123,\\n \\"OutputRows\\": 2345,\\n \\"InputSize\\": 345,\\n \\"OutputSize\\": 234,\\n \\"OperatorInfo\\": \\"Group By字段：uid\\"\\n }\\n ]\\n }\\n ],\\n \\"OperatorAgg\\": [\\n {\\n \\"MetricName\\": \\"OperatorCost\\",\\n \\"SearchResults\\": [\\n {\\n \\"OperatorName\\": \\"Window\\",\\n \\"MaxValue\\": 2345,\\n \\"TotalValue\\": 345,\\n \\"AvgValue\\": 234,\\n \\"OperatorCount\\": 3\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"检测到Aggregation算子消耗内存资源较多\\\\n\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '计算节点检测', + ], + 'DescribeWorkerDetection' => [ + 'summary' => '查询存储层诊断结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194345', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-xxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~612293~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-11-18T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-04-25T02:04Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置建议的显示语言，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E5B37B61-E6C9-5FE0-9374-45BAA548AEF6', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-xxxxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => '指标检测', + ], + 'Results' => [ + 'description' => '检测结果。', + 'type' => 'object', + 'properties' => [ + 'SkewedTables' => [ + 'description' => '表倾斜检测。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'platfunc', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'sls_log_cheat_action', + ], + 'DDL' => [ + 'description' => '建表语句。', + 'type' => 'string', + 'example' => 'create table test(id varchar)', + ], + 'PartitionCount' => [ + 'description' => '分区数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalDataSize' => [ + 'description' => '表数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'TotalRowCount' => [ + 'description' => '表行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34', + ], + 'TotalPkSize' => [ + 'description' => '表主键数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'TotalRemoteDataSize' => [ + 'description' => '冷数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'TotalLocalDataSize' => [ + 'description' => '本地数据量，单位Byte。', + 'type' => 'string', + 'example' => '2345', + ], + 'ShardSkewedRows' => [ + 'description' => '表倾斜行数。', + 'type' => 'string', + 'example' => '1234', + ], + ], + ], + ], + 'PartitionedTables' => [ + 'description' => '分区不合理表集合。', + 'type' => 'array', + 'items' => [ + 'description' => '不合理分区表。', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'nxg', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'zhw_place_order', + ], + 'DDL' => [ + 'description' => '建表语句。', + 'type' => 'string', + 'example' => 'create table test(id varchar)', + ], + 'PartitionCount' => [ + 'description' => '分区数。', + 'type' => 'string', + 'example' => '234', + ], + 'PartitionIds' => [ + 'description' => '不合理分区ID。', + 'type' => 'string', + 'example' => '[2024,2025]', + ], + 'TotalDataSize' => [ + 'description' => '表总的数据量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'TopAccessTables' => [ + 'description' => '表访问检测结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '表访问检测结果。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '检测指标名。', + 'type' => 'string', + 'example' => '峰值内存检测', + ], + 'SearchResults' => [ + 'description' => '表访问检索结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '表访问检索结果。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'tiberias_2copt_origin_order_goods_info', + ], + 'MaxScanCost' => [ + 'description' => '最大扫描耗时，单位ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '345', + ], + 'AvgScanCost' => [ + 'description' => '平均扫描耗时，单位ms。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234', + ], + 'MaxScanSize' => [ + 'description' => '最大数据读取量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'AvgScanSize' => [ + 'description' => '平均表读取量，单位Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234', + ], + 'AccessCount' => [ + 'description' => '表被访问的次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + ], + ], + ], + ], + ], + ], + 'OperatorDetails' => [ + 'description' => '算子检测结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '算子检测结果。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '指标名。', + 'type' => 'string', + 'example' => 'PeakMemory', + ], + 'SearchResults' => [ + 'description' => '检索结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '算子检测结果。', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '返回SQL查询ID，便于用户诊断。', + 'type' => 'string', + 'example' => '2024041909301402103302422803151411141', + ], + 'StageId' => [ + 'description' => '阶段ID。', + 'type' => 'string', + 'example' => 'Stage[2]', + ], + 'OperatorName' => [ + 'description' => '算子名。', + 'type' => 'string', + 'example' => 'TableScan', + ], + 'PeakMemory' => [ + 'description' => '算子消耗的峰值内存，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23', + ], + 'OperatorCost' => [ + 'description' => '该阶段内部总的算子耗时，等同于该阶段的CPU Time，可用于判断查询哪些部分消耗了较多的计算资源。单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23', + ], + 'InputRows' => [ + 'description' => '算子的输入行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'OutputRows' => [ + 'description' => '算子的输出行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'InputSize' => [ + 'description' => '算子的输入数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'OutputSize' => [ + 'description' => '算子的输出数据量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'OperatorInfo' => [ + 'description' => '算子属性信息。', + 'type' => 'string', + 'example' => 'Group By字段：id', + ], + ], + ], + ], + ], + ], + ], + 'OperatorAgg' => [ + 'description' => '算子指标聚合检测结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '算子指标聚合检测项名。', + 'type' => 'string', + 'example' => '峰值内存', + ], + 'SearchResults' => [ + 'description' => '算子聚合指标检索结果集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperatorName' => [ + 'description' => '算子名。', + 'type' => 'string', + 'example' => 'Aggregation', + ], + 'MaxValue' => [ + 'description' => '算子指标最大值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '444', + ], + 'TotalValue' => [ + 'description' => '算子指标累加值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'AvgValue' => [ + 'description' => '算子指标平均值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2234', + ], + 'OperatorCount' => [ + 'description' => '算子出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到多个表存在主键过多的问题', + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"20\\",\\n \\"RequestId\\": \\"E5B37B61-E6C9-5FE0-9374-45BAA548AEF6\\",\\n \\"DBClusterId\\": \\"am-xxxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"指标检测\\",\\n \\"Results\\": {\\n \\"SkewedTables\\": [\\n {\\n \\"SchemaName\\": \\"platfunc\\",\\n \\"TableName\\": \\"sls_log_cheat_action\\",\\n \\"DDL\\": \\"create table test(id varchar)\\",\\n \\"PartitionCount\\": 2,\\n \\"TotalDataSize\\": 2345,\\n \\"TotalRowCount\\": 34,\\n \\"TotalPkSize\\": 234,\\n \\"TotalRemoteDataSize\\": 234,\\n \\"TotalLocalDataSize\\": \\"2345\\",\\n \\"ShardSkewedRows\\": \\"1234\\"\\n }\\n ],\\n \\"PartitionedTables\\": [\\n {\\n \\"SchemaName\\": \\"nxg\\",\\n \\"TableName\\": \\"zhw_place_order\\",\\n \\"DDL\\": \\"create table test(id varchar)\\",\\n \\"PartitionCount\\": \\"234\\",\\n \\"PartitionIds\\": \\"[2024,2025]\\",\\n \\"TotalDataSize\\": 1234\\n }\\n ],\\n \\"TopAccessTables\\": [\\n {\\n \\"MetricName\\": \\"峰值内存检测\\",\\n \\"SearchResults\\": [\\n {\\n \\"TableName\\": \\"tiberias_2copt_origin_order_goods_info\\",\\n \\"MaxScanCost\\": 345,\\n \\"AvgScanCost\\": 234,\\n \\"MaxScanSize\\": 2345,\\n \\"AvgScanSize\\": 234,\\n \\"AccessCount\\": 1111\\n }\\n ]\\n }\\n ],\\n \\"OperatorDetails\\": [\\n {\\n \\"MetricName\\": \\"PeakMemory\\",\\n \\"SearchResults\\": [\\n {\\n \\"ProcessId\\": \\"2024041909301402103302422803151411141\\",\\n \\"StageId\\": \\"Stage[2]\\",\\n \\"OperatorName\\": \\"TableScan\\",\\n \\"PeakMemory\\": 23,\\n \\"OperatorCost\\": 23,\\n \\"InputRows\\": 123,\\n \\"OutputRows\\": 123,\\n \\"InputSize\\": 123,\\n \\"OutputSize\\": 123,\\n \\"OperatorInfo\\": \\"Group By字段：id\\"\\n }\\n ]\\n }\\n ],\\n \\"OperatorAgg\\": [\\n {\\n \\"MetricName\\": \\"峰值内存\\",\\n \\"SearchResults\\": [\\n {\\n \\"OperatorName\\": \\"Aggregation\\",\\n \\"MaxValue\\": 444,\\n \\"TotalValue\\": 123,\\n \\"AvgValue\\": 2234,\\n \\"OperatorCount\\": 1234\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"检测到多个表存在主键过多的问题\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '预留节点检测', + ], + 'DescribeControllerDetection' => [ + 'summary' => '查看接入层诊断结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194343', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> * 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-xxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-03-10T23:56Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '日志的结束时间。格式：**yyyy-MM-ddTHH:mmZ**（UTC时间）。'."\n" + ."\n" + .'> 查询日志时，结束时间需大于开始时间，且与开始时间最大间隔不超过30天。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-06-23T02:21Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询得到的结果总数。', + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '257FAE29-ED5F-586C-94E4-43BD1392F238', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-xxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果对象。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到接入节点CPU增高', + ], + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => 'CPU增高检测', + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNING'."\n" + .'CRITICAL', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"10\\",\\n \\"RequestId\\": \\"257FAE29-ED5F-586C-94E4-43BD1392F238\\",\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Message\\": \\"检测到接入节点CPU增高\\",\\n \\"Name\\": \\"CPU增高检测\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '接入节点检测', + ], + 'DescribeBadSqlDetection' => [ + 'summary' => '查看一段时间范围内影响实例稳定的BadSQL。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194347', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-01-23T02:18Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需晚于查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-11-17T02:16Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '584CFCAE-E3C8-5BBB-B46C-724E77A830A7', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-xxxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => 'Cost', + ], + 'Results' => [ + 'description' => '检测结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果对象。', + 'type' => 'object', + 'properties' => [ + 'Cost' => [ + 'description' => '查询的总耗时。单位：毫秒。'."\n" + .'> 该耗时指标是`QueuedTime`、`TotalPlanningTime`和`ExecutionTime`三个耗时指标的累加值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '709', + ], + 'PeakMemory' => [ + 'description' => '查询的峰值内存，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'OperatorCost' => [ + 'description' => '该阶段内部总的算子耗时，等同于该阶段的CPU Time，可用于判断查询哪些部分消耗了较多的计算资源。单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'ScanSize' => [ + 'description' => '扫描数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2342', + ], + 'OutputDataSize' => [ + 'description' => '返回数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235433', + ], + 'ProcessId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '202410161002191720161451770345363xxxx', + ], + 'TotalStages' => [ + 'description' => '查询生成的总Stage数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'DiagnosisResults' => [ + 'description' => '查询自诊断结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '查询自诊断结果对象。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '诊断码。', + 'type' => 'string', + 'example' => '查询返回客户端的数据量较大', + ], + 'Detail' => [ + 'description' => '诊断结果详情。', + 'type' => 'string', + 'example' => '当前SQL返回到客户端的数据量较大，考虑导入到OSS', + ], + 'StageId' => [ + 'description' => 'StageID。', + 'type' => 'string', + 'example' => 'Stage[67]', + ], + 'OperatorId' => [ + 'description' => '算子ID。', + 'type' => 'string', + 'example' => 'TableScan[234]', + ], + ], + ], + ], + 'SQL' => [ + 'description' => 'SQL语句详情。'."\n" + .'> 出于性能考虑，当前SQL语句最长支持显示5120个字符，超出限制的SQL语句会被截断。您可以调用[DownloadDiagnosisRecords](~~308212~~)接口下载符合指定条件的SQL语句的摘要信息，包括完整的SQL语句。', + 'type' => 'string', + 'example' => 'SELECT * FROM device WHERE product_key = \'h66zXfxet2X\' AND name = \'device@zntbtfptv5_9237117\'', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-09-06T02:11:00Z', + ], + 'PatternId' => [ + 'description' => 'SQL Pattern的ID。', + 'type' => 'string', + 'example' => '3467484070025860498', + ], + ], + ], + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'WARNING', + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到存在峰值内存教导的SQL', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"50\\",\\n \\"RequestId\\": \\"584CFCAE-E3C8-5BBB-B46C-724E77A830A7\\",\\n \\"DBClusterId\\": \\"amv-xxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"Cost\\",\\n \\"Results\\": [\\n {\\n \\"Cost\\": 709,\\n \\"PeakMemory\\": 234,\\n \\"OperatorCost\\": 2345,\\n \\"ScanSize\\": 2342,\\n \\"OutputDataSize\\": 235433,\\n \\"ProcessId\\": \\"202410161002191720161451770345363xxxx\\",\\n \\"TotalStages\\": 5,\\n \\"DiagnosisResults\\": [\\n {\\n \\"Code\\": \\"查询返回客户端的数据量较大\\",\\n \\"Detail\\": \\"当前SQL返回到客户端的数据量较大，考虑导入到OSS\\",\\n \\"StageId\\": \\"Stage[67]\\",\\n \\"OperatorId\\": \\"TableScan[234]\\"\\n }\\n ],\\n \\"SQL\\": \\"SELECT * FROM device WHERE product_key = \'h66zXfxet2X\' AND name = \'device@zntbtfptv5_9237117\'\\",\\n \\"StartTime\\": \\"2024-09-06T02:11:00Z\\",\\n \\"PatternId\\": \\"3467484070025860498\\"\\n }\\n ],\\n \\"Status\\": \\"WARNING\\",\\n \\"Message\\": \\"检测到存在峰值内存教导的SQL\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'BadSQL检测', + ], + 'DescribeAbnormalPatternDetection' => [ + 'summary' => '查询异常Pattern诊断结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194346', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '运维事件所在地域的地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-zhangjiakou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询起始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-09-30T00:10Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'> 查询结束时间需晚于查询开始时间。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-11-17T02:16Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '15', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '19B824E0-690D-5A78-9992-5398C2F43694', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-xxxx', + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => 'Cost', + ], + 'Results' => [ + 'description' => '检测结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '检测结果对象。', + 'type' => 'object', + 'properties' => [ + 'PatternId' => [ + 'description' => 'SQL Pattern的ID。', + 'type' => 'string', + 'example' => '2803084667741875187', + ], + 'SQLPattern' => [ + 'description' => 'SQL Pattern的具体语句。', + 'type' => 'string', + 'example' => 'SELECT `tsid`nFROM `prod_ods_marketing_engine_material`nWHERE `tsid` = ?nLIMIT ?', + ], + 'Detail' => [ + 'description' => '检测结果描述。', + 'type' => 'string', + 'example' => '检测到2个totalTime指标异常Pattern，可能导致CPU使用率增高，或者查询变慢，影响系统稳定性，请到监控页面使用一键诊断查看详情，并进行优化', + ], + 'RelatedMetrics' => [ + 'description' => 'Pattern相关指标。', + 'type' => 'string', + 'example' => '最大查询耗时：1.43s'."\n" + .'最大峰值内存：20.73MB'."\n" + .'最大表读取数据量：10.12MB', + ], + 'User' => [ + 'description' => '提交查询的用户名。', + 'type' => 'string', + 'example' => 'test', + ], + 'AccessIp' => [ + 'description' => '提交Pattern相关的SQL客户端IP地址。', + 'type' => 'string', + 'example' => '172.16.133.168', + ], + 'Tables' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'dw_student_exam.ods_school_queanal', + ], + 'QueryCount' => [ + 'description' => '查询总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72', + ], + 'FailedCount' => [ + 'description' => '指定时间范围内，Pattern的失败次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"15\\",\\n \\"RequestId\\": \\"19B824E0-690D-5A78-9992-5398C2F43694\\",\\n \\"DBClusterId\\": \\"amv-xxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"Cost\\",\\n \\"Results\\": [\\n {\\n \\"PatternId\\": \\"2803084667741875187\\",\\n \\"SQLPattern\\": \\"SELECT `tsid`nFROM `prod_ods_marketing_engine_material`nWHERE `tsid` = ?nLIMIT ?\\",\\n \\"Detail\\": \\"检测到2个totalTime指标异常Pattern，可能导致CPU使用率增高，或者查询变慢，影响系统稳定性，请到监控页面使用一键诊断查看详情，并进行优化\\",\\n \\"RelatedMetrics\\": \\"最大查询耗时：1.43s\\\\n最大峰值内存：20.73MB\\\\n最大表读取数据量：10.12MB\\",\\n \\"User\\": \\"test\\",\\n \\"AccessIp\\": \\"172.16.133.168\\",\\n \\"Tables\\": \\"dw_student_exam.ods_school_queanal\\",\\n \\"QueryCount\\": 72,\\n \\"FailedCount\\": 7\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询异常模式检测', + ], + 'DescribeInclinedNodes' => [ + 'summary' => '查询所有存储节点的磁盘水位。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '217356', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-wz9jd******d1765', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日语。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C0BF6685-0519-543E-90F8-DB8949E4D5F2', + ], + 'Items' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '存储节点信息。', + 'type' => 'object', + 'properties' => [ + 'Node' => [ + 'description' => '存储节点编号。', + 'type' => 'string', + 'example' => 'Node1', + ], + 'DiskUsageRatio' => [ + 'description' => '存储节点磁盘水位。', + 'type' => 'string', + 'example' => '90.5', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0BF6685-0519-543E-90F8-DB8949E4D5F2\\",\\n \\"Items\\": [\\n {\\n \\"Node\\": \\"Node1\\",\\n \\"DiskUsageRatio\\": \\"90.5\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询存储节点磁盘水位', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeDBClusterHealthStatus' => [ + 'summary' => '查看集群的健康状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '151720', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'>您可以调用[DescribeDBClusters](~~612397~~)接口查看集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf6o6m8p6x7v****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CS' => [ + 'description' => '实例接入节点状态的列表。', + 'type' => 'object', + 'properties' => [ + 'ActiveCount' => [ + 'description' => '健康节点个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UnavailableCount' => [ + 'description' => '不可用节点个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RiskCount' => [ + 'description' => '风险节点个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpectedCount' => [ + 'description' => '接入节点总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'description' => '实例接入节点状态，取值说明：'."\n" + .'- **RISK**：风险。'."\n" + .'- **NORMAL**：健康。'."\n" + .'- **UNAVAILABLE**：不可用。', + 'type' => 'string', + 'example' => 'UNAVAILABLE', + ], + ], + ], + 'Executor' => [ + 'description' => '计算节点组健康状态列表。', + 'type' => 'object', + 'properties' => [ + 'ActiveCount' => [ + 'description' => '健康节点个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UnavailableCount' => [ + 'description' => '不可用节点个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RiskCount' => [ + 'description' => '风险节点个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpectedCount' => [ + 'description' => '计算节点总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'description' => '计算节点组健康状态，取值说明：'."\n" + .'- **RISK**：风险。'."\n" + .'- **NORMAL**：健康。'."\n" + .'- **UNAVAILABLE**：不可用。', + 'type' => 'string', + 'example' => 'UNAVAILABLE', + ], + ], + ], + 'Worker' => [ + 'description' => '存储节点健康状态列表。', + 'type' => 'object', + 'properties' => [ + 'ActiveCount' => [ + 'description' => '健康存储节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UnavailableCount' => [ + 'description' => '不可用存储节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RiskCount' => [ + 'description' => '风险存储节点组个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExpectedCount' => [ + 'description' => '存储节点组总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'description' => '存储节点组健康状态，取值说明：'."\n" + .'- **RISK**：风险。'."\n" + .'- **NORMAL**：健康。'."\n" + .'- **UNAVAILABLE**：不可用。', + 'type' => 'string', + 'example' => 'UNAVAILABLE', + ], + ], + ], + 'InstanceStatus' => [ + 'description' => '集群的健康状态，取值说明：'."\n" + .'- **RISK**：风险。'."\n" + .'- **NORMAL**：健康。'."\n" + .'- **UNAVAILABLE**：不可用。'."\n" + .'>当集群的实例接入节点状态、计算节点组健康状态和存储节点组健康状态，三个健康状态均为**健康**且实例探活成功，则集群的健康状态为**健康**；三个健康状态中包含**风险**时，则集群的健康状态为**风险**；三个健康状态中包含**不可用**时，则集群的健康状态为**不可用**。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CAV', + ], + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CS\\": {\\n \\"ActiveCount\\": 0,\\n \\"UnavailableCount\\": 1,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 1,\\n \\"Status\\": \\"UNAVAILABLE\\"\\n },\\n \\"Executor\\": {\\n \\"ActiveCount\\": 0,\\n \\"UnavailableCount\\": 1,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 1,\\n \\"Status\\": \\"UNAVAILABLE\\"\\n },\\n \\"Worker\\": {\\n \\"ActiveCount\\": 0,\\n \\"UnavailableCount\\": 1,\\n \\"RiskCount\\": 1,\\n \\"ExpectedCount\\": 1,\\n \\"Status\\": \\"UNAVAILABLE\\"\\n },\\n \\"InstanceStatus\\": \\"NORMAL\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CAV\\",\\n \\"AccessDeniedDetail\\": \\"\\"\\n}","type":"json"}]', + 'title' => '查询集群健康检查状态', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => '查看目标集群的性能数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131503', + 'abilityTreeNodes' => [ + 'FEATUREadsCVPI8C', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~~612397~~~)接口查看目标地域下所有集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1hx5n1o8f61****', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的性能指标名称（监控项Key），多个值之间用英文逗号（,）分隔。支持查询的指标详情请参见[监控项概览](~~2863211~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'AnalyticDB_CPU_Usage_Percentage', + 'default' => 'AnalyticDB_CPU_Usage_Percentage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。UTC时间，格式为yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-03-10T23:56Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。UTC时间，格式为yyyy-MM-ddTHH:mmZ。'."\n" + ."\n" + .'> 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过两天。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-03-11T15:01Z', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~612393~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourcePools', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '查询结束时间。UTC时间，格式为yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2022-03-11T15:01Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BD8C3096-8BC6-51DF-A4AB-BACD9DC10435', + ], + 'StartTime' => [ + 'description' => '查询开始时间。UTC时间，格式为yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2022-03-10T23:56Z', + ], + 'DBClusterId' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有集群的集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1hx5n1o8f61****', + ], + 'Performances' => [ + 'description' => '集群性能指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '性能指标名称。', + 'type' => 'string', + 'example' => 'AnalyticDB_CPU_Usage_Percentage', + ], + 'Unit' => [ + 'description' => '监控指标的单位。', + 'type' => 'string', + 'example' => '%', + ], + 'Series' => [ + 'description' => '性能数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '不同时间点下的性能值详情。', + 'type' => 'array', + 'items' => [ + 'description' => '不同时间点下的性能值详情。', + 'type' => 'string', + 'example' => '['."\n" + .' [ '."\n" + .' "2023-06-27T13:21:00+08:00","0.1250" '."\n" + .' ], '."\n" + .' [ '."\n" + .' "2022-03-11T10:00:42.739Z","0.3125" '."\n" + .' ]...'."\n" + .']', + ], + ], + 'Name' => [ + 'description' => '性能指标名称（监控指标Value Name）。详情请参见[监控项概览](~~2863211~~)。', + 'type' => 'string', + 'example' => 'AnalyticDB_Storage_CPU_Avg_Usage_Percentage', + ], + 'Tags' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => "\n" + .'{instance_name: "am-***"}', + ], + 'TranslateKey' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-03-11T15:01Z\\",\\n \\"RequestId\\": \\"BD8C3096-8BC6-51DF-A4AB-BACD9DC10435\\",\\n \\"StartTime\\": \\"2022-03-10T23:56Z\\",\\n \\"DBClusterId\\": \\"amv-bp1hx5n1o8f61****\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_CPU_Usage_Percentage\\",\\n \\"Unit\\": \\"%\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n \\"[\\\\n [ \\\\n \\\\\\"2023-06-27T13:21:00+08:00\\\\\\",\\\\\\"0.1250\\\\\\" \\\\n ], \\\\n [ \\\\n \\\\\\"2022-03-11T10:00:42.739Z\\\\\\",\\\\\\"0.3125\\\\\\" \\\\n ]...\\\\n]\\"\\n ],\\n \\"Name\\": \\"AnalyticDB_Storage_CPU_Avg_Usage_Percentage\\",\\n \\"Tags\\": \\"\\\\n{instance_name: \\\\\\"am-***\\\\\\"}\\",\\n \\"TranslateKey\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2022-03-11T15:01:00Z\\n BD8C3096-8BC6-51DF-A4AB-BACD9DC10435\\n 2022-03-10T23:56:00Z\\n am-bp1hx5n1o8f61****\\n \\n AnalyticDB_CPU\\n %\\n \\n [ \\"2022-03-11T03:00:12.72Z\\", \\"0.1250\\" ], [ \\"2022-03-11T10:00:42.739Z\\", \\"0.3125\\" ]\\n worker_avg_cpu_used\\n \\n \\n","errorExample":""}]', + 'title' => '查看集群性能数据', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeClusterResourceUsage' => [ + 'summary' => '调用DescribeClusterResourceUsage接口查询集群资源使用情况。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~612397~~)接口查看集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-11-29T10:20Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-08-22T01:06:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse', + 'description' => 'PlainResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '集群资源使用详情。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-uf6dj23rt5zo9s9d', + ], + 'StartTime' => [ + 'description' => '查询开始时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2023-03-14T03:42:15Z', + ], + 'EndTime' => [ + 'description' => '查询结束时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2023-03-23T02:31Z', + ], + 'AcuInfo' => [ + 'description' => '集群ACU资源使用情况。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '对应指标项取值的状态，取值说明：'."\n" + .'- `TotalAcuNumber`：总ACU资源数。'."\n" + .'- `ReservedAcuNumber`：预留资源ACU数。'."\n" + .'- `ReservedAcuUsageNumber`：已使用的预留资源ACU数。', + 'type' => 'string', + 'example' => 'TotalAcuNumber', + ], + 'Values' => [ + 'description' => '对应指标项在各时间点的具体取值。', + 'type' => 'array', + 'items' => [ + 'description' => '不同时间点下的性能值详情。', + 'type' => 'string', + 'example' => '16.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAW\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"DBClusterId\\": \\"amv-uf6dj23rt5zo9s9d\\",\\n \\"StartTime\\": \\"2023-03-14T03:42:15Z\\",\\n \\"EndTime\\": \\"2023-03-23T02:31Z\\",\\n \\"AcuInfo\\": [\\n {\\n \\"Name\\": \\"TotalAcuNumber\\",\\n \\"Values\\": [\\n \\"16.0\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询集群资源使用情况', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeClusterResourceDetail' => [ + 'summary' => '查询集群资源具体使用详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1jj9xqft1po****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse', + 'description' => 'PlainResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '集群资源具体使用详情。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-adbxxxxx', + ], + 'ComputeResource' => [ + 'description' => '计算预留资源。取值范围：0ACU～4096ACU，步长：16。1 ACU约等于1核4 GB。', + 'type' => 'string', + 'example' => '16ACU', + ], + 'FreeComputeResource' => [ + 'description' => '空闲计算预留资源。取值范围：0ACU～4096ACU，步长：16。1 ACU约等于1核4 GB。', + 'type' => 'string', + 'example' => '0ACU', + ], + 'StorageResource' => [ + 'description' => '存储预留资源。取值范围：0ACU～2064ACU，步长：24。1 ACU约等于1核4 GB。', + 'type' => 'string', + 'example' => '24ACU', + ], + 'ResourceGroupList' => [ + 'description' => '资源组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PoolId' => [ + 'description' => '资源组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17', + ], + 'PoolName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'testadb', + ], + 'PoolType' => [ + 'description' => '资源组类型。', + 'type' => 'string', + 'example' => 'interactive', + ], + 'MinComputeResource' => [ + 'description' => '最小计算预留资源，单位为ACU。'."\n", + 'type' => 'string', + 'example' => '16ACU', + ], + 'MaxComputeResource' => [ + 'description' => '最大计算预留资源，单位为ACU。', + 'type' => 'string', + 'example' => '128ACU', + ], + 'PoolUsers' => [ + 'description' => '资源组用户。', + 'type' => 'string', + 'example' => 'user1', + ], + 'Status' => [ + 'description' => '资源组状态，取值说明：'."\n" + .'- **running**：运行中'."\n" + .'- **deleting**：删除中'."\n" + .'- **scaling**：变配中', + 'type' => 'string', + 'example' => 'running', + ], + 'ClusterSizeResource' => [ + 'description' => '预留参数(不涉及)', + 'type' => 'string', + 'example' => '0', + ], + 'MinClusterCount' => [ + 'description' => '预留参数（不涉及）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxClusterCount' => [ + 'description' => '预留参数（不涉及）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RunningClusterCount' => [ + 'description' => '预留参数（不涉及）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ClusterMode' => [ + 'description' => '预留参数（不涉及）', + 'type' => 'string', + 'required' => true, + 'example' => '0', + 'default' => 'Disable', + ], + 'EnableSpot' => [ + 'description' => '资源组是否开启竞价实例功能。开启竞价实例后资源单价降低，但是有概率被释放。取值：'."\n" + .'- **True**：开启竞价实例功能。'."\n" + .'- **False**：关闭竞价实例功能。'."\n" + ."\n" + .'仅Job型资源组可以为True。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"DBClusterId\\": \\"amv-adbxxxxx\\",\\n \\"ComputeResource\\": \\"16ACU\\",\\n \\"FreeComputeResource\\": \\"0ACU\\",\\n \\"StorageResource\\": \\"24ACU\\",\\n \\"ResourceGroupList\\": [\\n {\\n \\"PoolId\\": 17,\\n \\"PoolName\\": \\"testadb\\",\\n \\"PoolType\\": \\"interactive\\",\\n \\"MinComputeResource\\": \\"16ACU\\",\\n \\"MaxComputeResource\\": \\"128ACU\\",\\n \\"PoolUsers\\": \\"user1\\",\\n \\"Status\\": \\"running\\",\\n \\"ClusterSizeResource\\": \\"0\\",\\n \\"MinClusterCount\\": 0,\\n \\"MaxClusterCount\\": 0,\\n \\"RunningClusterCount\\": 0,\\n \\"ClusterMode\\": \\"0\\",\\n \\"EnableSpot\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询集群资源具体使用详情', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeStorageResourceUsage' => [ + 'summary' => '调用DescribeStorageResourceUsage接口查询集群存储资源使用情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp10yt0gva71ei7d', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-08-22T01:06:00Z'."\n", + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-08-23T01:06:00Z'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse', + 'description' => 'PlainResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1bg858bo8c****', + ], + 'StartTime' => [ + 'description' => '查询开始时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2022-08-22T01:06:00Z'."\n", + ], + 'EndTime' => [ + 'description' => '查询结束时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2022-08-23T01:06:00Z'."\n", + ], + 'AcuInfo' => [ + 'description' => '集群ACU资源使用情况。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '对应指标项取值的状态，取值说明：'."\n" + .'- `TotalAcuNumber`：总ACU资源数。'."\n" + .'- `ReservedAcuNumber`：预留资源ACU数。', + 'type' => 'string', + 'example' => 'TotalAcuNumber', + ], + 'Values' => [ + 'description' => '对应指标项在各时间点的具体取值。', + 'type' => 'array', + 'items' => [ + 'description' => '不同时间点下的性能值详情。', + 'type' => 'string', + 'example' => '16ACU', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAW\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"DBClusterId\\": \\"amv-bp1bg858bo8c****\\",\\n \\"StartTime\\": \\"2022-08-22T01:06:00Z\\\\n\\",\\n \\"EndTime\\": \\"2022-08-23T01:06:00Z\\\\n\\",\\n \\"AcuInfo\\": [\\n {\\n \\"Name\\": \\"TotalAcuNumber\\",\\n \\"Values\\": [\\n \\"16ACU\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询集群存储资源使用情况', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeJobResourceUsage' => [ + 'summary' => '获取作业资源使用统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173228', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-02-04T03:45:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需要大于查询开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-03-17T16:00:00Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse', + 'description' => 'PlainResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-clusterxxx', + ], + 'StartTime' => [ + 'description' => '开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-05-22T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-05-23T16:00:00Z'."\n", + ], + 'JobAcuUsage' => [ + 'description' => 'Job型资源组ACU使用情况。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '1592', + ], + 'ResourceGroupName' => [ + 'description' => 'Job型资源组名称。', + 'type' => 'string', + 'example' => 'job_default', + ], + 'JobStartTime' => [ + 'description' => '任务开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-05-22T16:00:00Z'."\n", + ], + 'JobEndTime' => [ + 'description' => '任务结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-05-23T16:00:00Z', + ], + 'AcuUsageDetail' => [ + 'description' => 'ACU资源使用情况。', + 'type' => 'object', + 'properties' => [ + 'TotalAcuNumber' => [ + 'description' => '总ACU资源数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '32ACU', + ], + 'ReservedAcuNumber' => [ + 'description' => '预留资源ACU数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '16ACU', + ], + 'ElasticAcuNumber' => [ + 'description' => '弹性资源ACU数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '16ACU', + ], + 'SpotAcuNumber' => [ + 'description' => '竞价实例资源ACU数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '16ACU', + ], + 'SpotAcuPercentage' => [ + 'description' => '竞价实例资源占总弹性资源的比例。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + ], + ], + 'UseCachePool' => [ + 'type' => 'boolean', + ], + ], + ], + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"DBClusterId\\": \\"amv-clusterxxx\\",\\n \\"StartTime\\": \\"2023-05-22T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-05-23T16:00:00Z\\\\n\\",\\n \\"JobAcuUsage\\": [\\n {\\n \\"JobId\\": \\"1592\\",\\n \\"ResourceGroupName\\": \\"job_default\\",\\n \\"JobStartTime\\": \\"2023-05-22T16:00:00Z\\\\n\\",\\n \\"JobEndTime\\": \\"2023-05-23T16:00:00Z\\",\\n \\"AcuUsageDetail\\": {\\n \\"TotalAcuNumber\\": 0,\\n \\"ReservedAcuNumber\\": 0,\\n \\"ElasticAcuNumber\\": 0,\\n \\"SpotAcuNumber\\": 0,\\n \\"SpotAcuPercentage\\": 0.9\\n },\\n \\"UseCachePool\\": true\\n }\\n ],\\n \\"PageNumber\\": 0,\\n \\"PageSize\\": 0,\\n \\"TotalCount\\": 0\\n }\\n}","type":"json"}]', + 'title' => '查询任务型资源使用情况', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribePerformanceViews' => [ + 'summary' => '获取监控视图列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220841', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 调用[DescribeDBClusters](~~612397~~)接口可以查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8', + ], + 'Views' => [ + 'description' => '监控视图列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个监控视图信息。', + 'type' => 'object', + 'properties' => [ + 'ViewName' => [ + 'description' => '监控视图名称。', + 'type' => 'string', + 'example' => '自定义-1', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-06-18T07:06:53.000+00:00', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-06-18T07:07:32.000+00:00', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有Ram校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8\\",\\n \\"Views\\": [\\n {\\n \\"ViewName\\": \\"自定义-1\\",\\n \\"CreateTime\\": \\"2024-06-18T07:06:53.000+00:00\\",\\n \\"UpdateTime\\": \\"2024-06-18T07:07:32.000+00:00\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '获取监控视图列表', + ], + 'CreatePerformanceView' => [ + 'summary' => '创建自定义监控视图。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221254', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 调用[DescribeDBClusters](~~612397~~)接口可以查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ViewDetail', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '监控视图详情。', + 'type' => 'object', + 'properties' => [ + 'ChartsPerLine' => [ + 'description' => '每一行展示的图表数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'ChartLinked' => [ + 'description' => '是否联动图表。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Categories' => [ + 'description' => '指标分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指标分类。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => '指标分类名，取值：'."\n" + .'* **Node**：节点资源指标。'."\n" + .'* **DiskData**：磁盘指标。'."\n" + .'* **WorkLoad**：负载指标。'."\n" + .'* **ResourceGroup**：资源组指标。', + 'type' => 'string', + 'required' => false, + 'example' => 'Node', + ], + 'Keys' => [ + 'description' => '指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个指标配置。', + 'type' => 'object', + 'properties' => [ + 'KeyName' => [ + 'description' => '指标Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'AnalyticDB_CPU', + ], + 'Selected' => [ + 'description' => '是否选中。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控视图名称。', + 'type' => 'string', + 'required' => true, + 'example' => '自定义-全部指标-2列-联动', + ], + ], + [ + 'name' => 'CreateFromViewType', + 'in' => 'query', + 'schema' => [ + 'description' => '当前监控视图复制自原始监控视图的类型，取值：'."\n" + ."\n" + .'- **Basic**：基础视图'."\n" + .'- **Advanced**：高级视图', + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + [ + 'name' => 'FillOriginViewKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '查看监控视图时，是否填充原始监控视图完成的Key。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', + ], + 'CreateStatus' => [ + 'description' => '创建结果，取值：'."\n" + ."\n" + .'- **SUCCESS**：成功。'."\n" + .'- **FAILED**：失败。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有Ram校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"CreateStatus\\": \\"SUCCESS\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '创建自定义监控视图', + ], + 'ModifyPerformanceView' => [ + 'summary' => '修改自定义监控视图。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220840', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 调用[DescribeDBClusters](~~612397~~)接口可以查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控视图名称。', + 'type' => 'string', + 'required' => true, + 'example' => '自定义-全部指标-2列-联动', + ], + ], + [ + 'name' => 'ViewDetail', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '监控视图详情。', + 'type' => 'object', + 'properties' => [ + 'ChartsPerLine' => [ + 'description' => '每一行展示的图表数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'ChartLinked' => [ + 'description' => '是否联动图表。取值：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Categories' => [ + 'description' => '指标分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指标分类。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => '指标分类名，取值：'."\n" + .'* **Node**：节点资源指标'."\n" + .'* **DiskData**：磁盘指标'."\n" + .'* **WorkLoad**：负载指标'."\n" + .'* **ResourceGroup**：资源组指标', + 'type' => 'string', + 'required' => false, + 'example' => 'Node', + ], + 'Keys' => [ + 'description' => '指标列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个指标配置。', + 'type' => 'object', + 'properties' => [ + 'KeyName' => [ + 'description' => '指标Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'AnalyticDB_CPU', + ], + 'Selected' => [ + 'description' => '是否选中。取值：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', + ], + 'ModifyStatus' => [ + 'description' => '修改结果，取值：'."\n" + ."\n" + .'- **SUCCESS**：成功'."\n" + .'- **FAILED**：失败', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有校验RAM失败后，字段才会返回。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"ModifyStatus\\": \\"SUCCESS\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '修改自定义监控视图', + ], + 'DescribePerformanceViewAttribute' => [ + 'summary' => '查看监控视图详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220839', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 调用[DescribeDBClusters](~~612397~~)接口可以查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控视图名称。', + 'type' => 'string', + 'required' => true, + 'example' => '自定义-全部指标-2列-联动', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', + ], + 'ViewName' => [ + 'description' => '监控视图名称。', + 'type' => 'string', + 'example' => '自定义-全部指标-2列-联动', + ], + 'CreateFromViewType' => [ + 'description' => '原始图表来源的类型，取值：'."\n" + ."\n" + .'- **Basic**：基础视图'."\n" + .'- **Advanced**：高级视图', + 'type' => 'string', + 'example' => 'Basic', + ], + 'ViewDetail' => [ + 'description' => '监控视图详情。', + 'type' => 'object', + 'properties' => [ + 'ChartsPerLine' => [ + 'description' => '每一行展示的图表数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ChartLinked' => [ + 'description' => '是否联动图表。取值：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Categories' => [ + 'description' => '指标分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指标分类。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => '指标分类名，取值：'."\n" + .'* **Node**：节点资源指标'."\n" + .'* **DiskData**：磁盘指标'."\n" + .'* **WorkLoad**：负载指标'."\n" + .'* **ResourceGroup**：资源组指标', + 'type' => 'string', + 'example' => 'Node', + ], + 'Keys' => [ + 'description' => '指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个指标配置。', + 'type' => 'object', + 'properties' => [ + 'KeyName' => [ + 'description' => '指标Key。', + 'type' => 'string', + 'example' => 'AnalyticDB_CPU', + ], + 'Selected' => [ + 'description' => '是否选中。取值：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'GroupType' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Engine' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'EnableAutoMc' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有Ram校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp198m028ih55xxxx', + ], + 'FillOriginViewKeys' => [ + 'description' => '查看监控视图时，是否填充原始监控视图完成的Key。取值：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'PerformanceViewNotFound', + 'errorMessage' => 'Performance view not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"ViewName\\": \\"自定义-全部指标-2列-联动\\",\\n \\"CreateFromViewType\\": \\"Basic\\",\\n \\"ViewDetail\\": {\\n \\"ChartsPerLine\\": 2,\\n \\"ChartLinked\\": true,\\n \\"Categories\\": [\\n {\\n \\"Category\\": \\"Node\\",\\n \\"Keys\\": [\\n {\\n \\"KeyName\\": \\"AnalyticDB_CPU\\",\\n \\"Selected\\": true,\\n \\"GroupType\\": [\\n \\"\\"\\n ],\\n \\"Engine\\": [\\n \\"\\"\\n ],\\n \\"EnableAutoMc\\": true\\n }\\n ]\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\",\\n \\"DBClusterId\\": \\"amv-bp198m028ih55xxxx\\",\\n \\"FillOriginViewKeys\\": true\\n}","type":"json"}]', + 'title' => '查看监控视图详情', + ], + 'DeletePerformanceView' => [ + 'summary' => '删除监控视图。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221469', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 调用[DescribeDBClusters](~~612397~~)接口可以查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控视图名称。', + 'type' => 'string', + 'required' => true, + 'example' => '自定义-全部指标-2列-联动', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DeleteStatus' => [ + 'description' => '删除结果，取值：'."\n" + ."\n" + .'- **SUCCESS**：成功'."\n" + .'- **FAILED**：失败', + 'type' => 'boolean', + 'example' => 'SUCCESS', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息.'."\n" + .'> 只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'PerformanceViewNotFound', + 'errorMessage' => 'Performance view not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DeleteStatus\\": true,\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '删除监控视图', + ], + 'ExistRunningSQLEngine' => [ + 'summary' => '是否有存活的SQL ENGINE。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '150789', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~612397~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1cit7z8j****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组名称。'."\n" + .'>您可以调用[DescribeDBResourceGroup](~~459446~~)接口查看指定集群的资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'spark_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FA675D68-14A4-5D9C-8820-92537D9F447E', + ], + 'Data' => [ + 'description' => '选定资源组是否存在运行中的Spark SQL Engine。'."\n" + ."\n" + .'取值：'."\n" + .'- **True**：存在。'."\n" + .'- **False**：不存在。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'True' => 'True', + 'False' => 'False', + ], + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA675D68-14A4-5D9C-8820-92537D9F447E\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '检测是否存在运行中的Spark SQLEngine', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'ExecuteSparkWarehouseBatchSQL' => [ + 'summary' => '批量执行Spark SQL。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '235566', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Agency', + 'in' => 'formData', + 'schema' => [ + 'description' => '客户标记提交的客户端类型，可以是任意合法的纯英文字符串，如Aliyun Dataworks。', + 'type' => 'string', + 'required' => false, + 'example' => 'Dataworks。', + 'default' => 'POPSDK', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Query', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要批量执行的SQL语句。多个SQL之间用英文分号（;）分隔。 执行引擎会按照顺序在同一个会话中依次执行这些SQL。', + 'type' => 'string', + 'required' => true, + 'example' => 'CREATE TABLE user(id INT, name STRING);'."\n" + .'INSERT INTO t VALUE(1, \'Bob\');'."\n" + .'SELECT * FROM t;', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'ExecuteResultLimit', + 'in' => 'formData', + 'schema' => [ + 'description' => '抽取部分数据写入 OSS。单位为 MB，默认值为 4096。由于压缩后文件的大小难以准确估计，实际写入到OSS中的数据会小于此处的配置值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '4096', + 'default' => '1000', + ], + ], + [ + 'name' => 'ExecuteTimeLimitInSeconds', + 'in' => 'formData', + 'schema' => [ + 'description' => '最大允许可执行时长，单位为秒（s）。如果一组SQL在提交后长时间未能执行成功，会被标记为超时失败。默认值为360000秒即为100小时。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600000', + 'default' => '604800', + ], + ], + [ + 'name' => 'RuntimeConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '执行SQL时的额外运行参数，输入结构需要是一个JSON字符串。'."\n" + ."\n" + .'这里允许写入所有Apache Spark官方文档中的运行时SQL配置。'."\n" + ."\n" + .'同时此处还包含了用于当前API的控制参数，对写OSS的行为进行控制，说明如下：'."\n" + ."\n" + .'‒ `spark.adb.sqlOutputFormat`: 写入到OSS中的文件格式，默认值是`CSV`。可选值为`CSV`,`JSON`。'."\n" + ."\n" + .'‒ `spark.adb.sqlOutputPartitions`: 写入到OSS中的SQL结果的分区数，默认值为1。'."\n" + ."\n" + .'‒ `spark.adb.sqlOutputLocation`：指定写入OSS的地址，SQL执行结果的抽样会被写入到该地址。此配置为空，则不会讲SQL执行结果的抽样数据写入OSS。'."\n" + ."\n" + .'‒ `spark.adb.sqlIgnorePersistError`：是否忽略写抽样结果时发生的错误，默认值为`false`。当配置为`true`时，执行过程中SQL执行成功，但SQL结果的抽样信息写入OSS失败不会打断执行步骤。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "OSSURL": "oss://testBucketname/"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBE843D8-964D-5EA3-9D31-822125611B6E', + ], + 'Data' => [ + 'description' => '返回数据体。', + 'example' => 'true', + '$ref' => '#/components/schemas/SparkBatchSQL', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBE843D8-964D-5EA3-9D31-822125611B6E\\",\\n \\"Data\\": {\\n \\"QueryId\\": \\"amv-202401-xx\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"QueryStartTime\\": 1723521767000,\\n \\"QueryEndTime\\": 1723521767000,\\n \\"Schema\\": \\"default\\",\\n \\"Uid\\": 12222222,\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"ResourceGroupName\\": \\"spark_rg\\",\\n \\"Query\\": \\"query\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"amv-20240711-stmt\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"JSON格式执行结果集\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\"\\n }\\n}","type":"json"}]', + 'title' => '批量执行Spark SQL', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'CancelSparkWarehouseBatchSQL' => [ + 'summary' => '取消Spark SQL执行。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235570', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'QueryId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Spark SQL的执行ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sq202501011001s****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-uf6485635f***', + ], + ], + [ + 'name' => 'Agency', + 'in' => 'formData', + 'schema' => [ + 'description' => '协助记录客户端名称，最长16个字符的意义字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'DMS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '771C5FAA-530F-52F7-B84D-EBAD45***', + ], + 'Data' => [ + 'description' => '返回结果。', + 'example' => '123', + '$ref' => '#/components/schemas/SparkBatchSQL', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771C5FAA-530F-52F7-B84D-EBAD45***\\",\\n \\"Data\\": {\\n \\"QueryId\\": \\"amv-202401-xx\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"QueryStartTime\\": 1723521767000,\\n \\"QueryEndTime\\": 1723521767000,\\n \\"Schema\\": \\"default\\",\\n \\"Uid\\": 12222222,\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"ResourceGroupName\\": \\"spark_rg\\",\\n \\"Query\\": \\"query\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"amv-20240711-stmt\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"JSON格式执行结果集\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\"\\n }\\n}","type":"json"}]', + 'title' => '取消Spark SQL执行', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'ListSparkWarehouseBatchSQL' => [ + 'summary' => '分页查询所有执行的Spark SQL。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236211', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => '开启了Spark引擎的Interactive型资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '当前页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Queries' => [ + 'description' => 'Spark SQL执行列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Spark SQL结果的结构体。', + 'example' => '[{\\"doc_id\\":[\\"1293619227704606720\\"]}]', + '$ref' => '#/components/schemas/SparkBatchSQL', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"Total\\": 0,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Queries\\": [\\n {\\n \\"QueryId\\": \\"amv-202401-xx\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"QueryStartTime\\": 1723521767000,\\n \\"QueryEndTime\\": 1723521767000,\\n \\"Schema\\": \\"default\\",\\n \\"Uid\\": 12222222,\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"ResourceGroupName\\": \\"spark_rg\\",\\n \\"Query\\": \\"query\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"amv-20240711-stmt\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"JSON格式执行结果集\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '分页查询所有执行的Spark SQL', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkWarehouseBatchSQL' => [ + 'summary' => '获取Spark SQL执行结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235568', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'QueryId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Spark SQ的L执行ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sq2024123*****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-uf6485635f***', + ], + ], + [ + 'name' => 'Agency', + 'in' => 'formData', + 'schema' => [ + 'description' => '协助记录客户端名称，最长16个字符的意义字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'DMS', + 'default' => 'POPSDK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3D44EDA0-A9DC-580D-9B5A-019370C075F4', + ], + 'Data' => [ + 'description' => '返回数据。', + 'example' => '{\'DBClusterId\': \'amv-uf6485635fz852mn\', \'Statements\': [{\'Code\': \'show databases\', \'State\': \'FINISHED\', \'StatementId\': \'sq202501141001sh8e12e080006846-0000\', \'Result\': \'+--------------------+n', + '$ref' => '#/components/schemas/SparkBatchSQL', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3D44EDA0-A9DC-580D-9B5A-019370C075F4\\",\\n \\"Data\\": {\\n \\"QueryId\\": \\"amv-202401-xx\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"QueryStartTime\\": 1723521767000,\\n \\"QueryEndTime\\": 1723521767000,\\n \\"Schema\\": \\"default\\",\\n \\"Uid\\": 12222222,\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"ResourceGroupName\\": \\"spark_rg\\",\\n \\"Query\\": \\"query\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"amv-20240711-stmt\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"JSON格式执行结果集\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\"\\n }\\n}","type":"json"}]', + 'title' => '获取Spark SQL执行结果', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'StartSparkReplSession' => [ + 'summary' => '启动一个Spark会话。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1mfe9qm****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Job型资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'schema' => [ + 'description' => '启动Spark的具体配置，格式为JSON。详情请参见[Spark Conf配置](~~471203~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '{ "spark.shuffle.timeout": ":0s" }', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C1797FEA-B7D6-5ED6-A24B-2C8C5F4D7361', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => '执行代码的会话ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AttemptId' => [ + 'description' => 'Spark应用的重试ID。', + 'type' => 'string', + 'example' => 's202301061000h****', + ], + 'Error' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'session time out', + ], + 'WebUiAddress' => [ + 'description' => 'Spark应用的Web UI地址。', + 'type' => 'string', + 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', + ], + 'State' => [ + 'description' => '会话状态，取值如下：'."\n" + .'- IDLE: 会话空闲'."\n" + .'- BUSY: 会话繁忙，有任务在执行'."\n" + .'- DEAD: 会话关闭', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'IDLE', + ], + 'AliyunUid' => [ + 'description' => '集群所属的阿里云主账号。', + 'type' => 'string', + 'example' => '178157466******', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1797FEA-B7D6-5ED6-A24B-2C8C5F4D7361\\",\\n \\"Data\\": {\\n \\"SessionId\\": 1,\\n \\"AttemptId\\": \\"s202301061000h****\\",\\n \\"Error\\": \\"session time out\\",\\n \\"WebUiAddress\\": \\"https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\",\\n \\"State\\": \\"IDLE\\",\\n \\"AliyunUid\\": \\"178157466******\\"\\n }\\n}","type":"json"}]', + 'title' => '启动一个Spark会话', + ], + 'GetSparkReplStatement' => [ + 'summary' => '获取一段代码的执行结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => '应用ID。'."\n" + .'> 可调用[ListSparkApps](~~455888~~)接口查询Spark应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 's202411071444hzdvk486d9d200****', + 'default' => 'ADB-Spark-Application', + ], + ], + [ + 'name' => 'StatementId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Spark作业中代码块的唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '执行代码的会话ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'StatementId' => [ + 'description' => '此Spark作业中代码块的唯一ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Code' => [ + 'description' => '执行的代码。', + 'type' => 'string', + 'example' => 'print(1+1)', + ], + 'CodeType' => [ + 'description' => '代码的类型，取值如下：'."\n" + .'- PYTHON'."\n" + .'- SCALA', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PYTHON', + ], + 'CodeState' => [ + 'description' => '代码执行状态，取值如下：'."\n" + .'- CANCELLED: 取消执行'."\n" + .'- RUNNING: 执行中'."\n" + .'- SUCCEEDED: 执行完成'."\n" + .'- ERROR: 执行失败', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RUNNING', + ], + 'AliyunUid' => [ + 'description' => '实例所属的阿里云账户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '144740799645****', + ], + 'OutputType' => [ + 'description' => '输出结果的类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'TABLE' => '表。', + 'TEXT' => '文本。', + ], + 'example' => 'TEXT', + ], + 'Output' => [ + 'description' => '输出结果，一个JSON格式的STRING。', + 'type' => 'string', + 'example' => '{"text/plain": 2}', + ], + 'Columns' => [ + 'description' => '列名数组。', + 'type' => 'array', + 'items' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'col1', + ], + ], + 'Error' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'stackoverflow error', + ], + 'StartTime' => [ + 'description' => '任务开始时间，Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730968194000', + ], + 'EndTime' => [ + 'description' => '任务结束时间，Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730968194000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"StatementId\\": 123,\\n \\"Code\\": \\"print(1+1)\\",\\n \\"CodeType\\": \\"PYTHON\\",\\n \\"CodeState\\": \\"RUNNING\\",\\n \\"AliyunUid\\": 0,\\n \\"OutputType\\": \\"TEXT\\",\\n \\"Output\\": \\"{\\\\\\"text/plain\\\\\\": 2}\\",\\n \\"Columns\\": [\\n \\"col1\\"\\n ],\\n \\"Error\\": \\"stackoverflow error\\",\\n \\"StartTime\\": 1730968194000,\\n \\"EndTime\\": 1730968194000\\n }\\n}","type":"json"}]', + 'title' => '获取一段代码的执行结果', + ], + 'ExecuteSparkReplStatement' => [ + 'summary' => '执行Spark作业中的部分代码。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => '应用ID。'."\n" + .'> 您可以调用[ListSparkApps](~~455888~~)接口查询Spark的应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 's202411071444hzdvk486d9d2001****', + 'default' => 'ADB-Spark-Application', + ], + ], + [ + 'name' => 'Code', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要执行的代码。', + 'type' => 'string', + 'required' => true, + 'example' => 'print(1+1)', + ], + ], + [ + 'name' => 'CodeType', + 'in' => 'formData', + 'schema' => [ + 'description' => '代码的语言类型，取值如下：'."\n" + .'- SCALA'."\n" + .'- PYTHON', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'PYTHON', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '执行代码的会话ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'StatementId' => [ + 'description' => 'Spark作业中代码块的唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Code' => [ + 'description' => '执行的代码。', + 'type' => 'string', + 'example' => 'print(1+1)', + ], + 'CodeType' => [ + 'description' => '代码的类型，取值如下：'."\n" + .'- SCALA'."\n" + .'- PYTHON', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PYTHON', + ], + 'CodeState' => [ + 'description' => '代码执行状态，取值如下：'."\n" + .'- CANCELLED：取消执行'."\n" + .'- RUNNING：执行中'."\n" + .'- SUCCEEDED：执行成功'."\n" + .'- ERROR：执行失败', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RUNNING', + ], + 'AliyunUid' => [ + 'description' => '集群所属的阿里云主账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17108278707****', + ], + 'OutputType' => [ + 'description' => '执行结果的序列化格式，结构为一个JSON，取值如下：'."\n" + .'- TEXT： 输出结果为Apache Livy标准下的文本内容。'."\n" + .'- TABLE：输出结果为Apache Livy标准下的表格内容。', + 'type' => 'string', + 'enumValueTitles' => [ + 'TABLE' => '表格', + 'TEXT' => '文本', + ], + 'example' => 'TEXT', + ], + 'Output' => [ + 'description' => '代码执行结果，一个JSON格式的字符串，格式上符合Apache Livy的输出标准。', + 'type' => 'string', + 'example' => '{"text/plain": 2}', + ], + 'Columns' => [ + 'description' => '列名数组。', + 'type' => 'array', + 'items' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'col1', + ], + ], + 'Error' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'StackOverflow Exception', + ], + 'StartTime' => [ + 'description' => '开始时间，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730968125000', + ], + 'EndTime' => [ + 'description' => '结束时间，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730968125000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"StatementId\\": 123,\\n \\"Code\\": \\"print(1+1)\\",\\n \\"CodeType\\": \\"PYTHON\\",\\n \\"CodeState\\": \\"RUNNING\\",\\n \\"AliyunUid\\": 0,\\n \\"OutputType\\": \\"TEXT\\",\\n \\"Output\\": \\"{\\\\\\"text/plain\\\\\\": 2}\\",\\n \\"Columns\\": [\\n \\"col1\\"\\n ],\\n \\"Error\\": \\"StackOverflow Exception\\",\\n \\"StartTime\\": 1730968125000,\\n \\"EndTime\\": 1730968125000\\n }\\n}","type":"json"}]', + 'title' => '执行Spark作业中的部分代码', + ], + 'CancelSparkReplStatement' => [ + 'summary' => '终止Spark作业中的部分代码块。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => '应用ID。'."\n" + .'> 可调用[ListSparkApps](~~455888~~)接口查询Spark应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 's202411071444hzdvk486d9d2001****', + 'default' => 'ADB-Spark-Application', + ], + ], + [ + 'name' => 'StatementId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Spark作业中代码块的唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '会话ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'StatementId' => [ + 'description' => 'Spark作业中代码块的唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Code' => [ + 'description' => '输入的代码。', + 'type' => 'string', + 'example' => 'print(1+1)', + ], + 'CodeType' => [ + 'description' => '代码的类型，取值如下：'."\n" + .'- SCALA'."\n" + .'- PYTHON', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PYTHON', + ], + 'CodeState' => [ + 'description' => '代码执行状态，取值如下：'."\n" + .'- CANCELLED： 执行取消'."\n" + .'- RUNNING： 执行中'."\n" + .'- SUCCEEDED： 执行成功'."\n" + .'- ERROR： 执行失败', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RUNNING', + ], + 'AliyunUid' => [ + 'description' => '集群所属的阿里云主账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '190063530332****', + ], + 'OutputType' => [ + 'description' => '执行结果的序列化格式，结构为一个JSON，取值如下：'."\n" + .'- TEXT： 输出结果为Apache Livy标准下的文本内容。'."\n" + .'- TABLE：输出结果为Apache Livy标准下的表格内容。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'TEXT', + ], + 'Output' => [ + 'description' => '代码执行结果，一个JSON格式的字符串，格式上符合Apache Livy的输出标准。', + 'type' => 'string', + 'example' => '{"text/plain": "2"}', + ], + 'Columns' => [ + 'description' => '当输出结果为表时，表的列名。', + 'type' => 'array', + 'items' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'col1', + ], + ], + 'Error' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'StackOverflow Exception：', + ], + 'StartTime' => [ + 'description' => '执行开始时间的毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730968056000', + ], + 'EndTime' => [ + 'description' => '执行结束时间的毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730968056000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"StatementId\\": 123,\\n \\"Code\\": \\"print(1+1)\\",\\n \\"CodeType\\": \\"PYTHON\\",\\n \\"CodeState\\": \\"RUNNING\\",\\n \\"AliyunUid\\": 0,\\n \\"OutputType\\": \\"TEXT\\",\\n \\"Output\\": \\"{\\\\\\"text/plain\\\\\\": \\\\\\"2\\\\\\"}\\",\\n \\"Columns\\": [\\n \\"col1\\"\\n ],\\n \\"Error\\": \\"StackOverflow Exception：\\",\\n \\"StartTime\\": 1730968056000,\\n \\"EndTime\\": 1730968056000\\n }\\n}","type":"json"}]', + 'title' => '终止Spark作业中的部分代码块', + ], + 'GetSparkReplSession' => [ + 'summary' => '获取会话状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => '应用ID。'."\n" + .'> 您可以调用[ListSparkApps](~~455888~~)接口查询所有的应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 's202411071444hzdvk486d9d200****', + 'default' => 'ADB-Spark-Application', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '执行代码的会话ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4CE6DF97-AEA4-484F-906F-C407EE3770EB', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => '执行代码的会话ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'State' => [ + 'description' => '当前会话状态，取值如下：'."\n" + .'- IDLE： 空闲'."\n" + .'- BUSY： 繁忙，执行任务中'."\n" + .'- DEAD： 会话关闭', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'IDEL', + ], + 'AttemptId' => [ + 'description' => 'Spark应用的重试ID。', + 'type' => 'string', + 'example' => 's202301061000hz57d797b00002****', + ], + 'Error' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'Session timed out', + ], + 'WebUiAddress' => [ + 'description' => 'Spark应用的Web UI地址。', + 'type' => 'string', + 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', + ], + 'AliyunUid' => [ + 'description' => '实例所属的阿里云账户ID。', + 'type' => 'string', + 'example' => '178157466101****', + ], + 'Active' => [ + 'description' => '是否处于活跃状态，取值如下：'."\n" + .'- true： 活跃'."\n" + .'- false：不活跃', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE3770EB\\",\\n \\"Data\\": {\\n \\"SessionId\\": 1,\\n \\"State\\": \\"IDEL\\",\\n \\"AttemptId\\": \\"s202301061000hz57d797b00002****\\",\\n \\"Error\\": \\"Session timed out\\",\\n \\"WebUiAddress\\": \\"https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\",\\n \\"AliyunUid\\": \\"178157466101****\\",\\n \\"Active\\": \\"true\\"\\n }\\n}","type":"json"}]', + 'title' => '获取会话状态', + ], + 'DescribeSparkAppType' => [ + 'summary' => '查询Spark应用类型。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189112', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-wz9w49b12933****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + .'> 调用[ListSparkApps](~~612475~~)接口查询Spark应用的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202407161205sza4c07c1000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '596AF63B-8798-501E-BA06-CD2184D48A35', + ], + 'Type' => [ + 'description' => 'Spark应用的类型，可取值如下：'."\n" + .'- BATCH：批处理应用。'."\n" + .'- SQLENGINE：SQL引擎应用。', + 'type' => 'string', + 'enumValueTitles' => [ + 'SQLENGINE' => 'SQL引擎应用。', + 'BATCH' => '批处理应用。', + ], + 'example' => 'Batch', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"596AF63B-8798-501E-BA06-CD2184D48A35\\",\\n \\"Type\\": \\"Batch\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '查询Spark应用类型', + ], + 'PreloadSparkAppMetrics' => [ + 'summary' => '预加载Spark App 指标数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '169119', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => 'Spark应用的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202204221525hzca7d8140000003', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp1mfe9qmsw1dzyg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84489769-3065-5A28-A4CB-977CD426F1C3', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 's202212181815shaccb8be0000253', + ], + 'AttemptId' => [ + 'description' => 'Spark应用的重试ID。', + 'type' => 'string', + 'example' => 's202301061000hz57d797b0000201-0001', + ], + 'Finished' => [ + 'description' => '解析是否结束：'."\n" + .'- true：表示已结束。'."\n" + .'- false：表示未结束。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'EventLogPath' => [ + 'description' => 'Event日志路径。', + 'type' => 'string', + 'example' => 'oss://path/to/eventLog', + ], + 'ScanMetrics' => [ + 'description' => '指标数据。', + 'type' => 'object', + 'properties' => [ + 'OutputRowsCount' => [ + 'description' => '扫描行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'TotalReadFileSizeInByte' => [ + 'description' => '扫描字节大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84489769-3065-5A28-A4CB-977CD426F1C3\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202212181815shaccb8be0000253\\",\\n \\"AttemptId\\": \\"s202301061000hz57d797b0000201-0001\\",\\n \\"Finished\\": true,\\n \\"EventLogPath\\": \\"oss://path/to/eventLog\\",\\n \\"ScanMetrics\\": {\\n \\"OutputRowsCount\\": 1000,\\n \\"TotalReadFileSizeInByte\\": 10000\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 84489769-3065-5A28-A4CB-977CD426F1C3\\n \\n s202212181815shaccb8be0000253\\n s202301061000hz57d797b0000201-0001\\n true\\n oss://path/to/eventLog\\n \\n 1000\\n 10000\\n \\n \\n","errorExample":""}]', + 'title' => '预加载Spark App指标数据', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkAppMetrics' => [ + 'summary' => '获取Spark App指标数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '169120', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202204221525hzca7d8140000003', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~612397~~)接口查询目标地域中所有集群的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp1ggnu61d77****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 's202302051515shfa865f8000****', + ], + 'AttemptId' => [ + 'description' => 'Spark应用的重试ID。', + 'type' => 'string', + 'example' => 's202301061000hz57d797b0000201-****', + ], + 'Finished' => [ + 'description' => '解析是否结束：'."\n" + .'- **true**：已结束。'."\n" + .'- **false**：未结束。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'EventLogPath' => [ + 'description' => 'Event日志路径。', + 'type' => 'string', + 'example' => 'oss://path/to/eventLog', + ], + 'ScanMetrics' => [ + 'description' => '指标数据。', + 'type' => 'object', + 'properties' => [ + 'OutputRowsCount' => [ + 'description' => '扫描行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'TotalReadFileSizeInByte' => [ + 'description' => '扫描字节大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.CancelNotebookStatementFailed', + 'errorMessage' => 'Failed to cancel the execution of notebook statements.', + ], + [ + 'errorCode' => 'Spark.CloseNotebookKernelFailed', + 'errorMessage' => 'Failed to disable the notebook kernel.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.ExecuteNotebookStatementFailed', + 'errorMessage' => 'Failed to execute notebook statements.', + ], + [ + 'errorCode' => 'Spark.GetNotebookKernelFailed', + 'errorMessage' => 'Failed to start the notebook kernel. Try again later.', + ], + [ + 'errorCode' => 'Spark.GetNotebookKernelStateFailed', + 'errorMessage' => 'Failed to obtain the status of the notebook kernel.', + ], + [ + 'errorCode' => 'Spark.GetNotebookStatementLogFailed', + 'errorMessage' => 'Failed to obtain notebook statement logs.', + ], + [ + 'errorCode' => 'Spark.GetNotebookStatementResultFailed', + 'errorMessage' => 'Failed to obtain notebook statement execution results.', + ], + [ + 'errorCode' => 'Spark.GetNotebookStatementUiFailed', + 'errorMessage' => 'Failed to obtain notebook statement UI.', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.NotebookKernelBusy', + 'errorMessage' => 'Too many jobs in the notebook kernel. Try again later.', + ], + [ + 'errorCode' => 'Spark.NotebookKernelExpired', + 'errorMessage' => 'The notebook kernel has expired. Restart the kernel.', + ], + [ + 'errorCode' => 'Spark.NotebookKernelInvalidStatus', + 'errorMessage' => 'The status of the notebook kernel is invalid.', + ], + [ + 'errorCode' => 'Spark.NotebookKernelNotStartup', + 'errorMessage' => 'The notebook kernel has not been started', + ], + [ + 'errorCode' => 'Spark.NotebookKernelStarting', + 'errorMessage' => 'The notebook kernel is starting. Try again later.', + ], + [ + 'errorCode' => 'Spark.NotebookNamingDuplicate', + 'errorMessage' => 'The name of the notebook is duplicated, please change the name', + ], + [ + 'errorCode' => 'Spark.NotebookNotFound', + 'errorMessage' => 'The notebook is not found', + ], + [ + 'errorCode' => 'Spark.NotebookParagraphMissingProgramCode', + 'errorMessage' => 'The notebook paragraph program code is missing', + ], + [ + 'errorCode' => 'Spark.NotebookParagraphNotFound', + 'errorMessage' => 'The notebook paragraph is not found', + ], + [ + 'errorCode' => 'Spark.NotebookParagraphNotRunning', + 'errorMessage' => 'The notebook paragraph has not been running', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + [ + 'errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', + 'errorMessage' => 'Can\'t load the content from file: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202302051515shfa865f8000****\\",\\n \\"AttemptId\\": \\"s202301061000hz57d797b0000201-****\\",\\n \\"Finished\\": true,\\n \\"EventLogPath\\": \\"oss://path/to/eventLog\\",\\n \\"ScanMetrics\\": {\\n \\"OutputRowsCount\\": 1000,\\n \\"TotalReadFileSizeInByte\\": 10000\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询Spark App指标数据', + 'description' => '- 在调用该接口前，必须先调用[PreloadSparkAppMetrics](~~612447~~)接口预加载Spark任务的指标数据，否则会调用失败。'."\n" + .'- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'ListSparkLogAnalyzeTasks' => [ + 'summary' => '获取所有的Spark日志分析任务列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-9scxs****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '页码号', + 'description' => '页码号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '每页数量', + 'description' => '每页返回分析任务数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709', + ], + 'Data' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'TaskList' => [ + 'title' => '分析任务列表', + 'description' => 'Spark日志分析任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Spark日志分析任务详情列表。', + '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + ], + ], + 'PageNumber' => [ + 'title' => '页码号', + 'description' => '页码号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页数量', + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => 'Task总数', + 'description' => '集群中Spark日志分析任务总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1DF5AF5B-C803-1861-A0FF-63666A557709\\",\\n \\"Data\\": {\\n \\"TaskList\\": [\\n {\\n \\"TaskId\\": 10,\\n \\"UserId\\": 0,\\n \\"SubmittedTimeInMillis\\": 1672123543000,\\n \\"TerminatedTimeInMillis\\": 1672123543000,\\n \\"TaskState\\": \\"WAITING\\",\\n \\"Result\\": {\\n \\"AppErrorCode\\": \\"EXCEEDED_QUOTA\\",\\n \\"AppErrorLog\\": \\"exception: xxxx\\",\\n \\"AppErrorAdvice\\": \\"\\"\\n },\\n \\"StartedTimeInMillis\\": 1672123543000,\\n \\"RuleMatched\\": true,\\n \\"TaskErrMsg\\": \\"Driver log not found\\",\\n \\"DBClusterId\\": \\"amv-adbxxxxx\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1DF5AF5B-C803-1861-A0FF-63666A557709\\n \\n \\n 10\\n 1672123543000\\n 1672123543000\\n WAITING\\n \\n EXCEEDED_QUOTA\\n exception: xxxx\\n \\n 1672123543000\\n true\\n Driver log not found\\n amv-adbxxxxx\\n \\n 1\\n 20\\n 100\\n \\n","errorExample":""}]', + 'title' => '查询Spark日志分析任务列表', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'SubmitSparkLogAnalyzeTask' => [ + 'summary' => '提交一个Spark日志分析任务,，服务端会开启指定Spark作业日志的分析流程并返回分析结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App ID'."\n", + 'description' => 'Spark应用ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 's202301121553hzd9c6f7xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709', + ], + 'Data' => [ + 'description' => 'Spark日志分析任务详情。', + '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1DF5AF5B-C803-1861-A0FF-63666A557709\\",\\n \\"Data\\": {\\n \\"TaskId\\": 10,\\n \\"UserId\\": 0,\\n \\"SubmittedTimeInMillis\\": 1672123543000,\\n \\"TerminatedTimeInMillis\\": 1672123543000,\\n \\"TaskState\\": \\"WAITING\\",\\n \\"Result\\": {\\n \\"AppErrorCode\\": \\"EXCEEDED_QUOTA\\",\\n \\"AppErrorLog\\": \\"exception: xxxx\\",\\n \\"AppErrorAdvice\\": \\"\\"\\n },\\n \\"StartedTimeInMillis\\": 1672123543000,\\n \\"RuleMatched\\": true,\\n \\"TaskErrMsg\\": \\"Driver log not found\\",\\n \\"DBClusterId\\": \\"amv-adbxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n xxx-xxx-xxxx\\n \\n 10\\n 1672123543000\\n 1672123543000\\n WAITING\\n \\n EXCEEDED_QUOTA\\n exception: xxxx\\n \\n 1672123543000\\n true\\n Driver log not found\\n \\n","errorExample":""}]', + 'title' => '提交Spark日志分析任务', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'KillSparkLogAnalyzeTask' => [ + 'summary' => '终止一个Spark分析任务，返回尝试终止后的任务详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark日志分析任务ID'."\n", + 'description' => 'Spark日志分析任务ID。可以通过调用ListSparkLogAnalyzeTasks查询当前集群中所有的分析任务的ID和状态。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'example' => '15', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709', + ], + 'Data' => [ + 'description' => 'Spark日志分析任务详情。', + '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1DF5AF5B-C803-1861-A0FF-63666A557709\\",\\n \\"Data\\": {\\n \\"TaskId\\": 10,\\n \\"UserId\\": 0,\\n \\"SubmittedTimeInMillis\\": 1672123543000,\\n \\"TerminatedTimeInMillis\\": 1672123543000,\\n \\"TaskState\\": \\"WAITING\\",\\n \\"Result\\": {\\n \\"AppErrorCode\\": \\"EXCEEDED_QUOTA\\",\\n \\"AppErrorLog\\": \\"exception: xxxx\\",\\n \\"AppErrorAdvice\\": \\"\\"\\n },\\n \\"StartedTimeInMillis\\": 1672123543000,\\n \\"RuleMatched\\": true,\\n \\"TaskErrMsg\\": \\"Driver log not found\\",\\n \\"DBClusterId\\": \\"amv-adbxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1DF5AF5B-C803-1861-A0FF-63666A557709\\n \\n 10\\n 1672123543000\\n 1672123543000\\n WAITING\\n \\n EXCEEDED_QUOTA\\n exception: xxxx\\n \\n 1672123543000\\n true\\n Driver log not found\\n amv-adbxxxxx\\n \\n","errorExample":""}]', + 'title' => '终止Spark日志分析任务', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkLogAnalyzeTask' => [ + 'summary' => '获取Spark日志分析任务结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark日志分析任务ID'."\n", + 'description' => 'Spark日志分析任务ID。调用接口ListSparkLogAnalyzeTasks可以查询当前ADB集群中提交的所有Spark日志分析任务ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709', + ], + 'Data' => [ + 'description' => 'Spark日志分析任务详情。', + '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1DF5AF5B-C803-1861-A0FF-63666A557709\\",\\n \\"Data\\": {\\n \\"TaskId\\": 10,\\n \\"UserId\\": 0,\\n \\"SubmittedTimeInMillis\\": 1672123543000,\\n \\"TerminatedTimeInMillis\\": 1672123543000,\\n \\"TaskState\\": \\"WAITING\\",\\n \\"Result\\": {\\n \\"AppErrorCode\\": \\"EXCEEDED_QUOTA\\",\\n \\"AppErrorLog\\": \\"exception: xxxx\\",\\n \\"AppErrorAdvice\\": \\"\\"\\n },\\n \\"StartedTimeInMillis\\": 1672123543000,\\n \\"RuleMatched\\": true,\\n \\"TaskErrMsg\\": \\"Driver log not found\\",\\n \\"DBClusterId\\": \\"amv-adbxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1DF5AF5B-C803-1861-A0FF-63666A557709\\n \\n 10\\n 1672123543000\\n 1672123543000\\n WAITING\\n \\n EXCEEDED_QUOTA\\n exception: xxxx\\n \\n 1672123543000\\n true\\n Driver log not found\\n amv-adbxxxxx\\n \\n","errorExample":""}]', + 'title' => '查询Spark日志分析任务结果', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'SetSparkAppLogRootPath' => [ + 'summary' => '更改用户Spark的日志配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '156583', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的id', + 'description' => 'AnalyticDB for MySQL集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp169ea59k****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'OssLogPath', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OSS日志地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://testBucketname/to/log', + ], + ], + [ + 'name' => 'UseDefaultOss', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否使用默认生成的OSS地址。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'Data' => [ + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'IsLogPathExists' => [ + 'title' => '是否存在日志地址', + 'description' => '是否存在日志地址。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecordedLogPath' => [ + 'title' => '记录的地址名称', + 'description' => '记录的地址名称。', + 'type' => 'string', + 'example' => 'oss://testBucketname/to/log', + ], + 'ModifiedUid' => [ + 'title' => '修改者ID', + 'description' => '修改者ID。', + 'type' => 'string', + 'example' => '11111111', + ], + 'ModifiedTimestamp' => [ + 'title' => '上一次修改时间', + 'description' => '上一次修改时间。', + 'type' => 'string', + 'example' => '1675236908', + ], + 'DefaultLogPath' => [ + 'title' => '推荐的默认地址', + 'description' => '推荐的默认地址。', + 'type' => 'string', + 'example' => 'oss://testBucketname/to/log', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"IsLogPathExists\\": true,\\n \\"RecordedLogPath\\": \\"oss://testBucketname/to/log\\",\\n \\"ModifiedUid\\": \\"11111111\\",\\n \\"ModifiedTimestamp\\": \\"1675236908\\",\\n \\"DefaultLogPath\\": \\"oss://testBucketname/to/log\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n \\n true\\n oss://path/to/log\\n 1111111\\n 1675236908\\n oss://path/to/log\\n \\n","errorExample":""}]', + 'title' => '更改用户Spark的日志配置', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkConfigLogPath' => [ + 'summary' => '查询AnalyticDB MySQL Spark中的日志配置结果，包括默认的Spark日志写入地址。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '156541', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的id', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp19lm077co*****', + 'maxLength' => 64, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1919-xxx-ssdfsdff', + ], + 'Data' => [ + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'IsLogPathExists' => [ + 'title' => '是否存在日志地址', + 'description' => '是否存在日志地址。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecordedLogPath' => [ + 'title' => '记录的地址名称', + 'description' => '记录的地址名称。', + 'type' => 'string', + 'example' => 'oss://test/spark-logs/', + ], + 'ModifiedUid' => [ + 'title' => '修改者ID', + 'description' => '修改人的账号ID。', + 'type' => 'string', + 'example' => '10130223128xxx', + ], + 'ModifiedTimestamp' => [ + 'title' => '上一次修改时间', + 'description' => '上一次修改时间。', + 'type' => 'string', + 'example' => '1675654361000', + ], + 'DefaultLogPath' => [ + 'title' => '推荐的默认地址', + 'description' => '推荐的默认地址。', + 'type' => 'string', + 'example' => 'oss://aliyun-oa-adb-spark-****-oss-cn-hanghzou/spark-logs', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1919-xxx-ssdfsdff\\",\\n \\"Data\\": {\\n \\"IsLogPathExists\\": true,\\n \\"RecordedLogPath\\": \\"oss://test/spark-logs/\\",\\n \\"ModifiedUid\\": \\"10130223128xxx\\",\\n \\"ModifiedTimestamp\\": \\"1675654361000\\",\\n \\"DefaultLogPath\\": \\"oss://aliyun-oa-adb-spark-****-oss-cn-hanghzou/spark-logs\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1919-xxx-ssdfsdff\\n \\n true\\n oss://test/spark-logs/\\n 10130223128xxx\\n 1675654361000\\n oss://aliyun-oa-adb-spark-1111-oss-cn-hanghzou/spark-logs\\n \\n","errorExample":""}]', + 'title' => '获取Spark日志配置路径', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'StartSparkSQLEngine' => [ + 'summary' => '启动Spark SQL引擎。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '152577', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-abcd****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'spark-rg-name', + ], + ], + [ + 'name' => 'MinExecutor', + 'in' => 'formData', + 'schema' => [ + 'description' => '执行SQL时拉起的最小Exectuor数量，配置为0意味着当不需要执行SQL时不会常驻Exectuor。取值范围为0到2000，当配置数量超过资源组承载总量时会导致服务启动失败。此处配置值必须小于MaxExecutor的配置值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'MaxExecutor', + 'in' => 'formData', + 'schema' => [ + 'description' => '执行SQL时启动的最大的Exector数量。取值范围为1到2000，当配置数量超过资源组承载总量时会导致服务启动失败。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Jars', + 'in' => 'formData', + 'schema' => [ + 'description' => '启动SQL引擎时需要引入的第三方JAR包列表，以逗号分隔的JAR包所在的OSS地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://testBuckname/test.jar,oss://testBuckname/test2.jar', + ], + ], + [ + 'name' => 'SlotNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '最大槽位数，即最多可以维持多少个Spark Session来执行SQL。取值范围为1到500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + 'default' => '50', + ], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'schema' => [ + 'description' => '启动Spark SQL Engine的具体配置，以一个JSON来描述KEY-VALUE型配置信息。详情请参见[Spark Conf配置](~~471203~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "spark.shuffle.timeout": ":0s" }', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => 'Spark作业ID。', + 'type' => 'string', + 'example' => 's202301xxxx', + ], + 'State' => [ + 'description' => 'Spark SQL Engine状态：'."\n" + ."\n" + .'- SUBMITTED：提交启动请求。'."\n" + .'- STARTING：启动中。'."\n" + .'- RUNNING：运行中，可以执行SQL。'."\n" + .'- FAILED：引擎出错退出。', + 'type' => 'string', + 'example' => 'SUBMITTED', + ], + 'AppName' => [ + 'description' => 'Spark App名称。', + 'type' => 'string', + 'example' => 'SQLEngine1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202301xxxx\\",\\n \\"State\\": \\"SUBMITTED\\",\\n \\"AppName\\": \\"SQLEngine1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n \\n s202301xxxx\\n SUBMITTED\\n SQLEngine1\\n \\n","errorExample":""}]', + 'title' => '启动Spark SQL引擎', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'KillSparkSQLEngine' => [ + 'summary' => '关闭Spark SQL引擎。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152585', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-8vbn8pq537k8w****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'spark_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'Data' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n false\\n","errorExample":""}]', + 'title' => '关闭Spark SQL引擎', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkSQLEngineState' => [ + 'summary' => '查询Spark SQL引擎的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152586', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Job型资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_instance', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'xxxx-xxx-xx', + ], + 'Data' => [ + 'description' => 'Spark SQL 引擎状态详情。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 's202207151211hz0c****', + ], + 'MinExecutor' => [ + 'description' => 'Spark Executor 最小启动量。', + 'type' => 'string', + 'example' => '1', + ], + 'MaxExecutor' => [ + 'description' => 'Spark Executor 最大启动量。', + 'type' => 'string', + 'example' => '3', + ], + 'Jars' => [ + 'description' => '第三方JAR包。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test.jar', + ], + 'SlotNum' => [ + 'description' => 'Spark 应用槽位值。', + 'type' => 'string', + 'example' => '2', + ], + 'Config' => [ + 'description' => 'Spark 应用配置。', + 'type' => 'string', + 'example' => '{"key1": "value1", "key2": "value2"}', + ], + 'State' => [ + 'description' => '应用执行状态，取值说明：'."\n" + .'* SUBMITTED：已提交。'."\n" + .'* STARTING：开始启动。'."\n" + .'* RUNNING：执行中。'."\n" + .'* FAILING：任务失败，清理环境中。'."\n" + .'* FAILED：失败。'."\n" + .'* KILLING：中止任务，清理环境中。'."\n" + .'* KILLED：中止任务。'."\n" + .'* SUCCEEDING：任务执行结束，清理环境中。'."\n" + .'* COMPLETED：已完成。'."\n" + .'* FATAL：意外失败。'."\n" + .'* UNKNOWN：未知错误。', + 'type' => 'string', + 'example' => 'COMPLETED', + ], + 'SubmittedTimeInMillis' => [ + 'description' => 'Spark SQL 应用的提交时间，Unix时间戳，单位毫秒（ms）。', + 'type' => 'string', + 'example' => '1651213645000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxx-xx\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202207151211hz0c****\\",\\n \\"MinExecutor\\": \\"1\\",\\n \\"MaxExecutor\\": \\"3\\",\\n \\"Jars\\": \\"oss://test-bucket/test.jar\\",\\n \\"SlotNum\\": \\"2\\",\\n \\"Config\\": \\"{\\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"}\\",\\n \\"State\\": \\"COMPLETED\\",\\n \\"SubmittedTimeInMillis\\": \\"1651213645000\\"\\n }\\n}","type":"json"}]', + 'title' => '查询Spark SQL引擎状态', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'DescribeSparkCodeOutput' => [ + 'summary' => '获取spark代码的执行结果。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~612397~~)接口查询目标地域下集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf6210mmev07****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Spark Job 任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '620', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Output' => [ + 'description' => '执行的输出，为JSON对象格式。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '"{\\"schema\\":[\\"id\\",\\"name\\",\\"age\\"],\\"data\\":[\\"{\\\\\\"id\\\\\\":10,\\\\\\"name\\\\\\":\\\\\\"z\\\\\\",\\\\\\"age\\\\\\":123}\\",\\"{\\\\\\"id\\\\\\":2,\\\\\\"name\\\\\\":\\\\\\"b\\\\\\",\\\\\\"age\\\\\\":17}\\",\\"{\\\\\\"id\\\\\\":1,\\\\\\"name\\\\\\":\\\\\\"a\\\\\\",\\\\\\"age\\\\\\":15}\\",\\"{\\\\\\"id\\\\\\":3,\\\\\\"name\\\\\\":\\\\\\"c\\\\\\",\\\\\\"age\\\\\\":222}\\",\\"{\\\\\\"id\\\\\\":10,\\\\\\"name\\\\\\":\\\\\\"z\\\\\\",\\\\\\"age\\\\\\":123}\\"],\\"haveRows\\":true,\\"rowNumber\\":6}"', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Output\\": \\"\\\\\\"{\\\\\\\\\\\\\\"schema\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"age\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"z\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"age\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":123}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"b\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"age\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":17}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"a\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"age\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":15}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":3,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"c\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"age\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":222}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"z\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"age\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":123}\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"haveRows\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"rowNumber\\\\\\\\\\\\\\":6}\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '查询产品的代码配置详情', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeSparkCodeLog' => [ + 'summary' => '查询Spark code的执行日志。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口可以查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf6o6m8p6x7v****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Spark Job 任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1248', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CD65640-9963-5D60-929C-118F2C84070E', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Log' => [ + 'description' => '日志内容。', + 'type' => 'string', + 'example' => '>>>>>>>> stdout:n++++++++++++++++++executing sql: MSCK REPAIR TABLE `footprint_ethereum`.`dwd_eth_eth_txr_v2_di` n++n', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"1CD65640-9963-5D60-929C-118F2C84070E\\",\\n \\"Success\\": true,\\n \\"Log\\": \\">>>>>>>> stdout:n++++++++++++++++++executing sql: MSCK REPAIR TABLE `footprint_ethereum`.`dwd_eth_eth_txr_v2_di` n++n\\"\\n}","type":"json"}]', + 'title' => '查询产品的代码日志', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeSparkCodeWebUi' => [ + 'summary' => '查询Spark应用的Web UI地址。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1v6usq6m65****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Spark Job 任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1248', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '应用建议执行结果。取值说明：'."\n" + .'- 请求正常，返回**SUCCESS**。 '."\n" + .'- 请求异常，返回具体异常错误信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '774DDC37-1908-58F6-B9CA-99E3E45965A6', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Url' => [ + 'description' => 'Spark UI地址', + 'type' => 'string', + 'example' => 'https://adb-subuser-cn-hangzhou-1358535755648527-100000648.oss-cn-hangzhou.aliyuncs.com/%3Facl?Expires=1681295967&OSSAccessKeyId=LTAI5tB7NAkm25oiGASu****&Signature=hKAZ1vgvhJ%2FD8hNHTuX%2FOOBWht****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"774DDC37-1908-58F6-B9CA-99E3E45965A6\\",\\n \\"Success\\": true,\\n \\"Url\\": \\"https://adb-subuser-cn-hangzhou-1358535755648527-100000648.oss-cn-hangzhou.aliyuncs.com/%3Facl?Expires=1681295967&OSSAccessKeyId=LTAI5tB7NAkm25oiGASu****&Signature=hKAZ1vgvhJ%2FD8hNHTuX%2FOOBWht****\\"\\n}","type":"json"}]', + 'title' => '查询Spark code的web ui', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'ListSparkTemplateFileIds' => [ + 'summary' => '查询集群所有保存的Spark模板文件ID。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'title' => '文件ID列表', + 'description' => '文件ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Spark模板文件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": [\\n 10\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 10\\n 20\\n 30\\n","errorExample":""}]', + 'title' => '列出集群中的Spark模板文件ID', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkAppWebUiAddress' => [ + 'summary' => '查询Spark应用的Web UI地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '119937', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => '应用ID。'."\n" + .'> 您可以调用[ListSparkApps](~~455888~~)接口查询Spark的应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202205201533hz1209892000****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有湖仓版集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-uf6g8w25jacm7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'Data' => [ + 'title' => '', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'title' => 'spark app的id', + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 's202205201533hz1209892000****', + ], + 'ExpirationTimeInMillis' => [ + 'title' => 'spark app的WEB UI的可访问截止时间, 毫秒级时间戳.', + 'description' => '到期时间，Unix时间戳，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655801973000', + ], + 'WebUiAddress' => [ + 'title' => 'Spark App的WEB UI的临时访问地址, 有过期时间, 过期后需要再次生成.', + 'description' => 'Spark应用的Web UI地址。', + 'type' => 'string', + 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', + ], + 'DBClusterId' => [ + 'title' => '数据库ID'."\n", + 'description' => '数据库ID'."\n", + 'type' => 'string', + 'example' => 'amv-clusterxxx', + 'default' => 'DB_CLUSTER_ID', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202205201533hz1209892000****\\",\\n \\"ExpirationTimeInMillis\\": 1655801973000,\\n \\"WebUiAddress\\": \\"https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\",\\n \\"DBClusterId\\": \\"amv-clusterxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n \\n s202205201533hz1209892000****\\n 1655801973000\\n https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\n \\n","errorExample":""}]', + 'title' => '查询Spark Web UI地址', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'ListSparkAppAttempts' => [ + 'summary' => '查询指定Spark应用的重试信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => '应用ID。'."\n" + ."\n" + .'> 您可以调用[ListSparkApps](~~455888~~)接口查询所有的应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202204132018hzprec1ac****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码号', + 'description' => '页码，取值为正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页显示数量', + 'description' => '每页记录数，取值：'."\n" + .'- **10**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-uf6o6m8p6x***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AttemptInfoList' => [ + 'description' => '重试信息列表。返回参数说明：'."\n" + .'- **AttemptId**：重试ID。'."\n" + .'- **State**：应用执行状态，取值说明：'."\n" + .' - **SUBMITTED**：已提交。'."\n" + .' - **STARTING**：开始启动。'."\n" + .' - **RUNNING**：执行中。'."\n" + .' - **FAILING**：任务失败，清理环境中。'."\n" + .' - **FAILED**：失败。'."\n" + .' - **KILLING**：中止任务，清理环境中。'."\n" + .' - **KILLED**：中止任务。'."\n" + .' - **SUCCEEDING**：任务执行结束，清理环境中。'."\n" + .' - **COMPLETED**：任务执行结束。'."\n" + .' - **FATAL**：意外失败。'."\n" + .' - **UNKNOWN**：未知错误。'."\n" + .'- **Message**：返回告警信息，无告警时则返回为空。'."\n" + .'- **Data**：Spark应用模板数据。'."\n" + .'- **EstimateExecutionCpuTimeInSeconds**：执行Spark应用消耗CPU的时长，单位毫秒（ms）。'."\n" + .'- **LogRootPath**：日志文件存储路径。'."\n" + .'- **LastAttemptId**：上次重试的ID。'."\n" + .'- **WebUiAddress**：Web UI地址。'."\n" + .'- **SubmittedTimeInMillis**：提交Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **StartedTimeInMillis**：Spark应用的创建时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **LastUpdatedTimeInMillis**：最近一次更新Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **TerminatedTimeInMillis**：Spark应用终止执行的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **DBClusterId**：执行Spark应用的集群ID。'."\n" + .'- **ResourceGroupName**：Job型资源组名称。'."\n" + .'- **DurationInMillis**：Spark应用执行耗时，单位毫秒（ms）。', + 'type' => 'array', + 'items' => [ + 'description' => '重试信息列表。返回参数说明：'."\n" + .'- **AttemptId**：重试ID。'."\n" + .'- **State**：应用执行状态，取值说明：'."\n" + .' - **SUBMITTED**：已提交。'."\n" + .' - **STARTING**：开始启动。'."\n" + .' - **RUNNING**：执行中。'."\n" + .' - **FAILING**：任务失败，清理环境中。'."\n" + .' - **FAILED**：失败。'."\n" + .' - **KILLING**：中止任务，清理环境中。'."\n" + .' - **KILLED**：中止任务。'."\n" + .' - **SUCCEEDING**：任务执行结束，清理环境中。'."\n" + .' - **COMPLETED**：任务执行结束。'."\n" + .' - **FATAL**：意外失败。'."\n" + .' - **UNKNOWN**：未知错误。'."\n" + .'- **Message**：返回告警信息，无告警时则返回为空。'."\n" + .'- **Data**：Spark应用模板数据。'."\n" + .'- **EstimateExecutionCpuTimeInSeconds**：执行Spark应用消耗CPU的时长，单位毫秒（ms）。'."\n" + .'- **LogRootPath**：日志文件存储路径。'."\n" + .'- **LastAttemptId**：上次重试的ID。'."\n" + .'- **WebUiAddress**：Web UI地址。'."\n" + .'- **SubmittedTimeInMillis**：提交Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **StartedTimeInMillis**：Spark应用的创建时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **LastUpdatedTimeInMillis**：最后一次更新Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **TerminatedTimeInMillis**：Spark应用终止执行的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **DBClusterId**：执行Spark应用的集群ID。'."\n" + .'- **ResourceGroupName**：Job型资源组名称。'."\n" + .'- **DurationInMillis**：Spark应用执行耗时，单位毫秒（ms）。', + '$ref' => '#/components/schemas/SparkAttemptInfo', + ], + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"AttemptInfoList\\": [\\n {\\n \\"AttemptId\\": \\"s202207151211hz0cb4200*****-0001\\",\\n \\"Priority\\": \\"NORMAL\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"Message\\": \\"WARN: Disk is full\\",\\n \\"Detail\\": {\\n \\"DurationInMillis\\": 100,\\n \\"LogRootPath\\": \\"oss:///logs/driver\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kv****\\",\\n \\"Data\\": \\"{ \\\\\\"name\\\\\\": \\\\\\"SparkPi\\\\\\", \\\\\\"file\\\\\\": \\\\\\"local:///tmp/spark-examples.jar\\\\\\", \\\\\\"className\\\\\\": \\\\\\"org.apache.spark.examples.SparkPi\\\\\\", \\\\\\"args\\\\\\": [ \\\\\\"1000000\\\\\\" ], \\\\\\"conf\\\\\\": { \\\\\\"spark.driver.resourceSpec\\\\\\": \\\\\\"small\\\\\\", \\\\\\"spark.executor.instances\\\\\\": 1, \\\\\\"spark.executor.resourceSpec\\\\\\": \\\\\\"small\\\\\\" } }\\",\\n \\"EstimateExecutionCpuTimeInSeconds\\": 100,\\n \\"LastUpdatedTimeInMillis\\": 1651213645200,\\n \\"RunningStartTimeInMillis\\": 36000,\\n \\"LastAttemptId\\": \\"s202204291426hzpre60cfa*****-0003\\",\\n \\"TerminatedTimeInMillis\\": 1651213645300,\\n \\"ResourceProvisioningDurationInMillis\\": 36000,\\n \\"ExecutionDurationInMillis\\": 36000,\\n \\"WebUiAddress\\": \\"https://sparkui.aliyuncs.com/token=xxx\\",\\n \\"SubmittedTimeInMillis\\": 1651213645000,\\n \\"StartedTimeInMillis\\": 1651213645010,\\n \\"AppType\\": \\"BATCH\\",\\n \\"ResourceGroupName\\": \\"spark-rg\\"\\n }\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n \\n s202207151211hz0cb4200*****-0001\\n RUNNING\\n WARN: Disk is full\\n \\n { \\"name\\": \\"SparkPi\\", \\"file\\": \\"local:///tmp/spark-examples.jar\\", \\"className\\": \\"org.apache.spark.examples.SparkPi\\", \\"args\\": [ \\"1000000\\" ], \\"conf\\": { \\"spark.driver.resourceSpec\\": \\"small\\", \\"spark.executor.instances\\": 1, \\"spark.executor.resourceSpec\\": \\"small\\" } }\\n 100\\n oss://<bucket-name>/logs/driver\\n s202204291426hzpre60cfa*****-0003\\n https://sparkui.aliyuncs.com/token=xxx\\n 1651213645000\\n 1651213645010\\n 1651213645200\\n 1651213645300\\n amv-bp11q28kv****\\n spark-rg\\n 100\\n \\n \\n 1\\n 10\\n 3\\n \\n","errorExample":""}]', + 'title' => '查询Spark应用的重试信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'CreateSparkTemplate' => [ + 'summary' => '创建Spark应用模板。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '132061', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件所在数据库ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'formData', + 'schema' => [ + 'title' => '父文件夹ID', + 'description' => '应用模板所属的目录ID。'."\n" + .'> 调用[GetSparkTemplateFolderTree](~~456218~~)接口查询目录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件名称', + 'description' => '应用模板名称。长度不超过64个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'batchfile', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件类型, 可以为FOLDER或者FILE', + 'description' => '应用模板类型，取值说明：'."\n" + .'- **folder**：目录'."\n" + .'- **file**：应用', + 'type' => 'string', + 'required' => true, + 'example' => 'file', + 'enum' => [], + ], + ], + [ + 'name' => 'AppType', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件内容的类型, 可选值有 BATCH, STREAMING, SQL, 默认为UNDEFINED', + 'description' => '应用类型，取值说明：'."\n" + .'- **SQL**：SQL应用'."\n" + .'- **STREAMING**：流应用'."\n" + .'- **BATCH**：离线应用'."\n" + ."\n" + .'> 当应用模板类型为folder时，无需配置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'SQL', + 'default' => 'UNDEFINED', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '应用模板创建结果。', + 'type' => 'object', + 'properties' => [ + 'Succeeded' => [ + 'title' => '是否创建成功', + 'description' => '是否创建成功，取值说明：'."\n" + .'- **True**：成功'."\n" + .'- **False**：失败', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"Succeeded\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n true\\n \\n","errorExample":""}]', + 'title' => '创建Spark应用模板', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'DeleteSparkTemplate' => [ + 'summary' => '删除Spark模板文件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '132062', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '待删除模板文件的ID', + 'description' => '待删除模板文件的目录ID或应用ID。'."\n" + .'> - 您可以调用[GetSparkTemplateFullTree](~~612467~~)接口查询目录ID或应用ID。'."\n" + .'- 输入目录ID时，会删除目录及目录下所有的应用模板文件。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '725204', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件所在数据库的ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + 'maxLength' => 64, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '删除结果。', + 'type' => 'object', + 'properties' => [ + 'Succeeded' => [ + 'title' => '是否删除成功', + 'description' => '是否删除成功，取值说明：'."\n" + .'- **True**：删除成功。'."\n" + .'- **False**：删除失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', + 'errorMessage' => 'Can\'t load the content from file: %s', + ], + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"Succeeded\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n true\\n \\n","errorExample":""}]', + 'title' => '删除Spark模板', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkTemplateFolderTree' => [ + 'summary' => '查询Spark应用的目录结构。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + 'maxLength' => 64, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'title' => '模板文件的结构, 仅包含文件夹, 以树形结构展示.', + 'description' => 'Spark应用的目录结构，以树形结构展示。返回参数说明：'."\n" + .'- **Uid**：阿里云账号的UID。'."\n" + .'- **Type**：应用模板类型。取值说明：'."\n" + .' **FOLDER**：目录。'."\n" + .'- **Parent**：父级。取值说明：'."\n" + .' - **0**：无子目录。'."\n" + .' - **-1**：有子目录。'."\n" + .'- **Children**：子目录结构。'."\n" + .'- **LastModified**：最近一次修改目录中应用的时间，格式为Unix时间戳，单位秒（s）。'."\n" + .'- **Name**：目录名称。'."\n" + .'- **Id**：目录ID。', + 'type' => 'string', + 'example' => '{ "Uid":195813423****, "Type":"FOLDER", "Parent":-1, "Children":[ { "LastModified":1647853173, "Uid":195813423****, "Type":"FOLDER", "Parent":0, "Id":157, "Name":"t" } ], "Id":725204, "Name":"root" }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": \\"{ \\\\\\"Uid\\\\\\":195813423****, \\\\\\"Type\\\\\\":\\\\\\"FOLDER\\\\\\", \\\\\\"Parent\\\\\\":-1, \\\\\\"Children\\\\\\":[ { \\\\\\"LastModified\\\\\\":1647853173, \\\\\\"Uid\\\\\\":195813423****, \\\\\\"Type\\\\\\":\\\\\\"FOLDER\\\\\\", \\\\\\"Parent\\\\\\":0, \\\\\\"Id\\\\\\":157, \\\\\\"Name\\\\\\":\\\\\\"t\\\\\\" } ], \\\\\\"Id\\\\\\":725204, \\\\\\"Name\\\\\\":\\\\\\"root\\\\\\" }\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n { \\"Uid\\":195813423****, \\"Type\\":\\"FOLDER\\", \\"Parent\\":-1, \\"Children\\":[ { \\"LastModified\\":1647853173, \\"Uid\\":195813423****, \\"Type\\":\\"FOLDER\\", \\"Parent\\":0, \\"Id\\":157, \\"Name\\":\\"t\\" } ], \\"Id\\":725204, \\"Name\\":\\"root\\" }\\n","errorExample":""}]', + 'title' => '查询Spark应用的目录结构', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkTemplateFullTree' => [ + 'summary' => '查看Spark应用的目录结构。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + 'maxLength' => 64, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'title' => '模板文件的树形结构', + 'description' => '应用模板的目录结构。返回参数说明：'."\n" + .'- **Uid**：阿里云账号的UID。'."\n" + .'- **Type**：应用模板类型。取值说明：'."\n" + .' - **FOLDER**：目录。'."\n" + .' - **FILE**：应用。'."\n" + .'- **Parent**：父级。取值：'."\n" + .' - **0**：无子目录。'."\n" + .' - **-1**：有子目录。'."\n" + .'- **Children**：子目录结构。'."\n" + .'- **LastModified**：最近一次修改应用的时间，格式为Unix时间戳，单位秒（s）。'."\n" + .'- **AppType**：应用类型。取值说明：'."\n" + .' - **SQL**：SQL应用。'."\n" + .' - **STREAMING**：流应用。'."\n" + .' - **BATCH**：离线应用。'."\n" + .'- **Name**：目录名称或应用名称。'."\n" + .'- **Id**：目录ID或应用ID。', + 'type' => 'string', + 'example' => '{ "Uid": 10415777****, "Type": "FOLDER", "Parent": -1, "Children": [ { "LastModified": 1648544748, "Uid": 104157779****, "Type": "FILE", "Parent": 0, "Id": s202204132****, "AppType": "SQL", "Name": "f" }, { "LastModified": 1648544956, "Uid": 1041577795****, "Type": "FOLDER", "Parent": 0, "Id": 157, "Name": "f3333" } ], "Id": 725204, "Name": "root" }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": \\"{ \\\\\\"Uid\\\\\\": 10415777****, \\\\\\"Type\\\\\\": \\\\\\"FOLDER\\\\\\", \\\\\\"Parent\\\\\\": -1, \\\\\\"Children\\\\\\": [ { \\\\\\"LastModified\\\\\\": 1648544748, \\\\\\"Uid\\\\\\": 104157779****, \\\\\\"Type\\\\\\": \\\\\\"FILE\\\\\\", \\\\\\"Parent\\\\\\": 0, \\\\\\"Id\\\\\\": s202204132****, \\\\\\"AppType\\\\\\": \\\\\\"SQL\\\\\\", \\\\\\"Name\\\\\\": \\\\\\"f\\\\\\" }, { \\\\\\"LastModified\\\\\\": 1648544956, \\\\\\"Uid\\\\\\": 1041577795****, \\\\\\"Type\\\\\\": \\\\\\"FOLDER\\\\\\", \\\\\\"Parent\\\\\\": 0, \\\\\\"Id\\\\\\": 157, \\\\\\"Name\\\\\\": \\\\\\"f3333\\\\\\" } ], \\\\\\"Id\\\\\\": 725204, \\\\\\"Name\\\\\\": \\\\\\"root\\\\\\" }\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n { \\"Uid\\": 10415777****, \\"Type\\": \\"FOLDER\\", \\"Parent\\": -1, \\"Children\\": [ { \\"LastModified\\": 1648544748, \\"Uid\\": 104157779****, \\"Type\\": \\"FILE\\", \\"Parent\\": 0, \\"Id\\": s202204132****, \\"AppType\\": \\"SQL\\", \\"Name\\": \\"f\\" }, { \\"LastModified\\": 1648544956, \\"Uid\\": 1041577795****, \\"Type\\": \\"FOLDER\\", \\"Parent\\": 0, \\"Id\\": 157, \\"Name\\": \\"f3333\\" } ], \\"Id\\": 725204, \\"Name\\": \\"root\\" }\\n","errorExample":""}]', + 'title' => '查询Spark应用的目录结构', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkTemplateFileContent' => [ + 'summary' => '获取Spark应用模板的内容。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的id', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-8vbn8pq537k8w****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件的ID', + 'description' => '应用模板ID。'."\n" + .'> 调用[GetSparkTemplateFullTree](~~456205~~)接口查询应用模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '725204', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AppType' => [ + 'description' => '应用类型，取值说明：'."\n" + .'- **SQL**：SQL应用。'."\n" + .'- **STREAMING**：流应用。'."\n" + .'- **BATCH**：离线应用。', + 'type' => 'string', + 'example' => 'SQL', + ], + 'Content' => [ + 'description' => '应用模板内容。', + 'type' => 'string', + 'example' => 'set spark.driver.resourceSpec=medium;set spark.executor.instances=2;set spark.executor.resourceSpec=medium;set spark.app.name=Spark SQL Test;', + ], + 'Id' => [ + 'description' => '应用模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '725204', + ], + 'Type' => [ + 'description' => '文件类型，取值说明：'."\n" + .'- **folder**：目录（文件夹）。'."\n" + .'- **file**：文件。', + 'type' => 'string', + 'example' => 'file', + ], + 'ResourceGroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppType\\": \\"SQL\\",\\n \\"Content\\": \\"set spark.driver.resourceSpec=medium;set spark.executor.instances=2;set spark.executor.resourceSpec=medium;set spark.app.name=Spark SQL Test;\\",\\n \\"Id\\": 725204,\\n \\"Type\\": \\"file\\",\\n \\"ResourceGroupName\\": \\"test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n \\n SQL\\n set spark.driver.resourceSpec=medium;set spark.executor.instances=2;set spark.executor.resourceSpec=medium;set spark.app.name=Spark SQL Test;\\n 725204\\n file\\n test\\n \\n","errorExample":""}]', + 'title' => '查询Spark应用模板的内容', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'UpdateSparkTemplateFile' => [ + 'summary' => '更新Spark应用模板。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '123242', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-pz5vp4585l466****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件ID', + 'description' => '应用模板ID。'."\n" + .'> 调用[GetSparkTemplateFullTree](~~456205~~)接口查询应用模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '718056', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件内容', + 'description' => '应用模板数据。'."\n" + .'> 此参数不填写时，不更新应用模板。如何配置Spark应用模板，请参见[Spark应用配置指南](~~452402~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'set spark.driver.resourceSpec=medium;set spark.executor.instances=2;set spark.executor.resourceSpec=medium;set spark.app.name=Spark SQL Test;', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组的名称', + 'description' => 'Job型资源组名称。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C', + ], + 'Data' => [ + 'description' => '更新结果。', + 'type' => 'object', + 'properties' => [ + 'Succeeded' => [ + 'title' => '是否更新成功', + 'description' => '应用模板更新是否成功，取值说明：'."\n" + .'- **True**：更新成功。'."\n" + .'- **False**：更新失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\",\\n \\"Data\\": {\\n \\"Succeeded\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\n \\n true\\n \\n","errorExample":""}]', + 'title' => '更新Spark应用模板', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'DeleteSparkTemplateFile' => [ + 'summary' => '删除Spark模板文件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '123240', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件的ID', + 'description' => '需要删除模板的文件ID。'."\n" + .'> 调用[GetSparkTemplateFullTree](~~456205~~)接口查询所有现存的模板文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '284', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1y769u11748****', + 'maxLength' => 64, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C', + ], + 'Data' => [ + 'description' => '删除结果。', + 'type' => 'object', + 'properties' => [ + 'Succeeded' => [ + 'description' => '是否成功删除，取值说明：'."\n" + .'- **true**：删除成功。'."\n" + .'- **false**：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + [ + 'errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', + 'errorMessage' => 'Can\'t load the content from file: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\",\\n \\"Data\\": {\\n \\"Succeeded\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\n \\n true\\n \\n","errorExample":""}]', + 'title' => '删除Spark模板', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkAppAttemptLog' => [ + 'summary' => '查询Spark应用的重试日志。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AttemptId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark重试的id', + 'description' => '重试日志的ID。'."\n" + .'> 调用[ListSparkAppAttempts](~~455887~~)接口查询应用的重试历史信息，包含重试日志ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202207151211hz****-0001', + 'maxLength' => 72, + ], + ], + [ + 'name' => 'LogLength', + 'in' => 'formData', + 'schema' => [ + 'title' => '返回尾部日志的行数', + 'description' => '重试日志的行数。取值范围：1~500，默认值为300。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '500', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '20', + 'default' => '300', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '读取日志的其实偏移量。', + 'description' => '读取日志的其实偏移量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '一页的日志行数', + 'description' => '单页数据行数。', + 'type' => 'string', + 'required' => false, + 'example' => '500', + 'default' => '100000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'LogContent' => [ + 'description' => '日志内容。', + 'type' => 'string', + 'example' => '22/04/22 15:30:49 INFO Utils: Start the dump task because s202207151211hz****-0001 app end, the interval is 238141ms;22/04/22 15:30:49 INFO AbstractConnector: Stopped Spark@5e774d9d{HTTP/1.1, (http/1.1)}{0.0.0.0:4040}', + ], + 'Message' => [ + 'description' => '返回告警信息，如任务执行失败或资源不足等，无告警时则返回为空。', + 'type' => 'string', + 'example' => 'WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1bg858bo8c****', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 's202204132018hzprec1ac61a000****', + ], + 'LogSize' => [ + 'title' => '日志的行数，0代表没有有效日志。', + 'description' => '日志的行数，0代表没有有效日志。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '775946240', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\",\\n \\"Data\\": {\\n \\"LogContent\\": \\"22/04/22 15:30:49 INFO Utils: Start the dump task because s202207151211hz****-0001 app end, the interval is 238141ms;22/04/22 15:30:49 INFO AbstractConnector: Stopped Spark@5e774d9d{HTTP/1.1, (http/1.1)}{0.0.0.0:4040}\\",\\n \\"Message\\": \\"WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/\\",\\n \\"DBClusterId\\": \\"amv-bp1bg858bo8c****\\",\\n \\"AppId\\": \\"s202204132018hzprec1ac61a000****\\",\\n \\"LogSize\\": 775946240\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\n \\n 22/04/22 15:30:49 INFO Utils: Start the dump task because s202207151211hz****-0001 app end, the interval is 238141ms;22/04/22 15:30:49 INFO AbstractConnector: Stopped Spark@5e774d9d{HTTP/1.1, (http/1.1)}{0.0.0.0:4040}\\n WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/\\n \\n","errorExample":""}]', + 'title' => '查询Spark应用的重试日志', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'ListSparkApps' => [ + 'summary' => '查看Spark应用列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库的ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job型资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_instance', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码号', + 'description' => '页码，取值为正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **10**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '30', + 'default' => '10', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'schema' => [ + 'description' => '以JSON格式的字符串来定义过滤条件，在JSON中可以使用的合法的KEY值和业务含义如下：'."\n" + .'- SubmittedTimeRange：开始时间。'."\n" + .'- TerminatedTimeRange： 结束时间。'."\n" + .'- AppStates：Spark作业的状态。'."\n" + .'- AppId：Spark作业的ID。'."\n" + .'- AppNameRegex: Spark作业的名称的正则表达式。'."\n" + .'- Tag：tag信息。'."\n" + .'- ResourceGroupName：资源组名称。'."\n" + ."\n" + .'其中开始时间和结束时间过滤条件，通过如下的子结构来输入范围：'."\n" + .'- Min：时间范围的下限，null代表无限制。'."\n" + .'- Max：时间范围的上限，null代表无限制。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .'"SubmittedTimeRang": {'."\n" + .' "Max": 10000,'."\n" + .' "Min": 0'."\n" + .' },'."\n" + .' "TerminatedTimeRange": {'."\n" + .' "Max": 10000,'."\n" + .' "Min": 0'."\n" + .' },'."\n" + .' "AppStates": ["STARTING"],'."\n" + .' "AppId": "adc",'."\n" + .' "AppNameRegex": "cde",'."\n" + .' "AttemptId": "abc-001"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AppInfoList' => [ + 'description' => '应用信息列表。返回参数说明：'."\n" + .'- **Data**：Spark应用模板数据。'."\n" + .'- **EstimateExecutionCpuTimeInSeconds**：执行Spark应用消耗CPU的时长，单位毫秒（ms）。'."\n" + .'- **LogRootPath**：日志文件存储路径。'."\n" + .'- **LastAttemptId**：重试ID。'."\n" + .'- **WebUiAddress**：Web UI地址。'."\n" + .'- **SubmittedTimeInMillis**：提交Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **StartedTimeInMillis**：Spark应用的创建时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **LastUpdatedTimeInMillis**：最近一次更新Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **TerminatedTimeInMillis**：Spark应用终止执行的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **DBClusterId**：执行Spark应用的集群ID。'."\n" + .'- **ResourceGroupName**：Job型资源组名称。'."\n" + .'- **DurationInMillis**：Spark应用执行耗时，单位毫秒（ms）。', + 'type' => 'array', + 'items' => [ + 'description' => '应用信息列表。返回参数说明：'."\n" + .'- **Data**：Spark应用模板数据。'."\n" + .'- **EstimateExecutionCpuTimeInSeconds**：执行Spark应用消耗CPU的时长，单位毫秒（ms）。'."\n" + .'- **LogRootPath**：日志文件存储路径。'."\n" + .'- **LastAttemptId**：重试ID。'."\n" + .'- **WebUiAddress**：Web UI地址。'."\n" + .'- **SubmittedTimeInMillis**：提交Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **StartedTimeInMillis**：Spark应用的创建时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **LastUpdatedTimeInMillis**：最近一次更新Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **TerminatedTimeInMillis**：Spark应用终止执行的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **DBClusterId**：执行Spark应用的集群ID。'."\n" + .'- **ResourceGroupName**：Job型资源组名称。'."\n" + .'- **DurationInMillis**：Spark应用执行耗时，单位毫秒（ms）。', + 'example' => '{'."\n" + .' "AppId": "test-app-id",'."\n" + .' "State": "Running",'."\n" + .' "Detail": {'."\n" + .' "LastAttemptId": "0001",'."\n" + .' "WebUiAddress": "http://spark-ui:4040",'."\n" + .' "SubmittedTimeInMillis": 1644805200260,'."\n" + .' "DBClusterId": "db",'."\n" + .' "EstimateExecutionCpuTimeInSeconds": 1644812400,'."\n" + .' "AppConf": "{}",'."\n" + .' "StartedTimeInMillis": 1644806400260,'."\n" + .' "LastUpdatedTimeInMillis": 1644808800260,'."\n" + .' "ResourceGroupName": "rg"'."\n" + .' },'."\n" + .' "AppName": "test app name"'."\n" + .' }', + '$ref' => '#/components/schemas/SparkAppInfo', + ], + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppInfoList\\": [\\n {\\n \\"AppId\\": \\"s202207151211hz0cb4*****\\",\\n \\"AppName\\": \\"Spark Test\\",\\n \\"Priority\\": \\"NORMAL\\",\\n \\"State\\": \\"FAILED\\",\\n \\"Message\\": \\"WARN: Disk is full\\",\\n \\"Detail\\": {\\n \\"DurationInMillis\\": 100,\\n \\"LogRootPath\\": \\"oss:///logs/driver\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kv****\\",\\n \\"Data\\": \\"{ \\\\\\"name\\\\\\": \\\\\\"SparkPi\\\\\\", \\\\\\"file\\\\\\": \\\\\\"local:///tmp/spark-examples.jar\\\\\\", \\\\\\"className\\\\\\": \\\\\\"org.apache.spark.examples.SparkPi\\\\\\", \\\\\\"args\\\\\\": [ \\\\\\"1000000\\\\\\" ], \\\\\\"conf\\\\\\": { \\\\\\"spark.driver.resourceSpec\\\\\\": \\\\\\"small\\\\\\", \\\\\\"spark.executor.instances\\\\\\": 1, \\\\\\"spark.executor.resourceSpec\\\\\\": \\\\\\"small\\\\\\" } }\\",\\n \\"EstimateExecutionCpuTimeInSeconds\\": 100,\\n \\"LastUpdatedTimeInMillis\\": 1651213645200,\\n \\"RunningStartTimeInMillis\\": 36000,\\n \\"LastAttemptId\\": \\"s202204291426hzpre60cfa*****-0003\\",\\n \\"TerminatedTimeInMillis\\": 1651213645300,\\n \\"ResourceProvisioningDurationInMillis\\": 36000,\\n \\"ExecutionDurationInMillis\\": 36000,\\n \\"WebUiAddress\\": \\"https://sparkui.aliyuncs.com/token=xxx\\",\\n \\"SubmittedTimeInMillis\\": 1651213645000,\\n \\"StartedTimeInMillis\\": 1651213645010,\\n \\"AppType\\": \\"BATCH\\",\\n \\"ResourceGroupName\\": \\"spark-rg\\"\\n },\\n \\"DBClusterId\\": \\"amv-23xxxx\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 10\\n 1\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n \\n \\n s202207151211hz0cb4*****\\n Spark Test\\n FAILED\\n WARN: Disk is full\\n \\n { \\"name\\": \\"SparkPi\\", \\"file\\": \\"local:///tmp/spark-examples.jar\\", \\"className\\": \\"org.apache.spark.examples.SparkPi\\", \\"args\\": [ \\"1000000\\" ], \\"conf\\": { \\"spark.driver.resourceSpec\\": \\"small\\", \\"spark.executor.instances\\": 1, \\"spark.executor.resourceSpec\\": \\"small\\" } }\\n 100\\n oss://<bucket-name>/logs/driver\\n s202204291426hzpre60cfa*****-0003\\n https://sparkui.aliyuncs.com/token=xxx\\n 1651213645000\\n 1651213645010\\n 1651213645200\\n 1651213645300\\n amv-bp11q28kv****\\n spark-rg\\n 100\\n \\n \\n 1\\n 10\\n 1\\n \\n","errorExample":""}]', + 'title' => '查询Spark应用列表', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkAppInfo' => [ + 'summary' => '查看Spark应用的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => '应用ID。'."\n" + .'> 您可以调用[ListSparkApps](~~455888~~)接口查询Spark应用的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202205201533hz1209892000****', + 'maxLength' => 64, + 'minLength' => 0, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n\n" + .'> 您可以调用[DescribeDBClusters](~~612397~~)接口查看集群的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'Data' => [ + 'description' => 'Spark应用的信息。返回参数说明：'."\n" + .'- **Data**：Spark应用模板数据。'."\n" + .'- **EstimateExecutionCpuTimeInSeconds**：执行Spark应用消耗CPU的时长，单位毫秒（ms）。'."\n" + .'- **LogRootPath**：日志文件存储路径。'."\n" + .'- **LastAttemptId**：重试ID。'."\n" + .'- **WebUiAddress**：Web UI地址。'."\n" + .'- **SubmittedTimeInMillis**：提交Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **StartedTimeInMillis**：Spark应用的创建时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **LastUpdatedTimeInMillis**：最近一次更新Spark应用的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **TerminatedTimeInMillis**：Spark应用终止执行的时间，Unix时间戳，单位毫秒（ms）。'."\n" + .'- **DBClusterId**：执行Spark应用的集群ID。'."\n" + .'- **ResourceGroupName**：Job型资源组名称。'."\n" + .'- **DurationInMillis**：Spark应用执行耗时，单位毫秒（ms）。', + 'example' => '{ \\"name\\": \\"SparkPi\\", \\"file\\": \\"local:///tmp/spark-examples.jar\\", \\"className\\": \\"org.apache.spark.examples.SparkPi\\", \\"args\\": [ \\"1000000\\" ], \\"conf\\": { \\"spark.driver.resourceSpec\\": \\"small\\", \\"spark.executor.instances\\": 1, \\"spark.executor.resourceSpec\\": \\"small\\" } }",'."\n" + .' "EstimateExecutionCpuTimeInSeconds" : 100,'."\n" + .' "LogRootPath" : "oss://test/logs/driver",'."\n" + .' "LastAttemptId" : "s202204291426hzpre60cfabb0000004-0003",'."\n" + .' "WebUiAddress" : "https://sparkui.aliyuncs.com/token=xxx",'."\n" + .' "SubmittedTimeInMillis" : 1651213645000,'."\n" + .' "StartedTimeInMillis" : 1651213645010,'."\n" + .' "LastUpdatedTimeInMillis" : 1651213645200,'."\n" + .' "TerminatedTimeInMillis" : 1651213645300,'."\n" + .' "DBClusterId" : "am-dbclusterid",'."\n" + .' "ResourceGroupName" : "spark-rg",'."\n" + .' "DurationInMillis" : 100'."\n" + .' }', + '$ref' => '#/components/schemas/SparkAppInfo', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + [ + 'errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', + 'errorMessage' => 'Can\'t load the content from file: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202207151211hz0cb4*****\\",\\n \\"AppName\\": \\"Spark Test\\",\\n \\"Priority\\": \\"NORMAL\\",\\n \\"State\\": \\"FAILED\\",\\n \\"Message\\": \\"WARN: Disk is full\\",\\n \\"Detail\\": {\\n \\"DurationInMillis\\": 100,\\n \\"LogRootPath\\": \\"oss:///logs/driver\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kv****\\",\\n \\"Data\\": \\"{ \\\\\\"name\\\\\\": \\\\\\"SparkPi\\\\\\", \\\\\\"file\\\\\\": \\\\\\"local:///tmp/spark-examples.jar\\\\\\", \\\\\\"className\\\\\\": \\\\\\"org.apache.spark.examples.SparkPi\\\\\\", \\\\\\"args\\\\\\": [ \\\\\\"1000000\\\\\\" ], \\\\\\"conf\\\\\\": { \\\\\\"spark.driver.resourceSpec\\\\\\": \\\\\\"small\\\\\\", \\\\\\"spark.executor.instances\\\\\\": 1, \\\\\\"spark.executor.resourceSpec\\\\\\": \\\\\\"small\\\\\\" } }\\",\\n \\"EstimateExecutionCpuTimeInSeconds\\": 100,\\n \\"LastUpdatedTimeInMillis\\": 1651213645200,\\n \\"RunningStartTimeInMillis\\": 36000,\\n \\"LastAttemptId\\": \\"s202204291426hzpre60cfa*****-0003\\",\\n \\"TerminatedTimeInMillis\\": 1651213645300,\\n \\"ResourceProvisioningDurationInMillis\\": 36000,\\n \\"ExecutionDurationInMillis\\": 36000,\\n \\"WebUiAddress\\": \\"https://sparkui.aliyuncs.com/token=xxx\\",\\n \\"SubmittedTimeInMillis\\": 1651213645000,\\n \\"StartedTimeInMillis\\": 1651213645010,\\n \\"AppType\\": \\"BATCH\\",\\n \\"ResourceGroupName\\": \\"spark-rg\\"\\n },\\n \\"DBClusterId\\": \\"amv-23xxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n \\n s202207151211hz0cb4*****\\n Spark Test\\n FAILED\\n WARN: Disk is full\\n \\n { \\"name\\": \\"SparkPi\\", \\"file\\": \\"local:///tmp/spark-examples.jar\\", \\"className\\": \\"org.apache.spark.examples.SparkPi\\", \\"args\\": [ \\"1000000\\" ], \\"conf\\": { \\"spark.driver.resourceSpec\\": \\"small\\", \\"spark.executor.instances\\": 1, \\"spark.executor.resourceSpec\\": \\"small\\" } }\\n 100\\n oss://<bucket-name>/logs/driver\\n s202204291426hzpre60cfa*****-0003\\n https://sparkui.aliyuncs.com/token=xxx\\n 1651213645000\\n 1651213645010\\n 1651213645200\\n 1651213645300\\n amv-bp11q28kv****\\n spark-rg\\n 100\\n \\n \\n","errorExample":""}]', + 'title' => '查询Spark应用的信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkAppState' => [ + 'summary' => '查询Spark应用的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => '应用ID。'."\n" + .'> 可调用[ListSparkApps](~~455888~~)接口查询Spark应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202204191546hzpread6a896000****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~612397~~)接口查询目标地域中所有集群的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp1h405854m****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 's202204191546hzpread6a896000****', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Message' => [ + 'description' => '返回告警信息，如任务执行失败或资源不足等，无告警时则返回为空。', + 'type' => 'string', + 'example' => 'Insufficient resources.', + ], + 'State' => [ + 'title' => 'spark app的状态', + 'description' => '应用执行状态，取值说明：'."\n" + .'- **SUBMITTED**：已提交。'."\n" + .'- **STARTING**：开始启动。'."\n" + .'- **RUNNING**：执行中。'."\n" + .'- **FAILING**：任务失败，清理环境中。'."\n" + .'- **FAILED**：失败。'."\n" + .'- **KILLING**：中止任务，清理环境中。'."\n" + .'- **KILLED**：中止任务。'."\n" + .'- **SUCCEEDING**：任务执行结束，清理环境中。'."\n" + .'- **COMPLETED**：已完成。'."\n" + .'- **FATAL**：意外失败。'."\n" + .'- **UNKNOWN**：未知错误。', + 'type' => 'string', + 'example' => 'COMPLETED', + ], + 'DBClusterId' => [ + 'title' => '数据库ID', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1h405854m****', + 'default' => 'DB_CLUSTER_ID', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202204191546hzpread6a896000****\\",\\n \\"AppName\\": \\"test\\",\\n \\"Message\\": \\"Insufficient resources.\\",\\n \\"State\\": \\"COMPLETED\\",\\n \\"DBClusterId\\": \\"amv-bp1h405854m****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D65A809F-34CE-4550-9BC1-0ED21ETG380\\n \\n s202204191546hzpread6a896000****\\n test\\n Insufficient resources.\\n COMPLETED\\n \\n","errorExample":""}]', + 'title' => '查询Spark应用的状态', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。、'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'GetSparkAppLog' => [ + 'summary' => '查询Spark应用的日志。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用Id', + 'description' => '应用ID。'."\n" + .'> 调用[ListSparkApps](~~612475~~)接口查询Spark应用的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202206061441hz22a35ab000****', + ], + ], + [ + 'name' => 'LogLength', + 'in' => 'formData', + 'schema' => [ + 'title' => '需要返回的尾部日志行数.', + 'description' => '日志的行数。取值范围为1~500，默认值为300。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '500', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '20', + 'default' => '300', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有集群的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-2ze6fl8ud7t***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '读取日志的偏移量。', + 'description' => '读取日志的页码号。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + 'default' => '100000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C', + ], + 'Data' => [ + 'description' => '日志详情。', + 'type' => 'object', + 'properties' => [ + 'LogContent' => [ + 'title' => 'spark app的日志内容, 如配置了重试则为最后一次重试的尾部日志内容.', + 'description' => '日志内容。', + 'type' => 'string', + 'example' => '22/04/22 15:30:49 INFO Utils: Start the dump task because s202206061441hz22a35ab000****-0001 app end, the interval is 238141ms;22/04/22 15:30:49 INFO AbstractConnector: Stopped Spark@5e774d9d{HTTP/1.1, (http/1.1)}{0.0.0.0:4040}', + ], + 'Message' => [ + 'title' => '额外备注信息', + 'description' => '返回告警信息，如任务执行失败或资源不足等，无告警时则返回为空。', + 'type' => 'string', + 'example' => 'WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-clusterxxx', + ], + 'LogSize' => [ + 'description' => '日志的行数，0代表没有有效日志。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3517972480', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\",\\n \\"Data\\": {\\n \\"LogContent\\": \\"22/04/22 15:30:49 INFO Utils: Start the dump task because s202206061441hz22a35ab000****-0001 app end, the interval is 238141ms;22/04/22 15:30:49 INFO AbstractConnector: Stopped Spark@5e774d9d{HTTP/1.1, (http/1.1)}{0.0.0.0:4040}\\",\\n \\"Message\\": \\"WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/\\",\\n \\"DBClusterId\\": \\"amv-clusterxxx\\",\\n \\"LogSize\\": 3517972480\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\n \\n 22/04/22 15:30:49 INFO Utils: Start the dump task because s202206061441hz22a35ab000****-0001 app end, the interval is 238141ms;22/04/22 15:30:49 INFO AbstractConnector: Stopped Spark@5e774d9d{HTTP/1.1, (http/1.1)}{0.0.0.0:4040}\\n WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/\\n \\n","errorExample":""}]', + 'title' => '查询Spark应用日志', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'SubmitSparkApp' => [ + 'summary' => '提交Spark应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '118686', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => '应用名称，可自定义字符串，长度不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestApp', + ], + ], + [ + 'name' => 'AppType', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的类型, 不填写默认为BATCH 批处理类型', + 'description' => '应用类型，取值说明：'."\n" + .'- **SQL**：SQL应用。'."\n" + .'- **STREAMING**：流应用。'."\n" + .'- **BATCH**（默认值）：离线应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'SQL', + 'default' => 'BATCH', + 'enum' => [], + ], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的配置信息, 定义SQL语句或者执行内容', + 'description' => '应用模板数据。'."\n" + .'> 应用模板配置，请参见[《Spark应用配置指南》](~~452402~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'conf spark.driver.resourceSpec=small; conf spark.executor.instances=1; conf spark.executor.resourceSpec=small; conf spark.app.name=TestApp;', + ], + ], + [ + 'name' => 'AgentSource', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户端类型', + 'description' => '客户端类型。可自定义字符串，长度不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'CONSOLE', + 'default' => 'SDK', + 'enum' => [], + ], + ], + [ + 'name' => 'AgentVersion', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户端版本', + 'description' => '应用程序使用的版本。可自定义字符串，长度不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '1.091', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的id', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口可以查询集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组的名称', + 'description' => 'Job型资源组名称。'."\n" + .'> 您可以调用[DescribeDBResourceGroup](~~612410~~)接口查看集群的资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'adb', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'TemplateFileId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件id', + 'description' => '应用模板ID。'."\n" + .'> 您可以调用[GetSparkTemplateFullTree](~~456205~~)接口可以查询应用模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '15', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '任务列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '数据列表。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'title' => 'Spark App的id', + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 's202204132018hzprec1ac61a000****', + ], + 'AppName' => [ + 'title' => 'spark app的名称', + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'TestApp', + ], + 'Message' => [ + 'title' => '备注信息', + 'description' => '返回告警信息，如任务执行失败或资源不足等，无告警时则返回为空。', + 'type' => 'string', + 'example' => 'Insufficient resources.', + ], + 'State' => [ + 'title' => 'spark app的状态', + 'description' => '应用执行状态，取值说明：'."\n" + .'- **SUBMITTED**：已提交。'."\n" + .'- **STARTING**：开始启动。'."\n" + .'- **RUNNING**：执行中。'."\n" + .'- **FAILING**：任务失败，清理环境中。'."\n" + .'- **FAILED**：失败。'."\n" + .'- **KILLING**：中止任务，清理环境中。'."\n" + .'- **KILLED**：中止任务。'."\n" + .'- **SUCCEEDING**：任务执行结束，清理环境中。'."\n" + .'- **COMPLETED**：任务执行结束。'."\n" + .'- **FATAL**：意外失败。'."\n" + .'- **UNKNOWN**：未知错误。', + 'type' => 'string', + 'example' => 'SUBMITTED', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.RoleARN.invalid', + 'errorMessage' => 'Current account fails to verify the permissions of the RAM system, please check the help information and configure the appropriate permissions for the current account.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202204132018hzprec1ac61a000****\\",\\n \\"AppName\\": \\"TestApp\\",\\n \\"Message\\": \\"Insufficient resources.\\",\\n \\"State\\": \\"SUBMITTED\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n s202204132018hzprec1ac61a000****\\n TestApp\\n Insufficient resources.\\n SUBMITTED\\n \\n","errorExample":""}]', + 'title' => '提交Spark应用', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'KillSparkApp' => [ + 'summary' => '强行停止运行中的Spark作业。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的ID', + 'description' => '需要停止的AppID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202204132018hzprec1ac****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口可以查看集群的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp1ub9grke1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '69D0810B-F9F5-5F4C-A57F-DF36133B63C9', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'title' => 'Spark App的ID', + 'description' => '停止执行的AppID。', + 'type' => 'string', + 'example' => 's202204132018hzprec1ac****', + ], + 'AppName' => [ + 'title' => 'Spark App的名称', + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Message' => [ + 'title' => '特殊注释信息', + 'description' => '分析失败时错误信息。', + 'type' => 'string', + 'example' => '[Advisor] Advisor feature is not available for instance: amv-bp11q28kvl688****', + ], + 'State' => [ + 'title' => 'App的状态信息', + 'description' => '应用执行状态，取值说明：'."\n" + .'- **SUBMITTED**：已提交。'."\n" + .'- **STARTING**：开始启动。'."\n" + .'- **RUNNING**：执行中。'."\n" + .'- **FAILING**：任务失败，清理环境中。'."\n" + .'- **FAILED**：失败。'."\n" + .'- **KILLING**：中止任务，清理环境中。'."\n" + .'- **KILLED**：中止任务。'."\n" + .'- **SUCCEEDING**：任务执行结束，清理环境中。'."\n" + .'- **COMPLETED**：已完成。'."\n" + .'- **FATAL**：意外失败。'."\n" + .'- **UNKNOWN**：未知错误。', + 'type' => 'string', + 'example' => 'KILLED', + ], + 'DBClusterId' => [ + 'title' => '数据库ID', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp11q28kvl688****', + 'default' => 'DB_CLUSTER_ID', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69D0810B-F9F5-5F4C-A57F-DF36133B63C9\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202204132018hzprec1ac****\\",\\n \\"AppName\\": \\"test\\",\\n \\"Message\\": \\"[Advisor] Advisor feature is not available for instance: amv-bp11q28kvl688****\\",\\n \\"State\\": \\"KILLED\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 69D0810B-F9F5-5F4C-A57F-DF36133B63C9\\n \\n s202204132018hzprec1ac****\\n test\\n [Advisor] Advisor feature is not available for instance: amv-bp11q28kvl688****\\n running\\n amv-bp11q28kvl688****\\n \\n","errorExample":""}]', + 'title' => '强行停止运行中的Spark作业', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。'."\n" + .'> 如果华北1（青岛）、华南1（深圳）、华南3（广州）、中国香港发起请求时，遇到409错误，请联系技术支持。', + ], + 'CreateOssSubDirectory' => [ + 'summary' => 'OSS创建子目录。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '125729', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建的子目录的完整OSS路径'."\n", + 'description' => '创建目录的完整OSS路径。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://testBucketName/das_lakehouse', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'>您可以调用[DescribeDBClusters](~~612397~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp149vz49b36t****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应模式。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A0DE2E0-A37B-5EE4-9136-C4C473714802', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ClientCRC' => [ + 'description' => 'Client.CRC校验值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ETag' => [ + 'description' => 'OSS路径的标签。', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A0DE2E0-A37B-5EE4-9136-C4C473714802', + ], + 'ServerCRC' => [ + 'description' => '阿里云OSS Bucket的CRC-64值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3A0DE2E0-A37B-5EE4-9136-C4C473714802\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"ClientCRC\\": 1,\\n \\"ETag\\": \\"1\\",\\n \\"RequestId\\": \\"3A0DE2E0-A37B-5EE4-9136-C4C473714802\\",\\n \\"ServerCRC\\": 1\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 3A0DE2E0-A37B-5EE4-9136-C4C473714802\\n Success\\n 200\\n \\n 1\\n 1\\n 3A0DE2E0-A37B-5EE4-9136-C4C473714802\\n 1\\n \\n true\\n","errorExample":""}]', + 'title' => '创建oss目录', + 'description' => '- 中心的公网接入地址：`adb.aliyuncs.com`。'."\n" + .'- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeViewJobs' => [ + 'summary' => '获取视图任务', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo_db', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。'."\n" + .'类型取值：'."\n" + .'- Asc；'."\n" + .'- Desc；'."\n" + ."\n" + .'域取值：'."\n" + .'- StartTime；'."\n" + .'- EndTime;'."\n" + .'- ScheduledStartTime;', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"Field\\":\\"StartTime\\",\\"Type\\":\\"Desc\\"}', + ], + ], + [ + 'name' => 'FilterViewName', + 'in' => 'query', + 'schema' => [ + 'description' => '视图名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_mv', + ], + ], + [ + 'name' => 'FilterViewType', + 'in' => 'query', + 'schema' => [ + 'description' => '视图类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'-VIRTUAL_VIEW'."\n" + ."\n" + .'-MATERIALIZED_VIEW'."\n" + ."\n\n" + .'默认值：空', + 'type' => 'string', + 'required' => false, + 'example' => 'MATERIALIZED_VIEW', + ], + ], + [ + 'name' => 'FilterOwner', + 'in' => 'query', + 'schema' => [ + 'description' => '所有者。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1ub9grke1****'."\n", + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2A318054-6815-528A-AA94-8AC921******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '44', + ], + 'Data' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '44', + ], + 'MvRefreshJobModels' => [ + 'description' => '刷新任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '刷新任务详情。', + '$ref' => '#/components/schemas/open_struct_RefreshJobModel', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A318054-6815-528A-AA94-8AC921******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 44,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 44,\\n \\"MvRefreshJobModels\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"RefreshModel\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"RefreshInterval\\": \\"\\",\\n \\"Processid\\": \\"\\",\\n \\"ScheduledStartTime\\": \\"\\",\\n \\"SchemaName\\": \\"\\",\\n \\"ResourceGroup\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询物化视图刷新任务列表', + ], + 'DescribeTableDetail' => [ + 'summary' => '调用DescribeTableDetail接口查看表在每个Shard的数据分布情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194789', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '9', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'Shard' => [ + 'description' => '分区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分区列表。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '表大小，行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9484858', + ], + 'Id' => [ + 'description' => '分区号（只返回分区名数字部分）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'AvgSize' => [ + 'description' => '平均分区行数。', + 'type' => 'string', + 'example' => '160', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"9\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Shard\\": [\\n {\\n \\"Size\\": 9484858,\\n \\"Id\\": 1\\n }\\n ]\\n },\\n \\"AvgSize\\": \\"160\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '查询表详情', + ], + 'GetCreateTableSQL' => [ + 'summary' => '查询某个表的建表语句。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212744', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL湖仓版（3.0）集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2ze8mbuai974s4y2', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL支持的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '109462AF-B5FA-3D5A-9377-B27E5B******', + ], + 'SQL' => [ + 'description' => 'SQL语句。', + 'type' => 'string', + 'example' => 'create table ('."\n" + .' id varchar(32)'."\n" + .');', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"109462AF-B5FA-3D5A-9377-B27E5B******\\",\\n \\"SQL\\": \\"create table (\\\\n id varchar(32)\\\\n);\\"\\n}","type":"json"}]', + 'title' => '查询某个表的建表语句', + ], + 'DescribeTableStatistics' => [ + 'summary' => '查看集群的表统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186727', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口可以查询集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-****************', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定字段排序，JSON格式：JSON数组，有序，按顺序输入排列字段和升降序类型：'."\n" + ."\n" + .'如：'."\n" + ."\n" + .'```'."\n" + .'['."\n" + ."\n" + .' {'."\n" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\n" + .' }'."\n" + ."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'其中Field表示需要排序的字段名，目前仅支持对"Name" 字段排序。'."\n" + .'Type表示排序类型 Desc为降序，Asc为升序'."\n" + ."\n" + .'均不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"SchemaName","Type":"Desc"}]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~612393~~)接口可以查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，支持根据表名模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'you_table_name', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '693', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4C4433FF-5D3A-4C3E-A19C-6D93B2******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-****************', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TableStatisticRecords' => [ + 'description' => '表统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表统计信息详情。', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_schema', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test_table', + ], + 'RowCount' => [ + 'description' => '表行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'DataSize' => [ + 'description' => '表数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15592', + ], + 'IndexSize' => [ + 'description' => '索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3076', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => '主键索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16340', + ], + 'PartitionCount' => [ + 'description' => '分区数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ColdDataSize' => [ + 'description' => '冷数据总量，单位：byte。'."\n" + .'>3.1.3.4及以上内核版本的集群支持该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4428120064', + ], + 'SpaceRatio' => [ + 'description' => '表空间占比，单位：%。'."\n" + ."\n" + .'> 计算公式为：表空间占比 = (表总数据量 / 实例总数据量) * 100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '66.23', + ], + 'TotalSize' => [ + 'description' => '总数据量，单位：Byte。'."\n" + ."\n" + .'> 总数据量的计算，以下2个公式都成立。'."\n" + ."\n" + .'- 公式1：总数据量 = 热数据量 + 冷数据量。'."\n" + .'- 公式2：总数据量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1577', + ], + 'HotDataSize' => [ + 'description' => '热数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'OtherSize' => [ + 'description' => '其他，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + ], + ], + ], + ], + ], + 'SchemaNames' => [ + 'description' => '数据库名列表。', + 'type' => 'string', + 'example' => '[\'adb_platform\', \'adb_ai\', \'adb_data\']', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"693\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"4C4433FF-5D3A-4C3E-A19C-6D93B2******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-****************\\",\\n \\"Items\\": {\\n \\"TableStatisticRecords\\": [\\n {\\n \\"SchemaName\\": \\"test_schema\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"RowCount\\": 3,\\n \\"DataSize\\": 15592,\\n \\"IndexSize\\": 3076,\\n \\"PrimaryKeyIndexSize\\": 16340,\\n \\"PartitionCount\\": 1,\\n \\"ColdDataSize\\": 4428120064,\\n \\"SpaceRatio\\": 66.23,\\n \\"TotalSize\\": 1577,\\n \\"HotDataSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n }\\n ]\\n },\\n \\"SchemaNames\\": \\"[\'adb_platform\', \'adb_ai\', \'adb_data\']\\"\\n}","type":"json"}]', + 'title' => '查看表统计信息', + ], + 'DescribeAdbMySqlTableMeta' => [ + 'summary' => '用于查看表元数据信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'AnalyticDB MySQL湖仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL湖仓版集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标表名。'."\n" + .'> 若该参数留空，则会返回当前日期内目标集群下所有表的使用频次数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TableMeta' => [ + 'description' => '表元数据信息', + 'type' => 'object', + 'properties' => [ + 'TableSchema' => [ + 'description' => '表所属的数据库。', + 'type' => 'string', + 'example' => 'tpch', + ], + 'TableName' => [ + 'description' => '目标表名。'."\n" + .'> 若该参数留空，则会返回当前日期内目标集群下所有表的使用频次数据。', + 'type' => 'string', + 'example' => 'external_supplier', + ], + 'TableType' => [ + 'description' => '表类型。', + 'type' => 'string', + 'example' => 'fact_table', + ], + 'DistributeType' => [ + 'description' => '分布类型。', + 'type' => 'string', + 'example' => 'hash', + ], + 'DistributeColumn' => [ + 'description' => '分布键列。', + 'type' => 'string', + 'example' => 'customer_id', + ], + 'PartitionType' => [ + 'description' => '分区类型。', + 'type' => 'string', + 'example' => 'value', + ], + 'PartitionColumn' => [ + 'description' => '分区列信息。', + 'type' => 'string', + 'example' => 'DATE_FORMAT(login_time, \'%Y%m%d\')', + ], + 'PrimaryKeyColumn' => [ + 'description' => '主键列。', + 'type' => 'string', + 'example' => 'login_time,customer_id,phone_num', + ], + 'TableEngine' => [ + 'description' => '表引擎。', + 'type' => 'string', + 'example' => 'XUANWU', + ], + 'IsDictEncode' => [ + 'description' => '是否字典编码。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsHidden' => [ + 'description' => '表示页面是否隐藏。'."\n" + .'- **false**：否。'."\n" + .'- **true**：是。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsAllIndex' => [ + 'description' => '是否是全索引。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsFullTextDict' => [ + 'description' => '是否全文索引。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-03-14 02:18:08.0', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-07-25 02:07:23.0', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Success\\": true,\\n \\"TableMeta\\": {\\n \\"TableSchema\\": \\"tpch\\",\\n \\"TableName\\": \\"external_supplier\\",\\n \\"TableType\\": \\"fact_table\\",\\n \\"DistributeType\\": \\"hash\\",\\n \\"DistributeColumn\\": \\"customer_id\\",\\n \\"PartitionType\\": \\"value\\",\\n \\"PartitionColumn\\": \\"DATE_FORMAT(login_time, \'%Y%m%d\')\\",\\n \\"PrimaryKeyColumn\\": \\"login_time,customer_id,phone_num\\",\\n \\"TableEngine\\": \\"XUANWU\\",\\n \\"IsDictEncode\\": true,\\n \\"IsHidden\\": true,\\n \\"IsAllIndex\\": false,\\n \\"IsFullTextDict\\": true,\\n \\"CreateTime\\": \\"2025-03-14 02:18:08.0\\",\\n \\"UpdateTime\\": \\"2024-07-25 02:07:23.0\\"\\n }\\n}","type":"json"}]', + 'title' => '查看表元数据信息', + ], + 'DescribeAdbMySqlIndexes' => [ + 'summary' => '用于查看表索引信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。'."\n" + .'> 您可以调用 [DescribeRegions](~~612393~~) 接口查看集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'tpch_oss', + 'default' => 'INFORMATION_SCHEMA', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标表名。'."\n" + .'> 若该参数留空，则会返回当前日期内目标集群下所有表的使用频次数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'orders', + 'default' => 'COLUMNS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID，阿里云为该请求生成的标识符。', + 'type' => 'string', + 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Schema' => [ + 'description' => '数据库名。 '."\n" + ."\n" + .'>
如填写，后续迁移或同步操作，只会针对该数据库操作。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'IndexCount' => [ + 'description' => '索引个数（索引缺失表目前所拥有的索引个数）筛选条件。输入格式为`运算符+分割服“”+索引个数`，例如`>=100`。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Indexes' => [ + 'description' => '索引列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '索引类型。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Name' => [ + 'description' => '索引名。', + 'type' => 'string', + 'example' => 'ttl', + ], + 'Column' => [ + 'description' => '列名称。', + 'type' => 'string', + 'example' => 'preclcu', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\",\\n \\"Success\\": true,\\n \\"Schema\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test\\",\\n \\"IndexCount\\": 10,\\n \\"Indexes\\": [\\n {\\n \\"Type\\": \\"normal\\",\\n \\"Name\\": \\"ttl\\",\\n \\"Column\\": \\"preclcu\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看表索引信息', + ], + 'DescribeMvRecommendSubTasks' => [ + 'summary' => '查看物化视图子任务', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '物化视图推荐任务的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_task_1', + ], + ], + [ + 'name' => 'SubtaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '子任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。'."\n" + .'类型取值：'."\n" + .'- Asc；'."\n" + .'- Desc；'."\n" + ."\n" + .'域取值：'."\n" + .'- StartTime;'."\n" + .'- EndTime;', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"Type\\": \\"ASC\\", \\"Field\\": \\"StartTime\\"}', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '固定值，不支持修改。', + 'type' => 'string', + 'required' => false, + 'example' => '不支持修改', + ], + ], + [ + 'name' => 'ActionInner', + 'in' => 'query', + 'schema' => [ + 'description' => '固定值，不支持修改。', + 'type' => 'string', + 'required' => false, + 'example' => '不支持修改', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'MvRecommendSubTaskModels' => [ + 'description' => '物化视图推荐任务执行列表。', + 'type' => 'array', + 'items' => [ + 'description' => '物化视图推荐任务执行详情。', + '$ref' => '#/components/schemas/open_struct_MvRecommendSubTaskModel', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 4,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 4,\\n \\"MvRecommendSubTaskModels\\": [\\n {\\n \\"SubQueriesCount\\": 0,\\n \\"Status\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"SubtaskId\\": 0,\\n \\"ScanQueriesCount\\": 0,\\n \\"MinRewriteQueryCount\\": 0,\\n \\"MinRewriteQueryPattern\\": 0,\\n \\"SlowQueryThreshold\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询物化视图推荐任务执行列表', + ], + 'DescribeMVRecommendResults' => [ + 'summary' => '查询物化视图推荐任务结果。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SubtaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '子任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '推荐任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'task_n1', + ], + ], + [ + 'name' => 'SubQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => '子查询ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '固定值，不支持修改。', + 'type' => 'string', + 'required' => false, + 'example' => '不支持修改', + ], + ], + [ + 'name' => 'ActionInner', + 'in' => 'query', + 'schema' => [ + 'description' => '固定值，不支持修改。', + 'type' => 'string', + 'required' => false, + 'example' => '不支持修改', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Type": "Desc","Field": "AcceleratedQueriesCount"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MvRecommendResultModels' => [ + 'description' => '物化视图推荐结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '推荐结果详情', + '$ref' => '#/components/schemas/open_struct_MVRecommendResultModel', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 20,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"MvRecommendResultModels\\": [\\n {\\n \\"BaseTables\\": [\\n {\\n \\"TableName\\": \\"\\",\\n \\"DataVolumn\\": \\"\\",\\n \\"EnableBinlog\\": true,\\n \\"SchemaName\\": \\"\\"\\n }\\n ],\\n \\"AcceleratedQueriesCount\\": 0,\\n \\"SupportIncrementalRefresh\\": true,\\n \\"SubqueryId\\": 0,\\n \\"SavedScanbytes\\": 0,\\n \\"Subquery\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询物化视图推荐结果列表', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeMvRecommendTasks' => [ + 'summary' => '查看物化视图推荐任务', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '物化视图推荐任务的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_task_1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '固定值，不支持修改。', + 'type' => 'string', + 'required' => false, + 'example' => '不支持修改', + ], + ], + [ + 'name' => 'ActionInner', + 'in' => 'query', + 'schema' => [ + 'description' => '固定值，不支持修改。', + 'type' => 'string', + 'required' => false, + 'example' => '不支持修改', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'MvRecommendTaskModels' => [ + 'description' => '物化视图推荐任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '物化视图推荐任务详情。', + '$ref' => '#/components/schemas/open_struct_MvRecommendTaskModel', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 4,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 4,\\n \\"MvRecommendTaskModels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"CreatedTime\\": \\"\\",\\n \\"LastRunAt\\": \\"\\",\\n \\"TaskName\\": \\"\\",\\n \\"ScanQueriesRange\\": 0,\\n \\"SchedulingSettings\\": \\"\\",\\n \\"MinRewriteQueryCount\\": 0,\\n \\"MinRewriteQueryPattern\\": 0,\\n \\"SlowQueryThreshold\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询物化视图推荐任务列表', + ], + 'CreateMaterializedViewRecommend' => [ + 'summary' => '创建物化视图自动推荐任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-8vbwm***', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务名称', + 'description' => '推荐任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'task_n1', + ], + ], + [ + 'name' => 'SchedulingPolicy', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐的策略，取值"daliy"或"weekly"', + 'description' => '推荐的策略，取值如下：'."\n" + ."\n" + .'daily：按日调度。'."\n" + ."\n" + .'weekly：按周调度。', + 'type' => 'string', + 'required' => true, + 'example' => 'weekly', + 'enum' => [ + 'daily', + 'weekly', + ], + ], + ], + [ + 'name' => 'SchedulingDay', + 'in' => 'query', + 'schema' => [ + 'title' => '仅当SchedulingPolicy取值为weekly时有效，取值为：Monday|Tuesday|Wendesday|Thursday|Friday|Saturday|Sunday，多天以逗号分隔符拼接', + 'description' => '仅当SchedulingPolicy取值为weekly时有效，取值如下：'."\n" + ."\n" + .'- Monday'."\n" + .'- Tuesday'."\n" + .'- Wednesday'."\n" + .'- Thursday'."\n" + .'- Friday'."\n" + .'- Saturday'."\n" + .'- Sunday'."\n" + ."\n" + .'多天以逗号分隔符拼接。', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday;Wednesday', + ], + ], + [ + 'name' => 'SpecifiedTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务的执行时间，格式HH:MM:SS', + 'description' => '任务的执行时间，格式HH:MM:SS。', + 'type' => 'string', + 'required' => true, + 'example' => '10:00:00', + ], + ], + [ + 'name' => 'ScanQueriesRange', + 'in' => 'query', + 'schema' => [ + 'title' => '扫描的时间范围，单位天，默认取值3', + 'description' => '扫描的时间范围，单位天，默认取值3。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务的描述', + 'description' => '推荐任务的描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'task desc', + ], + ], + [ + 'name' => 'SlowQueryThreshold', + 'in' => 'query', + 'schema' => [ + 'title' => '慢查询阈值', + 'description' => '慢查询阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'MinRewriteQueryPattern', + 'in' => 'query', + 'schema' => [ + 'title' => '最小可加速的Pattern数量', + 'description' => '最小可加速的Pattern数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '5', + ], + ], + [ + 'name' => 'MinRewriteQueryCount', + 'in' => 'query', + 'schema' => [ + 'title' => 'Pattern匹配的最少慢查询个数', + 'description' => 'Pattern匹配的最少慢查询个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '创建物化视图自动推荐任务', + ], + 'ModifyMaterializedView' => [ + 'summary' => '修改物化视图。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ADB实例ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-******', + ], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'title' => '物化视图名称', + 'description' => '物化视图名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'mv_1', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'title' => '物化视图所在DB名', + 'description' => '物化视图所在数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myDB', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '物化视图绑定的资源组名称', + 'description' => '物化视图绑定的资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'res_1', + ], + ], + [ + 'name' => 'QueryWrite', + 'in' => 'query', + 'schema' => [ + 'title' => '启用/禁用重写功能', + 'description' => '是否开启重写功能。取值如下： '."\n" + .'- true：是。 '."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableFailureAlert', + 'in' => 'query', + 'schema' => [ + 'title' => '开启刷新任务失败告警', + 'description' => '开启刷新任务失败告警。取值如下：'."\n" + ."\n" + .'- true：是。 '."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'EnableDelayAlert', + 'in' => 'query', + 'schema' => [ + 'title' => '开启刷新延迟告警', + 'description' => '开启刷新延迟告警。取值如下：'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'LatencyTolerance', + 'in' => 'query', + 'schema' => [ + 'title' => '刷新延迟容忍度（分钟）', + 'description' => '刷新延迟容忍度（分钟）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CF8BA882-C9D8-5BEF-AAA3-AD03875F3E18', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF8BA882-C9D8-5BEF-AAA3-AD03875F3E18\\"\\n}","type":"json"}]', + 'title' => '修改物化视图', + ], + 'ModifyMaterializedViewRecommend' => [ + 'summary' => '修改物化视图自动推荐任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf6o*****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务名称', + 'description' => '物化视图推荐任务的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'task_n1', + ], + ], + [ + 'name' => 'SchedulingPolicy', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐的策略，取值"daliy"或"weekly"', + 'description' => '推荐的策略。取值如下： '."\n" + .'- daliy：按日调度。'."\n" + .'- weekly：按周调度。', + 'type' => 'string', + 'required' => false, + 'example' => 'weekly', + 'enum' => [ + 'daily', + 'weekly', + ], + ], + ], + [ + 'name' => 'SchedulingDay', + 'in' => 'query', + 'schema' => [ + 'title' => '仅当SchedulingPolicy取值为weekly时有效，取值为：Monday|Tuesday|Wendesday|Thursday|Friday|Saturday|Sunday，多天以逗号分隔符拼接', + 'description' => '仅当SchedulingPolicy取值为weekly时有效，取值如下：'."\n" + .'- Monday'."\n" + .'- Tuesday'."\n" + .'- Wednesday'."\n" + .'- Thursday'."\n" + .'- Friday'."\n" + .'- Saturday'."\n" + .'- Sunday'."\n" + ."\n" + .'多天以逗号分隔符拼接。', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday;Wednesday', + ], + ], + [ + 'name' => 'SpecifiedTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务的执行时间，格式HH:MM:SS', + 'description' => '任务的执行时间，格式HH:MM:SS。', + 'type' => 'string', + 'required' => false, + 'example' => '10:00:00', + ], + ], + [ + 'name' => 'ScanQueriesRange', + 'in' => 'query', + 'schema' => [ + 'title' => '扫描的时间范围，单位天，默认取值3', + 'description' => '扫描的时间范围，单位天，默认取值3。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务的描述', + 'description' => '推荐任务的描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'task desc', + ], + ], + [ + 'name' => 'SlowQueryThreshold', + 'in' => 'query', + 'schema' => [ + 'title' => '慢查询阈值', + 'description' => '慢查询阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'MinRewriteQueryPattern', + 'in' => 'query', + 'schema' => [ + 'title' => '最小可加速的Pattern数量', + 'description' => '最小可加速的Pattern数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '5', + ], + ], + [ + 'name' => 'MinRewriteQueryCount', + 'in' => 'query', + 'schema' => [ + 'title' => 'Pattern匹配的最少慢查询个数', + 'description' => 'Pattern匹配的最少慢查询个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\"\\n}","type":"json"}]', + 'title' => '修改物化视图自动推荐任务', + ], + 'DeleteMaterializedViewRecommend' => [ + 'summary' => '删除物化视图自动推荐任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf66*****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务名称', + 'description' => '物化视图推荐任务的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'my_task_1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7B081A85-0568-5E54-82EF-6958C4A3D4B4', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B081A85-0568-5E54-82EF-6958C4A3D4B4\\"\\n}","type":"json"}]', + 'title' => '删除物化视图自动推荐任务', + ], + 'DescribeInclinedTables' => [ + 'summary' => '查看集群表倾斜信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186716', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下AnalyticDB MySQL湖仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-k2jofo4pi5zhd****', + ], + ], + [ + 'name' => 'TableType', + 'in' => 'query', + 'schema' => [ + 'description' => '表类型，取值说明：'."\n" + .'- **FactTable**：分区表。'."\n" + .'- **DimensionTable**：维度表。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'FactTable', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定字段排序，json格式：JSON数组，有序，按顺序输入排列字段和升降序类型：'."\n" + ."\n" + .'如：'."\n" + ."\n" + .'```'."\n" + .'['."\n" + ."\n" + .' {'."\n" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\n" + .' }'."\n" + ."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'其中Field表示需要排序的字段名，目前仅支持对"Name" 字段排序。'."\n" + .'Type表示排序类型 Desc为降序，Asc为升序'."\n" + ."\n" + .'均不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Field":"Name", "Type":"Asc" } ]', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）。'."\n" + .'- **50**。'."\n" + .'- **100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过integer数据类型的最大值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL支持的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hongkong', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置建议的显示语言，取值说明：'."\n" + .'- **zh（默认值）**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '15', + ], + 'PageSize' => [ + 'description' => '总页数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码，取值为大于0且不超过integer数据类型的最大值。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => '表列表。', + 'type' => 'object', + 'properties' => [ + 'Table' => [ + 'description' => '表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表列表信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '倾斜表检测类型。', + 'type' => 'string', + 'example' => 'Fact', + ], + 'Schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'spark_test', + ], + 'Size' => [ + 'description' => '表大小，行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Name' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'admin_daily_own_statistic_record', + ], + 'IsIncline' => [ + 'description' => '是否倾斜。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'TotalSize' => [ + 'description' => '总数据量，单位：Byte。'."\n" + ."\n" + .'> 总数据量的计算，以下2个公式都成立。'."\n" + ."\n" + .'- 公式1：'."\n" + .'总数据量= 热数据量 + 冷数据量。'."\n" + ."\n" + .'- 公式2：总数据量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '53687091200', + ], + 'SpaceRatio' => [ + 'description' => '表空间占比，单位：%。'."\n" + ."\n" + .'> 计算公式为：表空间占比 = (表总数据量 / 实例总数据量) * 100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.4', + ], + 'RowCount' => [ + 'description' => '表行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '具体检测结果。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => '表倾斜', + ], + 'Message' => [ + 'description' => '检测结果消息。', + 'type' => 'string', + 'example' => '检测到有表存在shard倾斜', + ], + 'Status' => [ + 'description' => '检测结果状态。', + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNNING'."\n" + .'CRITICAL', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有Ram校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"15\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Table\\": [\\n {\\n \\"Type\\": \\"Fact\\",\\n \\"Schema\\": \\"spark_test\\",\\n \\"Size\\": 200,\\n \\"Name\\": \\"admin_daily_own_statistic_record\\",\\n \\"IsIncline\\": true,\\n \\"TotalSize\\": 53687091200,\\n \\"SpaceRatio\\": 0.4,\\n \\"RowCount\\": 1000\\n }\\n ]\\n },\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"表倾斜\\",\\n \\"Message\\": \\"检测到有表存在shard倾斜\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNNING\\\\nCRITICAL\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '查看表监控', + ], + 'DescribeAdbMySqlColumns' => [ + 'summary' => '查询集群指定表的列信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + 'default' => 'INFORMATION_SCHEMA', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'default' => 'COLUMNS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A9F013CD-0222-595E-8157-445969B97F03', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'TableName' => [ + 'description' => "\n" + .'表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'ColumnCount' => [ + 'description' => '总列数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Columns' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列的数据类型。', + 'type' => 'string', + 'example' => 'bigint', + ], + 'Name' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'id', + ], + 'Comment' => [ + 'description' => '列注释。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A9F013CD-0222-595E-8157-445969B97F03\\",\\n \\"Success\\": true,\\n \\"Schema\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnCount\\": 1,\\n \\"Columns\\": [\\n {\\n \\"Type\\": \\"bigint\\",\\n \\"Name\\": \\"id\\",\\n \\"Comment\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n A9F013CD-0222-595E-8157-445969B97F03\\n true\\n adb_demo\\n test\\n 1\\n \\n bigint\\n id\\n test\\n \\n","errorExample":""}]', + 'title' => '查询表的列信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeAdbMySqlTables' => [ + 'summary' => '枚举集群指定数据库下所有表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + 'default' => 'INFORMATION_SCHEMA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7A7D49E3-5585-5DF8-B62C-75C46B4991DC', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'Tables' => [ + 'description' => '表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"7A7D49E3-5585-5DF8-B62C-75C46B4991DC\\",\\n \\"Success\\": true,\\n \\"Schema\\": \\"adb_demo\\",\\n \\"Tables\\": [\\n \\"test\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n 7A7D49E3-5585-5DF8-B62C-75C46B4991DC\\n true\\n adb_demo\\n test\\n","errorExample":""}]', + 'title' => '查询数据库下所有表信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeAdbMySqlSchemas' => [ + 'summary' => '枚举指定集群下所有数据库列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Schemas' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo,adb_test,mysql', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Schemas\\": [\\n \\"adb_demo,adb_test,mysql\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n true\\n adb_demo,adb_test,mysql\\n","errorExample":""}]', + 'title' => '查询所有数据库列表', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeTableAccessCount' => [ + 'summary' => '查看指定日期内集群下目标表或所有表被访问次数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2ze627uzpkh8a8****', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标表名。'."\n" + .'> 若该参数留空，则会返回当前日期内目标集群下所有表的使用频次数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'CUSTOMER', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 仅支持查看30天内的数据。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-09-25T12:10:00Z', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JOSN字符串，例如`[{"Field":"TableSchema","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `TableSchema`：表所属的数据库名。'."\n" + .' - `TableName`：表名。'."\n" + .' - `AccessCount`：表被访问的次数。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照目标表所属的数据库升序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"TableSchema","Type":"Asc"}]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **10**（默认值）'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6B7D627B-DA23-572D-AD71-256F64698B7D', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '表使用详情。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'ReportDate' => [ + 'description' => '表使用日期。', + 'type' => 'string', + 'example' => '2022-09-26', + ], + 'TableSchema' => [ + 'description' => '表所属的数据库。', + 'type' => 'string', + 'example' => 'tpch', + ], + 'AccessCount' => [ + 'description' => '表被访问的次数。', + 'type' => 'string', + 'example' => '6', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'CUSTOMER', + ], + 'InstanceName' => [ + 'description' => '表所属集群的集群ID。', + 'type' => 'string', + 'example' => 'amv-2ze627uzpkh8a8****', + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6B7D627B-DA23-572D-AD71-256F64698B7D\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"ReportDate\\": \\"2022-09-26\\",\\n \\"TableSchema\\": \\"tpch\\",\\n \\"AccessCount\\": \\"6\\",\\n \\"TableName\\": \\"CUSTOMER\\",\\n \\"InstanceName\\": \\"amv-2ze627uzpkh8a8****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 6B7D627B-DA23-572D-AD71-256F64698B7D\\n 1\\n 30\\n 1\\n \\n 2022-09-26\\n tpch\\n 6\\n CUSTOMER\\n amv-2ze627uzpkh8a8****\\n \\n","errorExample":""}]', + 'title' => '查询表的访问次数', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'GetViewDDL' => [ + 'summary' => '查询视图的创建语句。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157089', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => '视图名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'v_modbus', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', + ], + 'SQL' => [ + 'description' => 'SQL语句详情。', + 'type' => 'string', + 'example' => 'CREATE VIEW `test`.`test_view` AS SELECT'."\n" + .' `id`'."\n" + .', `name`'."\n" + .'FROM'."\n" + .' `test_tbl_adb`', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"SQL\\": \\"CREATE VIEW `test`.`test_view` AS SELECT\\\\n `id`\\\\n, `name`\\\\nFROM\\\\n `test_tbl_adb`\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 421794A3-72A5-5D27-9E8B-A75A4C503E17\\n CREATE VIEW `test`.`test_view` AS SELECT\\n `id`\\n, `name`\\nFROM\\n `test_tbl_adb`\\n","errorExample":""}]', + 'title' => '查询视图的创建语句', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'GetViewObjects' => [ + 'summary' => '查询视图信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157080', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。'."\n" + .'类型取值：'."\n" + .'- Asc；'."\n" + .'- Desc；'."\n" + ."\n" + .'域取值：'."\n" + .'-ViewName；'."\n" + ."\n" + .'-CreateTime;'."\n" + ."\n" + .'-UpdateTime;'."\n" + ."\n" + .'默认值：{"Type": "Desc","Field": "ViewName"}；', + 'type' => 'string', + 'required' => false, + 'example' => '{"Type": "Desc","Field": "ViewName"}', + ], + ], + [ + 'name' => 'FilterViewName', + 'in' => 'query', + 'schema' => [ + 'description' => '视图名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_filter', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'FilterViewType', + 'in' => 'query', + 'schema' => [ + 'description' => '视图类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'-VIRTUAL_VIEW'."\n" + ."\n" + .'-MATERIALIZED_VIEW'."\n" + ."\n\n" + .'默认值：空', + 'type' => 'string', + 'required' => false, + 'example' => 'VIRTUAL_VIEW', + ], + ], + [ + 'name' => 'FilterOwner', + 'in' => 'query', + 'schema' => [ + 'description' => '所有者。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ShowMvBaseTable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否展示物化视图基表信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型最大值的正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型最大值的正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TableSummaryModels' => [ + 'description' => '结果数组。', + 'type' => 'array', + 'items' => [ + 'description' => '视图概要信息。', + '$ref' => '#/components/schemas/TableSummaryModel', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"TableSummaryModels\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"TableSize\\": 0,\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"SQL\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"MvDetailModel\\": {\\n \\"FirstRefreshTime\\": \\"\\",\\n \\"QueryRewriteEnabled\\": true,\\n \\"ExplicitHit\\": 0,\\n \\"IsInactive\\": true,\\n \\"RemoteSize\\": 0,\\n \\"LocalSize\\": 0,\\n \\"RefreshState\\": \\"\\",\\n \\"RefreshInterval\\": \\"\\",\\n \\"ImplicitHit\\": 0,\\n \\"UpdatedAt\\": \\"\\",\\n \\"ResourceGroup\\": \\"\\",\\n \\"BaseTableInfos\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"BaseTableIsMv\\": true,\\n \\"TableEngine\\": \\"\\"\\n }\\n ],\\n \\"TableEngine\\": \\"\\",\\n \\"BaseTableNames\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"EnableDelayAlert\\": 0,\\n \\"EnableFailureAlert\\": 0,\\n \\"LatencyTolerance\\": 0\\n },\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n 1\\n 30\\n 1\\n \\n 1\\n 30\\n 1\\n \\n \\n","errorExample":""}]', + 'title' => '查询视图信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'GetDatabaseObjects' => [ + 'summary' => '查询数据库信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。'."\n" + .'类型取值：'."\n" + .'- Asc；'."\n" + .'- Desc；'."\n" + ."\n" + .'域取值：'."\n" + .'-DatabseName；'."\n" + .'-CreateTime;'."\n" + .'-UpdateTime;'."\n" + ."\n" + .'默认值：{"Type": "Desc","Field": "DatabaseName"}；', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Type": "Desc",'."\n" + .' "Field": "DatabaseName"'."\n" + .'}', + ], + ], + [ + 'name' => 'FilterSchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- 30；'."\n" + .'- 50；'."\n" + .'- 100；'."\n" + ."\n" + .'默认值：30。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1565u55p32****', + ], + ], + [ + 'name' => 'FilterOwner', + 'in' => 'query', + 'schema' => [ + 'description' => '所有者。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '863D51B7-5321-41D8-A0B6-A088B0******', + ], + 'PageNumber' => [ + 'description' => '页码，取值为正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DatabaseSummaryModels' => [ + 'description' => '结果数组。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库概要信息。', + '$ref' => '#/components/schemas/DatabaseSummaryModel', + ], + ], + 'PageNumber' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- 30；'."\n" + .'- 50；'."\n" + .'- 100；'."\n" + ."\n" + .'默认值：30。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Data\\": {\\n \\"DatabaseSummaryModels\\": [\\n {\\n \\"Owner\\": \\"\\",\\n \\"SchemaName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\",\\n \\"DbType\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 863D51B7-5321-41D8-A0B6-A088B0******\\n 1\\n 30\\n 1\\n \\n \\n 1\\n 30\\n 1\\n \\n","errorExample":""}]', + 'title' => '查询数据库信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'GetTable' => [ + 'summary' => '获取表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '160312', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'dbName', + 'default' => 'MYSQL', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '查询表名。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'tableName', + 'default' => 'USER', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '""', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Table' => [ + 'description' => '表详细信息。', + '$ref' => '#/components/schemas/TableModel', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"TblId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"MappedName\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"PkPosition\\": 0,\\n \\"IsPartitionKey\\": true,\\n \\"OrdinalPosition\\": 0,\\n \\"ColumnRawName\\": \\"\\",\\n \\"PhysicalColumnName\\": \\"\\",\\n \\"Nullable\\": true,\\n \\"AutoIncrement\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"Primarykey\\": true,\\n \\"DefaultValue\\": \\"\\",\\n \\"Tokenizer\\": \\"\\",\\n \\"Encode\\": \\"\\",\\n \\"Compression\\": \\"\\",\\n \\"Delimiter\\": \\"\\",\\n \\"ValueType\\": \\"\\",\\n \\"CompressFloatUseShort\\": true,\\n \\"OnUpdate\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Sd\\": {\\n \\"SdId\\": 0,\\n \\"Location\\": \\"\\",\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Compressed\\": true,\\n \\"NumBuckets\\": 0,\\n \\"SerDeInfo\\": {\\n \\"SerDeId\\": 0,\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"CreateTime\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"Comment\\": \\"\\",\\n \\"Cols\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"MappedName\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"PkPosition\\": 0,\\n \\"IsPartitionKey\\": true,\\n \\"OrdinalPosition\\": 0,\\n \\"ColumnRawName\\": \\"\\",\\n \\"PhysicalColumnName\\": \\"\\",\\n \\"Nullable\\": true,\\n \\"AutoIncrement\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"Primarykey\\": true,\\n \\"DefaultValue\\": \\"\\",\\n \\"Tokenizer\\": \\"\\",\\n \\"Encode\\": \\"\\",\\n \\"Compression\\": \\"\\",\\n \\"Delimiter\\": \\"\\",\\n \\"ValueType\\": \\"\\",\\n \\"CompressFloatUseShort\\": true,\\n \\"OnUpdate\\": \\"\\"\\n }\\n ],\\n \\"DistributeColumns\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"MappedName\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"PkPosition\\": 0,\\n \\"IsPartitionKey\\": true,\\n \\"OrdinalPosition\\": 0,\\n \\"ColumnRawName\\": \\"\\",\\n \\"PhysicalColumnName\\": \\"\\",\\n \\"Nullable\\": true,\\n \\"AutoIncrement\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"Primarykey\\": true,\\n \\"DefaultValue\\": \\"\\",\\n \\"Tokenizer\\": \\"\\",\\n \\"Encode\\": \\"\\",\\n \\"Compression\\": \\"\\",\\n \\"Delimiter\\": \\"\\",\\n \\"ValueType\\": \\"\\",\\n \\"CompressFloatUseShort\\": true,\\n \\"OnUpdate\\": \\"\\"\\n }\\n ],\\n \\"PhysicalTableName\\": \\"\\",\\n \\"PhysicalDatabaseName\\": \\"\\",\\n \\"DistributeType\\": \\"\\",\\n \\"PartitionType\\": \\"\\",\\n \\"PartitionColumn\\": \\"\\",\\n \\"PartitionCount\\": 0,\\n \\"PreviousVersion\\": 0,\\n \\"CurrentVersion\\": 0,\\n \\"UpdateTime\\": \\"\\",\\n \\"TableEngineName\\": \\"\\",\\n \\"IsAllIndex\\": true,\\n \\"BlockSize\\": 0,\\n \\"Compression\\": \\"\\",\\n \\"RawTableName\\": \\"\\",\\n \\"SubpartitionType\\": \\"\\",\\n \\"SubpartitionColumn\\": \\"\\",\\n \\"SubpartitionCount\\": 0,\\n \\"ArchiveType\\": \\"\\",\\n \\"MaxColumnId\\": 0,\\n \\"EnableDfs\\": true,\\n \\"StoragePolicy\\": \\"\\",\\n \\"HotPartitionCount\\": 0,\\n \\"IsFulltextDict\\": true,\\n \\"RtIndexAll\\": true,\\n \\"RouteColumns\\": [],\\n \\"RtEngineType\\": \\"\\",\\n \\"RtModeType\\": \\"\\",\\n \\"RouteType\\": \\"\\",\\n \\"DictEncode\\": true,\\n \\"BucketCount\\": 0,\\n \\"Bucket\\": 0,\\n \\"ViewSecurityMode\\": \\"\\",\\n \\"Indexes\\": [\\n {\\n \\"DatabaseName\\": \\"\\",\\n \\"PhysicalTableName\\": \\"\\",\\n \\"IndexName\\": \\"\\",\\n \\"IndexType\\": \\"\\",\\n \\"IndexColumns\\": [],\\n \\"ColumnOrds\\": [\\n \\"\\"\\n ],\\n \\"Options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\"\\n }\\n ],\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n 0\\n \\"\\"\\n true\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n
\\n","errorExample":""}]', + 'title' => '查询表信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'GetTableColumns' => [ + 'summary' => '查询列信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157085', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ColumnName', + 'in' => 'query', + 'schema' => [ + 'description' => '列名。', + 'type' => 'string', + 'required' => false, + 'example' => 'assist_user_phone', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '结果中数据的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '结果中数据的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'Table' => [ + 'description' => '表的详细信息。', + '$ref' => '#/components/schemas/TableDetailModel', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 15,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 15,\\n \\"Table\\": {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"PartitionKey\\": true,\\n \\"Nullable\\": true,\\n \\"PrimaryKey\\": true,\\n \\"DistributeKey\\": true\\n }\\n ],\\n \\"Catalog\\": \\"\\",\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n 1\\n 30\\n 15\\n \\n 1\\n 30\\n 15\\n \\n \\n
\\n \\n","errorExample":""}]', + 'title' => '查询列信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'GetTableDDL' => [ + 'summary' => '查询建表语句。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157088', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '863D51B7-5321-41D8-A0B6-A088B0******', + ], + 'SQL' => [ + 'description' => 'SQL语句。', + 'type' => 'string', + 'example' => 'create table ('."\n" + .' id varchar(32)'."\n" + .');', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0******\\",\\n \\"SQL\\": \\"create table (\\\\n id varchar(32)\\\\n);\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 863D51B7-5321-41D8-A0B6-A088B0******\\n create table (\\n id varchar(32)\\n);\\n","errorExample":""}]', + 'title' => '查询建表语句', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'GetTableObjects' => [ + 'summary' => '查询表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157079', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。'."\n" + .'类型取值：'."\n" + .'- Asc；'."\n" + .'- Desc；'."\n" + ."\n" + .'域取值：'."\n" + .'-TableName；'."\n" + .'-TableSize；'."\n" + .'-CreateTime;'."\n" + .'-UpdateTime;'."\n" + ."\n" + .'默认值：{"Type": "Desc","Field": "TableName"}；'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Type": "Desc","Field": "TableName"}', + ], + ], + [ + 'name' => 'FilterTblName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_tbl', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- 30；'."\n" + .'- 50；'."\n" + .'- 100；'."\n" + ."\n" + .'默认值：30。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1565u55p32****', + ], + ], + [ + 'name' => 'FilterTblType', + 'in' => 'query', + 'schema' => [ + 'description' => '表类型。'."\n" + .'取值：'."\n" + ."\n" + .'-DIMENSION_TABLE'."\n" + ."\n" + .'-FACT_TABLE'."\n" + ."\n" + .'-EXTERNAL_TABLE'."\n" + ."\n" + .'默认值：空', + 'type' => 'string', + 'required' => false, + 'example' => 'FACT_TABLE', + ], + ], + [ + 'name' => 'FilterOwner', + 'in' => 'query', + 'schema' => [ + 'description' => '所有者。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'FilterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '863D51B7-5321-41D8-A0B6-A088B0******', + ], + 'PageNumber' => [ + 'description' => '页码，取值为正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，取值为正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TableSummaryModels' => [ + 'description' => '结果数组。', + 'type' => 'array', + 'items' => [ + 'description' => '表概要信息。', + '$ref' => '#/components/schemas/TableSummaryModel', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"TableSummaryModels\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"TableSize\\": 0,\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"SQL\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"MvDetailModel\\": {\\n \\"FirstRefreshTime\\": \\"\\",\\n \\"QueryRewriteEnabled\\": true,\\n \\"ExplicitHit\\": 0,\\n \\"IsInactive\\": true,\\n \\"RemoteSize\\": 0,\\n \\"LocalSize\\": 0,\\n \\"RefreshState\\": \\"\\",\\n \\"RefreshInterval\\": \\"\\",\\n \\"ImplicitHit\\": 0,\\n \\"UpdatedAt\\": \\"\\",\\n \\"ResourceGroup\\": \\"\\",\\n \\"BaseTableInfos\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"BaseTableIsMv\\": true,\\n \\"TableEngine\\": \\"\\"\\n }\\n ],\\n \\"TableEngine\\": \\"\\",\\n \\"BaseTableNames\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"EnableDelayAlert\\": 0,\\n \\"EnableFailureAlert\\": 0,\\n \\"LatencyTolerance\\": 0\\n },\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 863D51B7-5321-41D8-A0B6-A088B0******\\n 1\\n 30\\n 1\\n \\n 1\\n 30\\n 1\\n \\n \\n","errorExample":""}]', + 'title' => '查询表信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'CheckSampleDataSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-wz9r8f67h4cqz41u', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '内置数据集状态，取值说明：'."\n" + .'- **SUCCEED**：加载成功。'."\n" + ."\n" + .'- **INIT**：加载中。'."\n" + ."\n" + .'- **FAILED**：加载失败。'."\n" + ."\n" + .'- **UNINITIALIZED**：未加载。', + 'type' => 'string', + 'example' => 'UNINITIALIZED', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '0CE655C3-C211-513D-A42F-D4AE2D1A867C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"UNINITIALIZED\\",\\n \\"RequestId\\": \\"0CE655C3-C211-513D-A42F-D4AE2D1A867C\\"\\n}","type":"json"}]', + 'title' => '检查内置数据集状态', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeSchemas' => [ + 'summary' => '查询指定实例的数据库列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190445', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1xxxxxxxx47', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库信息。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp11q28kvl688****', + ], + 'SchemaName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25B56BC7-4978-40B3-9E48-4B7067******\\",\\n \\"Items\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '枚举实例的库列表', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeAllDataSource' => [ + 'summary' => '枚举实例下所有数据库列表、表列表和列列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190495', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1pke2pcfavw****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', + ], + 'Tables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => '表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '逻辑表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1pke2pcfavw****', + ], + 'SchemaName' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + 'Columns' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => '列列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列的数据类型。', + 'type' => 'string', + 'example' => 'bigint', + ], + 'ColumnName' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'id', + ], + 'TableName' => [ + 'description' => '逻辑表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'AutoIncrementColumn' => [ + 'description' => '列是否自增，取值说明：'."\n" + .'- **true**：自增。'."\n" + .'- **false**：不自增。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1pke2pcfavw****', + ], + 'PrimaryKey' => [ + 'description' => '列是否为主键，取值说明：'."\n" + .'- **true**：主键。'."\n" + .'- **false**：非主键。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SchemaName' => [ + 'description' => '逻辑库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + 'Schemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库信息。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1pke2pcfavw****', + ], + 'SchemaName' => [ + 'description' => '逻辑库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"Tables\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"DBClusterId\\": \\"amv-bp1pke2pcfavw****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n },\\n \\"Columns\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"bigint\\",\\n \\"ColumnName\\": \\"id\\",\\n \\"TableName\\": \\"test\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"amv-bp1pke2pcfavw****\\",\\n \\"PrimaryKey\\": false,\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n },\\n \\"Schemas\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"amv-bp1pke2pcfavw****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '枚举数据库列表', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeTables' => [ + 'summary' => '查询指定数据库的表列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => '表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1xxxxxxxx47', + ], + 'SchemaName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"DBClusterId\\": \\"amv-bp1xxxxxxxx47\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '枚举数据库的表列表', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeColumns' => [ + 'summary' => '查询指定表的列列表信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '查询表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-XXX442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => '列列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列数据类型。', + 'type' => 'string', + 'example' => 'bigint', + ], + 'ColumnName' => [ + 'description' => '列名称。', + 'type' => 'string', + 'example' => 'id', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'AutoIncrementColumn' => [ + 'description' => '列是否自增，取值说明：'."\n" + .'- **true**：自增。'."\n" + .'- **false**：不自增。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-bp111m2cfrdl1****', + ], + 'PrimaryKey' => [ + 'description' => '列是否为主键，取值说明：'."\n" + .'- **true**：主键。'."\n" + .'- **false**：非主键。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SchemaName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-XXX442913CEF\\",\\n \\"Items\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"bigint\\",\\n \\"ColumnName\\": \\"id\\",\\n \\"TableName\\": \\"test\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"amv-bp111m2cfrdl1****\\",\\n \\"PrimaryKey\\": false,\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '枚举表的列列表', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'LoadSampleDataSet' => [ + 'summary' => '调用LoadSampleDataSet接口加载内置数据集。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 调用[DescribeDBClusters](~~454250~~)接口查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2ze0z517o1mg****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FA31BE84-ABE8-554A-A769-5F860C34EE10', + ], + 'DBClusterId' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'example' => 'amv-2ze0z517o1mg****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA31BE84-ABE8-554A-A769-5F860C34EE10\\",\\n \\"DBClusterId\\": \\"amv-2ze0z517o1mg****\\"\\n}","type":"json"}]', + 'title' => '加载内置数据集', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'GetADBSparkNecessaryRAMPermissions' => [ + 'summary' => '查看当前用户的Spark基本权限诊断报告。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~129857~~)接口可以查看目标地域下所有集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1r053byu48p****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '642F3512-C628-5D0C-8815-F6670C****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Passed' => [ + 'description' => '检查是否具有使用ADB Spark的基本权限。'."\n" + ."\n" + .'- true：通过检查，持有基本权限。'."\n" + .'- false：检查失败，缺少部分权限。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DeniedDetail' => [ + 'description' => '权限检查失败时，返回权限检查失败相关的诊断信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceOwnerId' => [ + 'description' => '资源拥有者的ID。', + 'type' => 'string', + 'example' => '11685695632****', + ], + 'Action' => [ + 'description' => '鉴权失败的RAM Action名称。', + 'type' => 'string', + 'example' => 'ListSparkApps', + ], + 'PrincipalType' => [ + 'description' => '当前用户的身份类型，取值如下：'."\n" + .'- SubUser：RAM用户。'."\n" + .'- AssumedRoleUser：RAM角色。', + 'type' => 'string', + 'example' => 'SubUser', + ], + 'ResourceAuthTargetInfo' => [ + 'description' => '鉴权对象的信息，可以是当前用户的RAM账号ID，或者当前访问者对应的角色信息。', + 'type' => 'string', + 'example' => '223345695632****'."\n", + ], + 'PolicyType' => [ + 'description' => '引起无权限的策略类型，取值如下:'."\n" + .'- ControlPolicy ：管控策略。'."\n" + .'- SessionPolicy：临时Token额外添加的一个权限策略。'."\n" + .'- AssumeRolePolicy：RAM角色的授信策略。'."\n" + .'- AccountLevelIdentityBasedPolicy：账号授权范围的主体策略，包含自定义策略和系统策略。'."\n" + .'- ResourceGroupLevelIdentityBasedPolicy：资源组授权范围的主体策略，包含自定义策略和系统策略。', + 'type' => 'string', + 'example' => 'ControlPolicy', + ], + 'NoPermissionType' => [ + 'description' => '权限策略拒绝的类型，取值如下：'."\n" + .'- ImplicitDeny：资源持有者未配置相关权限策略给当前用户，缺省拒绝未授权的操作。'."\n" + .'- ExplicitDeny：资源持有者配置的RAM策略明确拒绝了当前用户访问对应的资源。', + 'type' => 'string', + 'example' => 'ImplicitDeny', + ], + ], + ], + 'Suggestion' => [ + 'description' => '根据诊断信息，推荐客户在RAM系统中进行的配置。', + 'type' => 'string', + 'example' => 'Grant the system RAM policy \'AliyunADBDeveloperAccess\' to current RAM user can quickly solve this issue.', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Spark parameter is not valid, please check error info: %s.', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"642F3512-C628-5D0C-8815-F6670C****\\",\\n \\"Data\\": {\\n \\"Passed\\": true,\\n \\"DeniedDetail\\": {\\n \\"ResourceOwnerId\\": \\"11685695632****\\",\\n \\"Action\\": \\"ListSparkApps\\",\\n \\"PrincipalType\\": \\"SubUser\\",\\n \\"ResourceAuthTargetInfo\\": \\"223345695632****\\\\n\\",\\n \\"PolicyType\\": \\"ControlPolicy\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\"\\n },\\n \\"Suggestion\\": \\"Grant the system RAM policy \'AliyunADBDeveloperAccess\' to current RAM user can quickly solve this issue.\\"\\n }\\n}","type":"json"}]', + 'title' => '查看当前用户的Spark基本权限诊断报告', + 'description' => 'API诊断报告中包含了当前用户是否具有ADB Spark相关功能需要的所有权限，检测权限的范围可能会超过业务最小需求。当前API的诊断报告用于ADB Spark的环境快速初始化场景。如果需要细粒度配置权限，[请参考ADB Spark细粒度权限配置文档。](https://www.alibabacloud.com/help/zh/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role?spm=a2c63.p38356.help-menu-92664.d_2_5_0.48362a487dMzm9#section-y2z-ucd-1ko)', + ], + 'KillProcess' => [ + 'summary' => '调用KillProcess接口终止正在进行的任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189978', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-xxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看可用地域的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。'."\n" + .'> 您可以调用[DescribeProcessList](~~612277~~)接口查看目标SQL的任务ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '202011191048151921681492420315100****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '终止正在进行的任务', + ], + 'DescribeAdviceServiceEnabled' => [ + 'summary' => '查询建议服务是否开启。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2ze0vp0j6t3to****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'Message', + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', + ], + 'Result' => [ + 'title' => 'Advice Service Enabled', + 'description' => '建议服务是否开启。取值说明：'."\n" + .'- 开启，返回**True**。 '."\n" + .'- 关闭，返回**False**。', + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => '查询建议服务是否开启', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeSparkSQLDiagnosisList' => [ + 'summary' => '查询SparkSQL诊断列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197113', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL湖仓版（3.0）集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2zez35ww415xjwk5', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StatementId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Spark作业中代码块的唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '20', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"MaxExclusiveTime","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。取值说明：'."\n" + .' - `MaxExclusiveTime`：最大执行时间。'."\n" + .' - `PeakMemory`：内存峰值。'."\n" + .' - `QueryStartTime`： query开始时间。'."\n" + .' - `QueryWallclockTime`：query 执行时间。'."\n" + ."\n" + .'- `Type`表示排序方式。取值说明：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> - 若不设置参数，默认按照`MaxExclusiveTime`字段升序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"Field\\":\\"QueryStartTime\\",\\"Type\\":\\"Desc\\"}]', + ], + ], + [ + 'name' => 'MinStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '最小起始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-28 22:00:00', + ], + ], + [ + 'name' => 'MaxStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '最大起始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-28 23:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1343', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A91C9D07-7462-5F35-BB47-83629CE6CCAC', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'SQLDiagnosisList' => [ + 'description' => 'SQL 诊断信息集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'State' => [ + 'description' => 'Query 最终执行状态：'."\n" + ."\n" + .'- COMPLETED：完成。'."\n" + .'- CANCELED：取消。'."\n" + .'- ABORTED：中止。'."\n" + .'- FAILED：失败。', + 'type' => 'string', + 'example' => 'COMPLETED', + ], + 'SQL' => [ + 'description' => 'SQL语句。', + 'type' => 'string', + 'example' => 'select * from device where name = \'105506012112790031\'', + ], + 'AppId' => [ + 'description' => '应用ID。'."\n" + .'> 调用[ListSparkApps](~~612475~~)接口查询Spark应用的ID。', + 'type' => 'string', + 'example' => 's202404291020bjd448ad40002122', + ], + 'StatementId' => [ + 'description' => 'Spark作业中代码块的唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'InnerQueryId' => [ + 'description' => 'Spark 应用内部 query 执行 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-11-20 09:09:00', + ], + 'ElapsedTime' => [ + 'description' => '实际运行时间，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'MaxExclusiveTime' => [ + 'description' => '最大算子执行时间，单位毫秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'PeakMemory' => [ + 'description' => '最大算子内存消耗，单位byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'ScanRowCount' => [ + 'description' => '扫描行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1343,\\n \\"RequestId\\": \\"A91C9D07-7462-5F35-BB47-83629CE6CCAC\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"SQLDiagnosisList\\": [\\n {\\n \\"State\\": \\"COMPLETED\\",\\n \\"SQL\\": \\"select * from device where name = \'105506012112790031\'\\",\\n \\"AppId\\": \\"s202404291020bjd448ad40002122\\",\\n \\"StatementId\\": 1,\\n \\"InnerQueryId\\": 1,\\n \\"StartTime\\": \\"2024-11-20 09:09:00\\",\\n \\"ElapsedTime\\": 100,\\n \\"MaxExclusiveTime\\": 90,\\n \\"PeakMemory\\": 1024,\\n \\"ScanRowCount\\": 100\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]', + 'title' => '查询SparkSQL诊断列表', + ], + 'DescribeSparkSQLDiagnosisAttribute' => [ + 'summary' => '查询单个Spark SQL的诊断详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197163', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> * 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2zeq4788qyy7k662', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + .'> 调用[ListSparkApps](~~612475~~)接口查询Spark应用的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202411071444hzdvk486d9d2001****', + ], + ], + [ + 'name' => 'InnerQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Spark 应用内部 query 执行 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '9223372036854775807', + 'exclusiveMaximum' => true, + 'minimum' => '-2', + 'exclusiveMinimum' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。系统权限策略的描述将以此语言返回。'."\n" + ."\n" + .'- en：英文。'."\n" + .'- zh：中文。', + 'type' => 'string', + 'required' => true, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'AppId' => [ + 'description' => '应用ID。'."\n" + .'> 调用[ListSparkApps](~~612475~~)接口查询Spark应用的ID。', + 'type' => 'string', + 'example' => 's202411071444hzdvk486d9d2001****', + ], + 'InnerQueryId' => [ + 'description' => 'Spark 应用内部 query 执行 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ElapsedTime' => [ + 'description' => '实际运行时间，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DiagnosisInfos' => [ + 'description' => '诊断建议集合', + 'type' => 'array', + 'items' => [ + 'description' => '诊断建议', + '$ref' => '#/components/schemas/Adb4MysqlSparkDiagnosisInfo', + ], + ], + 'OperatorListSortedByMetrics' => [ + 'description' => '按 metrics 排序后的算子队列', + 'type' => 'object', + 'properties' => [ + 'OperatorListSortedByMaxMemory' => [ + 'description' => '按最大内存消耗排序后的算子队列', + 'type' => 'array', + 'items' => [ + 'description' => 'Spark 算子信息', + '$ref' => '#/components/schemas/SparkOperatorInfo', + ], + ], + 'OperatorListSortedByExclusiveTime' => [ + 'description' => '按执行时间排序后的算子队列', + 'type' => 'array', + 'items' => [ + 'description' => 'Spark 算子信息', + '$ref' => '#/components/schemas/SparkOperatorInfo', + ], + ], + ], + ], + 'Root' => [ + 'description' => 'Spark 执行计划树', + '$ref' => '#/components/schemas/OperatorNode', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"AppId\\": \\"s202411071444hzdvk486d9d2001****\\",\\n \\"InnerQueryId\\": 1,\\n \\"ElapsedTime\\": 100,\\n \\"DiagnosisInfos\\": [\\n {\\n \\"DiagnosisType\\": \\"APPLICATION\\",\\n \\"DiagnosisCode\\": \\"\\",\\n \\"DiagnosisCodeLabel\\": \\"\\",\\n \\"DiagnosisMsg\\": \\"\\"\\n }\\n ],\\n \\"OperatorListSortedByMetrics\\": {\\n \\"OperatorListSortedByMaxMemory\\": [\\n {\\n \\"OperatorName\\": \\"\\",\\n \\"MetricValue\\": 0\\n }\\n ],\\n \\"OperatorListSortedByExclusiveTime\\": [\\n {\\n \\"OperatorName\\": \\"\\",\\n \\"MetricValue\\": 0\\n }\\n ]\\n },\\n \\"Root\\": {\\n \\"nodeName\\": \\"\\",\\n \\"id\\": 0,\\n \\"nodeDepth\\": 0,\\n \\"parentId\\": 0,\\n \\"levelWidth\\": 0,\\n \\"nodeWidth\\": 0,\\n \\"stats\\": {\\n \\"parameters\\": \\"\\",\\n \\"bytes\\": 0,\\n \\"outputRows\\": 0,\\n \\"timeCost\\": 0,\\n \\"peakMemory\\": 0\\n },\\n \\"children\\": [\\n {\\n \\"nodeName\\": \\"\\",\\n \\"id\\": 0,\\n \\"nodeDepth\\": 0,\\n \\"parentId\\": 0,\\n \\"levelWidth\\": 0,\\n \\"nodeWidth\\": 0,\\n \\"stats\\": {\\n \\"parameters\\": \\"\\",\\n \\"bytes\\": 0,\\n \\"outputRows\\": 0,\\n \\"timeCost\\": 0,\\n \\"peakMemory\\": 0\\n },\\n \\"children\\": [\\n {\\n \\"nodeName\\": \\"\\",\\n \\"id\\": 0,\\n \\"nodeDepth\\": 0,\\n \\"parentId\\": 0,\\n \\"levelWidth\\": 0,\\n \\"nodeWidth\\": 0,\\n \\"stats\\": {\\n \\"parameters\\": \\"\\",\\n \\"bytes\\": 0,\\n \\"outputRows\\": 0,\\n \\"timeCost\\": 0,\\n \\"peakMemory\\": 0\\n },\\n \\"children\\": []\\n }\\n ]\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]', + 'title' => '查询SparkSQL诊断详情', + ], + 'DescribeOversizeNonPartitionTableInfos' => [ + 'summary' => '调用DescribeOversizeNonPartitionTableInfos接口查看集群非分区表是否存在不合理的情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217358', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，UTC时间，格式为：yyyy-MM-ddTHH:mmZ。'."\n" + .'> 仅当SQL审计状态为开启时，才能查询到SQL审计日志，且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计，再次打开时，仅能查询到再次打开后的SQL审计日志。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-05-11T05:44Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 查询结束时间需晚于查询开始时间，且与查询开始时间间隔小于7天。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-05-11T05:44Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- 30；'."\n" + .'- 50；'."\n" + .'- 100'."\n" + ."\n" + .'默认值：30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh（默认值）**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日语。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定字段排序，json格式：JSON数组，有序，按顺序输入排列字段和升降序类型：'."\n" + ."\n" + .'如：'."\n" + ."\n" + .'```'."\n" + .'['."\n" + ."\n" + .' {'."\n" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\n" + .' }'."\n" + ."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'其中Field表示需要排序的字段名，目前仅支持对"Name" 字段排序。'."\n" + .'Type表示排序类型 Desc为降序，Asc为升序'."\n" + ."\n" + .'均不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"SchemaName","Type":"Asc"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp16t5ci7r74s****', + ], + 'Tables' => [ + 'description' => '不合理非分区表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => '数据库名称。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'RowCount' => [ + 'description' => '表行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1222', + ], + 'IndexSize' => [ + 'description' => '普通索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'DataSize' => [ + 'description' => '表数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2921132457984', + ], + 'LocalDataSize' => [ + 'description' => '热数据量大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1223', + ], + 'PrimaryKeySize' => [ + 'description' => '主键索引大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RemoteDataSize' => [ + 'description' => '冷数据量大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122', + ], + 'SpaceRatio' => [ + 'description' => '表空间占比，单位：%。'."\n" + ."\n" + .'> 计算公式为：表空间占比 = (表总数据量 / 实例总数据量) * 100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.3', + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名。', + 'type' => 'string', + 'example' => '非分区表过大', + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到多个非分区表过大', + ], + 'Status' => [ + 'description' => '检测结果状态。', + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNING'."\n" + .'CRITICAL', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp16t5ci7r74s****\\",\\n \\"Tables\\": [\\n {\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test\\",\\n \\"RowCount\\": 1222,\\n \\"IndexSize\\": 111,\\n \\"DataSize\\": 2921132457984,\\n \\"LocalDataSize\\": 1223,\\n \\"PrimaryKeySize\\": 123,\\n \\"RemoteDataSize\\": 122,\\n \\"SpaceRatio\\": 0.3\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"非分区表过大\\",\\n \\"Message\\": \\"检测到多个非分区表过大\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '检测非分区表不合理', + ], + 'DescribeTablePartitionDiagnose' => [ + 'summary' => '调用DescribeTablePartitionDiagnose接口查询分区诊断信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186721', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp171g24yvbxxxxx', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JOSN字符串，例如`[{"Field":"TotalSize","Type":"Desc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `SchemaName`：表所属的数据库名。'."\n" + .' - `TableName`：表名。'."\n" + .' - `TotalSize`：总数据量。'."\n" + .' - `SpaceRatio`：空间占比。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照目标表的总数据量倒序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"Field\\":\\"TotalSize\\",\\"Type\\":\\"Desc\\"}]', + 'default' => '[{"Field":"SchemaName", "Type": "desc" }]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + .'- **ja**：日语。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '185', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp171g24yvbxxxxx', + ], + 'SuggestMaxRecordsPerPartition' => [ + 'description' => '建议每个二级分区的最大行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640000000', + ], + 'SuggestMinRecordsPerPartition' => [ + 'description' => '建议每个二级分区的最小行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64000000', + ], + 'Items' => [ + 'description' => '详情。', + 'type' => 'array', + 'items' => [ + 'description' => '信息列表。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'user', + ], + 'PartitionDetail' => [ + 'description' => '不合理分区。', + 'type' => 'string', + 'example' => '[20210110, 20210113,20210123]', + ], + 'SchemaName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'PartitionNumber' => [ + 'description' => '分区个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalSize' => [ + 'description' => '总数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42949672960', + ], + 'SpaceRatio' => [ + 'description' => '表空间占比，单位：%。'."\n" + ."\n" + .'> 计算公式为：表空间占比 = 表总数据量 / 实例总数据量 * 100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '66.23', + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => '表分区合理性检测', + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到表存在分区不合理的情况', + ], + 'Status' => [ + 'description' => '检测结果状态。取值：'."\n" + ."\n" + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 185,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBClusterId\\": \\"amv-bp171g24yvbxxxxx\\",\\n \\"SuggestMaxRecordsPerPartition\\": 640000000,\\n \\"SuggestMinRecordsPerPartition\\": 64000000,\\n \\"Items\\": [\\n {\\n \\"TableName\\": \\"user\\",\\n \\"PartitionDetail\\": \\"[20210110, 20210113,20210123]\\",\\n \\"SchemaName\\": \\"test_db\\",\\n \\"PartitionNumber\\": 2,\\n \\"TotalSize\\": 42949672960,\\n \\"SpaceRatio\\": 66.23\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"表分区合理性检测\\",\\n \\"Message\\": \\"检测到表存在分区不合理的情况\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '查询二级分区诊断新系列', + ], + 'DescribeSparkAppDiagnosisInfo' => [ + 'summary' => '查询Spark应用诊断信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189113', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf663j39b0jd2***', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'> 您可以调用[ListSparkApps](~~455888~~)接口查询所有的应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's202411061017sh0ad564b000****', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型，返回结果将以该语言展示。取值如下： '."\n" + ."\n" + .'- en：英文 '."\n" + .'- zh（默认值）：中文', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FB5AC339-91F6-5000-8E5A-F47065B01B87', + ], + 'AppId' => [ + 'description' => '应用ID。'."\n" + .'> 您可以调用[ListSparkApps](~~455888~~)接口查询所有的应用ID。', + 'type' => 'string', + 'example' => 's202404141952sz6a1391200****', + ], + 'StartedTime' => [ + 'description' => '执行开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1718329831000', + ], + 'DurationInMillis' => [ + 'description' => 'Spark应用执行耗时，单位毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '281063', + ], + 'State' => [ + 'description' => '需要查询的异步导入或导出任务的状态，取值说明如下：'."\n" + .'* **RUNNING**：任务进行中。'."\n" + .'* **FINISHED**：任务执行成功。'."\n" + .'* **FAILED**：任务执行失败。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'CpuUtilization' => [ + 'description' => 'CPU使用率。单位为百分比（%）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'PeakMemoryInByte' => [ + 'description' => '峰值内存使用量，单位是Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096000', + ], + 'ShuffleWriteInByte' => [ + 'description' => 'Shuffle写过程的数据量，单位是Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096000', + ], + 'ShuffleReadInByte' => [ + 'description' => 'Shuffle读过程涉及到的数据量，单位是Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096000', + ], + 'SpillInByte' => [ + 'description' => '内存不足时，交换写入到磁盘的数据量，单位是Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'JVMGcCostInMillis' => [ + 'description' => 'Java虚拟机执行垃圾回收操作的耗时，单位是毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '81055', + ], + 'DiagnosisInfoList' => [ + 'description' => 'Spark分析信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Spark分析信息。', + '$ref' => '#/components/schemas/Adb4MysqlSparkDiagnosisInfo', + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FB5AC339-91F6-5000-8E5A-F47065B01B87\\",\\n \\"AppId\\": \\"s202404141952sz6a1391200****\\",\\n \\"StartedTime\\": 1718329831000,\\n \\"DurationInMillis\\": 281063,\\n \\"State\\": \\"FINISHED\\",\\n \\"CpuUtilization\\": 100,\\n \\"PeakMemoryInByte\\": 4096000,\\n \\"ShuffleWriteInByte\\": 4096000,\\n \\"ShuffleReadInByte\\": 4096000,\\n \\"SpillInByte\\": 0,\\n \\"JVMGcCostInMillis\\": 81055,\\n \\"DiagnosisInfoList\\": [\\n {\\n \\"DiagnosisType\\": \\"APPLICATION\\",\\n \\"DiagnosisCode\\": \\"\\",\\n \\"DiagnosisCodeLabel\\": \\"\\",\\n \\"DiagnosisMsg\\": \\"\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '查询Spark应用诊断信息', + ], + 'EnableAdviceService' => [ + 'summary' => '用EnableAdviceService来开启建议服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1q10xxzq2z4****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E1745C03-7CCE-55CF-932E-08121AAFA6AF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1745C03-7CCE-55CF-932E-08121AAFA6AF\\"\\n}","type":"json"}]', + 'title' => '开通建议服务', + ], + 'DescribeAppliedAdvices' => [ + 'summary' => '显示已采纳的优化建议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193678', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'StartTime', + 'description' => '查询建议的开始日期，格式为 yyyyMMdd。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20220811', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'EndTime', + 'description' => '查询建议的结束日期，格式为 yyyyMMdd。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20220824', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => 'Lang', + 'description' => '设置建议的显示语言，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AdviceType', + 'in' => 'query', + 'schema' => [ + 'description' => '建议的类型，取值说明：'."\n" + .'- **INDEX**：索引优化。'."\n" + .'- **TIERING**：冷热数据优化。', + 'type' => 'string', + 'required' => false, + 'example' => 'INDEX', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，支持根据表名模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'you_table_name', + ], + ], + [ + 'name' => 'SchemaTableName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名和表名。格式为**数据库.表**。', + 'type' => 'string', + 'required' => false, + 'example' => 'tpch.lineitem', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"SchemaName","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `SchemaName`：数据库名。'."\n" + .' - `TableName`：表名。'."\n" + .' - `JobStatus`：表Build任务状态。'."\n" + .' - `SubmitTime`：建议下发的时间。'."\n" + .' - `Benefit`：预期优化收益。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照优化建议下发的时间降序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"Field\\":\\"AdviceType\\",\\"Type\\":\\"Desc\\"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'title' => 'Items', + 'description' => '详情。', + 'type' => 'array', + 'items' => [ + 'description' => '建议列表。', + 'type' => 'object', + 'properties' => [ + 'AdviceId' => [ + 'title' => 'AdviceId', + 'description' => '建议ID。', + 'type' => 'string', + 'example' => '7417db9c-914d-43f3-a123-4d0e448f****', + ], + 'SubmitTime' => [ + 'title' => 'SubmitTime', + 'description' => '建议下发的时间，格式：yyMMddHHmm（UTC时间）。', + 'type' => 'string', + 'example' => '2208131600', + ], + 'SubmitStatus' => [ + 'title' => 'SubmitStatus', + 'description' => '建议的下发状态。'."\n" + .'取值说明：'."\n" + .'- **SUCCEED**：成功。'."\n" + .'- **FAILED**：失败。', + 'type' => 'string', + 'example' => 'SUCCEED', + ], + 'SQL' => [ + 'title' => 'SQL', + 'description' => '应用建议的SQL语句。', + 'type' => 'string', + 'example' => 'alter table `schema1`.`table1` drop key col1_1_idx', + ], + 'RollbackSQL' => [ + 'title' => 'RollbackSQL', + 'description' => '回滚建议的SQL语句。', + 'type' => 'string', + 'example' => 'alter table `schema1`.`table1` add key col1_1_idx(col1)', + ], + 'JobStatus' => [ + 'title' => 'JobStatus', + 'description' => '执行建议的任务的状态。'."\n" + .'取值说明：'."\n" + .'- **SUCCEED**：成功。'."\n" + .'- **FAILED**：失败。', + 'type' => 'string', + 'example' => 'SUCCEED', + ], + 'Benefit' => [ + 'title' => 'Benefit', + 'description' => '建议的收益。', + 'type' => 'string', + 'example' => '节省0.4 GB的存储空间', + ], + 'BuildSQL' => [ + 'title' => 'Benefit', + 'description' => '执行Build任务的SQL语句。', + 'type' => 'string', + 'example' => 'build table `schema1`.`table1`', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '返回的结果总数，取值为：大于等于0且不超过Integer数据类型的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'IndexFields' => [ + 'type' => 'string', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84489769-3065-5A28-A4CB-977CD426F1C3', + ], + 'TotalCount' => [ + 'description' => '返回的结果总数，取值为：大于等于0且不超过Integer数据类型的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SchemaTableNames' => [ + 'description' => '数据库名和表名的字符串拼接。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库名和表名的字符串拼接。', + 'type' => 'string', + 'example' => '['."\n" + .' "tpch.lineitem",'."\n" + .' "tpch.partsupp",'."\n" + .' "tpch.orders"'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"AdviceId\\": \\"7417db9c-914d-43f3-a123-4d0e448f****\\",\\n \\"SubmitTime\\": \\"2208131600\\",\\n \\"SubmitStatus\\": \\"SUCCEED\\",\\n \\"SQL\\": \\"alter table `schema1`.`table1` drop key col1_1_idx\\",\\n \\"RollbackSQL\\": \\"alter table `schema1`.`table1` add key col1_1_idx(col1)\\",\\n \\"JobStatus\\": \\"SUCCEED\\",\\n \\"Benefit\\": \\"节省0.4 GB的存储空间\\",\\n \\"BuildSQL\\": \\"build table `schema1`.`table1`\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test\\",\\n \\"IndexFields\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"84489769-3065-5A28-A4CB-977CD426F1C3\\",\\n \\"TotalCount\\": 1,\\n \\"SchemaTableNames\\": [\\n \\"[\\\\n \\\\\\"tpch.lineitem\\\\\\",\\\\n \\\\\\"tpch.partsupp\\\\\\",\\\\n \\\\\\"tpch.orders\\\\\\"\\\\n]\\"\\n ]\\n}","type":"json"}]', + 'title' => '显示已采纳的优化', + ], + 'DisableAdviceService' => [ + 'summary' => '用DisableAdviceService来关闭建议服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf67culrr26q2****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '57EC6CCA-A582-572C-A33D-F61845CBC03C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"57EC6CCA-A582-572C-A33D-F61845CBC03C\\"\\n}","type":"json"}]', + 'title' => '关闭建议服务', + ], + 'BatchApplyAdviceByIdList' => [ + 'summary' => '批量应用优化建议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193683', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AdviceIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '待批量应用的建议 ID 列表，多个建议 ID 之间用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'c2589ff3-e86c-4f19-80c8-2aeb7dd9****,53414470-ebf4-4a53-a312-8a1ad8fd****,6e8dce84-fec8-4b0b-9c04-b0cea12c****,b3b9703d-55ca-47e0-96dd-6a4a9dbf****', + ], + ], + [ + 'name' => 'AdviceDate', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceDate', + 'description' => '建议生成的日期。格式：yyyyMMdd。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20221115', + ], + ], + [ + 'name' => 'ApplyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'BuildImmediately', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '86F92D26-B774-5FA1-8E53-82CBEEEBB012', + 'title' => 'Id of the request', + ], + ], + 'title' => 'Schema of Response', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"86F92D26-B774-5FA1-8E53-82CBEEEBB012\\"\\n}","type":"json"}]', + 'title' => '批量应用优化建议', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ApplyAdviceById' => [ + 'summary' => '应用单条优化建议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193679', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => '地域 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AdviceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceId', + 'description' => '建议 ID。', + 'type' => 'string', + 'required' => false, + 'example' => '0baf1f52-53df-487f-8292-99a03716****', + ], + ], + [ + 'name' => 'AdviceDate', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceDate', + 'description' => '建议生成的日期。格式：yyyyMMdd', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20221101', + ], + ], + [ + 'name' => 'ApplyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'BuildImmediately', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '5DC10091-348D-12B1-906D-AB49D658012E', + 'title' => 'Id of the request', + ], + ], + 'title' => 'Schema of Response', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"5DC10091-348D-12B1-906D-AB49D658012E\\"\\n}","type":"json"}]', + 'title' => '应用单条优化建议', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeAvailableAdvices' => [ + 'summary' => '用DescribeAvailableAdvices来显示可用优化建议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193677', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp198m028ih55****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AdviceDate', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceDate', + 'description' => '建议的生成日期，格式为yyyyMMdd。'."\n" + ."\n" + .'> 数据是每天凌晨分析后生成，因此要填T-1以上的时间才查询得到数据。譬如当前是20240627，那么应该传20240626或者更早的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '20221124', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => 'Lang', + 'description' => '设置建议的显示语言，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '30', + 'default' => '100', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'AdviceType', + 'in' => 'query', + 'schema' => [ + 'description' => '建议的类型，取值说明：'."\n" + .'- **INDEX**：索引优化。'."\n" + .'- **TIERING**：冷热数据优化。', + 'type' => 'string', + 'required' => false, + 'example' => 'INDEX', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，支持根据表名模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'you_table_name', + ], + ], + [ + 'name' => 'SchemaTableName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名和表名的字符串拼接。', + 'type' => 'string', + 'required' => false, + 'example' => 'tpch.lineitem', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"SchemaName","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。支持如下取值：'."\n" + .' - `SchemaName`：数据库名。'."\n" + .' - `TableName`：表名。'."\n" + .' - `Benefit`：预期优化收益。'."\n" + .'- `Type`表示排序方式。支持如下取值：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> 若不设置参数，默认按照”预期优化收益“降序排列。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"Field\\":\\"AdviceType\\",\\"Type\\":\\"Desc\\"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'title' => 'Items', + 'description' => '详情。', + 'type' => 'array', + 'items' => [ + 'description' => '建议列表。', + 'type' => 'object', + 'properties' => [ + 'AdviceId' => [ + 'title' => 'AdviceId', + 'description' => '建议ID。', + 'type' => 'string', + 'example' => 'dcd04135-0925-4aed-a5a7-e7d92cb1****', + ], + 'AdviceDate' => [ + 'title' => 'AdviceDate', + 'description' => '建议生成的时间，格式：yyyyMMdd。', + 'type' => 'string', + 'example' => '20221124', + ], + 'AdviceType' => [ + 'title' => 'AdviceType', + 'description' => '建议的类型，取值说明：'."\n" + .'- **INDEX**：索引优化。'."\n" + .'- **TIERING**：冷热数据优化。', + 'type' => 'string', + 'example' => 'INDEX', + ], + 'SQL' => [ + 'title' => 'SQL', + 'description' => '应用建议的SQL语句。', + 'type' => 'string', + 'example' => 'alter table `schema1`.`table1` drop key col1_1_idx', + ], + 'Reason' => [ + 'title' => 'Reason', + 'description' => '生成优化建议的原因。', + 'type' => 'string', + 'example' => '15天未使用，历史使用统计概率小于1%', + ], + 'Benefit' => [ + 'title' => 'Benefit', + 'description' => '建议的收益。', + 'type' => 'string', + 'example' => '节省0.4 GB的存储空间。', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '返回的结果总数，取值为：大于等于0且不超过Integer数据类型的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10192', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test_table', + ], + 'IndexFields' => [ + 'type' => 'string', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '96A55627-28E9-5E47-B8F6-D786BE551349', + ], + 'TotalCount' => [ + 'description' => '返回的结果总数，取值为：大于等于0且不超过Integer数据类型的最大值，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10192', + ], + 'SchemaTableNames' => [ + 'description' => '数据库名和表名的字符串拼接。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库名和表名的字符串拼接。', + 'type' => 'string', + 'example' => '['."\n" + .' "tpch.lineitem",'."\n" + .' "tpch.partsupp",'."\n" + .' "tpch.orders"'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.PageSize', + 'errorMessage' => 'The PageSize parameter is required.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"AdviceId\\": \\"dcd04135-0925-4aed-a5a7-e7d92cb1****\\",\\n \\"AdviceDate\\": \\"20221124\\",\\n \\"AdviceType\\": \\"INDEX\\",\\n \\"SQL\\": \\"alter table `schema1`.`table1` drop key col1_1_idx\\",\\n \\"Reason\\": \\"15天未使用，历史使用统计概率小于1%\\",\\n \\"Benefit\\": \\"节省0.4 GB的存储空间。\\",\\n \\"TotalCount\\": 10192,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"IndexFields\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"96A55627-28E9-5E47-B8F6-D786BE551349\\",\\n \\"TotalCount\\": 10192,\\n \\"SchemaTableNames\\": [\\n \\"[\\\\n \\\\\\"tpch.lineitem\\\\\\",\\\\n \\\\\\"tpch.partsupp\\\\\\",\\\\n \\\\\\"tpch.orders\\\\\\"\\\\n]\\"\\n ]\\n}","type":"json"}]', + 'title' => '显示可用优化建议', + ], + 'DescribeDiagnosisSQLInfo' => [ + 'summary' => '查看某个SQL的执行详情，包括执行计划、运行信息、资源使用、自诊断结果等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132343', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下AnalyticDB MySQL集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1r053by****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL支持的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '查询ID。'."\n" + .'> 您可以调用[DescribeDiagnosisRecords](~~308207~~)接口查看指定的AnalyticDB MySQL集群中SQL摘要信息，包括查询ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '20210702164322172016168****', + 'default' => '2023091317073501108614302703151362858', + ], + ], + [ + 'name' => 'ProcessStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的执行开始时间，格式为Unix时间戳，单位为毫秒（ms）。'."\n" + .'> 您可以调用[DescribeDiagnosisRecords](~~308207~~)接口查看指定的AnalyticDB MySQL集群中SQL摘要信息，包括SQL语句的执行开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1625215402000', + 'default' => '-1', + ], + ], + [ + 'name' => 'ProcessState', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的状态，取值如下：'."\n" + .'- **running**：执行中。'."\n" + .'- **finished**：已完成。'."\n" + .'- **failed**：执行失败。'."\n" + .'> 您可以调用[DescribeDiagnosisRecords](~~308207~~)接口查看指定的AnalyticDB MySQL集群中SQL摘要信息，包括SQL语句的状态信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'running', + 'default' => 'running', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日语。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProcessRcHost', + 'in' => 'query', + 'schema' => [ + 'description' => '执行SQL语句的AnalyticDB MySQL前端节点IP和端口信息。'."\n" + .'> 您可以调用[DescribeDiagnosisRecords](~~308207~~)接口查看指定的AnalyticDB MySQL集群中SQL摘要信息，包括前端节点IP和端口信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '192.45.***.***:3145', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DiagnosisSQLInfo' => [ + 'description' => 'SQL的执行详情，包括详细的SQL语句、统计信息、执行计划和算子信息等。', + 'type' => 'string', + 'example' => '{ "DiagnosisSQLInfo": { "hasSharedStage": false, "resourceGroup": "user_default", "cost": 274, "queuedTime": 0, "outputDataSize": 9, "scheduled": true, "query": "/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE \'PROMO%\' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate >= DATE \'1995-09-01\' AND l_shipdate < DATE \'1995-09-01\' + INTERVAL \'1\' MONTH", "outputRows": 1, "userName": "test_user", "parentId": 0, "maxOutputRows": 200000, "scanSize": 8247470, "peakMemory": 13188295, "startTime": 1626330527632, "state": "FINISHED", "endTime": 1626330527905, "writeTableRows": 0, "scanRows": 351966 } }', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1', + ], + 'StageInfos' => [ + 'description' => '查询的分阶段执行信息。', + 'type' => 'array', + 'items' => [ + 'description' => '查询的分阶段执行信息。', + 'type' => 'object', + 'properties' => [ + 'InputRows' => [ + 'description' => 'Stage总的输入行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'InputDataSize' => [ + 'description' => 'Stage总的输入数据量，单位为Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'OutputRows' => [ + 'description' => 'Stage总的输出行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'OutputDataSize' => [ + 'description' => 'Stage总的输出数据量，单位为Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'PeakMemory' => [ + 'description' => 'Stage总的峰值内存，单位为Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'OperatorCost' => [ + 'description' => 'Stage的算子累积耗时，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'StageId' => [ + 'description' => 'StageID。', + 'type' => 'string', + 'example' => 'Stage[26]', + ], + 'State' => [ + 'description' => 'Stage状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Progress' => [ + 'description' => 'Stage的执行进度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.3', + ], + 'ExecutionType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DiagnosisSQLInfo\\": \\"{ \\\\\\"DiagnosisSQLInfo\\\\\\": { \\\\\\"hasSharedStage\\\\\\": false, \\\\\\"resourceGroup\\\\\\": \\\\\\"user_default\\\\\\", \\\\\\"cost\\\\\\": 274, \\\\\\"queuedTime\\\\\\": 0, \\\\\\"outputDataSize\\\\\\": 9, \\\\\\"scheduled\\\\\\": true, \\\\\\"query\\\\\\": \\\\\\"/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE \'PROMO%\' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate >= DATE \'1995-09-01\' AND l_shipdate < DATE \'1995-09-01\' + INTERVAL \'1\' MONTH\\\\\\", \\\\\\"outputRows\\\\\\": 1, \\\\\\"userName\\\\\\": \\\\\\"test_user\\\\\\", \\\\\\"parentId\\\\\\": 0, \\\\\\"maxOutputRows\\\\\\": 200000, \\\\\\"scanSize\\\\\\": 8247470, \\\\\\"peakMemory\\\\\\": 13188295, \\\\\\"startTime\\\\\\": 1626330527632, \\\\\\"state\\\\\\": \\\\\\"FINISHED\\\\\\", \\\\\\"endTime\\\\\\": 1626330527905, \\\\\\"writeTableRows\\\\\\": 0, \\\\\\"scanRows\\\\\\": 351966 } }\\",\\n \\"RequestId\\": \\"1\\",\\n \\"StageInfos\\": [\\n {\\n \\"InputRows\\": 2341,\\n \\"InputDataSize\\": 2341,\\n \\"OutputRows\\": 2341,\\n \\"OutputDataSize\\": 2341,\\n \\"PeakMemory\\": 2341,\\n \\"OperatorCost\\": 2341,\\n \\"StageId\\": \\"Stage[26]\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"Progress\\": 0.3,\\n \\"ExecutionType\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n { \\"DiagnosisSQLInfo\\": { \\"hasSharedStage\\": false, \\"resourceGroup\\": \\"user_default\\", \\"cost\\": 274, \\"queuedTime\\": 0, \\"outputDataSize\\": 9, \\"scheduled\\": true, \\"query\\": \\"/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE \'PROMO%\' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate &gt;= DATE \'1995-09-01\' AND l_shipdate &lt; DATE \'1995-09-01\' + INTERVAL \'1\' MONTH\\", \\"outputRows\\": 1, \\"userName\\": \\"test_user\\", \\"parentId\\": 0, \\"maxOutputRows\\": 200000, \\"scanSize\\": 8247470, \\"peakMemory\\": 13188295, \\"startTime\\": 1626330527632, \\"state\\": \\"FINISHED\\", \\"endTime\\": 1626330527905, \\"writeTableRows\\": 0, \\"scanRows\\": 351966 } }\\n 1\\n \\n 123\\n 2341\\n 231\\n 12344\\n 3421\\n 2341\\n Stage[26]\\n RUNNING\\n 0.3\\n \\n","errorExample":""}]', + 'title' => '查看SQL执行详情', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeDiagnosisDimensions' => [ + 'summary' => '查看AnalyticDB MySQL湖仓版（3.0）集群符合指定检索条件的SQL在资源组、数据库名、用户名以及访问源地址等维度下的去重统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132346', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有AnalyticDB MySQL湖仓版（3.0）集群的集群ID。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bt6u59zcmd945****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为Unix时间戳，单位：毫秒。'."\n" + .'> 仅支持查看最近14天的数据，查询超过14天前的数据返回结果为空。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1625220210000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式为Unix时间戳，单位：毫秒。'."\n" + ."\n" + .'> * 查询结束时间需晚于查询开始时间。'."\n" + .'> * 开始时间与结束时间的间隔不能超过24小时。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1625220213000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定AnalyticDB MySQL湖仓版（3.0）集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL查询的条件，格式为JOSN字符串，包含`Type`、`Value`、`Min`或`Max`等字段。其中`Type` 表示查询维度（当前仅支持3个取值：`maxCost`、`status`和`cost`）；`Value`、`Min`或`Max`表示该维度下的查询范围。取值说明：'."\n" + .'- ` {"Type":"maxCost","Value":"100"}`：表示查看执行耗时最长的前100条SQL详情，当前`Value`的取值仅支持设置为100。'."\n" + .'- `{"Type":"status","Value":"finished"}`：表示查看已完成的SQL详情。您也可以将`Value`设置为`running`或`failed`来查询正在执行或执行失败的SQL详情。'."\n" + .'- `{"Type":"cost","Min":"10","Max":"200"}`：表示查看执行耗时为10毫秒~200毫秒的SQL详情，您也可以自定义执行耗时的最大值与最小值，单位：毫秒（ms）。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Type":"maxCost","Value":"100"}', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh-CN**：简体中文（默认语言）。'."\n" + .'- **en-US**：英文。'."\n" + .'- **ja**：日文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ClientIps' => [ + 'description' => '访问源地址。', + 'type' => 'array', + 'items' => [ + 'description' => '访问源地址。', + 'type' => 'string', + 'example' => '106.11.xx.xx', + ], + ], + 'ResourceGroups' => [ + 'description' => '资源组名称。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'user_defaul', + ], + ], + 'UserNames' => [ + 'description' => '用户名。', + 'type' => 'array', + 'items' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + ], + 'Databases' => [ + 'description' => '数据库名称。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DEA97C6B-D7A4-5E69-9EFC-D7F88737CED5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClientIps\\": [\\n \\"106.11.xx.xx\\"\\n ],\\n \\"ResourceGroups\\": [\\n \\"user_defaul\\"\\n ],\\n \\"UserNames\\": [\\n \\"test_user\\"\\n ],\\n \\"Databases\\": [\\n \\"adb_demo\\"\\n ],\\n \\"RequestId\\": \\"DEA97C6B-D7A4-5E69-9EFC-D7F88737CED5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n [\\"106.11.xx.xx\\",\\"106.11.xx.xx\\"]\\n user_defaul\\n test_user\\n adb_demo\\n DEA97C6B-D7A4-5E69-9EFC-D7F88737CED5\\n","errorExample":""}]', + 'title' => '查询不同维度的SQL去重统计信息', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DownloadDiagnosisRecords' => [ + 'summary' => '下载目标AnalyticDB MySQL湖仓版（3.0）集群中符合指定条件的查询SQL的摘要信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132341', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL湖仓版（3.0）集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL湖仓版（3.0）集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1q8bu9a****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为Unix时间戳，单位：毫秒。'."\n" + .'> 仅支持查看最近14天的数据。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1662364330000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式为Unix时间戳，单位：毫秒。'."\n" + .'> * 查询结束时间需晚于查询开始时间。'."\n" + .'> * 开始时间与结束时间的间隔不能超过24小时。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1662450730000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => '指定SQL查询的条件，格式为JOSN字符串，包含`Type`、`Value`、`Min`或`Max`等字段。其中`Type` 表示查询维度（当前仅支持`maxCost`、`status`和`cost`3个取值）；`Value`、`Min`或`Max`表示该维度下的查询范围。具体支持的取值范围如下：'."\n" + .'- ` {"Type":"maxCost","Value":"100"}`：表示查看执行耗时最长的前100条SQL详情，当前`Value`的取值仅支持设置为100。'."\n" + .'- `{"Type":"status","Value":"finished"}`：表示查看已完成的SQL详情。您也可以将`Value`设置为`running`或`failed`来查询正在执行或执行失败的SQL详情。'."\n" + .'- `{"Type":"cost","Min":"10","Max":"200"}`：表示查看执行耗时为10毫秒~200毫秒的SQL详情，您也可以自定义执行耗时的最大值与最小值，单位：毫秒。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"Type":"status","Value":"finished"}', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'select', + ], + ], + [ + 'name' => 'MinPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL的最小峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '88000000', + ], + ], + [ + 'name' => 'MaxPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL的最大峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '88000000', + ], + ], + [ + 'name' => 'MinScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL的最小扫描量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1073741824', + ], + ], + [ + 'name' => 'MaxScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL的最大扫描量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '64424509440', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL所属的资源组。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_default', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '执行目标SQL的用户名。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~~~)接口查看符合指定检索条件的SQL所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => [ + 'description' => '执行目标SQL的数据库。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源地址。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => '106.11.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadId' => [ + 'description' => '下载ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25494', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '845774AC-5D43-53A2-AAB8-C73828E68508', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DownloadId\\": 25494,\\n \\"RequestId\\": \\"845774AC-5D43-53A2-AAB8-C73828E68508\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25494\\n 845774AC-5D43-53A2-AAB8-C73828E68508\\n","errorExample":""}]', + 'title' => '下载SQL摘要信息', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeDiagnosisRecords' => [ + 'summary' => '调用DownloadDiagnosisRecords接口查看目标AnalyticDB MySQL集群中符合指定条件的SQL摘要信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131519', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~612397~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1scs48yc125****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为Unix时间戳，单位：毫秒。'."\n" + .'> 仅支持查看14天内的数据。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1632931200000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式为Unix时间戳，单位：毫秒。'."\n" + .'> * 查询结束时间需晚于查询开始时间。'."\n" + .'> * 开始时间与结束时间的间隔不能超过24小时。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1633017540000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL查询的条件，格式为JOSN字符串，包含`Type`、`Value`、`Min`或`Max`等字段。其中`Type` 表示查询维度（当前仅支持3个取值：`maxCost`、`status`和`cost`）；`Value`、`Min`或`Max`表示该维度下的查询范围。取值说明：'."\n" + .'- ` {"Type":"maxCost","Value":"100"}`：表示查看执行耗时最长的前100条SQL详情，当前`Value`的取值仅支持设置为100。'."\n" + .'- `{"Type":"status","Value":"finished"}`：表示查看已完成的SQL详情。您也可以将`Value`设置为`running`或`failed`来查询正在执行或执行失败的SQL详情。'."\n" + .'- `{"Type":"cost","Min":"10","Max":"200"}`：表示查看执行耗时为10毫秒~200毫秒的SQL详情，您也可以自定义执行耗时的最大值与最小值，单位：毫秒。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"Type":"status","Value":"finished"}', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '按SQL语句中包含的关键字过滤。', + 'type' => 'string', + 'required' => false, + 'example' => 'select', + ], + ], + [ + 'name' => 'MinPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的最小峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MaxPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的最大峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '89000000', + ], + ], + [ + 'name' => 'MinScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句的最小扫描量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MaxScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => '目标SQL的最大扫描量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1024000000', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL语句所属的资源组。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_default', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '执行SQL语句的用户名。'."\n" + .'您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => [ + 'description' => '执行SQL语句的数据库。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源地址。'."\n" + .'> 您可以调用[DescribeDiagnosisDimensions](~~308210~~)接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => '59.82.XX.XX', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定字段对SQL语句进行排序，格式为JSON，是一个有序JSON数组，按输入数组的顺序进行复合排序，包含`Field`和`Type`两个字段，例如`[{"Field":"StartTime", "Type": "desc" }]`。其中：'."\n" + ."\n" + .'- `Field`表示需要排序的字段名，支持如下字段：'."\n" + .' - `StartTime`：执行开始时间。'."\n" + .' - `Status`：执行状态。'."\n" + .' - `UserName`：用户名称。'."\n" + .' - `Cost`：执行耗时。'."\n" + .' - `PeakMemory`：峰值内存。'."\n" + .' - `ScanSize`：扫描数据量。'."\n" + .' - `Database`：数据库名称。'."\n" + .' - `ClientIp`：访问源地址.'."\n" + .' - `ResourceGroup`：资源组。'."\n" + .' - `QueueTime`：排队耗时。'."\n" + .' - `OutputRows`：输出行数。'."\n" + .' - `OutputDataSize`：输出数据量。'."\n" + .' - `ResourceCostRank`：SQL内部算子的耗时排名（仅当`QueryCondition`取值为`{"Type":"status","Value":"running"}`时，支持使用该字段）。'."\n" + ."\n" + .'- `Type`表示排序类型，支持如下取值（取值均不区分大小写）：'."\n" + .' - `Desc`：降序。'."\n" + .' - `Asc`：升序。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"StartTime", "Type": "desc" }]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PatternId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL Pattern的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5575924945138******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Querys' => [ + 'description' => 'SQL语句详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'SQL' => [ + 'description' => 'SQL语句详情。'."\n" + .'> 出于性能考虑，当前SQL语句最长支持显示5120个字符，超出限制的SQL语句会被截断。您可以调用[DownloadDiagnosisRecords](~~308212~~)接口下载符合指定条件的SQL语句的摘要信息，包括完整的SQL语句。', + 'type' => 'string', + 'example' => 'SELECT count(*)\\nFROM nation', + ], + 'SQLTruncatedThreshold' => [ + 'description' => 'SQL语句的截断阈值，固定为5120个字符。超过该长度的SQL语句会被截断。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5120', + ], + 'Status' => [ + 'description' => 'SQL语句的状态，取值为：'."\n" + .'- **running**：执行中。'."\n" + .'- **finished**：已完成。'."\n" + .'- **failed**：执行失败。', + 'type' => 'string', + 'example' => 'finished', + ], + 'OutputDataSize' => [ + 'description' => '返回数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'Cost' => [ + 'description' => '查询的总耗时。单位：毫秒。'."\n" + .'> 该耗时指标是`QueuedTime`、`TotalPlanningTime`和`ExecutionTime`三个耗时指标的累加值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OutputRows' => [ + 'description' => '返回行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RcHost' => [ + 'description' => '执行SQL语句的AnalyticDB MySQL前端节点IP和端口信息。', + 'type' => 'string', + 'example' => '10.0.XX.XX:3004', + ], + 'ScanSize' => [ + 'description' => '扫描数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'ProcessId' => [ + 'description' => '查询ID。', + 'type' => 'string', + 'example' => '2021093000414401000000023503151******', + ], + 'StartTime' => [ + 'description' => 'SQL语句的执行开始时间，格式为Unix时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1632933704000', + ], + 'SQLTruncated' => [ + 'description' => '查询结果的长度是否超过阈值（即是否被截断），取值说明：'."\n" + .'- **true**：查询结果的长度超过阈值。'."\n" + .'- **false**：查询结果的长度未超过阈值。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Database' => [ + 'description' => '执行SQL语句的数据库名称。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'ScanRows' => [ + 'description' => '扫描行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ResourceCostRank' => [ + 'description' => 'SQL语句内部算子的耗时排名。'."\n" + .'> 仅状态为执行中，即`Status`取值为`running`的SQL语句支持返回该字段。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClientIp' => [ + 'description' => '访问源地址。', + 'type' => 'string', + 'example' => '59.82.XX.XX', + ], + 'PeakMemory' => [ + 'description' => '峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16648', + ], + 'QueueTime' => [ + 'description' => '查询执行前的排队时间，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'ResourceGroup' => [ + 'description' => 'SQL语句所属的资源池。', + 'type' => 'string', + 'example' => 'user_default', + ], + 'UserName' => [ + 'description' => '执行SQL语句的用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'ExecutionTime' => [ + 'description' => '查询执行的耗时，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'TotalPlanningTime' => [ + 'description' => '生成执行计划的耗时，单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'EtlWriteRows' => [ + 'description' => 'ETL任务写表的行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalStages' => [ + 'description' => '查询生成的总Stage数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'QueryProperties' => [ + 'description' => '当前查询最终生效的属性列表。'."\n" + ."\n" + .'> 常用属性列表，可以参考官方文档，[Config和Hint配置参数](~~408955~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '属性键值描述。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '属性名称。', + 'type' => 'string', + 'example' => 'max_select_items_count', + ], + 'Value' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => '1024', + ], + ], + ], + ], + 'PatternId' => [ + 'description' => 'SQL Pattern的ID。'."\n" + .'> 您可以调用[DescribePatternPerformance](~~612503~~)接口查看指定时间内该SQLPattern执行的详细指标。', + 'type' => 'string', + 'example' => '-5575924945138******', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7F88BEFA-CF0B-5C95-8BB1-92EC9F09E40D', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Querys\\": [\\n {\\n \\"SQL\\": \\"SELECT count(*)\\\\\\\\nFROM nation\\",\\n \\"SQLTruncatedThreshold\\": 5120,\\n \\"Status\\": \\"finished\\",\\n \\"OutputDataSize\\": 9,\\n \\"Cost\\": 10,\\n \\"OutputRows\\": 1,\\n \\"RcHost\\": \\"10.0.XX.XX:3004\\",\\n \\"ScanSize\\": 9,\\n \\"ProcessId\\": \\"2021093000414401000000023503151******\\",\\n \\"StartTime\\": 1632933704000,\\n \\"SQLTruncated\\": false,\\n \\"Database\\": \\"adb_demo\\",\\n \\"ScanRows\\": 1,\\n \\"ResourceCostRank\\": 1,\\n \\"ClientIp\\": \\"59.82.XX.XX\\",\\n \\"PeakMemory\\": 16648,\\n \\"QueueTime\\": 6,\\n \\"ResourceGroup\\": \\"user_default\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"ExecutionTime\\": 6,\\n \\"TotalPlanningTime\\": 4,\\n \\"EtlWriteRows\\": 0,\\n \\"TotalStages\\": 2,\\n \\"QueryProperties\\": [\\n {\\n \\"Name\\": \\"max_select_items_count\\",\\n \\"Value\\": \\"1024\\"\\n }\\n ],\\n \\"PatternId\\": \\"-5575924945138******\\"\\n }\\n ],\\n \\"RequestId\\": \\"7F88BEFA-CF0B-5C95-8BB1-92EC9F09E40D\\"\\n}","type":"json"}]', + 'title' => '查看SQL摘要信息', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeDownloadRecords' => [ + 'summary' => '查看目标AnalyticDB MySQL湖仓版（3.0）集群中最近5次的SQL查询下载任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132356', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL湖仓版（3.0）集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-8vb6ha79k6e****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => '详情。', + 'type' => 'array', + 'items' => [ + 'description' => '下载列表详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态，取值为：'."\n" + .'- **running**：正在下载。'."\n" + .'- **finished**：已完成。'."\n" + .'- **failed**：下载失败。', + 'type' => 'string', + 'example' => 'finished', + ], + 'DownloadId' => [ + 'description' => '下载任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '636890', + ], + 'ExceptionMsg' => [ + 'description' => '下载任务失败时返回的异常信息。', + 'type' => 'string', + 'example' => 'The query result is empty.', + ], + 'Url' => [ + 'description' => '文件下载地址。', + 'type' => 'string', + 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/amv-*********/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******"', + ], + 'FileName' => [ + 'description' => '下载文件名。', + 'type' => 'string', + 'example' => '20210806094635-20210806095135', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D761DA51-12F8-5457-AAA9-F52B9F436D2D', + ], + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Records\\": [\\n {\\n \\"Status\\": \\"finished\\",\\n \\"DownloadId\\": 636890,\\n \\"ExceptionMsg\\": \\"The query result is empty.\\",\\n \\"Url\\": \\"https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/amv-*********/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******\\\\\\"\\",\\n \\"FileName\\": \\"20210806094635-20210806095135\\"\\n }\\n ],\\n \\"RequestId\\": \\"D761DA51-12F8-5457-AAA9-F52B9F436D2D\\",\\n \\"AccessDeniedDetail\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n finished\\n 636890\\n The query result is empty.\\n https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/amv-*********/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******\\"\\n 20210806094635-20210806095135\\n \\n D761DA51-12F8-5457-AAA9-F52B9F436D2D\\n","errorExample":""}]', + 'title' => '查看最近5次的SQL查询下载任务列表', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeSqlPattern' => [ + 'summary' => '查看指定日期内AnalyticDB for MySQL集群的SQL Pattern详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132339', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始日期，UTC时间，格式：yyyy-MM-dd。'."\n" + .'> 仅支持查看30天内的数据。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-08-30', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"Pattern","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。取值说明：'."\n" + .' - `Pattern`：SQL Pattern。'."\n" + .' - `AccessIP`：客户端IP。'."\n" + .' - `User`：用户名。'."\n" + .' - `QueryCount`：查询总数。'."\n" + .' - `AvgPeakMemory`：平均峰值内存，单位：KB。'."\n" + .' - `MaxPeakMemory`：最大峰值内存，单位：KB。'."\n" + .' - `AvgCpuTime`：平均计算耗时，单位：毫秒（ms）。'."\n" + .' - `MaxCpuTime`：最大计算耗时，单位：毫秒（ms）。'."\n" + .' - `AvgStageCount`：平均Stage个数。'."\n" + .' - `MaxStageCount`：最大Stage个数。'."\n" + .' - `AvgTaskCount`：平均Task个数。'."\n" + .' - `MaxTaskCount`：最大Task个数。'."\n" + .' - `AvgScanSize`：平均扫描量，单位：KB。'."\n" + .' - `MaxScanSize`：最大扫描量，单位：KB。'."\n" + ."\n" + .'- `Type`表示排序方式。取值说明：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。'."\n" + ."\n" + .'> - 若不设置参数，默认按照`Pattern`字段升序排列。'."\n" + .'- 若需要按照`AccessIP`字段排序，则`Type`参数必须设置为`accessip`；若需要按照`User`字段排序，则`Type`参数必须留空或设置为`user`。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"Field":"Pattern","Type":"Asc"}]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值：大于0且不超过Integer的最大值。'."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'SqlPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '需要包含的SQL Pattern的关键字。'."\n" + .'> 若该参数不填，默认返回目标集群在`StartTime`参数所设日期内的所有SQL Pattern详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定维度来聚合SQL Pattern。取值说明：'."\n" + .' - `user`：按用户维度聚合。'."\n" + .' - `accessip`：按访问IP来源聚合。'."\n" + ."\n" + .'> 若该参数不填，默认按照 `user`维度聚合。', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看目标地域下所有集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1ej1nq9n6****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **10**（默认值）'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Items' => [ + 'description' => '列表详情。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'AvgStageCount' => [ + 'description' => '平均扫描行数。', + 'type' => 'string', + 'example' => '2', + ], + 'MaxCpuTime' => [ + 'description' => 'SQL的最大运行时间，单位：毫秒（ms）。', + 'type' => 'string', + 'example' => '17', + ], + 'AccessIP' => [ + 'description' => '客户端IP。'."\n" + .'> 仅当**Type**参数设置为**accessip**时，返回该参数。', + 'type' => 'string', + 'example' => '100.104.xx.xx', + ], + 'AvgScanSize' => [ + 'description' => '平均扫描量，单位：KB。', + 'type' => 'string', + 'example' => '244', + ], + 'MaxScanSize' => [ + 'description' => '最大扫描量，单位：KB。', + 'type' => 'string', + 'example' => '1024', + ], + 'MaxPeakMemory' => [ + 'description' => '最大峰值内存，单位：KB。', + 'type' => 'string', + 'example' => '480096', + ], + 'AvgCpuTime' => [ + 'description' => '平均执行时间，单位：毫秒（ms）。', + 'type' => 'string', + 'example' => '1.0625', + ], + 'User' => [ + 'description' => '用户名。'."\n" + .'> 仅当**Type**参数留空或设置为**user**时，返回该参数。', + 'type' => 'string', + 'example' => 'test_acc', + ], + 'AvgPeakMemory' => [ + 'description' => '平均峰值内存，单位：KB。', + 'type' => 'string', + 'example' => '240048', + ], + 'MaxStageCount' => [ + 'description' => '最大Stage个数。', + 'type' => 'string', + 'example' => '2', + ], + 'MaxTaskCount' => [ + 'description' => '最大任务数。', + 'type' => 'string', + 'example' => '2', + ], + 'InstanceName' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1ej1nq9n6****', + ], + 'QueryCount' => [ + 'description' => '查询总数。', + 'type' => 'string', + 'example' => '16', + ], + 'ReportDate' => [ + 'description' => '查询日期。', + 'type' => 'string', + 'example' => '2022-08-30', + ], + 'Pattern' => [ + 'description' => 'SQL Pattern。', + 'type' => 'string', + 'example' => 'SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1', + ], + 'AvgTaskCount' => [ + 'description' => '平均任务数。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DB1F6C23-CBCA-5260-9366-BA7BB5EBF6F1', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 2,\\n \\"TotalCount\\": 50,\\n \\"Items\\": [\\n {\\n \\"AvgStageCount\\": \\"2\\",\\n \\"MaxCpuTime\\": \\"17\\",\\n \\"AccessIP\\": \\"100.104.xx.xx\\",\\n \\"AvgScanSize\\": \\"244\\",\\n \\"MaxScanSize\\": \\"1024\\",\\n \\"MaxPeakMemory\\": \\"480096\\",\\n \\"AvgCpuTime\\": \\"1.0625\\",\\n \\"User\\": \\"test_acc\\",\\n \\"AvgPeakMemory\\": \\"240048\\",\\n \\"MaxStageCount\\": \\"2\\",\\n \\"MaxTaskCount\\": \\"2\\",\\n \\"InstanceName\\": \\"amv-bp1ej1nq9n6****\\",\\n \\"QueryCount\\": \\"16\\",\\n \\"ReportDate\\": \\"2022-08-30\\",\\n \\"Pattern\\": \\"SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1\\",\\n \\"AvgTaskCount\\": \\"2\\"\\n }\\n ],\\n \\"RequestId\\": \\"DB1F6C23-CBCA-5260-9366-BA7BB5EBF6F1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 30\\n 2\\n 50\\n \\n 2\\n 17\\n 100.104.xx.xx\\n 244\\n 1024\\n 480096\\n 1.0625\\n test_acc\\n 240048\\n 2\\n 2\\n amv-bp1ej1nq9n6****\\n 16\\n 2022-08-30\\n SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1\\n 2\\n \\n DB1F6C23-CBCA-5260-9366-BA7BB5EBF6F1\\n","errorExample":""}]', + 'title' => '查询SQL Pattern详情', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeSQLPatterns' => [ + 'summary' => '查看指定日期内AnalyticDB MySQL湖仓版集群的SQL Pattern列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132328', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AnalyticDB MySQL湖仓版集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL湖仓版集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-8vb8de93v9b****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> - 仅支持查看最近14天的数据。'."\n" + .'- 查询开始时间和查询结束时间的间隔不能大于24小时。 ', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-09-06T03:06:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 查询结束时间需晚于查询开始时间。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-09-07T03:06:00Z', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '将查询结果按指定字段进行排序。格式为JSON字符串，例如`[{"Field":"AverageQueryTime","Type":"Asc"}]`。其中：'."\n" + .'- `Field`表示排序字段。取值说明：'."\n" + .' - `PatternCreationTime`：查询时间范围内，Pattern的最早提交时间。'."\n" + .' - `AverageQueryTime`：查询时间范围内，Pattern的平均总耗时。'."\n" + .' - `MaxQueryTime`：查询时间范围内，Pattern的最大总耗时。'."\n" + .' - `AverageExecutionTime`: 查询时间范围内，Pattern的平均执行耗时。'."\n" + .' - `MaxExecutionTime`: 查询时间范围内，Pattern的最大执行耗时。'."\n" + .' - `AveragePeakMemory`: 查询时间范围内，Pattern的平均峰值内存。'."\n" + .' - `MaxPeakMemory`: 查询时间范围内，Pattern的最大峰值内存。'."\n" + .' - `AverageScanSize`: 查询时间范围内，Pattern的平均数据读取量。'."\n" + .' - `MaxScanSize`: 查询时间范围内，Pattern的最大数据读取量。'."\n" + .' - `QueryCount`: 查询时间范围内，Pattern的执行次数。'."\n" + .' - `FailedCount`: 查询时间范围内，Pattern的失败次数。'."\n" + ."\n" + .'- `Type`表示排序方式。取值说明（取值不区分大小写）：'."\n" + .' - `Asc`：升序排序。'."\n" + .' - `Desc`： 降序排序。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"AverageQueryTime","Type":"Asc"}]', + 'default' => '[{"Type":"desc","Field":"AveragePeakMemory"}]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值：大于0且不超过Integer的最大值。'."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **10**（默认值）'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言配置，取值说明：'."\n" + .'- **zh**：简体中文（默认语言）。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'SQL Pattern的详细信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PatternDetails' => [ + 'description' => '列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL Pattern的详细信息。', + 'type' => 'object', + 'properties' => [ + 'SQLPattern' => [ + 'description' => 'SQL Pattern的语句。', + 'type' => 'string', + 'example' => 'SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)', + ], + 'PatternId' => [ + 'description' => 'SQL Pattern语句的ID。', + 'type' => 'string', + 'example' => '5575924945138******', + ], + 'User' => [ + 'description' => '提交Pattern相关的SQL数据库用户名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'AccessIp' => [ + 'description' => '提交Pattern的相关SQL客户端IP地址。', + 'type' => 'string', + 'example' => '192.168.xx.xx', + ], + 'Tables' => [ + 'description' => 'SQL Pattern扫描的列表信息。', + 'type' => 'string', + 'example' => 'tpch.orders', + ], + 'PatternCreationTime' => [ + 'description' => '指定时间范围内，Pattern的最早提交时间。', + 'type' => 'string', + 'example' => '2022-09-06 05:06:00', + ], + 'AverageQueryTime' => [ + 'description' => '指定时间范围内，Pattern的平均总耗时。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'MaxQueryTime' => [ + 'description' => '指定时间范围内，Pattern的最大总耗时。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2341', + ], + 'AverageExecutionTime' => [ + 'description' => '指定时间范围内，Pattern的平均执行时间。单位：毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234.78', + ], + 'MaxExecutionTime' => [ + 'description' => '指定时间范围内，Pattern的最大执行时间。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2142', + ], + 'AveragePeakMemory' => [ + 'description' => '指定时间范围内，Pattern的平均峰值内存。单位：Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234.22', + ], + 'MaxPeakMemory' => [ + 'description' => 'Pattern相关SQL的最大峰值内存，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234149', + ], + 'AverageScanSize' => [ + 'description' => '指定时间范围内，Pattern的平均数据读取量。单位：Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '234149.23', + ], + 'MaxScanSize' => [ + 'description' => 'Pattern相关SQL的最大数据读取量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32212254', + ], + 'QueryCount' => [ + 'description' => '指定时间范围内，Pattern的执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '345', + ], + 'FailedCount' => [ + 'description' => '指定时间范围内，Pattern的失败次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18', + ], + 'Blockable' => [ + 'description' => '能否拦截当前SQL Pattern的运行，取值说明：'."\n" + .'* **true**：支持拦截。'."\n" + .'* **false**：不支持拦截。'."\n" + .'> 目前AnalyticDB MySQL版仅支持Select和Insert相关语句的拦截。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'QueryTimeSum' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'QueryTimePercentage' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PeakMemorySum' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PeakMemoryPercentage' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'ScanSizeSum' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'ScanSizePercentage' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'AverageOperatorCost' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'MaxOperatorCost' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'OperatorCostSum' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'OperatorCostPercentage' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'AverageScanCost' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'MaxScanCost' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'ScanCostSum' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'ScanCostPercentage' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F3174013-5B7A-5A47-9FE0-6B5D397BD86A', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有Ram校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1*****************7",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "2***************9",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .'}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"PatternDetails\\": [\\n {\\n \\"SQLPattern\\": \\"SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)\\",\\n \\"PatternId\\": \\"5575924945138******\\",\\n \\"User\\": \\"test\\",\\n \\"AccessIp\\": \\"192.168.xx.xx\\",\\n \\"Tables\\": \\"tpch.orders\\",\\n \\"PatternCreationTime\\": \\"2022-09-06 05:06:00\\",\\n \\"AverageQueryTime\\": 4,\\n \\"MaxQueryTime\\": 2341,\\n \\"AverageExecutionTime\\": 234.78,\\n \\"MaxExecutionTime\\": 2142,\\n \\"AveragePeakMemory\\": 234.22,\\n \\"MaxPeakMemory\\": 234149,\\n \\"AverageScanSize\\": 234149.23,\\n \\"MaxScanSize\\": 32212254,\\n \\"QueryCount\\": 345,\\n \\"FailedCount\\": 18,\\n \\"Blockable\\": true,\\n \\"QueryTimeSum\\": 0,\\n \\"QueryTimePercentage\\": 0,\\n \\"PeakMemorySum\\": 0,\\n \\"PeakMemoryPercentage\\": 0,\\n \\"ScanSizeSum\\": 0,\\n \\"ScanSizePercentage\\": 0,\\n \\"AverageOperatorCost\\": 0,\\n \\"MaxOperatorCost\\": 0,\\n \\"OperatorCostSum\\": 0,\\n \\"OperatorCostPercentage\\": 0,\\n \\"AverageScanCost\\": 0,\\n \\"MaxScanCost\\": 0,\\n \\"ScanCostSum\\": 0,\\n \\"ScanCostPercentage\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"F3174013-5B7A-5A47-9FE0-6B5D397BD86A\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 10\\n 20\\n \\n SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)\\n 5575924945138******\\n test\\n 192.168.xx.xx\\n tpch.orders\\n 2022-09-06 05:06:00\\n 4\\n 2341\\n 234.78\\n 2142\\n 234.22\\n 234149\\n 234149.23\\n 32212254\\n 345\\n 18\\n true\\n \\n F3174013-5B7A-5A47-9FE0-6B5D397BD86B\\n","errorExample":""}]', + 'title' => '查询SQL Pattern列表', + 'description' => '- 中心的公网接入地址：`adb.aliyuncs.com`。'."\n" + .'- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribePatternPerformance' => [ + 'summary' => '查看集群指定时间段内SQL Pattern的各指标（如查询时间、平均内存消耗）详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132321', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf6li1r3do8m****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> - 当前日期为北京时间2022年8月22日，最早可以查询到北京时间2022年8月9日（UTC时间：2022-08-08T16:00:00Z)的数据，若查询时间早于8月9日（UTC时间：2022-08-08T16:00:00Z)，返回值为空。'."\n" + .'- 查询开始时间和查询结束时间的间隔不能大于24小时。 ', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-08-21T02:15:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。'."\n" + .'> 查询结束时间需晚于查询开始时间。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-08-22T01:06:00Z', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PatternId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL Pattern的ID。'."\n" + .'> 您可以调用[DescribeSQLPatterns](~~321868~~)接口查看指定时间内目标集群下所有的SQL Pattern列表信息，包括SQL Pattern的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '3847585356974******', + 'default' => '-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '查询结束时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2022-08-22T01:06:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F21AF487-B8C9-57E0-8E3A-A92BC3611FB6', + ], + 'StartTime' => [ + 'description' => '查询开始时间，UTC时间，格式：yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2022-08-21T02:15:00Z', + ], + 'Performances' => [ + 'description' => '详情。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '查询的各项性能指标项。取值说明：'."\n" + .'- **AnalyticDB_PatternQueryCount**：Pattern相关查询的总次数。'."\n" + .'- **AnalyticDB_PatternQueryTime**：Pattern相关查询的总耗时。'."\n" + .'- **AnalyticDB_PatternExecutionTime**：Pattern相关查询的执行耗时。'."\n" + .'- **AnalyticDB_PatternPeakMemory**：Pattern相关查询的峰值内存。'."\n" + .'- **AnalyticDB_PatternScanSize**：Pattern相关查询的数据读取量。', + 'type' => 'string', + 'example' => 'AnalyticDB_PatternExecutionTime', + ], + 'Unit' => [ + 'description' => '各项性能指标项对应的单位。取值说明：'."\n" + .'- 当性能指标项为查询时间相关（即`Key`值为`AnalyticDB_PatternQueryTime`或`AnalyticDB_PatternExecutionTime`）时，该返回值为**ms**。'."\n" + .'- 当性能指标项为峰值内存相关（即`Key`值为`AnalyticDB_PatternPeakMemory`）时，该返回值为**MB**。'."\n" + .'- 当性能指标项为数据读取量（即`Key`值为`AnalyticDB_PatternScanSize`）时，该返回值为**MB**。'."\n" + .'- 当性能指标项为查询次数（即`Key`值为`AnalyticDB_PatternQueryCount`）时，该返回值为空。', + 'type' => 'string', + 'example' => 'ms', + ], + 'Series' => [ + 'description' => '性能指标项下各个性能值的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '列表项。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '性能值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不同时间点下的性能值详细信息。', + 'type' => 'string', + 'example' => '[ "2021-11-18 13:38:00", "224" ]', + ], + ], + 'Name' => [ + 'description' => '性能值的名称。取值说明：'."\n" + .'- 当`Key`值为`AnalyticDB_PatternQueryCount`时，该参数返回 `pattern_query_count`，即当前Pattern相关SQL的执行次数。'."\n" + .'- 当`Key`值为`AnalyticDB_PatternQueryTime`时，该参数返回：'."\n" + .' - `average_query_time`，即当前Pattern相关SQL的平均总耗时。'."\n" + .' - `max_query_time`，即当前Pattern相关SQL的最大总耗时。'."\n" + .'- 当`Key`值为`AnalyticDB_PatternExecutionTime`时，该参数返回：'."\n" + .' - `average_execution_time`，即当前Pattern相关SQL的平均执行耗时。'."\n" + .' - `max_execution_time`，即当前Pattern相关SQL的最大执行耗时。'."\n" + .'- 当`Key`值为`AnalyticDB_PatternPeakMemory`时，该参数返回：'."\n" + .' - `average_peak_memory`，即当前Pattern相关SQL的平均峰值内存。'."\n" + .' - `max_peak_memory`，即当前Pattern相关SQL的最大峰值内存。'."\n" + .'- 当`Key`值为`AnalyticDB_PatternScanSize`时，该参数返回：'."\n" + .' - `average_scan_size`，即当前Pattern相关SQL的平均读取数据量。'."\n" + .' - `max_scan_size`，即当前Pattern相关SQL的最大数据读取量。', + 'type' => 'string', + 'example' => 'max_query_time', + ], + ], + ], + ], + ], + ], + ], + 'User' => [ + 'type' => 'string', + ], + 'AccessIp' => [ + 'type' => 'string', + ], + 'SQLPattern' => [ + 'type' => 'string', + ], + 'Tables' => [ + 'type' => 'string', + ], + 'FailedCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'QueryCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-08-22T01:06:00Z\\",\\n \\"RequestId\\": \\"F21AF487-B8C9-57E0-8E3A-A92BC3611FB6\\",\\n \\"StartTime\\": \\"2022-08-21T02:15:00Z\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_PatternExecutionTime\\",\\n \\"Unit\\": \\"ms\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n \\"[ \\\\\\"2021-11-18 13:38:00\\\\\\", \\\\\\"224\\\\\\" ]\\"\\n ],\\n \\"Name\\": \\"max_query_time\\"\\n }\\n ]\\n }\\n ],\\n \\"User\\": \\"\\",\\n \\"AccessIp\\": \\"\\",\\n \\"SQLPattern\\": \\"\\",\\n \\"Tables\\": \\"\\",\\n \\"FailedCount\\": 0,\\n \\"QueryCount\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\n 2022-08-22T01:06:00Z\\n F21AF487-B8C9-57E0-8E3A-A92BC3611FB6\\n 2022-08-21T02:15:00Z\\n \\n AnalyticDB_PatternExecutionTime\\n ms\\n \\n [ \\"2021-11-18 13:38:00\\", \\"224\\" ]\\n max_query_time\\n \\n \\n","errorExample":""}]', + 'title' => '查询SQL Pattern的指标', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeDBClusterSpaceSummary' => [ + 'summary' => '查看实例的空间概览信息，包括总数据量、热数据量、冷数据量、数据增长量等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212723', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-wz9v5sa7mm79z4l2', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => '总数据量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：总数据量 = 热数据总量 + 冷数据总量。', + 'type' => 'string', + 'example' => '8388608', + ], + 'HotData' => [ + 'description' => '热数据。', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => '热数据总量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：热数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4194304', + ], + 'DataSize' => [ + 'description' => '表记录数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'IndexSize' => [ + 'description' => '普通索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => '主键索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'OtherSize' => [ + 'description' => '其他，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + ], + ], + 'ColdData' => [ + 'description' => '冷数据。', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => '冷数据总量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：冷数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4194304', + ], + 'DataSize' => [ + 'description' => '表记录数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'IndexSize' => [ + 'description' => '普通索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => '主键索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'OtherSize' => [ + 'description' => '其他，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + ], + ], + 'DataGrowth' => [ + 'description' => '数据增长量。', + 'type' => 'object', + 'properties' => [ + 'DayGrowth' => [ + 'description' => '近1天增长量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：近1天增长量 = 当前总数据量 - 1天前总数据量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'WeekGrowth' => [ + 'description' => '近7天日均增长量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：近7天日均增长量 = (当前总数据量 - 7天前总数据量) / 7。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"TotalSize\\": \\"8388608\\",\\n \\"HotData\\": {\\n \\"TotalSize\\": 4194304,\\n \\"DataSize\\": 1048576,\\n \\"IndexSize\\": 1048576,\\n \\"PrimaryKeyIndexSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n },\\n \\"ColdData\\": {\\n \\"TotalSize\\": 4194304,\\n \\"DataSize\\": 1048576,\\n \\"IndexSize\\": 1048576,\\n \\"PrimaryKeyIndexSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n },\\n \\"DataGrowth\\": {\\n \\"DayGrowth\\": 1048576,\\n \\"WeekGrowth\\": 1048576\\n }\\n }\\n}","type":"json"}]', + 'title' => '查看集群的空间概览', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeExcessivePrimaryKeys' => [ + 'summary' => '查看集群存在主键过多的表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217360', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可通过接口[DescribeRegions](~~143074~~)查看可用的地域ID。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2019-06-01T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2019-06-01T16:00:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：'."\n" + .'- **zh（默认值）**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **ja**：日文。'."\n" + .'- **zh-tw**：繁体中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定字段排序，json格式：JSON数组，有序，按顺序输入排列字段和升降序类型：'."\n" + ."\n" + .'如：'."\n" + ."\n" + .'```'."\n" + .'['."\n" + ."\n" + .' {'."\n" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\n" + .' }'."\n" + ."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'其中Field表示需要排序的字段名，目前仅支持对"Name" 字段排序。'."\n" + .'Type表示排序类型 Desc为降序，Asc为升序'."\n" + ."\n" + .'均不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"TableName", "Type": "Desc" }]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'string', + 'example' => '300', + ], + 'PageNumber' => [ + 'description' => '页号，和传入的值一致。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认值）。'."\n" + .'* **50**。'."\n" + .'* **100**。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '863D51B7-5321-41D8-A0B6-A088B0******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'am-bp1ub9grke1****', + ], + 'Tables' => [ + 'description' => '主键过多表列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'ColumnCount' => [ + 'description' => '总列数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'PrimaryKeyCount' => [ + 'description' => '主键字段个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PrimaryKeyColumns' => [ + 'description' => '主键字段列表。', + 'type' => 'string', + 'example' => 'id,date'."\n", + ], + 'SpaceRatio' => [ + 'description' => '表空间占比，单位：%。'."\n" + ."\n" + .'> 计算公式为：表空间占比 = (表总数据量 / 实例总数据量) * 100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '23', + ], + 'TotalSize' => [ + 'description' => '冷数据总量，单位：Byte。'."\n" + ."\n" + .'> 计算公式为：冷数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => '主键索引数据量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '222', + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项及检测结果列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检测项名字。', + 'type' => 'string', + 'example' => '主键过多检测', + ], + 'Message' => [ + 'description' => '检测结果信息。', + 'type' => 'string', + 'example' => '检测到多个表存在主键过多的问题', + ], + 'Status' => [ + 'description' => '检测结果状态。', + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNNING'."\n" + .'CRITICAL', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "1906102576997697",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "202515810214480629",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "adb:DescribeExcessivePrimaryKeys"'."\n" + .' }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"300\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0******\\",\\n \\"DBClusterId\\": \\"am-bp1ub9grke1****\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"ColumnCount\\": 21,\\n \\"PrimaryKeyCount\\": 2,\\n \\"PrimaryKeyColumns\\": \\"id,date\\\\n\\",\\n \\"SpaceRatio\\": 23,\\n \\"TotalSize\\": 4,\\n \\"PrimaryKeyIndexSize\\": 222\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"主键过多检测\\",\\n \\"Message\\": \\"检测到多个表存在主键过多的问题\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNNING\\\\nCRITICAL\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1906102576997697\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"202515810214480629\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => '检测主键过多表', + ], + 'ModifyDBClusterMaintainTime' => [ + 'summary' => '修改指定集群的可维护时间段。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + 'name' => 'MaintainTime', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的可维护时间段，格式为hh:mmZ-hh:mmZ。'."\n" + .'> 时间间隔只能为1小时，且需要设置为整点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '22:00Z-23:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n","errorExample":""}]', + 'title' => '修改可维护时间段', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyDBClusterResourceGroup' => [ + 'summary' => '修改集群所属的阿里云资源组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bpxxxxx', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要移入云资源实例的资源组ID。'."\n" + ."\n" + .'> 资源组是在阿里云账号下进行资源分组管理的一种机制，资源组能够帮助您解决单个云账号内的资源分组和授权管理等复杂性问题。更多信息，请参见[什么是资源管理](~~94475~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rg-acxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupTime.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupPeriod.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter BackupRetentionPeriod is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]', + 'title' => '修改集群所属的资源组', + ], + 'ListTagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，您可通过接口[DescribeRegions](~~143074~~)查看可用的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型定义。唯一取值：**dbclusterlakeversion**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dbclusterlakeversion', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的 Token 继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群ID。支持同时传入多个集群ID，N的取值范围为：1~50。'."\n" + .'> ResourceId.N参数和Tag.N.Key参数至少传入一个。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。支持同时传入多个集群ID，N的取值范围为：1~50。'."\n" + .'> ResourceId.N参数和Tag.N.Key参数至少传入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp1l20nxxxxxxxxxx', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。支持同时传入多个标签键，不允许传入空字符串。N的取值范围为：1~20。'."\n" + ."\n" + .'> ResourceId.N参数和Tag.N.Key参数至少传入一个。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => '标签键对应的标签值。支持同时传入多个标签值，允许传入空字符串。N的取值范围为：1~20。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的 token 继续查询。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '184DE106-CB2C-4DD2-B57F-396652E6C8F8', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '查询到的集群和标签的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'dbclusterlakeversion', + ], + 'TagValue' => [ + 'description' => '标签键对应的标签值。', + 'type' => 'string', + 'example' => 'testvalue1', + ], + 'ResourceId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1l20nxxxxxxxxxx', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'testkey1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec21345\\",\\n \\"RequestId\\": \\"184DE106-CB2C-4DD2-B57F-396652E6C8F8\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"dbclusterlakeversion\\",\\n \\"TagValue\\": \\"testvalue1\\",\\n \\"ResourceId\\": \\"amv-bp1l20nxxxxxxxxxx\\",\\n \\"TagKey\\": \\"testkey1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询标签列表', + 'summary' => '调用ListTagResources查询一个或多个AnalyticDB MySQL集群已绑定的标签列表，或者查询一个或多个标签绑定的AnalyticDB MySQL集群列表。', + ], + 'DescribeAutoRenewalAttribute' => [ + 'summary' => '查询包年包月集群自动续费状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10788', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群 ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1u8c0mgfg58****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型最大值的正整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageRecordCount' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BA0F6761-7A8C-59F8-9624-FB56788C0EDF', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoRenewalAttribute' => [ + 'description' => '自动续费详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-uf6485635fz8****', + ], + 'AutoRenewalPeriodUnit' => [ + 'description' => '自动续费时长的单位，取值说明：'."\n" + ."\n" + .'- **Year**：年。'."\n" + .'- **Month**：月。', + 'type' => 'string', + 'example' => 'Year', + ], + 'AutoRenewalPeriod' => [ + 'description' => '自动续费时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AutoRenewalStatus' => [ + 'description' => '自动续费状态，取值说明：'."\n" + ."\n" + .'- **AutoRenewal**：自动续费。'."\n" + .'- **Normal**：手动续费，集群到期前通过短信提醒。'."\n" + .'- **NotRenewal**：到期不续费，集群到期前无提醒，只在到期前第三天发送不续费提醒。', + 'type' => 'string', + 'example' => 'AutoRenewal', + ], + 'AutoRenewalEnabled' => [ + 'description' => '是否开启自动续费，取值说明：'."\n" + ."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 20,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"BA0F6761-7A8C-59F8-9624-FB56788C0EDF\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"AutoRenewalAttribute\\": [\\n {\\n \\"DBClusterId\\": \\"amv-uf6485635fz8****\\",\\n \\"AutoRenewalPeriodUnit\\": \\"Year\\",\\n \\"AutoRenewalPeriod\\": 1,\\n \\"AutoRenewalStatus\\": \\"AutoRenewal\\",\\n \\"AutoRenewalEnabled\\": true,\\n \\"RegionId\\": \\"cn-shenzhen\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询包年包月集群自动续费状态', + ], + 'ModifyAutoRenewalAttribute' => [ + 'summary' => '设置包年包月集群自动续费状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10841', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf6pl56w1j8h****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AutoRenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费状态，取值说明：'."\n" + ."\n" + .'- **AutoRenewal**：自动续费。'."\n" + .'- **Normal**：手动续费，集群到期前通过短信提醒。'."\n" + .'- **NotRenewal**：到期不续费，集群到期前无提醒，只在到期前第三天发送不续费提醒。', + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + 'default' => 'AutoRenewal', + ], + ], + [ + 'name' => 'AutoRenewalPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费时长，默认值为1，取值说明：'."\n" + ."\n" + .'- 当**AutoRenewalPeriod**为**Month**时，取值为1~11（整数）。'."\n" + .'- 当**AutoRenewalPeriod**为**Year**时，取值为1、2、3、5（整数）。'."\n" + .'> 续费的时间越长价格越优惠，续费1年的实际价格会比10个月或11个月更划算。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoRenewalPeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费时长，取值说明：'."\n" + ."\n" + .'- Year：年。'."\n" + .'- Month：月。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + 'default' => 'Month', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\"\\n}","type":"json"}]', + 'title' => '设置包年包月集群自动续费状态', + ], + 'DescribeApsResourceGroups' => [ + 'summary' => '获取数据同步时所用资源组的详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146751', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看指定集群的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'>您可以调用[DescribeDBClusters](~~612397~~)接口查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1t6rym21****', + ], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据同步任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'aps-hz1686v37sx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应模式。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FC370D7-1D4C-5A8E-805E-F73366382C66', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回Success。'."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Data' => [ + 'description' => '资源组信息列表。', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'description' => '资源组的步长，单位ACU。'."\n" + .'- 当GroupType为**Interactive**时，步长为16 ACU。'."\n" + .'- 当GroupType为**Job**时，步长为8 ACU。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'ResourceGroups' => [ + 'description' => '资源组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组列表。', + 'type' => 'object', + 'properties' => [ + 'CuOptions' => [ + 'description' => '资源梯度值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源梯度值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '无', + ], + ], + 'MaxComputeResource' => [ + 'description' => '最大计算预留资源，单位ACU。'."\n" + .'- 当GroupType为**Interactive**时，计算预留资源最大为集群当前未分配资源，步长为16 ACU。'."\n" + .'- 当GroupType为**Job**时，计算预留资源最大为集群当前未分配资源，步长为8 ACU。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '512', + ], + 'LeftComputeResource' => [ + 'description' => '剩余计算资源，单位ACU。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '512', + ], + 'MinComputeResource' => [ + 'description' => '最小计算预留资源，单位ACU。'."\n" + .'- 当GroupType为**Interactive**时，计算预留资源最小为16 ACU。'."\n" + .'- 当GroupType为**Job**时，计算预留资源最小为0 ACU。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'GroupType' => [ + 'description' => '资源组类型，取值：'."\n" + .'- **Interactive**'."\n" + .'- **Job**'."\n" + .'> 关于湖仓版资源组的详细信息，请参见[资源组介绍](~~428610~~)。', + 'type' => 'string', + 'example' => 'Job', + ], + 'Available' => [ + 'description' => '资源组是否可用。取值说明：'."\n" + .'- **True**：可用。'."\n" + .'- **False**：不可用。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功。取值说明：'."\n" + .'- **True**：成功。'."\n" + .'- **False**：失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FC370D7-1D4C-5A8E-805E-F73366382C66\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Step\\": 8,\\n \\"ResourceGroups\\": [\\n {\\n \\"CuOptions\\": [\\n 0\\n ],\\n \\"MaxComputeResource\\": 512,\\n \\"LeftComputeResource\\": 512,\\n \\"MinComputeResource\\": 0,\\n \\"GroupName\\": \\"test\\",\\n \\"GroupType\\": \\"Job\\",\\n \\"Available\\": true\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 6FC370D7-1D4C-5A8E-805E-F73366382C66\\n Success\\n 200\\n \\n 8\\n \\n 512\\n 0\\n test\\n Job\\n true\\n \\n \\n true\\n","errorExample":""}]', + 'title' => '查询资源组信息', + 'description' => '- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'DescribeApsJobDetail' => [ + 'summary' => 'DescribeApsJobDetail。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '180625', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-E606-4A42-BF6D-******', + ], + 'APSJobDetail' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'SourceEndpointRegion' => [ + 'description' => '源数据库地域。'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'SourceEndpointInstanceID' => [ + 'description' => '源数据库实例ID。', + 'type' => 'string', + 'example' => 'pc-*******', + ], + 'DestinationEndpointRegion' => [ + 'description' => '目标实例所属地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DestinationEndpointInstanceID' => [ + 'description' => '目标端数据库实例ID。', + 'type' => 'string', + 'example' => 'amv-******', + ], + 'PartitionList' => [ + 'description' => '分区列表。', + 'type' => 'string', + 'example' => '{}', + ], + 'DbList' => [ + 'description' => '同步对象列表。'."\n" + ."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'TargetTableMode' => [ + 'description' => '目标表模式。', + 'type' => 'string', + 'example' => '0', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'Running', + ], + ], + 'example' => '-', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-E606-4A42-BF6D-******\\",\\n \\"APSJobDetail\\": {\\n \\"SourceEndpointRegion\\": \\"cn-beijing\\",\\n \\"SourceEndpointInstanceID\\": \\"pc-*******\\",\\n \\"DestinationEndpointRegion\\": \\"cn-beijing\\",\\n \\"DestinationEndpointInstanceID\\": \\"amv-******\\",\\n \\"PartitionList\\": \\"{}\\",\\n \\"DbList\\": \\"{}\\",\\n \\"TargetTableMode\\": \\"0\\",\\n \\"Status\\": \\"Running\\"\\n }\\n}","type":"json"}]', + 'title' => '查询APS任务详情', + ], + 'CreateApsWebhook' => [ + 'summary' => '用于为指定数据库集群和任务类型创建新的Webhook。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsBIVU9O', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群所属地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务类型。取值如下'."\n" + .'任务类型SLS/OSS导出任务：ResultExport。', + 'type' => 'string', + 'required' => true, + 'example' => 'ResultExport', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Webhook数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'Webhook信息。', + 'type' => 'object', + 'properties' => [ + 'WebhookType' => [ + 'description' => '通知方式。取值如下： dingtalk：钉钉。 lark：飞书。', + 'type' => 'string', + 'required' => true, + 'example' => 'dingtalk', + ], + 'Url' => [ + 'description' => '请求地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://example.com/webhook', + ], + 'Key' => [ + 'description' => '加签密钥。', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'Name' => [ + 'description' => 'Webhook名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MyWebhookName', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '1234567890abcdef', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '[]', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '请求返回Code。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890abcdef\\",\\n \\"Data\\": \\"[]\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建Webhook', + ], + 'DeleteApsWebhook' => [ + 'summary' => '用于删除指定数据库集群中的特定Webhook。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsBIVU9O', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf63i4ij56b***', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WebhookId', + 'in' => 'formData', + 'schema' => [ + 'description' => '待删除的Webhook的ID。', + 'type' => 'string', + 'required' => true, + 'example' => '***1*595*', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => 'exampleRequestId', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '[]', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => '操作成功', + ], + 'DBClusterId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'amv-uf63i4ij56b***'."\n", + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"exampleRequestId\\",\\n \\"Data\\": \\"[]\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"操作成功\\",\\n \\"DBClusterId\\": \\"amv-uf63i4ij56b***\\\\n\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除Webhook接口', + 'description' => '本API允许用户通过提供`RegionId`、`DBClusterId`以及`WebhookId`来删除一个已存在的Webhook配置。请确保提供的参数值准确无误，以免误删重要设置。', + ], + 'UpdateApsWebhook' => [ + 'summary' => '用于更新指定数据库集群的Webhook配置信息。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsBIVU9O', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'exampleDBClusterId', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'exampleRegionId', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Webhook数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'Webhook数组。', + 'type' => 'object', + 'properties' => [ + 'WebhookId' => [ + 'description' => 'Webhook ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '**355****', + ], + 'Url' => [ + 'description' => '请求地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.com/webhook', + ], + 'Key' => [ + 'description' => '加签密钥。', + 'type' => 'string', + 'required' => false, + 'example' => 'ABC**', + ], + 'WebhookType' => [ + 'description' => '通知方式。 dingtalk：钉钉。 lark：飞书。', + 'type' => 'string', + 'required' => false, + 'example' => 'dingtalk', + ], + 'Name' => [ + 'description' => 'Webhook名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'exampleWebhookName', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => 'exampleRequestId', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '-', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => '操作成功', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp11q28kvl688****', + ], + 'Code' => [ + 'description' => '返回结果编码。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"exampleRequestId\\",\\n \\"Data\\": \\"-\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"操作成功\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新Webhook配置', + ], + 'ListApsWebhook' => [ + 'summary' => '用于查询指定数据库集群下的Webhook配置信息。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsBIVU9O', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-8vbuyjhrih**', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'formData', + 'schema' => [ + 'description' => '**JobType** '."\n" + .'任务类型SLS/OSS导出任务：ResultExport。', + 'type' => 'string', + 'required' => false, + 'example' => 'ResultExport', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'exampleRequestId', + ], + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Webhook' => [ + 'description' => 'Webhook数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'Webhook数组。', + 'type' => 'object', + 'properties' => [ + 'WebhookType' => [ + 'description' => 'Webhook 类型。', + 'type' => 'string', + 'example' => 'dingtalk', + ], + 'WebhookId' => [ + 'description' => '要删除的webhook id。', + 'type' => 'string', + 'example' => '**35***', + ], + 'Url' => [ + 'description' => '请求地址。', + 'type' => 'string', + 'example' => 'https://example.com/webhook', + ], + 'Key' => [ + 'description' => '加签密钥。', + 'type' => 'string', + 'example' => 'your_secret_key', + ], + 'Name' => [ + 'description' => 'webhook名称。', + 'type' => 'string', + 'example' => 'webhook_name', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"exampleRequestId\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Webhook\\": [\\n {\\n \\"WebhookType\\": \\"dingtalk\\",\\n \\"WebhookId\\": \\"**35***\\",\\n \\"Url\\": \\"https://example.com/webhook\\",\\n \\"Key\\": \\"your_secret_key\\",\\n \\"Name\\": \\"webhook_name\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询Webhook', + 'description' => '通过此API，您可以根据`RegionId`、`DBClusterId`以及可选的`JobType`来获取已配置的Webhook列表。其中，`JobType`参数指定了任务类型（例如SLS/OSS导出任务），如果提供，则返回与该任务类型相关的Webhook；如果不提供，则返回所有类型的Webhook。'."\n" + ."\n" + .'注意：确保您提供的`RegionId`和`DBClusterId`是正确的，否则可能无法正确获取到Webhook信息。', + ], + 'CreateApsKafkaHudiJob' => [ + 'summary' => '创建APS Kafka入湖任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '157674', + 'abilityTreeNodes' => [ + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~129857~~)接口可以查看目标地域下所有AnalyticDB MySQL湖仓版（3.0）集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PartitionSpecs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '分区信息。', + 'type' => 'array', + 'items' => [ + 'description' => '"SourceColumn": 源端分区字段名。'."\n" + .'"Strategy": 策略。'."\n" + .'1) 按照格式化日期: "ParseAsTimeAndFormat"。'."\n" + .'2) 指定分区字段："CustomSpecify"。'."\n" + ."\0\n" + .'"SourceTypeFormat": 源端类型格式。'."\n" + .'"TargetTypeFormat": 目标端类型格式。'."\n" + .'"TargetColumn": 目标端分区字段名。'."\n" + ."\n" + .'其中SourceTypeFormat枚举及含义如下，右侧对应时间精度。'."\n" + .'APSLiteralTimestampMilliSecond ->毫秒级精度。'."\n" + .'APSLiteralTimestampMicroSecond -> 微秒级精度。'."\n" + .'APSLiteralTimestampSecond -> 秒级精度。'."\n" + .'APSMIDyyyyMMddHHmmssSSS -> yyyy-MM-dd HH:mm:ss.SSS。'."\n" + .'APSMIDyyyyMMddHHmmss -> yyyy-MM-dd HH:mm:ss'."\n" + .'APSMIDyyyyMMdd -> yyyy-MM-dd。'."\n" + .'APSyyyyMMddHHmmss -> yyyyMMddHHmmss。'."\n" + ."\0".'APSyyyyMMdd -> yyyyMMdd。'."\n" + .'APSyyyyMM -> yyyyMM。'."\n" + .'APSSLAyyyyMMdd -> yyyy/MM/dd。'."\n" + .'APSSLAMMddyyyy -> MM/dd/yyyy。', + 'type' => 'object', + 'required' => false, + 'example' => '[{ "SourceColumn": "NetOutFlow", "Strategy": "ParseAsTimeAndFormat", "SourceTypeFormat": "APSLiteralTimestampSecond", "TargetTypeFormat": "yyyy-MM-dd", "TargetColumn": "NetOutFlow" }]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '源端字段名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'a', + ], + 'MapName' => [ + 'description' => '目标端字段名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'b', + ], + 'Type' => [ + 'description' => '源端字段类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'string', + ], + 'MapType' => [ + 'description' => '目标端字段类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'string', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'PrimaryKeyDefinition', + 'in' => 'formData', + 'schema' => [ + 'description' => '主键设置。包含uuid策略和映射策略。解释如下。'."\n" + .'Uuid策略： "Strategy": "uuid"。'."\n" + .'映射策略：'."\n" + .'"Strategy": "mapping",'."\n" + .'"Values":['."\n" + .' "f1",'."\n" + .' "f2"'."\n" + .'],'."\n" + .'"RecordVersionField","xxx"'."\n" + .'其中RecordVersionField的含义是HUDI记录版本。', + 'type' => 'string', + 'required' => false, + 'example' => '"Strategy": "mapping"', + ], + ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Workload的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'LakehouseId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Lakehouse的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps', + ], + ], + [ + 'name' => 'HudiAdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端HUDI配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'hoodie.keep.min.commits=20', + ], + ], + [ + 'name' => 'AdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '高级配置。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'FullComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => '全量同步配置。', + 'type' => 'string', + 'required' => false, + 'example' => '2ACU', + ], + ], + [ + 'name' => 'IncrementalComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => '增量同步配置。', + 'type' => 'string', + 'required' => true, + 'example' => '2ACU', + ], + ], + [ + 'name' => 'KafkaClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Kafka实例ID。可以在Kafka控制台获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'KafkaTopic', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Kafka Topic ID。可以在Kafka控制台获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartingOffsets', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Kafka起始消费位点。'."\n" + .'枚举如下：'."\n" + .'begin_cursor/end_cursor/timestamp'."\n" + .'分别对应最早/最近/指定时间。', + 'type' => 'string', + 'required' => true, + 'example' => 'begincursor', + ], + ], + [ + 'name' => 'MaxOffsetsPerTrigger', + 'in' => 'formData', + 'schema' => [ + 'description' => '单次消费条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50000', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户自定义的数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户自定义的表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testTB', + ], + ], + [ + 'name' => 'OutputFormat', + 'in' => 'formData', + 'schema' => [ + 'description' => '输出数据格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'HUDI', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'TargetGenerateRule', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标生成规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'AcrossUid', + 'in' => 'formData', + 'schema' => [ + 'description' => '源端Kafka所属的阿里云账号的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123************', + ], + ], + [ + 'name' => 'AcrossRole', + 'in' => 'formData', + 'schema' => [ + 'description' => '可信实体为阿里云账号的RAM角色。如何创建RAM角色，请参见创建可信实体为阿里云账号的RAM角色。'."\n" + .'RAM角色中已将AnalyticDB MySQL所属阿里云账号设置为Kafka所属阿里云账号的信任云账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'aps', + ], + ], + [ + 'name' => 'SourceRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'JsonParseLevel', + 'in' => 'formData', + 'schema' => [ + 'description' => '设置JSON的嵌套解析层数，取值如下。'."\n" + .'0：不做解析。'."\n" + .'1：解析一层。'."\n" + .'2：解析两层。'."\n" + .'3：解析三层。'."\n" + .'4：解析四层。'."\n" + .'默认会解析一层。JSON的嵌套解析策略具体可见 JSON解析层级和Schema字段推断示例。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'DataOutputFormat', + 'in' => 'formData', + 'schema' => [ + 'description' => '枚举值及说明。'."\n" + .'Single：源端是单行的Json记录。'."\n" + .'Multi：源端是Json数组。需要输出单条Json记录。', + 'type' => 'string', + 'required' => false, + 'example' => 'Single', + ], + ], + [ + 'name' => 'OssLocation', + 'in' => 'formData', + 'schema' => [ + 'description' => '目的端湖仓地址，完整OSS路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-xx-zzz/yyy/', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DataFormatType', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Kafka消息类型，支持的消息类型为：json、general_canal_json、mongo_canal_json、dataworks_json和shareplex_json', + 'description' => 'Kafka消息类型，支持的消息类型为：json、general_canal_json、mongo_canal_json、dataworks_json和shareplex_json', + 'type' => 'string', + 'required' => false, + 'example' => 'json', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回创建的任务ID。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A943417-5B0E-1DB9-A8**-A566****C3', + ], + 'Success' => [ + 'description' => '是否请求成功。'."\n" + .'True：成功。False：不成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '同HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"xxx\\",\\n \\"RequestId\\": \\"1A943417-5B0E-1DB9-A8**-A566****C3\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"ok\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n xxx\\n 1A943417-5B0E-1DB9-A8**-A566****C3\\n true\\n 200\\n ok\\n","errorExample":""}]', + 'title' => '创建APS Kafka入湖任务', + ], + 'ListApsLifecycleStrategy' => [ + 'summary' => '获取当前ADB实例生命周期管理策略列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '200829', + 'abilityTreeNodes' => [ + 'FEATUREadsNQ1ZDK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01T11:22Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询终止时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-02T11:22Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页号。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '页大小。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultData', + 'description' => 'ResultData', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**OK**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'OperationTables' => [ + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProcessAll' => [ + 'description' => '是否全选，如果设置为true，则表示选择当前库中所有表。', + 'type' => 'string', + 'example' => 'true', + ], + 'TableNames' => [ + 'description' => '数据表的名称。', + 'type' => 'array', + 'items' => [ + 'description' => '数据表的名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'StrategyDesc' => [ + 'description' => '生命周期管理策略描述内容。', + 'type' => 'string', + 'example' => 'test', + ], + 'StrategyName' => [ + 'description' => '生命周期管理策略名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'StrategyType' => [ + 'description' => '生命周期管理策略类型。', + 'type' => 'string', + 'example' => 'KEEP_BY_TIME', + ], + 'StrategyValue' => [ + 'description' => '生命周期管理策略值，KEEP_BY_TIME对应的值。', + 'type' => 'string', + 'example' => '10', + ], + 'Status' => [ + 'description' => '生命周期管理策略的状态，两个枚举值分别为：'."\n" + .'1. on：标识启用当前策略'."\n" + .'2. off：表示禁用当前策略', + 'type' => 'string', + 'example' => 'on', + ], + 'CreatedTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2021-06-30T02:44:27Z', + ], + 'ModifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2021-07-03T06:33:00Z', + ], + 'ApsJobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'aps-******', + ], + 'StrategyDatabases' => [ + 'description' => '生命周期管理的库个数统计。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'StrategyTables' => [ + 'description' => '生命周期管理的表个数统计。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-*******', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"200\\",\\n \\"Items\\": [\\n {\\n \\"OperationTables\\": [\\n {\\n \\"DatabaseName\\": \\"test\\",\\n \\"ProcessAll\\": \\"true\\",\\n \\"TableNames\\": [\\n \\"test\\"\\n ]\\n }\\n ],\\n \\"StrategyDesc\\": \\"test\\",\\n \\"StrategyName\\": \\"test\\",\\n \\"StrategyType\\": \\"KEEP_BY_TIME\\",\\n \\"StrategyValue\\": \\"10\\",\\n \\"Status\\": \\"on\\",\\n \\"CreatedTime\\": \\"2021-06-30T02:44:27Z\\",\\n \\"ModifiedTime\\": \\"2021-07-03T06:33:00Z\\",\\n \\"ApsJobId\\": \\"aps-******\\",\\n \\"StrategyDatabases\\": 5,\\n \\"StrategyTables\\": 5,\\n \\"DBClusterId\\": \\"amv-*******\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n}","type":"json"}]', + 'title' => '获取当前ADB实例生命周期管理策略列表', + ], + 'GetApsManagedDatabases' => [ + 'summary' => '获取数据库列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '200691', + 'abilityTreeNodes' => [ + 'FEATUREadsNQ1ZDK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ADB实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"-\\"\\n}","type":"json"}]', + 'title' => '获取APS管理的数据库列表', + ], + 'CreateApsSlsADBJob' => [ + 'summary' => '创建一个SLS到ADB数仓的APS链路。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '207599', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*********', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PartitionSpecs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '分区信息。', + 'type' => 'array', + 'items' => [ + 'description' => '分区信息。', + 'type' => 'object', + 'required' => false, + 'example' => '-', + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '列名。', + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + 'MapName' => [ + 'description' => '映射名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Type' => [ + 'description' => '列数据类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'bigint', + ], + 'MapType' => [ + 'description' => '映射类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'int', + ], + ], + 'required' => false, + 'example' => '-', + ], + 'required' => true, + 'example' => '-', + ], + ], + [ + 'name' => 'PrimaryKeyDefinition', + 'in' => 'formData', + 'schema' => [ + 'description' => '主键定义。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作负载名。', + 'type' => 'string', + 'required' => true, + 'example' => 'sls-******', + ], + ], + [ + 'name' => 'LakehouseId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'lakehosue ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '高级配置。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'HudiAdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => 'huid高级配置。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'FullComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => '全量acu。', + 'type' => 'string', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'IncrementalComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => '增量acu。', + 'type' => 'string', + 'required' => false, + 'example' => '168', + ], + ], + [ + 'name' => 'Project', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Store', + 'in' => 'formData', + 'schema' => [ + 'description' => 'sls Store。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartingOffsets', + 'in' => 'formData', + 'schema' => [ + 'description' => '投递起始位点。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'MaxOffsetsPerTrigger', + 'in' => 'formData', + 'schema' => [ + 'description' => '最大位点。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbName', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => "\n" + .'表名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'OutputFormat', + 'in' => 'formData', + 'schema' => [ + 'description' => '输出格式。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ADB', + ], + ], + [ + 'name' => 'TargetGenerateRule', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端生成规则。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'AcrossUid', + 'in' => 'formData', + 'schema' => [ + 'description' => '跨账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'AcrossRole', + 'in' => 'formData', + 'schema' => [ + 'description' => '跨账号角色名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-role', + ], + ], + [ + 'name' => 'SourceRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '源集群所处地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'OssLocation', + 'in' => 'formData', + 'schema' => [ + 'description' => 'oss地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test*', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '327', + ], + ], + [ + 'name' => 'DirtyDataProcessPattern', + 'in' => 'formData', + 'schema' => [ + 'description' => '脏数据处理模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'STOP', + ], + ], + [ + 'name' => 'ExactlyOnce', + 'in' => 'formData', + 'schema' => [ + 'description' => '精确一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UnixTimestampConvert', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '时间戳转换。', + 'type' => 'object', + 'properties' => [ + 'Convert' => [ + 'description' => '转换。', + 'type' => 'string', + 'required' => false, + 'example' => 'false。', + ], + 'Format' => [ + 'description' => '格式。', + 'type' => 'string', + 'required' => false, + 'example' => "\0".'APSyyyyMMdd', + ], + 'Transform' => [ + 'description' => '转换开关。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => true, + 'example' => 'user_test', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'description' => '密码。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'DirtyDataHandleMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '脏数据处理模式。', + 'type' => 'string', + 'required' => true, + 'example' => '-', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Success' => [ + 'description' => '预检查结果，返回值说明：'."\n" + ."\n" + .'- **success**：检查通过。'."\n" + .'- **false**：检查不通过。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"-\\",\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]', + 'title' => '创建一个SLS到ADB数仓的APS链路', + ], + 'ListApsOptimizationTasks' => [ + 'summary' => '获取指定类型湖存储优化策略执行过的任务列表。湖存储优化策略会周期性调度执行优化任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '200821', + 'abilityTreeNodes' => [ + 'FEATUREadsNQ1ZDK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'StrategyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '生命周期管理策略类型。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'StrategyValue', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-23T02:18Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询终止时间。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-09-30T00:15Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Items' => [ + 'description' => '信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'ComputeUnit' => [ + 'description' => '任务使用的计算资源。', + 'type' => 'string', + 'example' => '2', + ], + 'CreatedTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-01-23T02:18Z', + ], + 'ModifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2022-09-30T00:15Z', + ], + 'TaskDesc' => [ + 'description' => '任务描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'TaskDuration' => [ + 'description' => '任务执行时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'sj-hz******', + ], + 'TaskMessage' => [ + 'description' => '任务执行错误信息。', + 'type' => 'string', + 'example' => '-', + ], + 'TaskStatus' => [ + 'description' => '任务执行状态，枚举类型，分为以下几种状态：'."\n" + .'1. NEW：任务刚新建，还未运行'."\n" + .'2. RUNNING：任务正在运行中'."\n" + .'3. SUCCESS：任务执行成功'."\n" + .'4. STOPPED：任务暂停中'."\n" + .'5. FAILED：任务执行失败', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'StrategyType' => [ + 'description' => '生命周期管理策略类型。', + 'type' => 'string', + 'example' => 'StrategyValue', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-*******', + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Message' => [ + 'description' => '应用建议执行结果。取值说明：'."\n" + .'- 请求正常，返回**SUCCESS**。 '."\n" + .'- 请求异常，返回具体异常错误信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Items\\": [\\n {\\n \\"ComputeUnit\\": \\"2\\",\\n \\"CreatedTime\\": \\"2022-01-23T02:18Z\\",\\n \\"ModifiedTime\\": \\"2022-09-30T00:15Z\\",\\n \\"TaskDesc\\": \\"test\\",\\n \\"TaskDuration\\": 1000,\\n \\"TaskId\\": \\"sj-hz******\\",\\n \\"TaskMessage\\": \\"-\\",\\n \\"TaskStatus\\": \\"RUNNING\\",\\n \\"StrategyType\\": \\"StrategyValue\\",\\n \\"DBClusterId\\": \\"amv-*******\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 15,\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Message\\": \\"SUCCESS\\"\\n}","type":"json"}]', + 'title' => '获取指定类型湖存储优化策略执行过的任务列表。', + ], + 'ListApsOptimizationStrategy' => [ + 'summary' => '获取当前ADB实例湖存储优化策略列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '200834', + 'abilityTreeNodes' => [ + 'FEATUREadsNQ1ZDK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultData', + 'description' => 'ResultData', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '应用建议执行结果。取值说明：'."\n" + .'- 请求正常，返回**SUCCESS**。 '."\n" + .'- 请求异常，返回具体异常错误信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Code' => [ + 'description' => '需要执行的代码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'StrategyDesc' => [ + 'description' => '生命周期管理策略描述内容。', + 'type' => 'string', + 'example' => 'test', + ], + 'StrategyName' => [ + 'description' => '生命周期管理策略名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'StrategyType' => [ + 'description' => '生命周期管理策略类型，目前只有一个值StrategyValue。', + 'type' => 'string', + 'example' => 'StrategyValue', + ], + 'Status' => [ + 'description' => '生命周期管理策略的状态，两个枚举值分别为：'."\n" + .'1. on：标识启用当前策略'."\n" + .'2. off：表示禁用当前策略', + 'type' => 'string', + 'example' => 'off', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-23xxxx', + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Data\\": [\\n {\\n \\"StrategyDesc\\": \\"test\\",\\n \\"StrategyName\\": \\"test\\",\\n \\"StrategyType\\": \\"StrategyValue\\",\\n \\"Status\\": \\"off\\",\\n \\"DBClusterId\\": \\"amv-23xxxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取当前ADB实例湖存储优化策略列表。', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeAPSADBInstances' => [ + 'summary' => '获取APS联邦分析ADB实例列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '204210', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '30', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'string', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '返回的结果总数。', + 'type' => 'string', + 'example' => '100', + ], + 'Items' => [ + 'description' => '列表。', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'AnalyticDB MySQL 湖仓版（3.0）集群 ID。', + 'type' => 'string', + 'example' => 'am-bp1********', + ], + 'DBClusterDescription' => [ + 'description' => '集群的描述信息。', + 'type' => 'string', + 'example' => 'adb_test', + ], + 'ZoneId' => [ + 'description' => '集群所在的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ComputeResource' => [ + 'description' => '计算预留资源规格。', + 'type' => 'string', + 'example' => '16ACU', + ], + 'StorageResource' => [ + 'description' => '存储预留资源规格。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24ACU', + ], + 'ReservedACU' => [ + 'description' => '集群剩余可分配计算预留资源。', + 'type' => 'string', + 'example' => '24ACU', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态。', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + 'example' => '-', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"Items\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp1********\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"ComputeResource\\": \\"16ACU\\",\\n \\"StorageResource\\": 0,\\n \\"ReservedACU\\": \\"24ACU\\",\\n \\"DBClusterStatus\\": \\"Running\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取联邦分析支持的ADB实例列表', + 'description' => '根据性能参数查看某个集群、某时间段范围内的性能监控数据。采集粒度为30秒。支持对慢SQL进行查询，提供SQL查询时长、扫描行数、扫描量等监控内容。', + ], + 'ModifyApsSlsADBJob' => [ + 'summary' => '修改sls投递adb数仓任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209632', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据链路任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aps-******', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'StartingOffsets', + 'in' => 'formData', + 'schema' => [ + 'description' => '起始位点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'end_cursor', + ], + ], + [ + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + 'MapName' => [ + 'description' => '映射名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'map_name', + ], + 'Type' => [ + 'description' => '列数据类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'bigint', + ], + 'MapType' => [ + 'description' => '映射类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'bigint', + ], + ], + 'required' => false, + 'example' => '-', + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作负载名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-name', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbName', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DirtyDataProcessPattern', + 'in' => 'formData', + 'schema' => [ + 'description' => '脏数据处理模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'STOP', + ], + ], + [ + 'name' => 'ExactlyOnce', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否开启精确一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UnixTimestampConvert', + 'in' => 'formData', + 'schema' => [ + 'description' => '时间戳转换。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'user-name', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'description' => '密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Message' => [ + 'description' => '应用建议执行结果。取值说明：'."\n" + .'- 请求正常，返回**SUCCESS**。 '."\n" + .'- 请求异常，返回具体异常错误信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Message\\": \\"SUCCESS\\"\\n}","type":"json"}]', + 'title' => '修改sls投递adb数仓任务', + ], + 'DescribeApsMigrationWorkloads' => [ + 'summary' => '查询APS迁移任务工作负载列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作负载名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'OssLocation', + 'in' => 'formData', + 'schema' => [ + 'description' => 'oss地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://******', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-06-20T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-07-20T16:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-57F0-9F06-******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MigrationWorkloads' => [ + 'description' => '迁移工作负载列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '任务修改的时间。', + 'type' => 'string', + 'example' => '2021-06-21T02:15:16Z', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2021-06-21T02:15:16Z', + ], + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '123', + ], + 'State' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'COMPLETED', + ], + 'OssLocation' => [ + 'description' => 'oss地址。', + 'type' => 'string', + 'example' => 'oss://******', + ], + 'TargetType' => [ + 'description' => '目标类型。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'WorkloadSubType' => [ + 'description' => '子任务类型。', + 'type' => 'string', + 'example' => 'test', + ], + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'TEST-001', + ], + 'AcuCount' => [ + 'description' => 'acu数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-', + ], + 'MaxRT' => [ + 'description' => '最大响应时间。', + 'type' => 'string', + 'example' => '1000', + ], + 'FailedMsg' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-57F0-9F06-******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 0,\\n \\"MigrationWorkloads\\": [\\n {\\n \\"ModifyTime\\": \\"2021-06-21T02:15:16Z\\",\\n \\"CreateTime\\": \\"2021-06-21T02:15:16Z\\",\\n \\"Id\\": \\"123\\",\\n \\"State\\": \\"COMPLETED\\",\\n \\"OssLocation\\": \\"oss://******\\",\\n \\"TargetType\\": \\"OSS\\",\\n \\"WorkloadSubType\\": \\"test\\",\\n \\"Name\\": \\"TEST-001\\",\\n \\"AcuCount\\": 0,\\n \\"MaxRT\\": \\"1000\\",\\n \\"FailedMsg\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询APS迁移任务工作负载列表', + ], + 'DescribeApsHiveWorkload' => [ + 'summary' => '查询APS Hive工作负载详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '170284', + 'abilityTreeNodes' => [ + 'FEATUREadsBIVU9O', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据链路任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '86F92D26-B774-5FA1-8E53-******', + ], + 'ApsWorkload' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-*******', + ], + 'WorkloadId' => [ + 'description' => '数据链路任务ID。', + 'type' => 'string', + 'example' => 'aps-******', + ], + 'WorkloadName' => [ + 'description' => '工作负载名。', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceGroup' => [ + 'description' => 'SQL语句所属的资源池。', + 'type' => 'string', + 'example' => 'test', + ], + 'FullComputeUnit' => [ + 'description' => '迁移所需acu数。', + 'type' => 'string', + 'example' => '16', + ], + 'SyncAllowExpression' => [ + 'description' => '手动匹配源端库表白名单表达式。', + 'type' => 'string', + 'example' => 'abc', + ], + 'SyncDenyExpression' => [ + 'description' => '手动匹配源端库表黑名单表达式。', + 'type' => 'string', + 'example' => 'def', + ], + 'TargetType' => [ + 'description' => '目标类型。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'OssLocation' => [ + 'description' => 'oss地址。', + 'type' => 'string', + 'example' => 'oss://******', + ], + 'ConflictStrategy' => [ + 'description' => '目的端存在同名库表处理策略。', + 'type' => 'string', + 'example' => 'Intercept', + ], + 'AdvancedConfig' => [ + 'description' => '高级配置。', + 'type' => 'string', + 'example' => 'test.adv.config=value', + ], + 'DatasourceId' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'DatasourceName' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'sls-******', + ], + 'Parallelism' => [ + 'description' => '并行度。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'WorkloadTypeName' => [ + 'description' => '工作负载名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'State' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'COMPLETED', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '-', + ], + 'MetaStoreUri' => [ + 'description' => 'hive meta store url。', + 'type' => 'string', + 'example' => '-', + ], + 'Vswitch' => [ + 'description' => '交换机（vSwitch）名称。', + 'type' => 'string', + 'example' => 'vsw-******', + ], + 'EmrClusterId' => [ + 'description' => 'EMR集群ID。', + 'type' => 'string', + 'example' => '-', + ], + ], + 'example' => '-', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86F92D26-B774-5FA1-8E53-******\\",\\n \\"ApsWorkload\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBClusterId\\": \\"amv-*******\\",\\n \\"WorkloadId\\": \\"aps-******\\",\\n \\"WorkloadName\\": \\"test\\",\\n \\"ResourceGroup\\": \\"test\\",\\n \\"FullComputeUnit\\": \\"16\\",\\n \\"SyncAllowExpression\\": \\"abc\\",\\n \\"SyncDenyExpression\\": \\"def\\",\\n \\"TargetType\\": \\"OSS\\",\\n \\"OssLocation\\": \\"oss://******\\",\\n \\"ConflictStrategy\\": \\"Intercept\\",\\n \\"AdvancedConfig\\": \\"test.adv.config=value\\",\\n \\"DatasourceId\\": 8,\\n \\"DatasourceName\\": \\"sls-******\\",\\n \\"Parallelism\\": 2,\\n \\"WorkloadTypeName\\": \\"test\\",\\n \\"State\\": \\"COMPLETED\\",\\n \\"CreateTime\\": \\"-\\",\\n \\"MetaStoreUri\\": \\"-\\",\\n \\"Vswitch\\": \\"vsw-******\\",\\n \\"EmrClusterId\\": \\"-\\"\\n }\\n}","type":"json"}]', + 'title' => '查询APS Hive工作负载详情', + ], + 'CreateApsCopyWorkload' => [ + 'summary' => '创建APS复制链路。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '186455', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'WorkloadType', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'SLS_INGESTION_ADB', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbName', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据链路任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回Success。'."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '删除的应用信息。', + 'type' => 'object', + 'example' => '-', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]', + 'title' => '创建APS复制链路', + ], + 'DescribeApsDatasource' => [ + 'summary' => '查询过APS数据源详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168878', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ADB实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'am-*******', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-**D8-5***-A***-****587', + ], + 'ApsDatasource' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'DatasourceName' => [ + 'description' => '数据源的名称。', + 'type' => 'string', + 'example' => 'kafka-2024***', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-04-12T15:03:38Z', + ], + 'DatasourceType' => [ + 'description' => '数据源类型。', + 'type' => 'string', + 'example' => 'KAFKA', + ], + 'DatasourceDescription' => [ + 'description' => '数据源描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'SlsInfo' => [ + 'description' => '日志服务（SLS）项目。', + 'type' => 'object', + 'properties' => [ + 'SourceRegionId' => [ + 'description' => '生产站点所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Project' => [ + 'description' => 'sls项目名称。', + 'type' => 'string', + 'example' => '***', + ], + 'Store' => [ + 'description' => 'sls logstore名称。', + 'type' => 'string', + 'example' => '***', + ], + 'Across' => [ + 'description' => '是否跨账号。取值：'."\n" + ."\n" + .'- **true** ：当前网络实例为跨账号资源。'."\n" + .'- **false** ：当前网络实例为本账号资源。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AcrossUid' => [ + 'description' => '跨账号UID。', + 'type' => 'string', + 'example' => '123456', + ], + 'AcrossRole' => [ + 'description' => '跨账号角色名。', + 'type' => 'string', + 'example' => 'test', + ], + ], + 'example' => '-', + ], + 'KafkaInfo' => [ + 'description' => 'kafka实例信息。', + 'type' => 'object', + 'properties' => [ + 'KafkaClusterId' => [ + 'description' => 'kafka实例ID。', + 'type' => 'string', + 'example' => '-', + ], + 'KafkaTopic' => [ + 'description' => 'kafka topic', + 'type' => 'string', + 'example' => '[{\'value\': \'hongxian_test\'}]', + ], + ], + 'example' => '-', + ], + 'HiveInfo' => [ + 'description' => 'hive数据源信息。', + 'type' => 'object', + 'properties' => [ + 'MetaStoreUri' => [ + 'description' => 'hive meta store url。', + 'type' => 'string', + 'example' => '-', + ], + 'Vswitch' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-******', + ], + 'SecurityGroup' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-******', + ], + 'EmrClusterId' => [ + 'description' => 'EMR集群ID', + 'type' => 'string', + 'example' => '-', + ], + ], + 'example' => '-', + ], + 'RdsMysqlInfo' => [ + 'description' => '目前已不再支持。', + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'RegionId' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'InstanceId' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'ConnectUrl' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'SecurityGroup' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + ], + 'example' => '-', + ], + 'PolarDBMysqlInfo' => [ + 'description' => '目前已不再支持。', + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'RegionId' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'InstanceId' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'ConnectUrl' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'SecurityGroup' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'Across' => [ + 'description' => '-', + 'type' => 'boolean', + 'example' => '-', + ], + 'AcrossUid' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + 'AcrossRole' => [ + 'description' => '-', + 'type' => 'string', + 'example' => '-', + ], + ], + 'example' => '-', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-******', + ], + 'DatabricksInfo' => [ + 'description' => 'databricks信息。', + 'type' => 'object', + 'properties' => [ + 'accessToken' => [ + 'description' => '访问databrick的令牌。', + 'type' => 'string', + 'example' => '******', + ], + 'workspaceURL' => [ + 'description' => '工作空间URL。', + 'type' => 'string', + 'example' => '-', + ], + ], + 'example' => '-', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-**D8-5***-A***-****587\\",\\n \\"ApsDatasource\\": {\\n \\"DatasourceName\\": \\"kafka-2024***\\",\\n \\"CreateTime\\": \\"2024-04-12T15:03:38Z\\",\\n \\"DatasourceType\\": \\"KAFKA\\",\\n \\"DatasourceDescription\\": \\"test\\",\\n \\"SlsInfo\\": {\\n \\"SourceRegionId\\": \\"cn-hangzhou\\",\\n \\"Project\\": \\"***\\",\\n \\"Store\\": \\"***\\",\\n \\"Across\\": false,\\n \\"AcrossUid\\": \\"123456\\",\\n \\"AcrossRole\\": \\"test\\"\\n },\\n \\"KafkaInfo\\": {\\n \\"KafkaClusterId\\": \\"-\\",\\n \\"KafkaTopic\\": \\"[{\'value\': \'hongxian_test\'}]\\"\\n },\\n \\"HiveInfo\\": {\\n \\"MetaStoreUri\\": \\"-\\",\\n \\"Vswitch\\": \\"vsw-******\\",\\n \\"SecurityGroup\\": \\"sg-******\\",\\n \\"EmrClusterId\\": \\"-\\"\\n },\\n \\"RdsMysqlInfo\\": {\\n \\"UserName\\": \\"-\\",\\n \\"RegionId\\": \\"-\\",\\n \\"InstanceId\\": \\"-\\",\\n \\"ConnectUrl\\": \\"-\\",\\n \\"SecurityGroup\\": \\"-\\"\\n },\\n \\"PolarDBMysqlInfo\\": {\\n \\"UserName\\": \\"-\\",\\n \\"RegionId\\": \\"-\\",\\n \\"InstanceId\\": \\"-\\",\\n \\"ConnectUrl\\": \\"-\\",\\n \\"SecurityGroup\\": \\"-\\",\\n \\"Across\\": true,\\n \\"AcrossUid\\": \\"-\\",\\n \\"AcrossRole\\": \\"-\\"\\n },\\n \\"DBClusterId\\": \\"amv-******\\",\\n \\"DatabricksInfo\\": {\\n \\"accessToken\\": \\"******\\",\\n \\"workspaceURL\\": \\"-\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询过APS数据源详情', + ], + 'CreateAPSJob' => [ + 'summary' => '创建APS任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '180008', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SourceEndpointInstanceID', + 'in' => 'formData', + 'schema' => [ + 'description' => '源数据库实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-xxxxx', + ], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'formData', + 'schema' => [ + 'description' => '源数据库地域。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'SourceEndpointUserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '源端用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + [ + 'name' => 'SourceEndpointPassword', + 'in' => 'formData', + 'schema' => [ + 'description' => '源端密码。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + ], + [ + 'name' => 'DestinationEndpointInstanceID', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端数据库实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-xxxxx', + ], + ], + [ + 'name' => 'DestinationEndpointPassword', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端实例密码。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + ], + [ + 'name' => 'DestinationEndpointUserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端实例用户名。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + ], + [ + 'name' => 'DbList', + 'in' => 'formData', + 'schema' => [ + 'description' => '同步对象列表。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"EntireInstance":true}', + ], + ], + [ + 'name' => 'ApsJobName', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-xxxxx', + ], + ], + [ + 'name' => 'PartitionList', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区列表。', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'TargetTableMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标表模式。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ApsJobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'aps-bj1xxxxxx', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D1B8ED33-5E9B-512D-B188-1579ED6xxx', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**OK**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'adb::2021-12-01::DescribeApsJobDetail', + 'callbackInterval' => 6000, + 'maxCallbackTimes' => 100, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ApsJobId\\": \\"aps-bj1xxxxxx\\",\\n \\"RequestId\\": \\"D1B8ED33-5E9B-512D-B188-1579ED6xxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '创建APS任务', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'StartApsJob' => [ + 'summary' => '启动APS任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '185195', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ApsJobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'aps-******', + ], + 'RequestId' => [ + 'description' => '请求的ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ErrCode' => [ + 'description' => '调用出错时返回的错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0', + ], + 'ErrMessage' => [ + 'description' => '调用错误时返回对应的错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**OK**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ApsJobId\\": \\"aps-******\\",\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"0\\",\\n \\"ErrMessage\\": \\"OK\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '启动APS任务', + ], + 'SuspendApsJob' => [ + 'summary' => '暂停APS任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183067', + 'abilityTreeNodes' => [ + 'FEATUREadsY28JLD', + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-bj1xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ApsJobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'aps-bj1xxxxxx', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Success' => [ + 'description' => '请求是否成功。取值说明：'."\n" + .'- **True**：成功。'."\n" + .'- **False**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrCode' => [ + 'description' => '调用出错时返回的错误码。'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'ErrMessage' => [ + 'description' => '调用错误时返回的错误信息。'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ApsJobId\\": \\"aps-bj1xxxxxx\\",\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '暂停APS任务', + ], + 'ModifyApsJob' => [ + 'summary' => '修改aps任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '183077', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-bj1xxxxxx', + ], + ], + [ + 'name' => 'DbList', + 'in' => 'formData', + 'schema' => [ + 'description' => '同步对象列表。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"EntireInstance":true}', + ], + ], + [ + 'name' => 'PartitionList', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区列表。', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ApsJobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'aps-bj1xxxxxx', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ErrMessage' => [ + 'description' => '调用错误时返回对应的错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => 'InvalidInput'."\n", + ], + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ApsJobId\\": \\"aps-bj1xxxxxx\\",\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"OK\\",\\n \\"Code\\": \\"InvalidInput\\\\n\\",\\n \\"Message\\": \\"SUCCESS\\"\\n}","type":"json"}]', + 'title' => '修改aps任务', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DeleteApsJob' => [ + 'summary' => '删除aps任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '183073', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ApsJobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'aps-*****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****-****-5D14-AC9F-*********', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ErrCode' => [ + 'description' => '调用出错时返回的错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ErrMessage' => [ + 'description' => '调用错误时返回对应的错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ApsJobId\\": \\"aps-*****\\",\\n \\"RequestId\\": \\"****-****-5D14-AC9F-*********\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"OK\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '删除APS任务', + 'description' => '- 删除备份集是异步操作，前端显示会有延迟，需要等待约10-20分钟才会生效。'."\n" + .'- 单次最大允许删除100个备份集。如果要删超过100个备份集，请分2次调用。'."\n" + .'- 为保证数据安全性，系统会强制保留1个有效备份集。当要删除仅有的备份集时，接口会禁止。', + ], + 'CreateApsDatasoure' => [ + 'summary' => '创建APS数据源。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168860', + 'abilityTreeNodes' => [ + 'FEATUREadsBIVU9O', + 'FEATUREadsY28JLD', + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-xxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DatasourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'KAFKA', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'sls-******', + ], + ], + [ + 'name' => 'DatasourceDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'formData', + 'schema' => [ + 'description' => '模式。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALI_CLOUD_INSTANCE', + ], + ], + [ + 'name' => 'SlsInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '创建的日志服务（SLS）信息。', + 'type' => 'object', + 'properties' => [ + 'SourceRegionId' => [ + 'description' => '源集群所处地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'Project' => [ + 'description' => '日志服务（SLS）项目。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-project', + ], + 'Store' => [ + 'description' => 'sls logstore。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-store', + ], + 'Across' => [ + 'description' => '是否跨账号。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'AcrossUid' => [ + 'description' => '跨账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + 'AcrossRole' => [ + 'description' => '跨账号角色名。', + 'type' => 'string', + 'required' => false, + 'example' => 'yyy', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'KafkaInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Kafka信息。', + 'type' => 'object', + 'properties' => [ + 'KafkaClusterId' => [ + 'description' => 'kafka实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + 'KafkaTopic' => [ + 'description' => '分配kafka topic名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'HiveInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Hive数据源信息。', + 'type' => 'object', + 'properties' => [ + 'MetaStoreUri' => [ + 'description' => 'meta store 连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + 'Vswitch' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1*****k', + ], + 'SecurityGroup' => [ + 'description' => '安全组。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-uf*******h', + ], + 'ClusterId' => [ + 'description' => '实例ID', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + 'HostConfig' => [ + 'description' => '主机配置。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'RdsMysqlInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'rds mysql数据源信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-xxxxxxx', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => '用户名。', + ], + 'Password' => [ + 'description' => '密码。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'ConnectUrl' => [ + 'description' => '只读实例连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + 'SecurityGroup' => [ + 'description' => '安全组。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-******', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'PolarDBMysqlInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'polardb mysql数据源信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-bp*********', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-user-name', + ], + 'Password' => [ + 'description' => '密码。', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'ConnectUrl' => [ + 'description' => '私有定制RDS连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + 'SecurityGroup' => [ + 'description' => '安全组。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-******', + ], + 'Across' => [ + 'description' => '是否跨账号。取值：'."\n" + ."\n" + .'- **true** ：当前网络实例为跨账号资源。'."\n" + .'- **false** ：当前网络实例为本账号资源。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'AcrossUid' => [ + 'description' => '跨账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '123456789*', + ], + 'AcrossRole' => [ + 'description' => '跨账号角色。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-role', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'PolarDBXInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'polardbx数据源信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'DatabricksInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'databricks数据源信息。', + 'type' => 'object', + 'properties' => [ + 'AccessToken' => [ + 'description' => '访问令牌。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + 'WorkspaceURL' => [ + 'description' => '工作空间URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxx', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '集群资源具体使用详情。', + 'type' => 'string', + 'example' => '69', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65D2***-45C1-5C18-**********', + ], + 'Success' => [ + 'description' => '预检查结果，返回值说明：'."\n" + ."\n" + .'- **success**：检查通过。'."\n" + .'- **false**：检查不通过。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'DBClusterId' => [ + 'description' => '集群ID。'."\n", + 'type' => 'string', + 'example' => 'amv-7xxxxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"69\\",\\n \\"RequestId\\": \\"65D2***-45C1-5C18-**********\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\",\\n \\"DBClusterId\\": \\"amv-7xxxxx\\"\\n}","type":"json"}]', + 'title' => '创建APS数据源', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyApsDatasoure' => [ + 'summary' => '修改APS数据源。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sls-******', + ], + ], + [ + 'name' => 'DatasourceDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SlsInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '日志服务（SLS）信息。', + 'type' => 'object', + 'properties' => [ + 'SourceRegionId' => [ + 'description' => '源地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'Across' => [ + 'description' => '是否跨账号。取值：'."\n" + ."\n" + .'- **true** ：当前网络实例为跨账号资源。'."\n" + .'- **false** ：当前网络实例为本账号资源。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'AcrossUid' => [ + 'description' => '跨账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + 'AcrossRole' => [ + 'description' => '跨账号角色。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-role', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'KafkaInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'KafkaClusterId' => [ + 'description' => 'kafka实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'KafkaTopic' => [ + 'description' => 'kafka topic名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-topic', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'LakehouseId', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Lakehouse ID。', + 'type' => 'object', + 'properties' => [ + 'Vswitch' => [ + 'description' => '交换机名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-******', + ], + 'SecurityGroup' => [ + 'description' => '安全组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-******', + ], + 'VpcId' => [ + 'description' => 'vpc id。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-******', + ], + ], + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'RdsMysqlInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '已废弃数据源信息。', + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => '-', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'Password' => [ + 'description' => '-', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'RegionId' => [ + 'description' => '-', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'ConnectUrl' => [ + 'description' => '-', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'PolarDBMysqlInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '已废弃数据源信息。', + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => '-', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'Password' => [ + 'description' => '-', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'RegionId' => [ + 'description' => '-', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'ConnectUrl' => [ + 'description' => '-', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A3EB3BCD-D974-52D4-B75C-BB06505916CB', + ], + 'Data' => [ + 'description' => '资源组信息列表。', + 'type' => 'string', + 'example' => '150', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'string', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput'."\n", + ], + 'Message' => [ + 'description' => '应用建议执行结果。取值说明：'."\n" + .'- 请求正常，返回**SUCCESS**。 '."\n" + .'- 请求异常，返回具体异常错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3EB3BCD-D974-52D4-B75C-BB06505916CB\\",\\n \\"Data\\": \\"150\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"InvalidInput\\\\n\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '修改APS数据源', + 'description' => '### 注意事项'."\n" + .'- 该接口仅适用于32核及以上规格的弹性模式集群版（新版）集群。'."\n" + .'- 不支持修改默认资源组USER_DEFAULT的节点数量。', + ], + 'ModifyApsWorkloadName' => [ + 'summary' => '修改APS工作负载名称。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '170156', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据链路任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作负载名。', + 'type' => 'string', + 'required' => true, + 'example' => 'sls-2024***93014', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '123', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput'."\n", + ], + 'Message' => [ + 'description' => '应用建议执行结果。取值说明：'."\n" + .'- 请求正常，返回**SUCCESS**。 '."\n" + .'- 请求异常，返回具体异常错误信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"123\\",\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\\\n\\",\\n \\"Message\\": \\"SUCCESS\\"\\n}","type":"json"}]', + 'title' => '修改APS工作负载名称', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeApsDatasources' => [ + 'summary' => '查询APS数据源列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '30', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ADB实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-******', + ], + ], + [ + 'name' => 'DatasourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'SLS', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-5213-******-B608-******', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '返回的结果总数。', + 'type' => 'string', + 'example' => '1', + ], + 'ApsDatasources' => [ + 'description' => '数据源数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasourceName' => [ + 'description' => '目标数据源的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-01-10 14:44:33', + ], + 'DatasourceType' => [ + 'description' => '数据源类型。', + 'type' => 'string', + 'example' => 'SLS', + ], + 'DatasourceDescription' => [ + 'description' => '数据源描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'DatasourceId' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'HasJob' => [ + 'description' => '是否有任务在使用这个数据源。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-5213-******-B608-******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"ApsDatasources\\": [\\n {\\n \\"DatasourceName\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-01-10 14:44:33\\",\\n \\"DatasourceType\\": \\"SLS\\",\\n \\"DatasourceDescription\\": \\"test\\",\\n \\"DatasourceId\\": 1,\\n \\"HasJob\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询APS数据源列表', + ], + 'CreateApsHiveJob' => [ + 'summary' => '创建APS Hive任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '170254', + 'abilityTreeNodes' => [ + 'FEATUREadsBIVU9O', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'AnalyticDB for MySQL集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '运维事件所在地域的地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作负载名。', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx-20240224100253', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'user_default', + ], + ], + [ + 'name' => 'FullComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => '迁移所需acu数。', + 'type' => 'string', + 'required' => true, + 'example' => '16', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '40', + ], + ], + [ + 'name' => 'SyncAllowExpression', + 'in' => 'formData', + 'schema' => [ + 'description' => '允许同步对象的表达式。', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + [ + 'name' => 'SyncDenyExpression', + 'in' => 'formData', + 'schema' => [ + 'description' => '允许同步对象的表达式。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'OssLocation', + 'in' => 'formData', + 'schema' => [ + 'description' => '目的端湖仓地址，完整OSS路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-test*/*0516/', + ], + ], + [ + 'name' => 'ConflictStrategy', + 'in' => 'formData', + 'schema' => [ + 'description' => '目的端存在同名库表处理策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'Intercept：报错拦截，暂停迁移'."\n" + .'Ignore：忽略并继续执行，仍然迁移相关库表'."\n" + .'Skip：跳过相关库表，只迁移其他库表', + ], + ], + [ + 'name' => 'AdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '高级配置。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'Parallelism', + 'in' => 'formData', + 'schema' => [ + 'description' => '并行任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2895BB82-B2C1-408E-AA73-DB8D59******', + ], + 'Data' => [ + 'description' => '工作负载返回数据。', + 'type' => 'string', + 'example' => '-', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。取值说明：'."\n" + .'- **True**：成功。'."\n" + .'- **False**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回Success。'."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2895BB82-B2C1-408E-AA73-DB8D59******\\",\\n \\"Data\\": \\"-\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]', + 'title' => '创建APS Hive任务', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeApsProgress' => [ + 'summary' => '查询APS进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171313', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-******', + ], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据链路任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'TotalTableCount' => [ + 'description' => '表总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SuccessTableCount' => [ + 'description' => '成功迁移表总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SuccessPercentage' => [ + 'description' => '成功百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ApsHiveProgress' => [ + 'description' => '迁移进度。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DbName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TbName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Progress' => [ + 'description' => '进度。', + 'type' => 'string', + 'example' => '95', + ], + 'Speed' => [ + 'description' => '迁移速度。', + 'type' => 'string', + 'example' => '2', + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"TotalTableCount\\": 10,\\n \\"SuccessTableCount\\": 10,\\n \\"SuccessPercentage\\": 100,\\n \\"ApsHiveProgress\\": [\\n {\\n \\"DbName\\": \\"test\\",\\n \\"TbName\\": \\"test\\",\\n \\"Progress\\": \\"95\\",\\n \\"Speed\\": \\"2\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询APS进度', + ], + 'DeleteApsDatasoure' => [ + 'summary' => '删除APS数据源。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '168866', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ADB实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FAE98A4F-****-****-BF6D-67EEAC9C39DE', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '7', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功。取值说明：'."\n" + .'- **True**：成功。'."\n" + .'- **False**：失败。', + 'type' => 'string', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAE98A4F-****-****-BF6D-67EEAC9C39DE\\",\\n \\"Data\\": \\"7\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '删除APS数据源', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'DescribeApsJobs' => [ + 'summary' => '查询APS任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '180030', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '30', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'formData', + 'schema' => [ + 'description' => '起始创建时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-23T01:10Z', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'formData', + 'schema' => [ + 'description' => '截止创建时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-23T01:10Z', + ], + ], + [ + 'name' => 'ApsJobName', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'aps-xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-7F9D-5DBD-993E-******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '0', + ], + 'APSJobs' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => '-', + ], + 'ApsJobName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'data-sync-******', + ], + 'DestinationInstanceID' => [ + 'description' => '目标端实例ID。', + 'type' => 'string', + 'example' => 'amv-*******', + ], + 'SourceInstanceID' => [ + 'description' => '源端实例ID。', + 'type' => 'string', + 'example' => 'pc-******', + ], + 'Delay' => [ + 'description' => '同步延迟时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-06-28 15:00:04', + ], + 'Projress' => [ + 'description' => '进展。', + 'type' => 'string', + 'example' => '30 ：进度 30%', + ], + 'ApsJobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'aps-******', + ], + 'SubStatus' => [ + 'description' => '子任务状态。', + 'type' => 'string', + 'example' => '-', + ], + 'ErrMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '后端错误码。', + 'type' => 'string', + 'example' => 'ok', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'ok', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-7F9D-5DBD-993E-******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalCount\\": \\"0\\",\\n \\"APSJobs\\": [\\n {\\n \\"Status\\": \\"-\\",\\n \\"ApsJobName\\": \\"data-sync-******\\",\\n \\"DestinationInstanceID\\": \\"amv-*******\\",\\n \\"SourceInstanceID\\": \\"pc-******\\",\\n \\"Delay\\": 0,\\n \\"CreateTime\\": \\"2022-06-28 15:00:04\\",\\n \\"Projress\\": \\"30 ：进度 30%\\",\\n \\"ApsJobId\\": \\"aps-******\\",\\n \\"SubStatus\\": \\"-\\",\\n \\"ErrMessage\\": \\"OK\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"ok\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => '查询APS任务列表', + ], + 'DescribeApsActionLogs' => [ + 'summary' => '查询集群实时数据接入任务的日志详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '154388', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业版、基础版或湖仓版的集群ID。'."\n" + .'湖仓版集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~454250~~)接口查看集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~454314~~)接口查看地域ID。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '日志的开始时间，格式：**yyyy-MM-ddTHH:mmZ**（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-02-11T08:30Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '日志的结束时间，格式：**yyyy-MM-ddTHH:mmZ**（UTC时间）。'."\n" + ."\n" + .'> 查询日志时，结束时间需大于开始时间，且与开始时间最大间隔不超过30天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-02-11T09:30Z', + ], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据链路任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aps-hz109vpvt4fg8528d****', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的关键字。在日志查询时模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'table_test', + ], + ], + [ + 'name' => 'Stage', + 'in' => 'query', + 'schema' => [ + 'description' => '任务阶段。取值：'."\n" + ."\n" + .'- **StructureMigrate**：结构迁移。'."\n" + .'- **FullDataSync**：全量同步。'."\n" + .'- **IncrementalSync**：增量同步。'."\n" + ."\n" + .'> 未指定该参数时，默认查询所有的任务阶段。', + 'type' => 'string', + 'required' => false, + 'example' => 'FullDataSync', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '日志类型。多个日志类型用英文逗号（,）分隔。取值：'."\n" + ."\n" + .'- **INFO**：信息。'."\n" + .'- **WARN**：警告。'."\n" + .'- **ERROR**：错误。'."\n" + ."\n" + .'> 未指定该参数时，默认查询所有的日志类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'INFO,WARN,ERROR', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录数。取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。取值为大于0且不超过Integer数据类型的正整数。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EDBA27-AF3E-5966-9503-FD1557E19167', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp1r053byu48p****', + ], + 'WorkloadId' => [ + 'description' => '数据链路任务ID。', + 'type' => 'string', + 'example' => 'aps-hz109vpvt4fg8528d****', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '3', + ], + 'PageSize' => [ + 'description' => '每页的记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'ActionLogs' => [ + 'description' => '日志列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '日志时间。格式：**yyyy-MM-ddTHH:mm:ssZ**（UTC时间）。', + 'type' => 'string', + 'example' => '2023-02-01T05:46:30Z', + ], + 'Stage' => [ + 'description' => '任务阶段。取值：'."\n" + ."\n" + .'- **StructureMigrate**：结构迁移。'."\n" + .'- **FullDataSync**：全量同步。'."\n" + .'- **IncrementalSync**：增量同步。', + 'type' => 'string', + 'example' => 'FullDataSync', + ], + 'State' => [ + 'description' => '日志类型。多个日志类型用英文逗号（,）分隔。取值：'."\n" + ."\n" + .'- **INFO**：信息。'."\n" + .'- **WARN**：警告。'."\n" + .'- **ERROR**：错误。', + 'type' => 'string', + 'example' => 'INFO,WARN,ERROR', + ], + 'Context' => [ + 'description' => '日志的内容。', + 'type' => 'string', + 'example' => 'DDL migration job finished', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '{'."\n" + .' "AuthAction": "xxx",'."\n" + .' "AuthPrincipalDisplayName": "sampleName",'."\n" + .' "AuthPrincipalOwnerId": "111111111111111111",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthResource": "xxx",'."\n" + .' "NoPermissionType": "xxx",'."\n" + .' "PolicyType": "xxx"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EDBA27-AF3E-5966-9503-FD1557E19167\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\",\\n \\"WorkloadId\\": \\"aps-hz109vpvt4fg8528d****\\",\\n \\"TotalCount\\": \\"3\\",\\n \\"PageSize\\": \\"30\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"ActionLogs\\": [\\n {\\n \\"Time\\": \\"2023-02-01T05:46:30Z\\",\\n \\"Stage\\": \\"FullDataSync\\",\\n \\"State\\": \\"INFO,WARN,ERROR\\",\\n \\"Context\\": \\"DDL migration job finished\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"sampleName\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"111111111111111111\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthResource\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"xxx\\\\\\"\\\\n}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5EDBA27-AF3E-5966-9503-FD1557E19167\\n amv-bp1r053byu48p****\\n aps-hz109vpvt4fg8528d****\\n 3\\n 20\\n 1\\n \\n \\n FullDataSync\\n INFO,WARN,ERROR\\n DDL migration job finished\\n \\n","errorExample":""}]', + 'title' => '查询实时数据接入任务的日志', + 'description' => '- 中心的公网接入地址：`adb.aliyuncs.com`。'."\n" + .'- 地域的公网接入地址：`adb..aliyuncs.com`。示例：`adb.cn-hangzhou.aliyuncs.com`。'."\n" + .'- 地域的VPC接入地址：`adb-vpc..aliyuncs.com`。示例：`adb-vpc.cn-hangzhou.aliyuncs.com`。', + ], + 'UpdateLakeStorage' => [ + 'summary' => '更新湖存储。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '216927', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '湖存储描述', + 'description' => '湖存储描述', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'LakeStorageId', + 'in' => 'formData', + 'schema' => [ + 'title' => '湖存储唯一标识', + 'description' => '湖存储唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ADB实例ID', + 'description' => 'ADB实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'Permissions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '湖存储权限', + 'description' => '湖存储权限', + 'type' => 'array', + 'items' => [ + 'title' => '权限项', + 'description' => '权限项', + 'type' => 'object', + 'properties' => [ + 'Read' => [ + 'title' => '读权限', + 'description' => '读权限', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + 'Write' => [ + 'title' => '写权限', + 'description' => '写权限', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + 'Account' => [ + 'title' => '账户ID', + 'description' => '账户ID', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + 'pattern' => '^\\d+$', + 'default' => '', + ], + 'Type' => [ + 'title' => '账户类型', + 'description' => '账户类型', + 'type' => 'string', + 'required' => true, + 'example' => 'SUB', + 'enum' => [ + 'Service', + 'User', + ], + ], + ], + 'required' => false, + 'example' => '-', + ], + 'required' => false, + 'example' => '-', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'LakeStorageId' => [ + 'title' => '湖存储唯一标识', + 'description' => '湖存储唯一标识', + 'type' => 'string', + 'example' => '-', + ], + 'Description' => [ + 'title' => '湖存储描述', + 'description' => '湖存储描述', + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterId' => [ + 'title' => 'ADB实例ID', + 'description' => 'ADB实例ID', + 'type' => 'string', + 'example' => 'amv-23xxxx', + ], + 'FileSize' => [ + 'title' => '总存储量', + 'description' => '总存储量', + 'type' => 'string', + 'example' => '142', + ], + 'RowCount' => [ + 'title' => '总数据行数', + 'description' => '总数据行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '>=', + 'pattern' => '', + 'default' => '', + ], + 'TableCount' => [ + 'title' => '库表数量', + 'description' => '库表数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1234', + 'pattern' => '', + 'default' => '', + ], + 'PartitionCount' => [ + 'description' => '分区数。', + 'type' => 'string', + 'example' => '0', + ], + 'CreatorUid' => [ + 'title' => '创建者UID', + 'description' => '创建者UID', + 'type' => 'string', + 'example' => '123456', + ], + 'OwnerUid' => [ + 'title' => '拥有者UID', + 'description' => '拥有者UID', + 'type' => 'string', + 'example' => '123456', + ], + 'OperatorUid' => [ + 'title' => '操作者UID', + 'description' => '操作者UID', + 'type' => 'string', + 'example' => '123456', + ], + 'Permissions' => [ + 'title' => '湖存储权限', + 'description' => '湖存储权限', + 'type' => 'array', + 'items' => [ + 'title' => '权限项', + 'description' => '权限项', + 'type' => 'object', + 'properties' => [ + 'Read' => [ + 'title' => '读权限', + 'description' => '读权限', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Write' => [ + 'title' => '写权限', + 'description' => '写权限', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Account' => [ + 'title' => '账户ID', + 'description' => '账户ID', + 'type' => 'string', + 'example' => 'test', + 'pattern' => '^\\d+$', + 'default' => '', + ], + 'Type' => [ + 'title' => '账户类型', + 'description' => '账户类型', + 'type' => 'string', + 'example' => 'SUB', + 'enum' => [ + 'CUSTOMER', + 'SUB', + 'STS', + ], + ], + ], + 'example' => '-', + ], + 'example' => '-', + 'maxItems' => 20, + 'minItems' => 0, + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-05-15T07:24:58Z', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-07-01T09:22:17Z', + ], + 'RegionId' => [ + 'title' => '区域ID', + 'description' => '区域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'example' => '-', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + ."\n" + .'- 请求正常，返回OK。'."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Data\\": {\\n \\"LakeStorageId\\": \\"-\\",\\n \\"Description\\": \\"test\\",\\n \\"DBClusterId\\": \\"amv-23xxxx\\",\\n \\"FileSize\\": \\"142\\",\\n \\"RowCount\\": 0,\\n \\"TableCount\\": 1234,\\n \\"PartitionCount\\": \\"0\\",\\n \\"CreatorUid\\": \\"123456\\",\\n \\"OwnerUid\\": \\"123456\\",\\n \\"OperatorUid\\": \\"123456\\",\\n \\"Permissions\\": [\\n {\\n \\"Read\\": true,\\n \\"Write\\": false,\\n \\"Account\\": \\"test\\",\\n \\"Type\\": \\"SUB\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-05-15T07:24:58Z\\",\\n \\"UpdateTime\\": \\"2024-07-01T09:22:17Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '更新湖存储', + ], + 'ListLakeStorages' => [ + 'summary' => '列取湖存储。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '216928', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'title' => '查询过滤参数，多个过滤参数之间是且的关系。例如:过滤实例名称为i-a123、i-b123，且实例状态为Stopped：&Filter.1.Name=InstanceName&Filter.1.Value.1=i-a123&Filter.1.Value.2=i-b123&Filter.2.Name=Status&Filter.2.Value=Stopped。', + 'description' => '查询过滤参数，多个过滤参数之间是且的关系。例如:过滤实例名称为i-a123、i-b123，且实例状态为Stopped：&Filter.1.Name=InstanceName&Filter.1.Value.1=i-a123&Filter.1.Value.2=i-b123&Filter.2.Name=Status&Filter.2.Value=Stopped。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果的最大个数。', + 'description' => '返回结果的最大个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****-964D-****-9D31-****', + ], + 'TotalCount' => [ + 'title' => '总记录数。', + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'title' => '当总结果个数大于MaxResults时，用于翻页的token。', + 'description' => '当总结果个数大于MaxResults时，用于翻页的token。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Items' => [ + 'title' => '数组，返回示例目录。', + 'description' => '数组，返回示例目录。', + 'type' => 'array', + 'items' => [ + 'title' => 'LakeStorageItemType', + 'description' => 'LakeStorageItemType', + 'type' => 'object', + 'properties' => [ + 'OwnerUid' => [ + 'title' => '拥有者UID', + 'description' => '拥有者UID', + 'type' => 'string', + 'example' => '123456', + ], + 'DBClusterId' => [ + 'title' => 'ADB实例ID', + 'description' => 'ADB实例ID', + 'type' => 'string', + 'example' => 'amv-*******', + ], + 'TotalRows' => [ + 'title' => '总数据行数', + 'description' => '总数据行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'pattern' => '', + 'default' => '', + ], + 'OperatorUid' => [ + 'title' => '操作者UID', + 'description' => '操作者UID', + 'type' => 'string', + 'example' => '123456', + ], + 'Permissions' => [ + 'title' => '湖存储权限', + 'description' => '湖存储权限', + 'type' => 'array', + 'items' => [ + 'title' => '权限项', + 'description' => '权限项', + 'type' => 'object', + 'properties' => [ + 'Read' => [ + 'title' => '读权限', + 'description' => '读权限', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Write' => [ + 'title' => '写权限', + 'description' => '写权限', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Account' => [ + 'title' => '账户ID', + 'description' => '账户ID', + 'type' => 'string', + 'example' => '-', + 'pattern' => '^\\d+$', + 'default' => '', + ], + 'Type' => [ + 'title' => '账户类型', + 'description' => '账户类型', + 'type' => 'string', + 'example' => '-', + 'enum' => [ + 'CUSTOMER', + 'SUB', + 'STS', + ], + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + 'TableCount' => [ + 'title' => '库表数量', + 'description' => '库表数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '湖存储描述', + 'description' => '湖存储描述', + 'type' => 'string', + 'example' => 'Create a role to run ROS StackGroups.', + ], + 'LakeStorageId' => [ + 'title' => '湖存储唯一标识', + 'description' => '湖存储唯一标识', + 'type' => 'string', + 'example' => '-', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-04-01T09:50:18Z', + ], + 'TotalStorage' => [ + 'title' => '总存储量', + 'description' => '总存储量', + 'type' => 'string', + 'example' => '111333', + ], + 'CreatorUid' => [ + 'title' => '创建者UID', + 'description' => '创建者UID', + 'type' => 'string', + 'example' => '123456', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-03-15T02:24:32', + ], + 'RegionId' => [ + 'title' => '区域ID', + 'description' => '区域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FileSize' => [ + 'description' => '数据文件大小。', + 'type' => 'string', + 'example' => '651', + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + 'Success' => [ + 'description' => '预检查结果，返回值说明：'."\n" + ."\n" + .'- **success**：检查通过。'."\n" + .'- **false**：检查不通过。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Ok**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****-964D-****-9D31-****\\",\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"OwnerUid\\": \\"123456\\",\\n \\"DBClusterId\\": \\"amv-*******\\",\\n \\"TotalRows\\": 30,\\n \\"OperatorUid\\": \\"123456\\",\\n \\"Permissions\\": [\\n {\\n \\"Read\\": true,\\n \\"Write\\": false,\\n \\"Account\\": \\"-\\",\\n \\"Type\\": \\"-\\"\\n }\\n ],\\n \\"TableCount\\": 30,\\n \\"Description\\": \\"Create a role to run ROS StackGroups.\\",\\n \\"LakeStorageId\\": \\"-\\",\\n \\"CreateTime\\": \\"2021-04-01T09:50:18Z\\",\\n \\"TotalStorage\\": \\"111333\\",\\n \\"CreatorUid\\": \\"123456\\",\\n \\"UpdateTime\\": \\"2024-03-15T02:24:32\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FileSize\\": \\"651\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]', + 'title' => '列取湖存储', + ], + 'GetLakeStorage' => [ + 'summary' => '获取湖存储。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '216924', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'LakeStorageId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例 ID。', + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******-3EEC-******-9F06-******', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'LakeStorageId' => [ + 'title' => '湖存储唯一标识', + 'description' => '湖存储唯一标识', + 'type' => 'string', + 'example' => '-', + ], + 'Description' => [ + 'title' => '湖存储描述', + 'description' => '湖存储描述', + 'type' => 'string', + 'example' => 'a test db', + ], + 'DBClusterId' => [ + 'title' => 'ADB实例ID', + 'description' => 'ADB实例ID', + 'type' => 'string', + 'example' => 'amv-*******', + ], + 'FileSize' => [ + 'title' => '总存储量', + 'description' => '总存储量', + 'type' => 'string', + 'example' => '1', + ], + 'RowCount' => [ + 'title' => '总数据行数', + 'description' => '总数据行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-', + 'pattern' => '', + 'default' => '', + ], + 'TableCount' => [ + 'title' => '库表数量', + 'description' => '库表数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-', + 'pattern' => '', + 'default' => '', + ], + 'PartitionCount' => [ + 'description' => '分区数。', + 'type' => 'string', + 'example' => '-', + ], + 'CreatorUid' => [ + 'title' => '创建者UID', + 'description' => '创建者UID', + 'type' => 'string', + 'example' => '123456', + ], + 'OwnerUid' => [ + 'title' => '拥有者UID', + 'description' => '拥有者UID', + 'type' => 'string', + 'example' => '123456', + ], + 'OperatorUid' => [ + 'title' => '操作者UID', + 'description' => '操作者UID', + 'type' => 'string', + 'example' => '123456', + ], + 'Permissions' => [ + 'title' => '湖存储权限', + 'description' => '湖存储权限', + 'type' => 'array', + 'items' => [ + 'title' => '权限项', + 'description' => '权限项', + 'type' => 'object', + 'properties' => [ + 'Read' => [ + 'title' => '读权限', + 'description' => '读权限', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Write' => [ + 'title' => '写权限', + 'description' => '写权限', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Account' => [ + 'title' => '账户ID', + 'description' => '账户ID', + 'type' => 'string', + 'example' => 'test', + 'pattern' => '^\\d+$', + 'default' => '', + ], + 'Type' => [ + 'title' => '账户类型', + 'description' => '账户类型', + 'type' => 'string', + 'example' => '-', + 'enum' => [ + 'CUSTOMER', + 'SUB', + 'STS', + ], + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-05-15T07:24:58Z', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-10-14T02:28:41Z', + ], + 'RegionId' => [ + 'title' => '区域ID', + 'description' => '区域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'example' => '-', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Ok**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"Data\\": {\\n \\"LakeStorageId\\": \\"-\\",\\n \\"Description\\": \\"a test db\\",\\n \\"DBClusterId\\": \\"amv-*******\\",\\n \\"FileSize\\": \\"1\\",\\n \\"RowCount\\": 0,\\n \\"TableCount\\": 0,\\n \\"PartitionCount\\": \\"-\\",\\n \\"CreatorUid\\": \\"123456\\",\\n \\"OwnerUid\\": \\"123456\\",\\n \\"OperatorUid\\": \\"123456\\",\\n \\"Permissions\\": [\\n {\\n \\"Read\\": true,\\n \\"Write\\": true,\\n \\"Account\\": \\"test\\",\\n \\"Type\\": \\"-\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-05-15T07:24:58Z\\",\\n \\"UpdateTime\\": \\"2024-10-14T02:28:41Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\"\\n}","type":"json"}]', + 'title' => '获取湖存储', + ], + 'CreateLakeStorage' => [ + 'summary' => '创建湖存储。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216925', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'RegionId', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '湖存储描述', + 'description' => '湖存储描述', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ADB实例ID', + 'description' => '湖存储绑定的ADB实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-******', + ], + ], + [ + 'name' => 'Permissions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '湖存储权限', + 'description' => '创建湖存储时会自动给操作的RAM账号和主账号加上权限，此处可以增加额外的主账号授权', + 'type' => 'array', + 'items' => [ + 'title' => '权限项', + 'description' => '权限项', + 'type' => 'object', + 'properties' => [ + 'Read' => [ + 'title' => '读权限', + 'description' => '读权限', + 'type' => 'boolean', + 'required' => false, + 'example' => '-', + ], + 'Write' => [ + 'title' => '写权限', + 'description' => '写权限', + 'type' => 'boolean', + 'required' => false, + 'example' => '-', + ], + 'Account' => [ + 'title' => '账户ID', + 'description' => '账户ID', + 'type' => 'string', + 'required' => false, + 'example' => '-', + 'pattern' => '^\\d+$', + 'default' => '', + ], + 'Type' => [ + 'title' => '账户类型', + 'description' => '账户类型', + 'type' => 'string', + 'required' => false, + 'example' => '-', + 'enum' => [ + 'CUSTOMER', + 'SUB', + 'STS', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '-', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******', + ], + 'Message' => [ + 'title' => '若创建接口为异步实现，则需返回明确的JobId。', + 'description' => '若创建接口为异步实现，则需返回明确的JobId。', + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Data' => [ + 'description' => '集群资源使用详情。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '创建湖存储', + ], + 'DeleteLakeStorage' => [ + 'summary' => '删除湖存储。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '216926', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'LakeStorageId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例 ID。', + 'description' => '湖存储实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '-', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ADB实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp*********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2******-B2C1-408E-AA73-DB8D59******', + ], + 'Message' => [ + 'title' => '若创建接口为异步实现，则需返回明确的JobId。', + 'description' => '若创建接口为异步实现，则需返回明确的JobId。', + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '删除结果。', + 'type' => 'string', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2******-B2C1-408E-AA73-DB8D59******\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"True\\"\\n}","type":"json"}]', + 'title' => '删除湖存储', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + 'ModifyLakeCacheSize' => [ + 'summary' => '修改集群湖存储加速缓存空间大小。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '214852', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp10yt0gva71ei7d', + ], + ], + [ + 'name' => 'EnableLakeCache', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启湖存储加速', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'Capacity', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存空间大小设置，单位为GB', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse', + 'description' => 'PlainResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '494486CE-6F49-574E-B304-29127EA12E36', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'Instances' => [ + 'description' => '共享湖存储缓存空间的集群列表', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID', + 'type' => 'string', + 'example' => 'amv-bp10yt0gva71ei7d', + ], + ], + 'Capacity' => [ + 'description' => '湖存储缓存空间大小，单位为GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DataSize' => [ + 'description' => '已使用的湖存储缓存空间容量，单位为GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"494486CE-6F49-574E-B304-29127EA12E36\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"Instances\\": [\\n \\"amv-bp10yt0gva71ei7d\\"\\n ],\\n \\"Capacity\\": 100,\\n \\"DataSize\\": 100\\n }\\n}","type":"json"}]', + 'title' => '修改湖存储缓存空间', + ], + 'DescribeLakeCacheSize' => [ + 'summary' => '获取集群湖存储加速缓存空间大小。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '214834', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看数仓版集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp10b6646l07akdt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse', + 'description' => 'PlainResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp10b6646l07akdt'."\n", + ], + 'EnableLakeCache' => [ + 'description' => '是否开启湖存储加速', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Instances' => [ + 'description' => '共享湖存储缓存空间的实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'amv-bp10b6646l07akdt'."\n", + ], + ], + 'Capacity' => [ + 'description' => '湖存储加速缓存空间大小，单位为GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DataSize' => [ + 'description' => '湖存储缓存空间已经使用的容量大小，单位为GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"DBClusterId\\": \\"amv-bp10b6646l07akdt\\\\n\\",\\n \\"EnableLakeCache\\": true,\\n \\"Instances\\": [\\n \\"amv-bp10b6646l07akdt\\\\n\\"\\n ],\\n \\"Capacity\\": 100,\\n \\"DataSize\\": 100\\n }\\n}","type":"json"}]', + 'title' => '查询湖存储缓存空间设置', + ], + 'DescribeCompactionServiceSwitch' => [ + 'summary' => '查询集群加速配置中，远程Build服务是否开启。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp149vz49b36t****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D761DA51-12F8-5457-AAA9-F52B9F436D2D', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'EnableCompactionService' => [ + 'description' => '是否开启远程Build服务。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D761DA51-12F8-5457-AAA9-F52B9F436D2D\\",\\n \\"Data\\": {\\n \\"EnableCompactionService\\": true\\n }\\n}","type":"json"}]', + 'title' => '查询集群加速配置', + ], + 'ModifyEssdCacheConfig' => [ + 'summary' => '修改集群加速配置，EIU云盘空间缓存大小。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp10yt0gva71ei7d', + ], + ], + [ + 'name' => 'EnableEssdCache', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启云盘缓存。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'EssdCacheSize', + 'in' => 'query', + 'schema' => [ + 'description' => '云盘缓存大小，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '500', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '115F9CCA-EF2E-5F91-AB60-4961D52FEAB4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"115F9CCA-EF2E-5F91-AB60-4961D52FEAB4\\"\\n}","type":"json"}]', + 'title' => '修改云盘缓存', + ], + 'DescribeEssdCacheConfig' => [ + 'summary' => '查询集群加速配置，云盘缓存空间大小，单位为GB。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf685u1o987hj6rn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'EnableEssdCache' => [ + 'description' => '是否开区云盘缓存。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'EssdCacheSize' => [ + 'description' => '云盘缓存空间大小，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"Data\\": {\\n \\"EnableEssdCache\\": true,\\n \\"EssdCacheSize\\": 500\\n }\\n}","type":"json"}]', + 'title' => '查询集群云盘缓存空间', + ], + 'ModifyCompactionServiceSwitch' => [ + 'summary' => '修改集群查询加速配置远程Build服务开关。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp14t95lun0w****', + ], + ], + [ + 'name' => 'EnableCompactionService', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启远程Build服务。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '21ABF219-10E0-571B-94B8-9C9AE5022BF8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21ABF219-10E0-571B-94B8-9C9AE5022BF8\\"\\n}","type":"json"}]', + 'title' => '修改远程Build服务开关', + ], + 'SubmitResultExportJob' => [ + 'summary' => '调用SubmitResultExportJob接口提交SQL查询并导出结果集。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219535', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[DescribeRegions](~~143074~~)接口查看集群的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'AnalyticDB MySQL湖仓版（3.0）集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查询目标地域中所有AnalyticDB MySQL湖仓版（3.0）集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp10a0ng21t5****', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务执行的引擎，目前只支持XIHE。', + 'type' => 'string', + 'required' => false, + 'example' => 'XIHE', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => '导出任务执行资源组。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_default', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'tpch_oss', + ], + ], + [ + 'name' => 'SQL', + 'in' => 'formData', + 'schema' => [ + 'description' => '仅支持执行SELECT语句，其他SQL语句会导致接口调用失败。', + 'type' => 'string', + 'required' => true, + 'example' => 'SELECT * FROM `fotor_com_datastore_resource`.`fotor_ai_create_task` where `date` = \'2023-05-13\' LIMIT 10;', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'formData', + 'schema' => [ + 'description' => '导出类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'SLS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultData', + 'description' => '返回详细信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**OK**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput'."\n", + ], + 'Data' => [ + 'description' => '结果集导出任务ID。', + 'type' => 'string', + 'example' => 'export_202405131927121980210080040****'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"InvalidInput\\\\n\\",\\n \\"Data\\": \\"export_202405131927121980210080040****\\\\n\\"\\n}","type":"json"}]', + 'title' => '提交结果集导出任务', + ], + 'ListResultExportJobHistory' => [ + 'summary' => '调用ListResultExportJobHistory接口查询当前RAM用户结果集导出执行历史记录列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219537', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'AnalyticDB MySQL湖仓版（3.0）集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~129857~~)接口查看目标地域下所有AnalyticDB MySQL湖仓版（3.0）集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-7xv5ty5m9o4v****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer最大值的整数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询开始时间。格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-01T12:01:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询结束时间，UTC时间，格式为：yyyy-MM-ddTHH:mmZ。'."\n" + ."\n" + .'> 查询结束时间需晚于查询开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-25T06:54:00Z', + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '根据指定字段对SQL语句进行排序，格式为JSON，是一个有序JSON数组，按输入数组的顺序进行复合排序，包含`Field`和`Type`两个字段，例如`[{"Field":"CreateTimee", "Type": "desc" }]`。其中：'."\n" + ."\n" + .'- `Field`表示需要排序的字段名，支持如下字段：'."\n" + .' - `CreateTime`：执行开始时间。'."\n" + .' - `Status`：执行状态。'."\n" + .' - `DatabaseUser`：用户名称。'."\n" + .' - `TimeCost`：执行耗时。'."\n" + .' - `ResourceGroup`：资源组。'."\n" + .' - `ExportRows`：导出行数。'."\n" + .' - `Progress`：导出进度。'."\n" + ."\n\n" + .'- `Type`表示排序类型，支持如下取值（取值均不区分大小写）：'."\n" + .' - `Desc`：降序。'."\n" + .' - `Asc`：升序。', + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'description' => '排序字段名称，支持的排序字段如下：'."\n" + ."\n" + .'- CreateTime'."\n" + .'- DatabaseUser'."\n" + .'- TimeCost'."\n" + .'- ResourceGroup'."\n" + .'- Status'."\n" + .'- Progress'."\n" + .'- ExportRows', + 'type' => 'string', + 'required' => false, + 'example' => 'DatabaseUser', + ], + 'Type' => [ + 'description' => '排序类型，取值：'."\n" + .'- **Desc**：降序'."\n" + .'- **Asc**：升序', + 'type' => 'string', + 'required' => false, + 'example' => 'Desc', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务执行状态列表（支持按照状态进行筛选）。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的状态有：'."\n" + .'1. **SUBMITTED**：任务提交成功。'."\n" + .'2. **RUNNING**：任务正在运行中。'."\n" + .'3. **SUCCEEDED**：任务执行成功。'."\n" + .'4. **FAILED**：任务执行失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务执行资源组（支持按照资源组进行筛选）。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_default', + ], + ], + [ + 'name' => 'DatabaseUser', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultData', + 'description' => '返回详细信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Ok**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Items' => [ + 'description' => '列表详情。', + 'type' => 'array', + 'items' => [ + 'description' => '结果集导出详情。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'AnalyticDB MySQL湖仓版（3.0）集群ID。', + 'type' => 'string', + 'example' => 'amv-7xv5ty5m9o4v****', + ], + 'AliUid' => [ + 'description' => 'RAM账号ID。', + 'type' => 'string', + 'example' => '120010511678****', + ], + 'Sql' => [ + 'description' => '结果集导出任务中使用的SQL语句详情。', + 'type' => 'string', + 'example' => 'SELECT * FROM `ADB_SampleData_TPCH`.`supplier` LIMIT 20', + ], + 'CreateTime' => [ + 'description' => '结果集导出任务创建时间。UTC时间，格式为yyyy-mm-ddThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-04-01T09:50:18Z', + ], + 'StartTime' => [ + 'description' => '任务的开始时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2021-07-03T04:00:00Z', + ], + 'EndTime' => [ + 'description' => '查询结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 查询结束时间需晚于查询开始时间。', + 'type' => 'string', + 'example' => '2023-06-15T02:13:00Z', + ], + 'DatabaseUser' => [ + 'description' => 'RAM用户关联的数据库账号名称。', + 'type' => 'string', + 'example' => 'ram_user', + ], + 'TimeCost' => [ + 'description' => '数据导出耗时，单位是毫秒。'."\n" + ."\n" + .'> 从数据导出任务启动开始算，直到导出结束。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '560', + ], + 'ExportJobId' => [ + 'description' => '结果集导出任务唯一标识。', + 'type' => 'string', + 'example' => 'export_2024051319271219802100800401300****'."\n", + ], + 'ResourceGroup' => [ + 'description' => '任务执行资源组。', + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'description' => '导出任务执行状态，枚举类型，分为以下几种状态：'."\n" + .'1. **SUBMITTED**：任务提交成功。'."\n" + .'2. **RUNNING**：任务正在运行中。'."\n" + .'3. **SUCCEEDED**：任务执行成功。'."\n" + .'4. **FAILED**：任务执行失败。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ExportPath' => [ + 'description' => '结果集完整地址。', + 'type' => 'string', + 'example' => 'oss://testBucketName/export_test/result_export/2024/05/13/202405131528400210090110690315154****/result.csv', + ], + 'Progress' => [ + 'description' => '导出进度。单位为百分比（%），取值范围[0,100]。', + 'type' => 'string', + 'example' => '30', + ], + 'ProcessId' => [ + 'description' => '返回SQL查询ID，便于用户诊断。'."\n" + .'> 您可以通过调用[DescribeDiagnosisSQLInfo](~~612495~~)接口进行查询诊断。', + 'type' => 'string', + 'example' => '202306121421111720161451770345339****', + ], + 'ExportRows' => [ + 'description' => '导出行数，接口调用成功才返回该参数。', + 'type' => 'string', + 'example' => '10000', + ], + 'Message' => [ + 'description' => '结果集导出SQL执行错误信息，只在任务执行失败时才返回该信息。', + 'type' => 'string', + 'example' => 'Failed to execute SQL', + ], + 'Engine' => [ + 'description' => '任务执行的引擎，目前只支持XIHE。', + 'type' => 'string', + 'example' => 'XIHE', + ], + 'Schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'lake_db', + ], + 'ExportType' => [ + 'description' => '导出类型。', + 'type' => 'string', + 'example' => '-', + ], + 'IsExpired' => [ + 'description' => '是否已过期：'."\n" + ."\n" + .'- **false**: 未过期，'."\n" + .'- **true**: 已过期', + 'type' => 'boolean', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页号，和传入的值一致。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '174', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Items\\": [\\n {\\n \\"DBClusterId\\": \\"amv-7xv5ty5m9o4v****\\",\\n \\"AliUid\\": \\"120010511678****\\",\\n \\"Sql\\": \\"SELECT * FROM `ADB_SampleData_TPCH`.`supplier` LIMIT 20\\",\\n \\"CreateTime\\": \\"2022-04-01T09:50:18Z\\",\\n \\"StartTime\\": \\"2021-07-03T04:00:00Z\\",\\n \\"EndTime\\": \\"2023-06-15T02:13:00Z\\",\\n \\"DatabaseUser\\": \\"ram_user\\",\\n \\"TimeCost\\": 560,\\n \\"ExportJobId\\": \\"export_2024051319271219802100800401300****\\\\n\\",\\n \\"ResourceGroup\\": \\"test\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExportPath\\": \\"oss://testBucketName/export_test/result_export/2024/05/13/202405131528400210090110690315154****/result.csv\\",\\n \\"Progress\\": \\"30\\",\\n \\"ProcessId\\": \\"202306121421111720161451770345339****\\",\\n \\"ExportRows\\": \\"10000\\",\\n \\"Message\\": \\"Failed to execute SQL\\",\\n \\"Engine\\": \\"XIHE\\",\\n \\"Schema\\": \\"lake_db\\",\\n \\"ExportType\\": \\"-\\",\\n \\"IsExpired\\": true\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 174\\n}","type":"json"}]', + 'title' => '列出结果集导出历史任务', + ], + 'DescribeSQLWebSocketDomain' => [ + 'summary' => '查看注册的WebSocket域名。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '180261', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~143074~~)接口查看指定AnalyticDB MySQL数仓版支持的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp1lw6g669zpi660', + ], + ], + [ + 'name' => 'Module', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E03F0806-A67B-5B24-8562-9589F20DEEB5', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'adb-ws-beijing.console.aliyun.com/query', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"E03F0806-A67B-5B24-8562-9589F20DEEB5\\",\\n \\"Success\\": true,\\n \\"Domain\\": \\"adb-ws-beijing.console.aliyun.com/query\\"\\n}","type":"json"}]', + 'title' => '查看注册的WebSocket域名', + ], + 'ConfigureResultExport' => [ + 'summary' => '配置导出的SLS 或者OSS 信息，实例级别唯一，遵循一次配置多次使用的原则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254776', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~129857~~)接口可以查看目标地域下所有AnalyticDB MySQL集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9509beptiz****', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'formData', + 'schema' => [ + 'description' => '导出类型，枚举类型，当前可选值为：'."\n" + ."\n" + .'- SLS：标识导出目的为SLS。'."\n" + .'- OSS：标识导出目的为OSS。', + 'type' => 'string', + 'required' => false, + 'example' => 'SLS', + ], + ], + [ + 'name' => 'SlsInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '当导出目的为SLS类型时，对应的SLS配置信息。', + 'type' => 'object', + 'properties' => [ + 'SlsProject' => [ + 'description' => 'SLS Project名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-project', + ], + 'ResourceGroup' => [ + 'description' => '导出SQL运行的资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'aps', + ], + 'LogstoreTtl' => [ + 'description' => '结果集导出临时生成的logstore的过期时间，单位为天，过期后自动删除。'."\n" + .'最小1天，最大30天，超过范围报错。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'OssInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '当导出目的为OSS类型时，对应的OSS配置信息。', + 'type' => 'object', + 'properties' => [ + 'ExportBasePath' => [ + 'description' => '导出结果存储的OSS路径地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://testBucketName/data_result', + ], + 'ResourceGroup' => [ + 'description' => '导出SQL运行的资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'aps', + ], + 'ResultFileTtl' => [ + 'description' => 'Oss文件过期时间，单位为天，最小1天，最大30天，超出范围报错。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultData', + 'description' => 'ResultData', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。取值说明：'."\n" + ."\n" + .'- 请求正常，返回OK。'."\n" + .'- 请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '后端错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '已配置的结果集导出信息', + 'type' => 'object', + 'properties' => [ + 'ExportType' => [ + 'description' => '导出类型，枚举类型，返回结果可能值为：'."\n" + ."\n" + .'- SLS：标识导出目的为SLS。'."\n" + .'- OSS：标识导出目的为OSS。', + 'type' => 'string', + 'example' => 'SLS', + ], + 'SlsInfo' => [ + 'description' => '当导出目的为SLS类型时，对应的SLS配置信息。', + 'type' => 'object', + 'properties' => [ + 'SlsProject' => [ + 'description' => 'SLS Project名称。', + 'type' => 'string', + 'example' => 'test-project', + ], + 'ResourceGroup' => [ + 'description' => '导出SQL运行的资源组名称。', + 'type' => 'string', + 'example' => 'aps', + ], + 'LogstoreTtl' => [ + 'description' => '结果集导出临时生成的logstore的过期时间，单位为天，过期后自动删除。 最小1天，最大30天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'OssInfo' => [ + 'description' => '当导出目的为OSS类型时，配置成功的OSS导出信息。', + 'type' => 'object', + 'properties' => [ + 'ExportBasePath' => [ + 'description' => '导出结果存储的OSS路径地址。', + 'type' => 'string', + 'example' => 'oss://testBucketName/data_result', + ], + 'ResourceGroup' => [ + 'description' => '导出SQL运行的资源组名称。', + 'type' => 'string', + 'example' => 'aps', + ], + 'ResultFileTtl' => [ + 'description' => 'Oss文件过期时间，单位为天，最小1天，最大30天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"ExportType\\": \\"SLS\\",\\n \\"SlsInfo\\": {\\n \\"SlsProject\\": \\"test-project\\",\\n \\"ResourceGroup\\": \\"aps\\",\\n \\"LogstoreTtl\\": 10\\n },\\n \\"OssInfo\\": {\\n \\"ExportBasePath\\": \\"oss://testBucketName/data_result\\",\\n \\"ResourceGroup\\": \\"aps\\",\\n \\"ResultFileTtl\\": 10\\n }\\n }\\n}","type":"json"}]', + 'title' => '配置结果集导出信息', + ], + 'DescribeResultExportConfig' => [ + 'summary' => '获取用户配置的结果集导出信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254784', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 调用[DescribeDBClusters](~~129857~~)接口可以查看目标地域下所有AnalyticDB MySQL集群的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-8vbf80pjcz*****', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'query', + 'schema' => [ + 'description' => '导出类型，枚举类型，当前可选值为：'."\n" + ."\n" + .'- SLS：标识导出目的为SLS。'."\n" + .'- OSS：标识导出目的为OSS。', + 'type' => 'string', + 'required' => false, + 'example' => 'SLS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultData', + 'description' => 'ResultData', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Success' => [ + 'description' => '请求是否成功。取值说明：'."\n" + .'- **True**：成功。'."\n" + .'- **False**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**OK**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '接口状态或POP错误码。', + 'type' => 'string', + 'example' => 'InvalidInput', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ExportType' => [ + 'description' => '导出类型，枚举类型，当前可选值为：'."\n" + ."\n" + .'- SLS：标识导出目的为SLS。'."\n" + .'- OSS：标识导出目的为OSS。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'SlsInfo' => [ + 'description' => '导出类型为SLS时，对应的SLS配置信息。', + 'type' => 'object', + 'properties' => [ + 'SlsProject' => [ + 'description' => 'SLS Project名称。', + 'type' => 'string', + 'example' => 'test-project', + ], + 'ResourceGroup' => [ + 'description' => '导出SQL运行的资源组名称。', + 'type' => 'string', + 'example' => 'aps', + ], + 'LogstoreTtl' => [ + 'description' => '结果集导出临时生成的logstore的过期时间，单位为天，过期后自动删除。 最小1天，最大30天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'OssInfo' => [ + 'description' => '导出类型为OSS时，对应的OSS信息。', + 'type' => 'object', + 'properties' => [ + 'ExportBasePath' => [ + 'description' => '导出结果存储的OSS路径地址。', + 'type' => 'string', + 'example' => 'oss://testBucketName/data_result'."\n", + ], + 'ResourceGroup' => [ + 'description' => '导出SQL运行的资源组名称。', + 'type' => 'string', + 'example' => 'aps', + ], + 'ResultFileTtl' => [ + 'description' => 'Oss文件过期时间，单位为天，最小1天，最大30天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Data\\": {\\n \\"ExportType\\": \\"OSS\\",\\n \\"SlsInfo\\": {\\n \\"SlsProject\\": \\"test-project\\",\\n \\"ResourceGroup\\": \\"aps\\",\\n \\"LogstoreTtl\\": 10\\n },\\n \\"OssInfo\\": {\\n \\"ExportBasePath\\": \\"oss://testBucketName/data_result\\\\n\\",\\n \\"ResourceGroup\\": \\"aps\\",\\n \\"ResultFileTtl\\": 10\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取结果集导出配置信息', + ], + 'ModifySqlTemplatePosition' => [ + 'summary' => '用于修改SQL模板的目录位置', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '分组Id', + 'description' => '模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '210208', + ], + ], + [ + 'name' => 'TargetTemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '参数模板Id', + 'description' => '模板分组ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '调用结果的信息。取值说明：'."\n" + .'- 请求正常，返回**Success**。 '."\n" + .'- 请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5DC10091-348D-12B1-906D-AB49D658012E', + ], + 'Success' => [ + 'description' => '调用是否成功，取值说明：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5DC10091-348D-12B1-906D-AB49D658012E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改SQL模板位置', + 'description' => '当前服务的接入地址请参见[服务接入点](~~612373~~)。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'adb.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'adb.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'adb.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'adb.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'adb.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'adb.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'adb.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'adb.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'adb.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'adb.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'adb.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'adb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'adb.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'adb.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'adb.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'adb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'adb.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'adb.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'adb.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'adb.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'adb.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'adb.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'adb.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'adb.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'adb.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'adb.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'adb.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'adb.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'adb.cn-north-2-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'adb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'adb.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3