From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/adb/2021-12-01/api-docs.php | 65215 +++++++++++++------------------ 1 file changed, 28035 insertions(+), 37180 deletions(-) (limited to 'data/en_us/adb/2021-12-01/api-docs.php') diff --git a/data/en_us/adb/2021-12-01/api-docs.php b/data/en_us/adb/2021-12-01/api-docs.php index c976ee2..34cc169 100644 --- a/data/en_us/adb/2021-12-01/api-docs.php +++ b/data/en_us/adb/2021-12-01/api-docs.php @@ -1,1766 +1,593 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'adb', - 'version' => '2021-12-01', - ], + 'info' => ['style' => 'RPC', 'product' => 'adb', 'version' => '2021-12-01'], 'directories' => [ [ - 'id' => 181281, - 'title' => 'Region management', + 'children' => ['DescribeClusterAccessWhiteList'], 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - ], - ], - [ - 'id' => 181282, 'title' => 'Cluster management', - 'type' => 'directory', - 'children' => [ - 'DescribeDBClusters', - 'CreateDBCluster', - 'ModifyDBCluster', - 'DeleteDBCluster', - 'DescribeDBClusterAttribute', - 'DescribeKernelVersion', - 'UpgradeKernelVersion', - 'DescribeDBClusterStatus', - 'ModifyDBClusterDescription', - 'DescribeClusterAccessWhiteList', - 'ModifyClusterAccessWhiteList', - 'ModifyClickhouseEngine', - ], ], [ - 'id' => 181284, - 'title' => 'Resource group management', + 'children' => ['DescribeAuditLogRecords', 'DescribeSparkAuditLogRecords'], 'type' => 'directory', - 'children' => [ - 'DescribeResourceGroupSpec', - 'CreateDBResourceGroup', - 'DescribeDBResourceGroup', - 'ModifyDBResourceGroup', - 'DeleteDBResourceGroup', - 'BindDBResourceGroupWithUser', - 'UnbindDBResourceGroupWithUser', - 'DescribeComputeResourceUsage', - 'DescribeUserQuota', - ], - ], - [ - 'id' => 181285, - 'title' => 'Elastic plan management', - 'type' => 'directory', - 'children' => [ - 'CreateElasticPlan', - 'DescribeElasticPlans', - 'ModifyElasticPlan', - 'EnableElasticPlan', - 'DisableElasticPlan', - 'DeleteElasticPlan', - 'DescribeElasticPlanJobs', - 'DescribeElasticPlanAttribute', - 'DescribeElasticPlanSpecifications', - ], + 'title' => 'SQL audit', ], [ - 'id' => 181295, - 'title' => 'Log management', + 'children' => ['DescribeClusterNetInfo', 'AllocateClusterPublicConnection', 'ReleaseClusterPublicConnection', 'DetachUserENI'], 'type' => 'directory', - 'children' => [ - 'DescribeAuditLogRecords', - 'ModifyAuditLogConfig', - 'DescribeSparkAuditLogRecords', - ], - ], - [ - 'id' => 196276, 'title' => 'Network management', - 'type' => 'directory', - 'children' => [ - 'DescribeClusterNetInfo', - 'AllocateClusterPublicConnection', - 'ReleaseClusterPublicConnection', - 'AttachUserENI', - 'DetachUserENI', - 'ModifyUserEniVswitchOptions', - 'ModifyDBClusterVip', - 'ModifyDBClusterSSL', - 'DescribeDBClusterSSL', - 'DownloadInstanceCACertificate', - ], ], [ - 'id' => 181296, - 'title' => 'Account management', + 'children' => ['BindAccount', 'DescribeAccountPrivileges', 'DescribeEnabledPrivileges', 'DescribeAccountAllPrivileges', 'DescribeAccountPrivilegeObjects', 'DescribeOperatorPermission'], 'type' => 'directory', - 'children' => [ - 'DescribeAccounts', - 'CreateAccount', - 'DeleteAccount', - 'ModifyAccountDescription', - 'ResetAccountPassword', - 'CheckBindRamUser', - 'BindAccount', - 'UnbindAccount', - 'ModifyAccountPrivileges', - 'DescribeAccountPrivileges', - 'DescribeEnabledPrivileges', - 'DescribeAccountAllPrivileges', - 'DescribeAccountPrivilegeObjects', - 'DescribeOperatorPermission', - 'RevokeOperatorPermission', - 'GrantOperatorPermission', - ], + 'title' => 'Account management', ], [ - 'id' => 196277, - 'title' => 'Backup management', + 'children' => ['DescribeExecutorDetection', 'DescribeWorkerDetection', 'DescribeControllerDetection', 'DescribeBadSqlDetection', 'DescribeAbnormalPatternDetection', 'DescribeDBClusterHealthStatus', 'DescribeJobResourceUsage', 'DescribePerformanceViews', 'CreatePerformanceView', 'ModifyPerformanceView', 'DescribePerformanceViewAttribute', 'DeletePerformanceView', 'ExistRunningSQLEngine'], 'type' => 'directory', - 'children' => [ - 'DescribeBackupPolicy', - 'ModifyBackupPolicy', - 'DescribeBackups', - 'CreateBackup', - 'DeleteBackups', - ], + 'title' => 'Monitoring information', ], [ - 'id' => 181298, - 'title' => 'Monitoring management', + 'children' => ['DeleteSparkTemplate', 'ListSparkApps', 'SubmitSparkApp'], '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 development', - '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' => 'Database management', + 'children' => ['DescribeViewJobs', 'DescribeTableDetail', 'DescribeTableStatistics', 'DescribeMvRecommendSubTasks', 'DescribeMVRecommendResults', 'DescribeMvRecommendTasks', 'CreateMaterializedViewRecommend', 'ModifyMaterializedView', 'ModifyMaterializedViewRecommend', 'DeleteMaterializedViewRecommend', 'DescribeInclinedTables', 'DescribeAdbMySqlTables', 'GetViewObjects', 'GetTableObjects', 'CheckSampleDataSet', 'DescribeColumns'], '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', - ], + 'title' => 'Data management', ], [ - 'id' => 181302, - 'title' => 'SQL diagnostics', + 'children' => ['GetADBSparkNecessaryRAMPermissions', 'DescribeOversizeNonPartitionTableInfos', 'DescribeSparkAppDiagnosisInfo', 'DescribeAppliedAdvices', 'BatchApplyAdviceByIdList', 'ApplyAdviceById', 'DescribeAvailableAdvices', 'DescribeSQLPatterns', 'DescribePatternPerformance'], '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', - ], + 'title' => 'Diagnosis and optimization', ], [ - 'id' => 190405, - 'title' => 'Storage analysis', + 'children' => ['DescribeExcessivePrimaryKeys'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterSpaceSummary', - 'DescribeExcessivePrimaryKeys', - ], + 'title' => 'Storage analysis', ], [ - 'id' => 181303, - 'title' => 'O\\&M management', + 'children' => ['DescribeAutoRenewalAttribute', 'ModifyAutoRenewalAttribute'], 'type' => 'directory', - 'children' => [ - 'ModifyDBClusterMaintainTime', - 'ModifyDBClusterResourceGroup', - 'ListTagResources', - 'DescribeAutoRenewalAttribute', - 'ModifyAutoRenewalAttribute', - ], + 'title' => 'O&M management', ], [ - 'id' => 186177, - 'title' => 'APS management', + 'children' => ['DescribeApsResourceGroups', 'CreateApsWebhook', 'DeleteApsWebhook', 'UpdateApsWebhook', 'ListApsWebhook', 'CreateApsKafkaHudiJob', 'CreateApsDatasoure', 'CreateApsHiveJob', 'DescribeApsJobs'], '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', - ], + 'title' => 'Data pipeline', ], [ - 'id' => 361662, - 'title' => 'Lake storage', - 'type' => 'directory', 'children' => [ - 'UpdateLakeStorage', - 'ListLakeStorages', - 'GetLakeStorage', - 'CreateLakeStorage', - 'DeleteLakeStorage', - 'ModifyLakeCacheSize', - 'DescribeLakeCacheSize', + 'DescribeSQLWebSocketDomain', 'ConfigureResultExport', 'DescribeResultExportConfig', 'ModifySqlTemplatePosition', 'AttachUserENI', 'BindDBResourceGroupWithUser', 'CancelSparkReplStatement', 'CancelSparkWarehouseBatchSQL', 'CheckBindRamUser', 'CheckFormationSchemaExists', 'CreateAPSJob', 'CreateAccount', 'CreateApsCopyWorkload', 'CreateApsSlsADBJob', 'CreateBackup', 'CreateDBCluster', 'CreateDBResourceGroup', 'CreateElasticPlan', 'CreateFormationCrawler', 'CreateLakeStorage', + 'CreateOssSubDirectory', 'CreateSemanticView', 'CreateSparkTemplate', 'DeleteAccount', 'DeleteApsDatasoure', 'DeleteApsJob', 'DeleteBackups', 'DeleteDBCluster', 'DeleteDBResourceGroup', 'DeleteElasticPlan', 'DeleteFormationCrawler', 'DeleteLakeStorage', 'DeleteSemanticView', 'DeleteSparkTemplateFile', 'DescribeAPSADBInstances', 'DescribeAccounts', 'DescribeAdbMySqlColumns', 'DescribeAdbMySqlIndexes', 'DescribeAdbMySqlSchemas', 'DescribeAdbMySqlTableMeta', + 'DescribeAdviceServiceEnabled', 'DescribeAllDataSource', 'DescribeApsActionLogs', 'DescribeApsDatasource', 'DescribeApsDatasources', 'DescribeApsHiveWorkload', 'DescribeApsJobDetail', 'DescribeApsMigrationWorkloads', 'DescribeApsProgress', 'DescribeBackupPolicy', 'DescribeBackups', 'DescribeClusterResourceDetail', 'DescribeClusterResourceUsage', 'DescribeCompactionServiceSwitch', 'DescribeComputeResourceUsage', 'DescribeDBClusterAttribute', 'DescribeDBClusterPerformance', 'DescribeDBClusterSSL', 'DescribeDBClusterSpaceSummary', 'DescribeDBClusterStatus', + 'DescribeDBClusters', 'DescribeDBResourceGroup', 'DescribeDiagnosisDimensions', 'DescribeDiagnosisRecords', 'DescribeDiagnosisSQLInfo', 'DescribeDownloadRecords', 'DescribeElasticPlanAttribute', 'DescribeElasticPlanJobs', 'DescribeElasticPlanSpecifications', 'DescribeElasticPlans', 'DescribeEssdCacheConfig', 'DescribeHistoryTasks', 'DescribeHistoryTasksStat', 'DescribeInclinedNodes', 'DescribeKernelVersion', 'DescribeLakeCacheSize', 'DescribeProcessList', 'DescribeRegions', 'DescribeResourceGroupSpec', 'DescribeSchemas', + 'DescribeSparkAppType', 'DescribeSparkCodeLog', 'DescribeSparkCodeOutput', 'DescribeSparkCodeWebUi', 'DescribeSparkSQLDiagnosisAttribute', 'DescribeSparkSQLDiagnosisList', 'DescribeSqlPattern', 'DescribeStorageResourceUsage', 'DescribeTableAccessCount', 'DescribeTablePartitionDiagnose', 'DescribeTables', 'DescribeUserQuota', 'DisableAdviceService', 'DisableElasticPlan', 'DownloadDiagnosisRecords', 'DownloadInstanceCACertificate', 'EnableAdviceService', 'EnableElasticPlan', 'ExecuteSparkReplStatement', 'ExecuteSparkWarehouseBatchSQL', + 'GenerateSqlBySemanticSql', 'GetCreateTableSQL', 'GetDatabaseObjects', 'GetFormationCrawler', 'GetLakeStorage', 'GetSemanticView', 'GetSparkAppAttemptLog', 'GetSparkAppInfo', 'GetSparkAppLog', 'GetSparkAppMetrics', 'GetSparkAppState', 'GetSparkAppWebUiAddress', 'GetSparkConfigLogPath', 'GetSparkLogAnalyzeTask', 'GetSparkReplSession', 'GetSparkReplStatement', 'GetSparkSQLEngineState', 'GetSparkTemplateFileContent', 'GetSparkTemplateFolderTree', 'GetSparkTemplateFullTree', + 'GetSparkWarehouseBatchSQL', 'GetTable', 'GetTableColumns', 'GetTableDDL', 'GetViewDDL', 'GrantOperatorPermission', 'KillProcess', 'KillSparkApp', 'KillSparkLogAnalyzeTask', 'KillSparkSQLEngine', 'ListLakeStorages', 'ListResultExportJobHistory', 'ListSemanticViewNames', 'ListSparkAppAttempts', 'ListSparkLogAnalyzeTasks', 'ListSparkTemplateFileIds', 'ListSparkWarehouseBatchSQL', 'ListTagResources', 'LoadSampleDataSet', 'ModifyAccountDescription', + 'ModifyAccountPrivileges', 'ModifyApsDatasoure', 'ModifyApsJob', 'ModifyApsSlsADBJob', 'ModifyApsWorkloadName', 'ModifyAuditLogConfig', 'ModifyBackupPolicy', 'ModifyClickhouseEngine', 'ModifyClusterAccessWhiteList', 'ModifyCompactionServiceSwitch', 'ModifyDBCluster', 'ModifyDBClusterDescription', 'ModifyDBClusterMaintainTime', 'ModifyDBClusterResourceGroup', 'ModifyDBClusterSSL', 'ModifyDBClusterVip', 'ModifyDBResourceGroup', 'ModifyElasticPlan', 'ModifyEssdCacheConfig', 'ModifyLakeCacheSize', + 'ModifyUserEniVswitchOptions', 'PreloadSparkAppMetrics', 'QueryFormationInstsByTaskID', 'QueryFormationTaskByID', 'QueryFormationTasksByType', 'RenameSemanticView', 'ReplaceSemanticView', 'ResetAccountPassword', 'RevokeOperatorPermission', 'RunMaterializedViewRecommend', 'SearchSemanticViews', 'SetSparkAppLogRootPath', 'StartApsJob', 'StartFormationCrawler', 'StartSparkReplSession', 'StartSparkSQLEngine', 'StopFormationCrawler', 'SubmitResultExportJob', 'SubmitSparkLogAnalyzeTask', 'SuspendApsJob', + 'UnbindAccount', 'UnbindDBResourceGroupWithUser', 'UpdateFormationCrawler', 'UpdateFormationCrawlerScheduleState', 'UpdateLakeStorage', 'UpdateSparkTemplateFile', 'UpgradeKernelVersion', ], - ], - [ - 'id' => 199647, - 'title' => 'Other', 'type' => 'directory', - 'children' => [ - 'DescribeCompactionServiceSwitch', - 'ModifyEssdCacheConfig', - 'DescribeEssdCacheConfig', - 'ModifyCompactionServiceSwitch', - 'SubmitResultExportJob', - 'ListResultExportJobHistory', - 'DescribeSQLWebSocketDomain', - 'ConfigureResultExport', - 'DescribeResultExportConfig', - 'ModifySqlTemplatePosition', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ + 'Adb4MysqlSparkDiagnosisInfo' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'DiagnosisType' => ['title' => '', 'type' => 'string', 'example' => 'APPLICATION', 'description' => ''], + 'DiagnosisCode' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'DiagnosisCodeLabel' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'DiagnosisMsg' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], 'ColDetailModel' => [ 'title' => '', 'description' => 'The queried column.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'ColumnName' => [ - 'title' => '', - 'description' => 'The logical name of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'example', - 'backendName' => 'name', - ], - 'Type' => [ - 'title' => '', - 'description' => 'The data type of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'string', - 'backendName' => 'type', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'description', - 'backendName' => 'description', - ], - 'SchemaName' => [ - 'title' => '', - 'description' => 'The logical name of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'schemaName', - 'backendName' => 'schemaName', - ], - 'TableName' => [ - 'title' => '', - 'description' => 'The logical name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tableName', - 'backendName' => 'tableName', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the column was created. The time is displayed in UTC.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05\'T\'13:17:55\'Z\'', - 'backendName' => 'createTime', - ], - 'UpdateTime' => [ - 'title' => '', - 'description' => 'The time when the column was updated. The time is displayed in UTC.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05\'T\'13:17:55\'Z\'', - 'backendName' => 'updateTime', - ], - 'PartitionKey' => [ - 'title' => '', - 'description' => 'Indicates whether the column is the partition key.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'partitionKey', - ], - 'Nullable' => [ - 'title' => '', - 'description' => 'Indicates whether the column can be empty.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'nullable', - ], - 'PrimaryKey' => [ - 'title' => '', - 'description' => 'Indicates whether the column is the primary key.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'primaryKey', - ], - 'DistributeKey' => [ - 'title' => '', - 'description' => 'Indicates whether the column is the distribution key.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'distributeKey', - ], - ], + 'ColumnName' => ['title' => '', 'description' => 'The logical name of the column.'."\n", 'type' => 'string', 'example' => 'example'], + 'Type' => ['title' => '', 'description' => 'The data type of the column.'."\n", 'type' => 'string', 'example' => 'string'], + 'Description' => ['title' => '', 'description' => 'The description of the column.'."\n", 'type' => 'string', 'example' => 'description'], + 'SchemaName' => ['title' => '', 'description' => 'The logical name of the database.'."\n", 'type' => 'string', 'example' => 'schemaName'], + 'TableName' => ['title' => '', 'description' => 'The logical name of the table.'."\n", 'type' => 'string', 'example' => 'tableName'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the column was created. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-01-05\'T\'13:17:55\'Z\''], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the column was updated. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-01-05\'T\'13:17:55\'Z\''], + 'PartitionKey' => ['title' => '', 'description' => 'Indicates whether the column is the partition key.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Nullable' => ['title' => '', 'description' => 'Indicates whether the column can be empty.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'PrimaryKey' => ['title' => '', 'description' => 'Indicates whether the column is the primary key.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'DistributeKey' => ['title' => '', 'description' => 'Indicates whether the column is the distribution key.'."\n", 'type' => 'boolean', 'example' => 'false'], + ], + 'example' => '', ], 'CstoreIndexModel' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The queried index.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'DatabaseName' => [ - 'title' => 'databaseName', - 'description' => 'The logical name of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'exampleDatabase', - 'backendName' => 'databaseName', - ], - 'PhysicalTableName' => [ - 'title' => 'physicalTableName', - 'description' => 'The physical name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'physicalDatabase', - 'backendName' => 'physicalTableName', - ], - 'IndexName' => [ - 'title' => 'indexName', - 'description' => 'The name of the index.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'indexName', - 'backendName' => 'indexName', - ], - 'IndexType' => [ - 'title' => 'indexType', - 'description' => 'The type of the index.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'NORMAL', - 'backendName' => 'indexType', - ], + 'DatabaseName' => ['title' => '', 'description' => 'The logical name of the database.'."\n", 'type' => 'string', 'example' => 'exampleDatabase'], + 'PhysicalTableName' => ['title' => '', 'description' => 'The physical name of the table.'."\n", 'type' => 'string', 'example' => 'physicalDatabase'], + 'IndexName' => ['title' => '', 'description' => 'The name of the index.'."\n", 'type' => 'string', 'example' => 'indexName'], + 'IndexType' => ['title' => '', 'description' => 'The type of the index.'."\n", 'type' => 'string', 'example' => 'NORMAL'], 'IndexColumns' => [ - 'title' => 'indexColumns', + 'title' => '', 'description' => 'The index columns.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The index column.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FieldSchemaModel', - ], - 'backendName' => 'indexColumns', + 'items' => ['description' => 'The index column.'."\n", '$ref' => '#/components/schemas/FieldSchemaModel', 'title' => '', 'example' => ''], + 'example' => '', ], 'ColumnOrds' => [ - 'title' => 'columnOrds', + 'title' => '', 'description' => 'The order of index columns.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The order of clustered indexes is the same as the order of index columns.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ASC/DESC', - 'extendType' => 'true', - ], - 'backendName' => 'columnOrds', + 'items' => ['description' => 'The order of clustered indexes is the same as the order of index columns.'."\n", 'type' => 'string', 'example' => 'ASC/DESC', 'title' => ''], + 'example' => '', ], 'Options' => [ - 'title' => 'options', + 'title' => '', 'description' => 'The properties.'."\n", - 'visibility' => 'public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The property of the ANN or full-text index.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'key:value', - ], - 'backendName' => 'options', - ], - 'CreateTime' => [ - 'title' => 'createTime', - 'description' => 'The time when the index was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'createTime', - ], - 'UpdateTime' => [ - 'title' => 'updateTime', - 'description' => 'The time when the index was updated.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'updateTime', + 'additionalProperties' => ['description' => 'The property of the ANN or full-text index.'."\n", 'type' => 'string', 'example' => 'key:value', 'title' => ''], + 'example' => '', ], + 'CreateTime' => ['title' => '', 'description' => 'The time when the index was created.'."\n", 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the index was updated.'."\n", 'type' => 'string', 'example' => '2023-01-05 13:17:55'], ], + 'example' => '', ], 'DatabaseSummaryModel' => [ 'title' => '', - 'description' => 'The summary of the database.'."\n", - 'visibility' => 'public', + 'description' => 'Database summary information.', 'type' => 'object', 'properties' => [ - 'Owner' => [ - 'title' => '', - 'description' => 'The owner of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'abc', - 'backendName' => 'owner', - ], - 'SchemaName' => [ - 'title' => '', - 'description' => 'The logical name of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'testSchema', - 'backendName' => 'schemaName', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'description', - 'backendName' => 'description', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the database was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'createTime', - ], - 'UpdateTime' => [ - 'title' => '', - 'description' => 'The time when the database was updated.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'updateTime', - ], - ], + 'Owner' => ['title' => '', 'description' => 'Owner.', 'type' => 'string', 'example' => 'abc'], + 'SchemaName' => ['title' => '', 'description' => 'logical database name.', 'type' => 'string', 'example' => 'testSchema'], + 'Description' => ['title' => '', 'description' => 'Description.', 'type' => 'string', 'example' => 'description'], + 'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'UpdateTime' => ['title' => '', 'description' => 'Update time.', 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'CreatedBySource' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CreatedByUser' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DbType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Location' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'example' => '', ], 'Detail' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The queried Spark application.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '', - 'description' => 'The configurations of the Spark application.'."\n", - 'visibility' => 'public', - '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" } }', - 'backendName' => 'data', - ], - 'EstimateExecutionCpuTimeInSeconds' => [ - 'title' => '', - 'description' => 'The amount of time it takes to consume CPU resources for executing the Spark application. Unit: milliseconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'estimateExecutionCpuTimeInSeconds', - ], - 'LogRootPath' => [ - 'title' => '', - 'description' => 'The path of log files.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'oss:///logs/driver', - 'backendName' => 'logRootPath', - ], - 'LastAttemptId' => [ - 'title' => '', - 'description' => 'The last attempt ID of the Spark application.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 's202204291426hzpre60****-0003', - 'backendName' => 'lastAttemptId', - ], - 'WebUiAddress' => [ - 'title' => '', - 'description' => 'The URL of the web UI.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', - 'backendName' => 'webUiAddress', - ], - 'SubmittedTimeInMillis' => [ - 'title' => '', - 'description' => 'The time when the Spark application was submitted. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1651213645000', - 'backendName' => 'submittedTimeInMillis', - ], - 'StartedTimeInMillis' => [ - 'title' => '', - 'description' => 'The time when the Spark application was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1651213645010', - 'backendName' => 'startedTimeInMillis', - ], - 'LastUpdatedTimeInMillis' => [ - 'title' => '', - 'description' => 'The time when the Spark application was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1651213645200', - 'backendName' => 'lastUpdatedTimeInMillis', - ], - 'TerminatedTimeInMillis' => [ - 'title' => '', - 'description' => 'The time when the Spark application execution was terminated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1651213645300', - 'backendName' => 'terminatedTimeInMillis', - ], - 'DBClusterId' => [ - 'title' => '', - 'description' => 'The ID of the cluster that executes the Spark application.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'amv-bp11q28kvl688****', - 'backendName' => 'dbClusterId', - ], - 'ResourceGroupName' => [ - 'title' => '', - 'description' => 'The name of the job resource group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'spark-rg', - 'backendName' => 'resourceGroupName', - ], - 'DurationInMillis' => [ - 'title' => '', - 'description' => 'The amount of time it takes to execute the Spark application. Unit: milliseconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'durationInMillis', - ], - ], + 'DurationInMillis' => ['title' => '', 'description' => 'The amount of time it takes to execute the Spark application. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'LogRootPath' => ['title' => '', 'description' => 'The path of log files.'."\n", 'type' => 'string', 'example' => 'oss:///logs/driver'], + 'DBClusterId' => ['title' => '', 'description' => 'The ID of the cluster that executes the Spark application.'."\n", 'type' => 'string', 'example' => 'amv-bp11q28kvl688****'], + 'Data' => ['title' => '', 'description' => 'The configurations of the Spark application.'."\n", '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' => '', 'description' => 'The amount of time it takes to consume CPU resources for executing the Spark application. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'LastUpdatedTimeInMillis' => ['title' => '', 'description' => 'The time when the Spark application was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1651213645200'], + 'RunningStartTimeInMillis' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '36000', 'description' => ''], + 'LastAttemptId' => ['title' => '', 'description' => 'The last attempt ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202204291426hzpre60****-0003'], + 'TerminatedTimeInMillis' => ['title' => '', 'description' => 'The time when the Spark application execution was terminated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1651213645300'], + 'ResourceProvisioningDurationInMillis' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '36000', 'description' => ''], + 'ExecutionDurationInMillis' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '36000', 'description' => ''], + 'WebUiAddress' => ['title' => '', 'description' => 'The URL of the web UI.'."\n", 'type' => 'string', 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****'], + 'SubmittedTimeInMillis' => ['title' => '', 'description' => 'The time when the Spark application was submitted. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1651213645000'], + 'StartedTimeInMillis' => ['title' => '', 'description' => 'The time when the Spark application was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1651213645010'], + 'AppType' => ['title' => '', 'type' => 'string', 'example' => 'BATCH', 'description' => ''], + 'ResourceGroupName' => ['title' => '', 'description' => 'The name of the job resource group.'."\n", 'type' => 'string', 'example' => 'spark-rg'], + ], + 'example' => '', ], 'FieldSchemaModel' => [ 'title' => '', 'description' => 'The queried column.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => 'name', - 'description' => 'The name of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'name', - 'backendName' => 'name', - ], - 'Type' => [ - 'title' => 'type', - 'description' => 'The type of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'long', - 'backendName' => 'type', - ], - 'Comment' => [ - 'title' => 'comment', - 'description' => 'The description of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'comment', - 'backendName' => 'comment', - ], - 'DatabaseName' => [ - 'title' => 'databaseName', - 'description' => 'The logical name of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'databaseName', - 'backendName' => 'databaseName', - ], - 'TableName' => [ - 'title' => 'tableName', - 'description' => 'The logical name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tableName', - 'backendName' => 'tableName', - ], - 'MappedName' => [ - 'title' => 'mappedName', - 'description' => 'The mapping name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'mappedName', - 'backendName' => 'mappedName', - ], - 'DataType' => [ - 'title' => 'dataType', - 'description' => 'The data type of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'long', - 'backendName' => 'dataType', - ], - 'CreateTime' => [ - 'title' => 'createTime', - 'description' => 'The time when the column was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'createTime', - ], - 'UpdateTime' => [ - 'title' => 'updateTime', - 'description' => 'The time when the index was updated.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'updateTime', - ], - 'PkPosition' => [ - 'title' => 'pkPosition', - 'description' => 'The location of the primary key.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - 'backendName' => 'pkPosition', - ], - 'IsPartitionKey' => [ - 'title' => 'isPartitionKey', - 'description' => 'Indicates whether the column is the partition key.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'isPartitionKey', - ], - 'OrdinalPosition' => [ - 'title' => 'ordinalPosition', - 'description' => 'The location of the column.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - 'backendName' => 'ordinalPosition', - ], - 'ColumnRawName' => [ - 'title' => 'columnRawName', - 'description' => 'The original name of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ColumnRawName', - 'backendName' => 'columnRawName', - ], - 'PhysicalColumnName' => [ - 'title' => 'physicalColumnName', - 'description' => 'The physical name of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'PhysicalColumnName', - 'backendName' => 'physicalColumnName', - ], - 'Nullable' => [ - 'title' => 'nullable', - 'description' => 'Indicates whether the column can be empty.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'nullable', - ], - 'AutoIncrement' => [ - 'title' => 'autoIncrement', - 'description' => 'Indicates whether the column is auto-incremented.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'autoIncrement', - ], - 'Precision' => [ - 'title' => 'precision', - 'description' => 'The precision of the column.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'precision', - ], - 'Scale' => [ - 'title' => 'scale', - 'description' => 'The scale of the column.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'scale', - ], - 'Primarykey' => [ - 'title' => 'primarykey', - 'description' => 'Indicates whether the column is the primary key.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'primarykey', - ], - 'DefaultValue' => [ - 'title' => 'defaultValue', - 'description' => 'The default value of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'default', - 'backendName' => 'defaultValue', - ], - 'Tokenizer' => [ - 'title' => 'tokenizer', - 'description' => 'The token of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tokenizer', - 'backendName' => 'tokenizer', - ], - 'Encode' => [ - 'title' => 'encode', - 'description' => 'The encryption method of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'encode', - 'backendName' => 'encode', - ], - 'Compression' => [ - 'title' => 'compression', - 'description' => 'The compression method of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'compression', - 'backendName' => 'compression', - ], - 'Delimiter' => [ - 'title' => 'delimiter', - 'description' => 'The delimiter of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'delimiter', - 'backendName' => 'delimiter', - ], - 'ValueType' => [ - 'title' => 'valueType', - 'description' => 'The value type of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'valueType', - 'backendName' => 'valueType', - ], - 'CompressFloatUseShort' => [ - 'title' => 'compressFloatUseShort', - 'description' => 'Indicates whether FLOAT data is compressed to SHORT data.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'compressFloatUseShort', - ], - 'OnUpdate' => [ - 'title' => 'onUpdate', - 'description' => 'The update condition of the column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'onUpdate', - 'backendName' => 'onUpdate', - ], - ], + 'Name' => ['title' => '', 'description' => 'The name of the column.'."\n", 'type' => 'string', 'example' => 'name'], + 'Type' => ['title' => '', 'description' => 'The type of the column.'."\n", 'type' => 'string', 'example' => 'long'], + 'Comment' => ['title' => '', 'description' => 'The description of the column.'."\n", 'type' => 'string', 'example' => 'comment'], + 'DatabaseName' => ['title' => '', 'description' => 'The logical name of the database.'."\n", 'type' => 'string', 'example' => 'databaseName'], + 'TableName' => ['title' => '', 'description' => 'The logical name of the table.'."\n", 'type' => 'string', 'example' => 'tableName'], + 'MappedName' => ['title' => '', 'description' => 'The mapping name.'."\n", 'type' => 'string', 'example' => 'mappedName'], + 'DataType' => ['title' => '', 'description' => 'The data type of the column.'."\n", 'type' => 'string', 'example' => 'long'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the column was created.'."\n", 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the index was updated.'."\n", 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'PkPosition' => ['title' => '', 'description' => 'The location of the primary key.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'IsPartitionKey' => ['title' => '', 'description' => 'Indicates whether the column is the partition key.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'OrdinalPosition' => ['title' => '', 'description' => 'The location of the column.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'ColumnRawName' => ['title' => '', 'description' => 'The original name of the column.'."\n", 'type' => 'string', 'example' => 'ColumnRawName'], + 'PhysicalColumnName' => ['title' => '', 'description' => 'The physical name of the column.'."\n", 'type' => 'string', 'example' => 'PhysicalColumnName'], + 'Nullable' => ['title' => '', 'description' => 'Indicates whether the column can be empty.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'AutoIncrement' => ['title' => '', 'description' => 'Indicates whether the column is auto-incremented.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Precision' => ['title' => '', 'description' => 'The precision of the column.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Scale' => ['title' => '', 'description' => 'The scale of the column.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Primarykey' => ['title' => '', 'description' => 'Indicates whether the column is the primary key.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'DefaultValue' => ['title' => '', 'description' => 'The default value of the column.'."\n", 'type' => 'string', 'example' => 'default'], + 'Tokenizer' => ['title' => '', 'description' => 'The token of the column.'."\n", 'type' => 'string', 'example' => 'tokenizer'], + 'Encode' => ['title' => '', 'description' => 'The encryption method of the column.'."\n", 'type' => 'string', 'example' => 'encode'], + 'Compression' => ['title' => '', 'description' => 'The compression method of the column.'."\n", 'type' => 'string', 'example' => 'compression'], + 'Delimiter' => ['title' => '', 'description' => 'The delimiter of the column.'."\n", 'type' => 'string', 'example' => 'delimiter'], + 'ValueType' => ['title' => '', 'description' => 'The value type of the column.'."\n", 'type' => 'string', 'example' => 'valueType'], + 'CompressFloatUseShort' => ['title' => '', 'description' => 'Indicates whether FLOAT data is compressed to SHORT data.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'OnUpdate' => ['title' => '', 'description' => 'The update condition of the column.'."\n", 'type' => 'string', 'example' => 'onUpdate'], + ], + 'example' => '', ], 'LogAnalyzeResult' => [ 'title' => '', 'description' => 'The Spark log analysis result.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'AppErrorCode' => [ - 'title' => '', - 'description' => 'The error type if an analysis error occurs.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'EXCEEDED_QUOTA', - 'backendName' => 'appErrorCode', - ], - 'AppErrorLog' => [ - 'title' => '', - 'description' => 'The error log of the Spark log analysis task.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'exception: cpu is exceeded limits 12/10', - 'backendName' => 'appErrorLog', - ], - 'AppErrorAdvice' => [ - 'title' => '', - 'description' => 'The solution for the error log.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Please increase cpu quota for your resource group', - 'backendName' => 'appErrorAdvice', - ], + 'AppErrorCode' => ['title' => '', 'description' => 'The error type if an analysis error occurs.'."\n", 'type' => 'string', 'example' => 'EXCEEDED_QUOTA'], + 'AppErrorLog' => ['title' => '', 'description' => 'The error log of the Spark log analysis task.'."\n", 'type' => 'string', 'example' => 'exception: cpu is exceeded limits 12/10'], + 'AppErrorAdvice' => ['title' => '', 'description' => 'The solution for the error log.'."\n", 'type' => 'string', 'example' => 'Please increase cpu quota for your resource group'], ], + 'example' => '', ], 'open_struct_MvBaseTableDetailModel' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Detailed information about the base table of a materialized view.', 'type' => 'object', 'properties' => [ - 'TableName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'tableName', - ], - 'DataVolumn' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '321233', - 'backendName' => 'dataVolumn', - ], - 'EnableBinlog' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableBinlog', - ], - 'SchemaName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'adb_demo', - 'backendName' => 'schemaName', - ], + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DataVolumn' => ['description' => 'The data volume.', 'type' => 'string', 'example' => '321233', 'title' => ''], + 'EnableBinlog' => ['description' => 'Indicates whether binary logging is enabled for the table.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'open_struct_MvDetailModel' => [ - 'description' => 'Materialized view summary data.'."\n", - 'visibility' => 'Public', + 'description' => 'Materialized view summary data.', 'type' => 'object', 'properties' => [ - 'FirstRefreshTime' => [ - 'description' => 'The first refresh time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-01-01 09:00:00', - 'backendName' => 'firstRefreshTime', - ], - 'QueryRewriteEnabled' => [ - 'description' => 'Whether to enable query rewrite for the current materialized view.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'queryRewriteEnabled', - ], - 'ExplicitHit' => [ - 'description' => 'The total number of explicit query hits in the last seven days.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'backendName' => 'explicitHit', - ], - 'IsInactive' => [ - 'description' => 'The system detects that the current materialized view has been created for more than 30 days and has not been accessed (including both explicit query and implicit query).'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'isInactive', - ], - 'RemoteSize' => [ - 'description' => 'Cold data disk space consumed by materialized views (bytes).'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - 'backendName' => 'remoteSize', - ], - 'LocalSize' => [ - 'description' => 'Hot data disk space consumed by materialized views (bytes).'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - 'backendName' => 'localSize', - ], - 'RefreshState' => [ - 'description' => 'Refresh mode for materialized views.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'FAST', - 'backendName' => 'refreshState', - ], - 'RefreshInterval' => [ - 'description' => 'The refresh interval.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '(now() + INTERVAL \'10\' SECOND)', - 'backendName' => 'refreshInterval', - ], - 'ImplicitHit' => [ - 'description' => 'The total number of implicit query hits in the last seven days.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'backendName' => 'implicitHit', - ], - 'UpdatedAt' => [ - 'description' => 'The last refresh time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-01-01 10:00:00', - 'backendName' => 'updatedAt', - ], - 'ResourceGroup' => [ - 'description' => 'The resource group used for the refresh.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user_default', - 'backendName' => 'resourceGroup', - ], + 'FirstRefreshTime' => ['description' => 'The time of the first refresh.', 'type' => 'string', 'example' => '2025-01-01 09:00:00', 'title' => ''], + 'QueryRewriteEnabled' => ['description' => 'Whether query rewrite is enabled for the materialized view.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ExplicitHit' => ['description' => 'The total number of explicit query hits in the last 7 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'IsInactive' => ['description' => 'Indicates whether the materialized view has not been accessed by explicit or implicit queries for more than 30 days since its creation.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'RemoteSize' => ['description' => 'The disk space that the materialized view occupies for cold data, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'LocalSize' => ['description' => 'The disk space that the materialized view occupies for hot data, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'RefreshState' => ['description' => 'The refresh model of the materialized view.', 'type' => 'string', 'example' => 'FAST', 'title' => ''], + 'RefreshInterval' => ['description' => 'The refresh interval.', 'type' => 'string', 'example' => '(now() + INTERVAL \'10\' SECOND)', 'title' => ''], + 'ImplicitHit' => ['description' => 'The total number of implicit query hits in the last 7 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'UpdatedAt' => ['description' => 'The time of the last refresh.', 'type' => 'string', 'example' => '2025-01-01 10:00:00', 'title' => ''], + 'ResourceGroup' => ['description' => 'The resource group on which the refresh depends.', 'type' => 'string', 'example' => 'user_default', 'title' => ''], 'BaseTableInfos' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'All direct parent base tables of the materialized view.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'SchemaName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_db', - 'backendName' => 'schemaName', - ], - 'TableName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_tbl', - 'backendName' => 'tableName', - ], - 'BaseTableIsMv' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'baseTableIsMv', - ], - 'TableEngine' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'XUANWU', - 'backendName' => 'tableEngine', - ], + 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'test_db', 'title' => ''], + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'test_tbl', 'title' => ''], + 'BaseTableIsMv' => ['description' => 'Whether the base table is a materialized view.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TableEngine' => ['description' => 'The table engine.', 'type' => 'string', 'example' => 'XUANWU', 'title' => ''], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'baseTableNames', - ], - 'TableEngine' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'XUANWU', - 'backendName' => 'tableEngine', + 'title' => '', + 'example' => '', ], + 'TableEngine' => ['description' => 'The table engine.', 'type' => 'string', 'example' => 'XUANWU', 'title' => ''], 'BaseTableNames' => [ - 'description' => 'All direct parent base tables of the current materialized view.'."\n", - 'visibility' => 'Public', + 'description' => 'All direct parent base tables of the materialized view.', 'type' => 'array', 'items' => [ - 'description' => 'The database name and table name of the base table.'."\n", - 'visibility' => 'Public', + 'description' => 'The database name and table name of the base table.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the database or table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 't1', - 'extendType' => 'true', - ], - 'extendType' => 'true', + 'items' => ['description' => 'The database name or table name.', 'type' => 'string', 'example' => 't1', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'backendName' => 'baseTableNames', - ], - 'EnableDelayAlert' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'false', - 'backendName' => 'enableDelayAlert', - ], - 'EnableFailureAlert' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'false', - 'backendName' => 'enableFailureAlert', - ], - 'LatencyTolerance' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'backendName' => 'latencyTolerance', + 'title' => '', + 'example' => '', ], + 'EnableDelayAlert' => ['description' => 'Indicates whether to enable alerting for refresh latency. Valid values:'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'integer', 'format' => 'int32', 'example' => 'false', 'title' => ''], + 'EnableFailureAlert' => ['description' => 'Indicates whether to enable alerting for refresh task failures. Valid values:'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'integer', 'format' => 'int32', 'example' => 'false', 'title' => ''], + 'LatencyTolerance' => ['description' => 'The refresh latency toleration, in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'open_struct_MVRecommendResultModel' => [ 'description' => 'Materialized view recommendation details.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'BaseTables' => [ 'description' => 'The base table associated with the subquery.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The details of the base table.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/open_struct_MvBaseTableDetailModel', - ], - 'backendName' => 'baseTables', - ], - 'AcceleratedQueriesCount' => [ - 'description' => 'The number of accelerated queries.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - 'backendName' => 'acceleratedQueriesCount', - ], - 'SupportIncrementalRefresh' => [ - 'description' => 'Whether the current subquery supports incremental refresh.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'supportIncrementalRefresh', - ], - 'SubqueryId' => [ - 'description' => 'The ID of the subquery.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'subqueryId', - ], - 'SavedScanbytes' => [ - 'description' => 'Estimated bytes scanned reduction by current materialized view from correlated parent queries (posterior calculation).'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '321321223', - 'backendName' => 'savedScanbytes', - ], - 'Subquery' => [ - 'description' => 'The extracted public subquery.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SELECT * FROM demo.tbl', - 'backendName' => 'subquery', + 'items' => ['description' => 'The details of the base table.'."\n", '$ref' => '#/components/schemas/open_struct_MvBaseTableDetailModel', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'AcceleratedQueriesCount' => ['description' => 'The number of accelerated queries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'SupportIncrementalRefresh' => ['description' => 'Whether the current subquery supports incremental refresh.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SubqueryId' => ['description' => 'The ID of the subquery.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SavedScanbytes' => ['description' => 'Estimated bytes scanned reduction by current materialized view from correlated parent queries (posterior calculation).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '321321223', 'title' => ''], + 'Subquery' => ['description' => 'The extracted public subquery.'."\n", 'type' => 'string', 'example' => 'SELECT * FROM demo.tbl', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'open_struct_MvRecommendSubTaskModel' => [ 'description' => 'Details of a recommendation task for a materialized view.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'SubQueriesCount' => [ - 'description' => 'The number of newly generated MV recommendations.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70', - 'backendName' => 'subQueriesCount', - ], - 'Status' => [ - 'description' => 'Current execution status.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RUNNING', - 'backendName' => 'status', - ], - 'EndTime' => [ - 'description' => 'The end time of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-10-16 16:56'."\n", - 'backendName' => 'endTime', - ], - 'StartTime' => [ - 'description' => 'The start time of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-10-16 16:55'."\n", - 'backendName' => 'startTime', - ], - 'SubtaskId' => [ - 'description' => 'The record ID of the task execution.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - 'backendName' => 'subtaskId', - ], - 'ScanQueriesCount' => [ - 'description' => 'The number of queries scanned.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '55', - 'backendName' => 'scanQueriesCount', - ], - 'MinRewriteQueryCount' => [ - 'description' => 'The minimum number of slow queries that match the pattern.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'minRewriteQueryCount', - ], - 'MinRewriteQueryPattern' => [ - 'description' => 'The number of minimum acceleration patterns.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'minRewriteQueryPattern', - ], - 'SlowQueryThreshold' => [ - 'description' => 'The wait threshold for slow queries.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'backendName' => 'slowQueryThreshold', - ], + 'SubQueriesCount' => ['description' => 'The number of newly generated MV recommendations.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '70', 'title' => ''], + 'Status' => ['description' => 'Current execution status.'."\n", 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the task.'."\n", 'type' => 'string', 'example' => '2025-10-16 16:56'."\n", 'title' => ''], + 'StartTime' => ['description' => 'The start time of the task.'."\n", 'type' => 'string', 'example' => '2025-10-16 16:55'."\n", 'title' => ''], + 'SubtaskId' => ['description' => 'The record ID of the task execution.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'ScanQueriesCount' => ['description' => 'The number of queries scanned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '55', 'title' => ''], + 'MinRewriteQueryCount' => ['description' => 'The minimum number of slow queries that match the pattern.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'MinRewriteQueryPattern' => ['description' => 'The number of minimum acceleration patterns.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'SlowQueryThreshold' => ['description' => 'The wait threshold for slow queries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'open_struct_MvRecommendTaskModel' => [ 'description' => 'Details of a recommendation task for a materialized view.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'Description.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'task desc'."\n", - 'backendName' => 'description', - ], - 'CreatedTime' => [ - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-12-12 23:59', - 'backendName' => 'createdTime', - ], - 'LastRunAt' => [ - 'description' => 'Last execution time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-12-13 00:10', - 'backendName' => 'lastRunAt', - ], - 'TaskName' => [ - 'description' => 'The name of the recommendation task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mv_task1', - 'backendName' => 'taskName', - ], - 'ScanQueriesRange' => [ - 'description' => 'The time range for scanning data. Unit: days. Default value: 3.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'scanQueriesRange', - ], - 'SchedulingSettings' => [ - 'description' => 'The execution schedule of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The 12:30 every day', - 'backendName' => 'schedulingSettings', - ], - 'MinRewriteQueryCount' => [ - 'description' => 'The minimum number of slow queries that match the pattern.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'minRewriteQueryCount', - ], - 'MinRewriteQueryPattern' => [ - 'description' => 'The number of minimum acceleration patterns.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'minRewriteQueryPattern', - ], - 'SlowQueryThreshold' => [ - 'description' => 'The wait threshold for slow queries.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'backendName' => 'slowQueryThreshold', - ], + 'Description' => ['description' => 'Description.'."\n", 'type' => 'string', 'example' => 'task desc'."\n", 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2024-12-12 23:59', 'title' => ''], + 'LastRunAt' => ['description' => 'Last execution time.'."\n", 'type' => 'string', 'example' => '2024-12-13 00:10', 'title' => ''], + 'TaskName' => ['description' => 'The name of the recommendation task.'."\n", 'type' => 'string', 'example' => 'mv_task1', 'title' => ''], + 'ScanQueriesRange' => ['description' => 'The time range for scanning data. Unit: days. Default value: 3.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'SchedulingSettings' => ['description' => 'The execution schedule of the task.'."\n", 'type' => 'string', 'example' => 'The 12:30 every day', 'title' => ''], + 'MinRewriteQueryCount' => ['description' => 'The minimum number of slow queries that match the pattern.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'MinRewriteQueryPattern' => ['description' => 'The number of minimum acceleration patterns.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'SlowQueryThreshold' => ['description' => 'The wait threshold for slow queries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'open_struct_RefreshJobModel' => [ 'description' => 'Refresh task details.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the queried refresh task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RUNNING', - 'backendName' => 'status', - ], - 'EndTime' => [ - 'description' => 'The end time of the refresh task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-01-15 10:12:00', - 'backendName' => 'endTime', - ], - 'RefreshModel' => [ - 'description' => 'The refresh model.'."\n" - ."\n" - .'* FAST'."\n" - .'* COMPLETE'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'FAST', - 'backendName' => 'refreshModel', - ], - 'StartTime' => [ - 'description' => 'The actual start time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-01-15 10:11:00', - 'backendName' => 'startTime', - ], - 'RefreshInterval' => [ - 'description' => 'The refresh interval.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '30s', - 'backendName' => 'refreshInterval', - ], - 'Processid' => [ - 'description' => 'The task ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025103010xxxxxxx', - 'backendName' => 'processId', - ], - 'ScheduledStartTime' => [ - 'description' => 'The scheduled start time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-01-15 10:11:00'."\n", - 'backendName' => 'scheduledStartTime', - ], - 'SchemaName' => [ - 'description' => 'The database name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'adb_demo', - 'backendName' => 'schemaName', - ], - 'ResourceGroup' => [ - 'description' => 'The resource group used for the refresh.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user_default', - 'backendName' => 'resourceGroup', + 'Status' => ['description' => 'The status of the queried refresh task.'."\n", 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the refresh task.'."\n", 'type' => 'string', 'example' => '2025-01-15 10:12:00', 'title' => ''], + 'RefreshModel' => ['description' => 'The refresh model.'."\n" + ."\n" + .'* FAST'."\n" + .'* COMPLETE'."\n", 'type' => 'string', 'example' => 'FAST', 'title' => ''], + 'StartTime' => ['description' => 'The actual start time.'."\n", 'type' => 'string', 'example' => '2025-01-15 10:11:00', 'title' => ''], + 'RefreshInterval' => ['description' => 'The refresh interval.'."\n", 'type' => 'string', 'example' => '30s', 'title' => ''], + 'Processid' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '2025103010xxxxxxx', 'title' => ''], + 'SchemaName' => ['description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'ResourceGroup' => ['description' => 'The resource group used for the refresh.'."\n", 'type' => 'string', 'example' => 'user_default', 'title' => ''], + 'Name' => ['description' => 'The materialized view name.'."\n", 'type' => 'string', 'example' => 'demo_mv', 'title' => ''], + 'ScheduledStartTime' => ['description' => 'The scheduled start time.'."\n", 'type' => 'string', 'example' => '2025-01-15 10:11:00'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'OperatorNode' => [ + 'title' => '', + 'description' => 'The Spark operator node.', + 'type' => 'object', + 'properties' => [ + 'nodeName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'id' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'nodeDepth' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'parentId' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'levelWidth' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'nodeWidth' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'stats' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'parameters' => ['title' => '', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'bytes' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'outputRows' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'timeCost' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'peakMemory' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', ], - 'Name' => [ - 'description' => 'The materialized view name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'demo_mv', - 'backendName' => 'name', + 'children' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/OperatorNode', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', ], ], + 'example' => '', + ], + 'SemanticViewModel' => [ + 'type' => 'object', + 'properties' => [ + 'ViewSchema' => ['description' => 'The schema where the semantic view resides', 'type' => 'string', 'title' => '', 'example' => 'sales_db'], + 'Definition' => ['description' => 'The YAML definition of the semantic view', 'type' => 'string', 'title' => '', 'example' => 'name: revenue_analysis'."\n" + .'description: "Semantic view for analyzing revenue across products and customers"'."\n" + ."\n" + .'tables:'."\n" + .' - name: customers'."\n" + .' description: "Customer information"'."\n" + .' base_table:'."\n" + .' schema: sales_db'."\n" + .' table: customers'."\n" + .' dimensions:'."\n" + .' - name: customer_name'."\n" + .' synonyms: ["client name", "customer"]'."\n" + .' description: "Full name of the customer"'."\n" + .' expr: c_name'."\n" + .' data_type: VARCHAR'."\n" + .' - name: customer_segment'."\n" + .' synonyms: ["segment", "market segment"]'."\n" + .' description: "Customer market segment"'."\n" + .' expr: c_mktsegment'."\n" + .' data_type: VARCHAR'."\n" + .' is_enum: true'."\n" + ."\n" + .' - name: orders'."\n" + .' description: "Order information"'."\n" + .' base_table:'."\n" + .' schema: sales_db'."\n" + .' table: orders'."\n" + .' dimensions:'."\n" + .' - name: order_date'."\n" + .' description: "Date when order was placed"'."\n" + .' expr: o_orderdate'."\n" + .' data_type: DATE'."\n" + .' - name: order_year'."\n" + .' description: "Year when order was placed"'."\n" + .' expr: YEAR(o_orderdate)'."\n" + .' data_type: NUMBER'."\n" + .' facts:'."\n" + .' - name: order_total'."\n" + .' description: "Total order amount"'."\n" + .' expr: o_totalprice'."\n" + .' data_type: NUMBER'."\n" + .' metrics:'."\n" + .' - name: total_orders'."\n" + .' description: "Total number of orders"'."\n" + .' expr: COUNT(*)'."\n" + .' - name: total_revenue'."\n" + .' description: "Total revenue of orders"'."\n" + .' expr: SUM(o_totalprice)'."\n" + .' - name: average_order_value'."\n" + .' description: "Average order value"'."\n" + .' expr: AVG(o_totalprice)'."\n" + ."\n" + .'relationships:'."\n" + .' - name: orders_to_customers'."\n" + .' left_table: orders'."\n" + .' right_table: customers'."\n" + .' relationship_columns:'."\n" + .' - left_column: o_custkey'."\n" + .' right_column: c_custkey'."\n" + ."\n" + .'metrics:'."\n" + .' - name: revenue_per_customer'."\n" + .' description: "Average revenue per customer"'."\n" + .' expr: orders.total_revenue / customers.customer_count'."\n"], + 'ViewName' => ['description' => 'The name of the semantic view', 'type' => 'string', 'title' => '', 'example' => 'revenue_analysis'], + 'Comment' => ['description' => 'The annotation for the semantic view', 'type' => 'string', 'title' => '', 'example' => '这是一个定义销售额相关指标的视图'], + 'Score' => ['description' => 'The vector retrieval match score (defaults to 1; during retrieval queries, it is a decimal between 0 and 1 representing vector similarity)', 'type' => 'number', 'title' => '', 'example' => '0.81', 'format' => 'double'], + ], + 'description' => 'Contains the definition and metadata for a semantic view.', + 'title' => '', + 'example' => '', ], 'SerDeInfoModel' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The information about serialization or deserialization.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'SerDeId' => [ - 'title' => 'serDeId', - 'description' => 'The ID of the serialization or deserialization information.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - 'backendName' => 'serDeId', - ], - 'Name' => [ - 'title' => 'name', - 'description' => 'The name of the serialization or deserialization information.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'example', - 'backendName' => 'name', - ], + 'SerDeId' => ['title' => '', 'description' => 'The ID of the serialization or deserialization information.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Name' => ['title' => '', 'description' => 'The name of the serialization or deserialization information.'."\n", 'type' => 'string', 'example' => 'example'], 'Parameters' => [ - 'title' => 'parameters', + 'title' => '', 'description' => 'The serialization or deserialization configuration parameter.'."\n", - 'visibility' => 'public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The value of the parameter.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'key:value', - ], - 'backendName' => 'parameters', - ], - 'SerializationLib' => [ - 'title' => 'serializationLib', - 'description' => 'The library that is used for serialization.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe', - 'backendName' => 'serializationLib', + 'additionalProperties' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => 'key:value', 'title' => ''], + 'example' => '', ], + 'SerializationLib' => ['title' => '', 'description' => 'The library that is used for serialization.'."\n", 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe'], ], + 'example' => '', ], 'SparkAnalyzeLogTask' => [ 'title' => '', 'description' => 'The queried Spark log analysis task.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '', - 'description' => 'The ID of the Spark log analysis task.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'backendName' => 'taskId', - ], - 'UserId' => [ - 'title' => '', - 'description' => 'The ID of the user who submitted the task.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13719918xxx', - 'backendName' => 'uid', - ], - 'SubmittedTimeInMillis' => [ - 'title' => '', - 'description' => 'The time when the task was submitted. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1672123543000', - 'backendName' => 'submittedTimeInMillis', - ], - 'TerminatedTimeInMillis' => [ - 'title' => '', - 'description' => 'The time when the task was terminated. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1672123543000', - 'backendName' => 'terminatedTimeInMillis', - ], - 'TaskState' => [ - 'title' => '', - 'description' => 'The state of the task.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'WAITING', - 'backendName' => 'taskState', - ], - 'Result' => [ - 'title' => '', - 'description' => 'The analysis result of the task.'."\n", - 'visibility' => 'public', - 'backendName' => 'logAnalyzeResult', - '$ref' => '#/components/schemas/LogAnalyzeResult', - ], - 'StartedTimeInMillis' => [ - 'title' => '', - 'description' => 'The time when the task was started. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1672123543000', - 'backendName' => 'startedTimeInMillis', - ], - 'RuleMatched' => [ - 'title' => '', - 'description' => 'Indicates whether the task matched a rule.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'ruleMatched', - ], - 'TaskErrMsg' => [ - 'title' => '', - 'description' => 'The error message returned if the task fails.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Driver log not found', - 'backendName' => 'taskErrMsg', - ], - 'DBClusterId' => [ - 'title' => '', - 'description' => 'The cluster ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'amv-adbxxxxx', - 'backendName' => 'dbClusterId', - ], - ], + 'TaskId' => ['title' => '', 'description' => 'The ID of the Spark log analysis task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'UserId' => ['title' => '', 'description' => 'The ID of the user who submitted the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '13719918xxx'], + 'SubmittedTimeInMillis' => ['title' => '', 'description' => 'The time when the task was submitted. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1672123543000'], + 'TerminatedTimeInMillis' => ['title' => '', 'description' => 'The time when the task was terminated. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1672123543000'], + 'TaskState' => ['title' => '', 'description' => 'The state of the task.'."\n", 'type' => 'string', 'example' => 'WAITING'], + 'Result' => ['title' => '', 'description' => 'The analysis result of the task.'."\n", '$ref' => '#/components/schemas/LogAnalyzeResult', 'example' => ''], + 'StartedTimeInMillis' => ['title' => '', 'description' => 'The time when the task was started. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1672123543000'], + 'RuleMatched' => ['title' => '', 'description' => 'Indicates whether the task matched a rule.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'TaskErrMsg' => ['title' => '', 'description' => 'The error message returned if the task fails.'."\n", 'type' => 'string', 'example' => 'Driver log not found'], + 'DBClusterId' => ['title' => '', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-adbxxxxx'], + ], + 'example' => '', ], 'SparkAppInfo' => [ 'title' => '', 'description' => 'The queried execution state of the Spark application.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'title' => '', - 'description' => 'The ID of the Spark application.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 's202207151211hz0c****', - 'backendName' => 'appId', - ], - 'AppName' => [ - 'title' => '', - 'description' => 'The name of the Spark application.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'SparkTest', - 'backendName' => 'appName', - ], - 'Priority' => [ - 'title' => '', - 'description' => 'The priority of the Spark application.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'NORMAL', - 'backendName' => 'priority', - ], - 'State' => [ - 'title' => '', - 'description' => 'The state of the Spark application. Valid values:'."\n" - ."\n" - .'* **SUBMITTED**'."\n" - .'* **STARTING**'."\n" - .'* **RUNNING**'."\n" - .'* **FAILING**'."\n" - .'* **FAILED**'."\n" - .'* **KILLING**'."\n" - .'* **KILLED**'."\n" - .'* **SUCCEEDING**'."\n" - .'* **COMPLETED**'."\n" - .'* **FATAL**'."\n" - .'* **UNKNOWN**'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'SUBMITTED', - 'backendName' => 'state', - ], - 'Message' => [ - 'title' => '', - 'description' => 'The alert message returned, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'WARN: Disk is full.', - 'backendName' => 'message', - ], - 'Detail' => [ - 'title' => '', - 'description' => 'The information about the Spark application.'."\n", - 'visibility' => 'public', - 'backendName' => 'detail', - '$ref' => '#/components/schemas/Detail', - ], - 'DBClusterId' => [ - 'title' => '', - 'description' => 'The database ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'amv-23xxxx', - 'backendName' => 'dbClusterId', - ], - ], + 'AppId' => ['title' => '', 'description' => 'The ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202207151211hz0c****'], + 'Message' => ['title' => '', 'description' => 'The alert message returned, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", 'type' => 'string', 'example' => 'WARN: Disk is full.'], + 'Priority' => ['title' => '', 'description' => 'The priority of the Spark application.'."\n", 'type' => 'string', 'example' => 'NORMAL'], + 'State' => ['title' => '', 'description' => 'The state of the Spark application. Valid values:'."\n" + ."\n" + .'* **SUBMITTED**'."\n" + .'* **STARTING**'."\n" + .'* **RUNNING**'."\n" + .'* **FAILING**'."\n" + .'* **FAILED**'."\n" + .'* **KILLING**'."\n" + .'* **KILLED**'."\n" + .'* **SUCCEEDING**'."\n" + .'* **COMPLETED**'."\n" + .'* **FATAL**'."\n" + .'* **UNKNOWN**'."\n", 'type' => 'string', 'example' => 'SUBMITTED'], + 'DBClusterId' => ['title' => '', 'description' => 'The database ID.'."\n", 'type' => 'string', 'example' => 'amv-23xxxx'], + 'Detail' => ['title' => '', 'description' => 'The information about the Spark application.'."\n", '$ref' => '#/components/schemas/Detail', 'example' => ''], + 'AppName' => ['title' => '', 'description' => 'The name of the Spark application.'."\n", 'type' => 'string', 'example' => 'SparkTest'], + ], + 'example' => '', ], 'SparkAttemptInfo' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The queried Spark application attempt.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'AttemptId' => [ - 'title' => '', - 'description' => 'The attempt ID of the Spark application.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 's202207151211hz****-0001', - 'backendName' => 'attemptId', - ], - 'Priority' => [ - 'title' => '', - 'description' => 'The attempt priority of the Spark application.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'NORMAL', - 'backendName' => 'priority', - ], - 'State' => [ - 'title' => '', - 'description' => 'The state of the Spark application. Valid values:'."\n" - ."\n" - .'* **SUBMITTED**'."\n" - .'* **STARTING**'."\n" - .'* **RUNNING**'."\n" - .'* **FAILING**'."\n" - .'* **FAILED**'."\n" - .'* **KILLING**'."\n" - .'* **KILLED**'."\n" - .'* **SUCCEEDING**'."\n" - .'* **COMPLETED**'."\n" - .'* **FATAL**'."\n" - .'* **UNKNOWN**'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'SUBMITTED', - 'backendName' => 'state', - ], - 'Message' => [ - 'title' => '', - 'description' => 'The alert message returned, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'WARN: Disk is full', - 'backendName' => 'message', - ], - 'Detail' => [ - 'title' => '', - 'description' => 'The information about the Spark application.'."\n", - 'visibility' => 'public', - 'backendName' => 'detail', - '$ref' => '#/components/schemas/Detail', - ], - ], + 'AttemptId' => ['title' => '', 'description' => 'The attempt ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202207151211hz****-0001'], + 'Message' => ['title' => '', 'description' => 'The alert message returned, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", 'type' => 'string', 'example' => 'WARN: Disk is full'], + 'Priority' => ['title' => '', 'description' => 'The attempt priority of the Spark application.'."\n", 'type' => 'string', 'example' => 'NORMAL'], + 'State' => ['title' => '', 'description' => 'The state of the Spark application. Valid values:'."\n" + ."\n" + .'* **SUBMITTED**'."\n" + .'* **STARTING**'."\n" + .'* **RUNNING**'."\n" + .'* **FAILING**'."\n" + .'* **FAILED**'."\n" + .'* **KILLING**'."\n" + .'* **KILLED**'."\n" + .'* **SUCCEEDING**'."\n" + .'* **COMPLETED**'."\n" + .'* **FATAL**'."\n" + .'* **UNKNOWN**'."\n", 'type' => 'string', 'example' => 'SUBMITTED'], + 'Detail' => ['title' => '', 'description' => 'The information about the Spark application.'."\n", '$ref' => '#/components/schemas/Detail', 'example' => ''], + ], + 'example' => '', ], 'SparkBatchSQL' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The information about SparkBatchSQL.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'QueryId' => [ - 'title' => 'Query ID', - 'description' => 'The query ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sq172352176****', - 'backendName' => 'queryId', - ], + 'Uid' => ['title' => '', 'description' => 'The Alibaba Cloud account ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2198002412336****'], + 'QuerySubmissionTime' => ['title' => '', 'description' => 'The submission timestamp of the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1723521767000'], + 'Query' => ['title' => '', 'description' => 'The text of the query.'."\n", 'type' => 'string', 'example' => 'SELECT * FROM db.tb'], + 'QueryId' => ['title' => '', 'description' => 'The query ID.'."\n", 'type' => 'string', 'example' => 'sq172352176****'], + 'Schema' => ['title' => '', 'description' => 'The name of the database for the query execution.'."\n", 'type' => 'string', 'example' => 'default'], + 'QueryEndTime' => ['title' => '', 'description' => 'The execution end timestamp of the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1723521767000'], + 'DBClusterId' => ['title' => '', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-bp17s73f016****'], 'QueryState' => [ 'title' => '', 'description' => 'The execution status of the query. Valid values:'."\n" @@ -1771,143 +598,33 @@ .'* PENDING'."\n" .'* SUBMITTED'."\n" .'* FINISHED'."\n", - 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'RUNNING', - 'backendName' => 'queryState', ], - 'QuerySubmissionTime' => [ + 'Statements' => [ 'title' => '', - 'description' => 'The submission timestamp of the query.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1723521767000', - 'backendName' => 'querySubmissionTime', + 'description' => 'The execution results of the SQL statements.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The information about the SQL statement.'."\n", '$ref' => '#/components/schemas/SparkBatchSQLStatement', 'title' => '', 'example' => ''], + 'example' => '', ], - 'QueryStartTime' => [ - 'title' => '', - 'description' => 'The execution start timestamp of the query.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1723521767000', - 'backendName' => 'queryStartTime', - ], - 'QueryEndTime' => [ - 'title' => '', - 'description' => 'The execution end timestamp of the query.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1723521767000', - 'backendName' => 'queryEndTime', - ], - 'Schema' => [ - 'title' => '', - 'description' => 'The name of the database for the query execution.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'default', - 'backendName' => 'schema', - ], - 'Uid' => [ - 'title' => '', - 'description' => 'The Alibaba Cloud account ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2198002412336****', - 'backendName' => 'uid', - ], - 'DBClusterId' => [ - 'title' => '', - 'description' => 'The cluster ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'amv-bp17s73f016****', - 'backendName' => 'dbClusterId', - ], - 'ResourceGroupName' => [ - 'title' => '', - 'description' => 'The name of the resource group.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'spark_rg', - 'backendName' => 'resourceGroupName', - ], - 'Query' => [ - 'title' => '', - 'description' => 'The text of the query.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SELECT * FROM db.tb', - 'backendName' => 'query', - ], - 'Statements' => [ - 'title' => '', - 'description' => 'The execution results of the SQL statements.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the SQL statement.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/SparkBatchSQLStatement', - ], - 'backendName' => 'statements', - ], - 'ErrMessage' => [ - 'title' => '', - 'description' => 'The error message for the query execution.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'schema is not found', - 'backendName' => 'errMessage', - ], - ], - ], - 'SparkBatchSQLStatement' => [ - 'title' => '', - 'description' => 'The information about SparkBatchSQLStatement.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'ResultUri' => [ - 'title' => '', - 'description' => 'The Object Storage Service (OSS) location where the execution results of the SQL statement are stored. If you do not specify a storage location, null is returned.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://yourbucket/result.json', - 'backendName' => 'resultUri', - ], - 'EndTime' => [ - 'title' => '', - 'description' => 'The execution end timestamp of the SQL statement.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1723521767000', - 'backendName' => 'endTime', - ], - 'AppId' => [ - 'title' => '', - 'description' => 'The ID of the Spark job that executes the SQL statement.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 's20240122jsdx****', - 'backendName' => 'appId', - ], - 'StatementId' => [ - 'title' => 'Statement Id', - 'description' => 'The ID of the SQL statement.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sq1723521767****-0001', - 'backendName' => 'statementId', - ], - 'State' => [ + 'ErrMessage' => ['title' => '', 'description' => 'The error message for the query execution.'."\n", 'type' => 'string', 'example' => 'schema is not found'], + 'QueryStartTime' => ['title' => '', 'description' => 'The execution start timestamp of the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1723521767000'], + 'ResourceGroupName' => ['title' => '', 'description' => 'The name of the resource group.'."\n", 'type' => 'string', 'example' => 'spark_rg'], + ], + 'example' => '', + ], + 'SparkBatchSQLStatement' => [ + 'title' => '', + 'description' => 'The information about SparkBatchSQLStatement.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResultUri' => ['title' => '', 'description' => 'The Object Storage Service (OSS) location where the execution results of the SQL statement are stored. If you do not specify a storage location, null is returned.'."\n", 'type' => 'string', 'example' => 'oss://yourbucket/result.json'], + 'EndTime' => ['title' => '', 'description' => 'The execution end timestamp of the SQL statement.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1723521767000'], + 'AppId' => ['title' => '', 'description' => 'The ID of the Spark job that executes the SQL statement.'."\n", 'type' => 'string', 'example' => 's20240122jsdx****'], + 'StatementId' => ['title' => '', 'description' => 'The ID of the SQL statement.'."\n", 'type' => 'string', 'example' => 'sq1723521767****-0001'], + 'State' => [ 'title' => '', 'description' => 'The execution status of the SQL statement. Valid values:'."\n" ."\n" @@ -1916,881 +633,313 @@ .'* CANCELED'."\n" .'* PENDING'."\n" .'* FINISHED'."\n", - 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'RUNNING', - 'backendName' => 'state', - ], - 'StartTime' => [ - 'title' => '', - 'description' => 'The execution start timestamp of the SQL statement.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1723521767000', - 'backendName' => 'startTime', - ], - 'Error' => [ - 'title' => '', - 'description' => 'The error message for the SQL statement execution.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'table is not found', - 'backendName' => 'error', - ], - 'Code' => [ - 'title' => '', - 'description' => 'The text of the SQL statement.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SELECT 100', - 'backendName' => 'code', - ], - 'Result' => [ - 'title' => '', - 'description' => 'The execution result of the SQL statement. The content is in the response format of the `DataFrame Show` statement in Spark.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '+---+-----+'."\n" - .'|age| name|'."\n" - .'+---+-----+'."\n" - .'| 14| Tom|'."\n" - .'| 23|Alice|'."\n" - .'+---+-----+', - 'backendName' => 'result', ], + 'StartTime' => ['title' => '', 'description' => 'The execution start timestamp of the SQL statement.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1723521767000'], + 'Error' => ['title' => '', 'description' => 'The error message for the SQL statement execution.'."\n", 'type' => 'string', 'example' => 'table is not found'], + 'Code' => ['title' => '', 'description' => 'The text of the SQL statement.'."\n", 'type' => 'string', 'example' => 'SELECT 100'], + 'Result' => ['title' => '', 'description' => 'The execution result of the SQL statement. The content is in the response format of the `DataFrame Show` statement in Spark.'."\n", 'type' => 'string', 'example' => '+---+-----+'."\n" + .'|age| name|'."\n" + .'+---+-----+'."\n" + .'| 14| Tom|'."\n" + .'| 23|Alice|'."\n" + .'+---+-----+'], + ], + 'example' => '', + ], + 'SparkOperatorInfo' => [ + 'title' => '', + 'description' => 'The Spark operator information.', + 'type' => 'object', + 'properties' => [ + 'OperatorName' => ['title' => '', 'type' => 'string', 'format' => 'byte', 'description' => '', 'example' => ''], + 'MetricValue' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], ], + 'example' => '', ], 'StorageDescriptorModel' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The queried storage description.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'SdId' => [ - 'title' => 'sdId', - 'description' => 'The ID of the storage description.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'sdId', - ], - 'Location' => [ - 'title' => 'location', - 'description' => 'The location of the storage description.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'oss://**************', - 'backendName' => 'location', - ], - 'InputFormat' => [ - 'title' => 'inputFormat', - 'description' => 'The input format of the storage description.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat', - 'backendName' => 'inputFormat', - ], - 'OutputFormat' => [ - 'title' => 'outputFormat', - 'description' => 'The output format of the storage description.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat', - 'backendName' => 'outputFormat', - ], - 'Compressed' => [ - 'title' => 'compressed', - 'description' => 'Indicates whether the storage description is compressed.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'compressed', - ], - 'NumBuckets' => [ - 'title' => 'numBuckets', - 'description' => 'The number of buckets.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'numBuckets', - ], - 'SerDeInfo' => [ - 'description' => 'The information about serialization or deserialization.'."\n", - 'visibility' => 'public', - 'backendName' => 'serDeInfo', - '$ref' => '#/components/schemas/SerDeInfoModel', - ], + 'SdId' => ['title' => '', 'description' => 'The ID of the storage description.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Location' => ['title' => '', 'description' => 'The location of the storage description.'."\n", 'type' => 'string', 'example' => 'oss://**************'], + 'InputFormat' => ['title' => '', 'description' => 'The input format of the storage description.'."\n", 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat'], + 'OutputFormat' => ['title' => '', 'description' => 'The output format of the storage description.'."\n", 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat'], + 'Compressed' => ['title' => '', 'description' => 'Indicates whether the storage description is compressed.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'NumBuckets' => ['title' => '', 'description' => 'The number of buckets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SerDeInfo' => ['description' => 'The information about serialization or deserialization.'."\n", '$ref' => '#/components/schemas/SerDeInfoModel', 'title' => '', 'example' => ''], 'Parameters' => [ - 'title' => 'parameters', + 'title' => '', 'description' => 'The storage configuration parameter.'."\n", - 'visibility' => 'public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The value of the parameter.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'key:value', - ], - 'backendName' => 'parameters', - ], - 'StoredAsSubDirectories' => [ - 'title' => 'storedAsSubDirectories', - 'description' => 'Indicates whether the storage description is stored in subdirectories.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'storedAsSubDirectories', + 'additionalProperties' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => 'key:value', 'title' => ''], + 'example' => '', ], + 'StoredAsSubDirectories' => ['title' => '', 'description' => 'Indicates whether the storage description is stored in subdirectories.'."\n", 'type' => 'boolean', 'example' => 'false'], ], + 'example' => '', ], 'TableDetailModel' => [ 'title' => '', - 'description' => 'The queried table.'."\n", - 'visibility' => 'public', + 'description' => 'Table details.', 'type' => 'object', 'properties' => [ - 'SchemaName' => [ - 'title' => '', - 'description' => 'The logical name of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'schemaName', - 'backendName' => 'schemaName', - ], - 'TableName' => [ - 'title' => '', - 'description' => 'The logical name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tableName', - 'backendName' => 'tableName', - ], - 'TableType' => [ - 'title' => '', - 'description' => 'The type of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'PHYSICAL_SCHEMA_NAME', - 'backendName' => 'tableType', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the table was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'createTime', - ], - 'UpdateTime' => [ - 'title' => '', - 'description' => 'The time when the table was updated.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'updateTime', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Description', - 'backendName' => 'description', - ], - 'Owner' => [ - 'title' => '', - 'description' => 'The owner of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'abc', - 'backendName' => 'owner', - ], + 'SchemaName' => ['title' => '', 'description' => 'Logical database name.', 'type' => 'string', 'example' => 'schemaName'], + 'TableName' => ['title' => '', 'description' => 'Logical table name.', 'type' => 'string', 'example' => 'tableName'], + 'TableType' => ['title' => '', 'description' => 'Table type.', 'type' => 'string', 'example' => 'PHYSICAL_SCHEMA_NAME'], + 'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'UpdateTime' => ['title' => '', 'description' => 'Update time.', 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'Description' => ['title' => '', 'description' => 'Description.', 'type' => 'string', 'example' => 'Description'], + 'Owner' => ['title' => '', 'description' => 'Owner.', 'type' => 'string', 'example' => 'abc'], 'Columns' => [ 'title' => '', - 'description' => 'The columns in the table.'."\n", - 'visibility' => 'public', + 'description' => 'Column information.', 'type' => 'array', - 'items' => [ - 'description' => 'The column in the table.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ColDetailModel', - ], - 'backendName' => 'columns', + 'items' => ['description' => 'Detailed column information.', '$ref' => '#/components/schemas/ColDetailModel', 'title' => '', 'example' => ''], + 'example' => '', ], - 'Catalog' => [ + 'Catalog' => ['title' => '', 'description' => 'External data source.', 'type' => 'string', 'example' => 'oss'], + 'CreatedBySource' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CreatedByUser' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Location' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Parameters' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', 'title' => '', - 'description' => 'The external data source.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'oss', - 'backendName' => 'catalog', + 'example' => '', ], ], + 'example' => '', ], 'TableModel' => [ - 'title' => 'A short description of struct', - 'description' => 'The queried table.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The table metadata.', 'type' => 'object', 'properties' => [ - 'TblId' => [ - 'title' => 'tblId', - 'description' => 'The table ID.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - 'backendName' => 'tblId', - ], - 'DbName' => [ - 'title' => 'dbName', - 'description' => 'The logical name of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'example', - 'backendName' => 'dbName', - ], - 'TableName' => [ - 'title' => 'tblName', - 'description' => 'The logical name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tableName', - 'backendName' => 'tableName', - ], - 'TableType' => [ - 'title' => 'tblType', - 'description' => 'The type of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'external_table', - 'backendName' => 'tableType', - ], + 'TblId' => ['title' => '', 'description' => 'The table ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'DbName' => ['title' => '', 'description' => 'The name of the logical database.', 'type' => 'string', 'example' => 'example'], + 'TableName' => ['title' => '', 'description' => 'The name of the logical table.', 'type' => 'string', 'example' => 'tableName'], + 'TableType' => ['title' => '', 'description' => 'The table type.', 'type' => 'string', 'example' => 'external_table'], 'PartitionKeys' => [ - 'title' => 'partitionKeys', - 'description' => 'The partition key.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The partition keys.', 'type' => 'array', - 'items' => [ - 'description' => 'The partition column.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FieldSchemaModel', - ], - 'backendName' => 'partitionKeys', + 'items' => ['description' => 'The information about the partition key columns.', '$ref' => '#/components/schemas/FieldSchemaModel', 'title' => '', 'example' => ''], + 'example' => '', ], 'Parameters' => [ - 'title' => 'parameters', - 'description' => 'The parameter.'."\n", - 'visibility' => 'public', - 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The value of the parameter.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'key:value', - ], - 'backendName' => 'parameters', - ], - 'Sd' => [ - 'title' => 'sd', - 'description' => 'The storage description.'."\n", - 'visibility' => 'public', - 'backendName' => 'sd', - '$ref' => '#/components/schemas/StorageDescriptorModel', - ], - 'CreateTime' => [ - 'title' => 'createTime', - 'description' => 'The time when the table was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'createTime', - ], - 'ViewOriginalText' => [ - 'title' => 'viewOriginalText', - 'description' => 'The SQL statement that is used to create the table or view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ViewOriginalText', - 'backendName' => 'viewOriginalText', - ], - 'ViewExpandedText' => [ - 'title' => 'viewExpandedText', - 'description' => 'The standardized SQL statement that is used to create the table or view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ViewExpandedText', - 'backendName' => 'viewExpandedText', - ], - 'Temporary' => [ - 'title' => 'temporary', - 'description' => 'Indicates whether the table is a temporary table.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'temporary', - ], - 'Comment' => [ - 'title' => 'comment', - 'description' => 'The description of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'description', - 'backendName' => 'comment', + 'title' => '', + 'description' => 'The parameters.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of the parameter.', 'type' => 'string', 'example' => 'key:value', 'title' => ''], + 'example' => '', ], + 'Sd' => ['title' => '', 'description' => 'The description of the storage.', '$ref' => '#/components/schemas/StorageDescriptorModel', 'example' => ''], + 'CreateTime' => ['title' => '', 'description' => 'The time when the table was created.', 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'ViewOriginalText' => ['title' => '', 'description' => 'The SQL statement used to create the view.', 'type' => 'string', 'example' => 'ViewOriginalText'], + 'ViewExpandedText' => ['title' => '', 'description' => 'The normalized SQL statement that is used to create the view.', 'type' => 'string', 'example' => 'ViewExpandedText'], + 'Temporary' => ['title' => '', 'description' => 'Indicates whether the table is a temporary table.', 'type' => 'boolean', 'example' => 'false'], + 'Comment' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'description'], 'Cols' => [ - 'title' => 'cols', - 'description' => 'The columns in the table.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The column information.', 'type' => 'array', - 'items' => [ - 'description' => 'The column in the table.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FieldSchemaModel', - ], - 'backendName' => 'cols', + 'items' => ['description' => 'The detailed information about the columns.', '$ref' => '#/components/schemas/FieldSchemaModel', 'title' => '', 'example' => ''], + 'example' => '', ], 'DistributeColumns' => [ - 'title' => 'distributeColumns', - 'description' => 'The distribution columns.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The distribution columns.', 'type' => 'array', - 'items' => [ - 'description' => 'The distribution column.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FieldSchemaModel', - ], - 'backendName' => 'distributeColumns', - ], - 'PhysicalTableName' => [ - 'title' => 'physicalTableName', - 'description' => 'The physical name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'physicalTableName', - 'backendName' => 'physicalTableName', - ], - 'PhysicalDatabaseName' => [ - 'title' => 'physicalDatabaseName', - 'description' => 'The physical name of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'physicalDatabaseName', - 'backendName' => 'physicalDatabaseName', - ], - 'DistributeType' => [ - 'title' => 'distributeType', - 'description' => 'The distribution type.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'DistributeType', - 'backendName' => 'distributeType', - ], - 'PartitionType' => [ - 'title' => 'partitionType', - 'description' => 'The partition type.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'PartitionType', - 'backendName' => 'partitionType', - ], - 'PartitionColumn' => [ - 'title' => 'partitionColumn', - 'description' => 'The partition column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'colName', - 'backendName' => 'partitionColumn', - ], - 'PartitionCount' => [ - 'title' => 'partitionCount', - 'description' => 'The number of partitions.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - 'backendName' => 'partitionCount', - ], - 'PreviousVersion' => [ - 'title' => 'previousVersion', - 'description' => 'The previous version.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'previousVersion', - ], - 'CurrentVersion' => [ - 'title' => 'currentVersion', - 'description' => 'The current version.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'backendName' => 'currentVersion', - ], - 'UpdateTime' => [ - 'title' => 'updateTime', - 'description' => 'The time when the table was updated.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'updateTime', - ], - 'TableEngineName' => [ - 'title' => 'tableEngineName', - 'description' => 'The engine name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'hive', - 'backendName' => 'tableEngineName', - ], - 'IsAllIndex' => [ - 'title' => 'isAllIndex', - 'description' => 'Indicates whether the table is fully indexed.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'isAllIndex', - ], - 'BlockSize' => [ - 'title' => 'blockSize', - 'description' => 'The block size.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '64', - 'backendName' => 'blockSize', - ], - 'Compression' => [ - 'title' => 'compression', - 'description' => 'The compression method.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Compression', - 'backendName' => 'compression', - ], - 'RawTableName' => [ - 'title' => 'rawTableName', - 'description' => 'The original name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'RawTableName', - 'backendName' => 'rawTableName', - ], - 'SubpartitionType' => [ - 'title' => 'subpartitionType', - 'description' => 'The subpartition type.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'SubpartitionColumn', - 'backendName' => 'subpartitionType', - ], - 'SubpartitionColumn' => [ - 'title' => 'subpartitionColumn', - 'description' => 'The subpartition column.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'SubpartitionColumn', - 'backendName' => 'subpartitionColumn', - ], - 'SubpartitionCount' => [ - 'title' => 'subpartitionCount', - 'description' => 'The number of subpartitions.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '64', - 'backendName' => 'subpartitionCount', - ], - 'ArchiveType' => [ - 'title' => 'archiveType', - 'description' => 'The archive type.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ArchiveType', - 'backendName' => 'archiveType', - ], - 'MaxColumnId' => [ - 'title' => 'maxColumnId', - 'description' => 'The maximum column ID.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'MaxColumnId', - 'backendName' => 'maxColumnId', - ], - 'EnableDfs' => [ - 'title' => 'enableDfs', - 'description' => 'Indicates whether a distributed file system (DFS) is allowed.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enableDfs', - ], - 'StoragePolicy' => [ - 'title' => 'storagePolicy', - 'description' => 'The storage policy.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'StoragePolicy', - 'backendName' => 'storagePolicy', - ], - 'HotPartitionCount' => [ - 'title' => 'hotPartitionCount', - 'description' => 'The number of hot partitions.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - 'backendName' => 'hotPartitionCount', - ], - 'IsFulltextDict' => [ - 'title' => 'isFulltextDict', - 'description' => 'Indicates whether a full-text index dictionary is used.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'isFulltextDict', - ], - 'RtIndexAll' => [ - 'title' => 'rtIndexAll', - 'description' => 'Indicates whether all indexes are routed.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'rtIndexAll', + 'items' => ['description' => 'The information about the distribution columns.', '$ref' => '#/components/schemas/FieldSchemaModel', 'title' => '', 'example' => ''], + 'example' => '', ], + 'PhysicalTableName' => ['title' => '', 'description' => 'The name of the physical table.', 'type' => 'string', 'example' => 'physicalTableName'], + 'PhysicalDatabaseName' => ['title' => '', 'description' => 'The name of the physical database.', 'type' => 'string', 'example' => 'physicalDatabaseName'], + 'DistributeType' => ['title' => '', 'description' => 'The distribution type.', 'type' => 'string', 'example' => 'DistributeType'], + 'PartitionType' => ['title' => '', 'description' => 'The partition type.', 'type' => 'string', 'example' => 'PartitionType'], + 'PartitionColumn' => ['title' => '', 'description' => 'The information about the partition key column.', 'type' => 'string', 'example' => 'colName'], + 'PartitionCount' => ['title' => '', 'description' => 'The number of partitions.', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'PreviousVersion' => ['title' => '', 'description' => 'The previous version.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CurrentVersion' => ['title' => '', 'description' => 'The current version.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the table was last updated.', 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'TableEngineName' => ['title' => '', 'description' => 'The name of the table engine.', 'type' => 'string', 'example' => 'hive'], + 'IsAllIndex' => ['title' => '', 'description' => 'Indicates whether the index is a full index.', 'type' => 'boolean', 'example' => 'true'], + 'BlockSize' => ['title' => '', 'description' => 'The block size.', 'type' => 'integer', 'format' => 'int64', 'example' => '64'], + 'Compression' => ['title' => '', 'description' => 'The compression method.', 'type' => 'string', 'example' => 'Compression'], + 'RawTableName' => ['title' => '', 'description' => 'The raw table name.', 'type' => 'string', 'example' => 'RawTableName'], + 'SubpartitionType' => ['title' => '', 'description' => 'The subpartition type.', 'type' => 'string', 'example' => 'SubpartitionColumn'], + 'SubpartitionColumn' => ['title' => '', 'description' => 'The information about the subpartition column.', 'type' => 'string', 'example' => 'SubpartitionColumn'], + 'SubpartitionCount' => ['title' => '', 'description' => 'The number of subpartitions.', 'type' => 'integer', 'format' => 'int64', 'example' => '64'], + 'ArchiveType' => ['title' => '', 'description' => 'The archive type.', 'type' => 'string', 'example' => 'ArchiveType'], + 'MaxColumnId' => ['title' => '', 'description' => 'The maximum column ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'MaxColumnId'], + 'EnableDfs' => ['title' => '', 'description' => 'Indicates whether DFS is allowed.', 'type' => 'boolean', 'example' => 'false'], + 'StoragePolicy' => ['title' => '', 'description' => 'The storage policy.', 'type' => 'string', 'example' => 'StoragePolicy'], + 'HotPartitionCount' => ['title' => '', 'description' => 'The number of hot partitions.', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], + 'IsFulltextDict' => ['title' => '', 'description' => 'Indicates whether the table is a full-text index dictionary.', 'type' => 'boolean', 'example' => 'false'], + 'RtIndexAll' => ['title' => '', 'description' => 'Indicates whether to route all indexes.', 'type' => 'boolean', 'example' => 'false'], 'RouteColumns' => [ - 'title' => 'routeColumns', - 'description' => 'The route columns.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The routing columns.', 'type' => 'array', - 'items' => [ - 'description' => 'The route column.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FieldSchemaModel', - ], - 'backendName' => 'routeColumns', - ], - 'RouteEffectiveColumn' => [ - 'title' => 'routeEffectiveColumn', - 'description' => 'The effective route column.'."\n", - 'visibility' => 'public', - 'backendName' => 'routeEffectiveColumn', - '$ref' => '#/components/schemas/FieldSchemaModel', - ], - 'RtEngineType' => [ - 'title' => 'rtEngineType', - 'description' => 'The route engine type.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'RtEngineType', - 'backendName' => 'rtEngineType', - ], - 'RtModeType' => [ - 'title' => 'rtModeType', - 'description' => 'The route mode type.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'RtModeType', - 'backendName' => 'rtModeType', - ], - 'RouteType' => [ - 'title' => 'routeType', - 'description' => 'The route type.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'routeType', - 'backendName' => 'routeType', - ], - 'DictEncode' => [ - 'title' => 'dictEncode', - 'description' => 'Indicates whether data is encrypted.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'dictEncode', - ], - 'BucketCount' => [ - 'title' => 'bucketCount', - 'description' => 'The number of buckets.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - 'backendName' => 'bucketCount', - ], - 'Bucket' => [ - 'title' => 'bucket', - 'description' => 'The bucket ID.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - 'backendName' => 'bucket', - ], - 'ViewSecurityMode' => [ - 'title' => 'viewSecurityMode', - 'description' => 'The security mode of the table or view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ViewSecurityMode', - 'backendName' => 'viewSecurityMode', + 'items' => ['description' => 'The information about the routing columns.', '$ref' => '#/components/schemas/FieldSchemaModel', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RouteEffectiveColumn' => ['title' => '', 'description' => 'The effective routing column.', '$ref' => '#/components/schemas/FieldSchemaModel', 'example' => ''], + 'RtEngineType' => ['title' => '', 'description' => 'The routing engine type.', 'type' => 'string', 'example' => 'RtEngineType'], + 'RtModeType' => ['title' => '', 'description' => 'The routing mode type.', 'type' => 'string', 'example' => 'RtModeType'], + 'RouteType' => ['title' => '', 'description' => 'The routing type.', 'type' => 'string', 'example' => 'routeType'], + 'DictEncode' => ['title' => '', 'description' => 'Indicates whether the dictionary is encrypted.', 'type' => 'boolean', 'example' => 'false'], + 'BucketCount' => ['title' => '', 'description' => 'The number of buckets.', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'Bucket' => ['title' => '', 'description' => 'The bucket ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'ViewSecurityMode' => ['title' => '', 'description' => 'The security mode of the view.', 'type' => 'string', 'example' => 'ViewSecurityMode'], 'Indexes' => [ - 'title' => 'indexes', - 'description' => 'The index.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The indexes.', 'type' => 'array', - 'items' => [ - 'description' => 'The index column.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/CstoreIndexModel', - ], - 'backendName' => 'indexes', + 'items' => ['description' => 'The information about the index columns.', '$ref' => '#/components/schemas/CstoreIndexModel', 'title' => '', 'example' => ''], + 'example' => '', ], + 'CreatedBySource' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CreatedByUser' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], 'TableSummaryModel' => [ 'title' => '', - 'description' => 'The summary of the table or view.'."\n", - 'visibility' => 'public', + 'description' => 'Summary data for the table or view.', 'type' => 'object', 'properties' => [ - 'SchemaName' => [ - 'title' => '', - 'description' => 'The logical name of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'schemaName', - 'backendName' => 'schemaName', - ], - 'TableName' => [ - 'title' => '', - 'description' => 'The logical name of the table or view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tableName', - 'backendName' => 'tableName', - ], - 'TableType' => [ - 'title' => '', - 'description' => 'The type of the table or view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'PHYSICAL_SCHEMA_NAME', - 'backendName' => 'tableType', - ], - 'TableSize' => [ - 'title' => '', - 'description' => 'The table size. Unit: bytes.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - 'backendName' => 'tableSize', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the table was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'createTime', - ], - 'UpdateTime' => [ - 'title' => '', - 'description' => 'The time when the table was updated.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-01-05 13:17:55', - 'backendName' => 'updateTime', - ], - 'SQL' => [ - 'title' => 'view SQL', - 'description' => 'The SQL statement that is used to create the table or view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'create table(a varchar)', - 'backendName' => 'SQL', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'descrtiption', - 'backendName' => 'description', - ], - 'Owner' => [ - 'title' => '', - 'description' => 'The owner of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'abc', - 'backendName' => 'owner', - ], - ], + 'SchemaName' => ['title' => '', 'description' => 'Logical database name.', 'type' => 'string', 'example' => 'schemaName'], + 'TableName' => ['title' => '', 'description' => 'Logical table name or logical view name.', 'type' => 'string', 'example' => 'tableName'], + 'TableType' => ['title' => '', 'description' => 'Table or view type.', 'type' => 'string', 'example' => 'PHYSICAL_SCHEMA_NAME'], + 'TableSize' => ['title' => '', 'description' => 'Table size in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'UpdateTime' => ['title' => '', 'description' => 'Update time.', 'type' => 'string', 'example' => '2023-01-05 13:17:55'], + 'SQL' => ['title' => '', 'description' => 'SQL for creating the table or view.', 'type' => 'string', 'example' => 'create table(a varchar)'], + 'Description' => ['title' => '', 'description' => 'Description.', 'type' => 'string', 'example' => 'descrtiption'], + 'Owner' => ['title' => '', 'description' => 'Owner.', 'type' => 'string', 'example' => 'abc'], + 'MvDetailModel' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/open_struct_MvDetailModel'], + 'CreatedBySource' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CreatedByUser' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], ], 'apis' => [ - 'DescribeRegions' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AllocateClusterPublicConnection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '154593', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131191', + 'abilityTreeNodes' => ['FEATUREads4DZDZG'], ], 'parameters' => [ [ - 'name' => 'AcceptLanguage', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The language that is used for the region and zone names indicated by the LocalName parameter in the response parameters. Valid values:'."\n" - ."\n" - .'* **zh-CN** (default): simplified Chinese.'."\n" - .'* **en-US**: English.'."\n" - .'* **ja**: Japanese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'en-US', - ], + 'schema' => ['description' => 'The cluster ID of an Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The cluster ID of a Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1z5d2q71is2****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => ['description' => 'The prefix of the public connection address.'."\n" + ."\n" + .'- It must begin with a lowercase letter and can contain only lowercase letters, digits, and hyphens (-).'."\n" + ."\n" + .'- It must be no more than 30 characters long.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test12', 'title' => ''], + ], + [ + 'name' => 'Engine', 'in' => 'query', 'schema' => [ + 'description' => 'The database engine. Valid values:'."\n" + ."\n" + .'- **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" + ."\n" + .'- **Clickhouse**: the wide table engine.', + 'enumValueTitles' => ['AnalyticDB' => 'AnalyticDB', 'Clickhouse' => 'Clickhouse'], 'type' => 'string', 'required' => false, + 'example' => 'Clickhouse', + 'title' => '', ], ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', - ], - 'Regions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Region' => [ - 'description' => 'The queried regions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RegionEndpoint' => [ - 'description' => 'The endpoint of the region.'."\n", - 'type' => 'string', - 'example' => 'adb.aliyuncs.com', - ], - 'LocalName' => [ - 'description' => 'The name of the region.'."\n", - 'type' => 'string', - 'example' => 'China (Hangzhou)', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Zones' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Zone' => [ - 'description' => 'The queried zones.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'VpcEnabled' => [ - 'description' => 'Indicates whether Virtual Private Cloud (VPC) is supported in the zone. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'LocalName' => [ - 'description' => 'The name of the zone.'."\n", - 'type' => 'string', - 'example' => 'Hangzhou Zone H', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '868EF07F-D0B2-5043-B092-0C14CD00B65A', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidConnectionStringPrefix.Malformed', 'errorMessage' => 'The specified connection string is invalid.', 'description' => 'The specified connection string is invalid.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ], ], - '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' => 'DescribeRegions', - 'summary' => 'Queries a list of regions and zones in which AnalyticDB for MySQL Data Lakehouse Edition (V3.0) is available.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeDBClusters' => [ - 'summary' => 'Queries the information about AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.', - 'methods' => [ - 'post', - 'get', + 'title' => 'AllocateClusterPublicConnection', + 'summary' => 'Allocates a public connection address for a cluster.', + 'description' => 'For a list of service endpoints, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-06-13T13:53:52.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2023-03-31T07:03:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:57.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocateClusterPublicConnection'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:AllocateClusterPublicConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868EF07F-D0B2-5043-B092-0C14CD00B65A\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ApplyAdviceById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2799,1096 +948,781 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '130697', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'abilityTreeCode' => '193679', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-uf6g8w25jacm7****', 'title' => ''], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBClusterIds', + 'name' => 'AdviceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'If you do not specify this parameter, the information about all clusters that reside in the region is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp1r053byu48p****', - ], + 'schema' => ['title' => '', 'description' => 'The suggestion ID.', 'type' => 'string', 'required' => false, 'example' => '0baf1f52-53df-487f-8292-99a03716****'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'AdviceDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the cluster.'."\n" - ."\n" - .'* The description cannot start with `http://` or `https://`.'."\n" - .'* The description must be 2 to 256 characters in length'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'The date when the suggestion was generated. Format: yyyyMMdd.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20221101'], ], [ - 'name' => 'DBClusterStatus', + 'name' => 'ApplyType', 'in' => 'query', 'schema' => [ - 'description' => 'The status of the cluster. Valid values:'."\n" - ."\n" - .'* **Preparing**'."\n" - .'* **Creating**'."\n" - .'* **Running**'."\n" - .'* **Deleting**'."\n" - .'* **Restoring**'."\n" - .'* **ClassChanging**'."\n" - .'* **NetAddressCreating**'."\n" - .'* **NetAddressDeleting**'."\n" - .'* **NetAddressModifying**'."\n", + 'description' => 'The adoption type.', + 'enumValueTitles' => ['DROP_INDEX' => 'DROP_INDEX', 'DISABLE_INDEX' => 'DISABLE_INDEX', 'ADD_INDEX' => 'ADD_INDEX'], 'type' => 'string', 'required' => false, - 'example' => 'Running', + 'example' => 'DROP_INDEX', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'BuildImmediately', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Specifies whether to immediately start the build task.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', 'required' => false, - 'example' => '30', - 'default' => '30', + 'example' => 'true', + 'title' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5DC10091-348D-12B1-906D-AB49D658012E'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Apply a single optimization suggestion', + 'summary' => 'Applies a single optimization suggestion.', + 'description' => 'For the endpoints of this service, refer to [Endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-07-09T06:38:11.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyAdviceById'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID. If you do not specify this parameter, the information about all resource groups in the cluster is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-4690g37929****', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ApplyAdviceById', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5DC10091-348D-12B1-906D-AB49D658012E\\"\\n}","type":"json"}]', + ], + 'AttachUserENI' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsPOF80W'], + ], + 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'DBClusterId', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-bp11q28kvl688****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The tags that are added to the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag that is added to the cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - ], - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + 'title' => 'AttachUserENI', + 'summary' => 'Attaches an elastic network interface (ENI) to an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachUserENI'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:AttachUserENI', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - 'required' => false, - 'maxItems' => 21, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + ], + 'BatchApplyAdviceByIdList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProductVersion', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193683', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-uf6g8w25jacm7****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'AdviceIdList', + 'in' => 'query', + 'schema' => ['description' => 'The list of suggestion IDs to apply in batches. Separate multiple suggestion IDs with commas (,).', '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****', 'title' => ''], + ], + [ + 'name' => 'AdviceDate', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The date when the suggestions were generated. Format: yyyyMMdd.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20221115'], + ], + [ + 'name' => 'ApplyType', 'in' => 'query', 'schema' => [ - 'description' => 'The edition of the cluster. Valid values:'."\n" - ."\n" - .'* **EnterpriseVersion**: Enterprise Edition.'."\n" - .'* **BasicVersion**: Basic Edition.'."\n" - ."\n" - .'> If you leave this parameter empty, the information about clusters of all editions is returned.'."\n", + 'description' => 'The adoption type.', + 'enumValueTitles' => ['DROP_INDEX' => 'DROP_INDEX', 'DISABLE_INDEX' => 'DISABLE_INDEX', 'ADD_INDEX' => 'ADD_INDEX'], 'type' => 'string', 'required' => false, - 'example' => 'BasicVersion', - 'enum' => [ - 'EnterpriseVersion', - 'BasicVersion', - ], + 'example' => 'DROP_INDEX', + 'title' => '', ], ], [ - 'name' => 'DBClusterVersion', + 'name' => 'BuildImmediately', 'in' => 'query', 'schema' => [ - 'description' => 'The version number corresponding to the edition of the cluster. Valid values:'."\n" - ."\n" - .'* **3.0**: Data Warehouse Edition.'."\n" - .'* **5.0** (default): includes Data Lakehouse Edition, Enterprise Edition, and Basic Edition.'."\n" - .'* **All**: all editions, including Data Warehouse Edition, Data Lakehouse Edition, Enterprise Edition, and Basic Edition.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to immediately start a build task.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', 'required' => false, - 'example' => '5.0', - 'default' => '5.0', - 'enum' => [ - 'All', - '3.0', - '5.0', - ], + 'example' => 'true', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5EDBA27-AF3E-5966-9503-FD1557E19167', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBCluster' => [ - 'description' => 'The queried clusters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expired' => [ - 'description' => 'Indicates whether the subscription cluster has expired. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the cluster has expired, the system locks or releases the cluster within a period of time. We recommend that you renew the expired cluster. For more information, see [Renewal policy](~~135246~~).'."\n" - ."\n" - .'* This parameter is not returned for pay-as-you-go clusters.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => 'The time when the cluster was created. The time follows the ISO 8601 standard in the *yyyy-mm-ddThh:mm:ssZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-04-01T09:50:18Z', - ], - 'PayType' => [ - 'description' => 'The billing method of the cluster. Valid values:'."\n" - ."\n" - .'* **Postpaid**: pay-as-you-go.'."\n" - .'* **Prepaid**: subscription.'."\n", - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'Mode' => [ - 'description' => 'The mode of the cluster. By default, **flexible** is returned, which indicates that the cluster is in elastic mode.'."\n", - 'type' => 'string', - 'example' => 'flexible', - ], - 'Port' => [ - 'description' => 'The port number that is used to connect to the cluster.'."\n", - 'type' => 'string', - 'example' => '3306', - ], - 'LockMode' => [ - 'description' => 'The lock status of the cluster. Valid values:'."\n" - ."\n" - .'* **Unlock**: The cluster is not locked.'."\n" - .'* **ManualLock**: The cluster is manually locked.'."\n" - .'* **LockByExpiration**: The cluster is automatically locked due to cluster expiration.'."\n", - 'type' => 'string', - 'example' => 'Unlock', - ], - 'StorageResource' => [ - 'description' => 'The specifications of reserved storage resources. Each AnalyticDB compute unit (ACU) is approximately equal to 1 core and 4 GB memory. Storage resources are used to read and write data. The increase in the storage resources can improve the read and write performance of the cluster.'."\n", - 'type' => 'string', - 'example' => '24ACU', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp163885f8q21****', - ], - 'ConnectionString' => [ - 'description' => 'The public endpoint that is used to connect to the cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp163885f8q21****.ads.aliyuncs.com', - ], - 'DBClusterType' => [ - 'description' => 'The type of the cluster. By default, **Common** is returned, which indicates a common cluster.'."\n", - 'type' => 'string', - 'example' => 'Common', - ], - 'CommodityCode' => [ - 'description' => 'The billing method of the cluster. Valid values:'."\n" - ."\n" - .'* **ads**: pay-as-you-go.'."\n" - .'* **ads_pre**: subscription.'."\n", - 'type' => 'string', - 'example' => 'ads_pre', - ], - 'ExpireTime' => [ - 'description' => 'The time when the cluster expires. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the billing method of the cluster is subscription, the actual expiration time is returned.'."\n" - ."\n" - .'* If the billing method of the cluster is pay-as-you-go, null is returned.'."\n", - 'type' => 'string', - 'example' => '2022-07-01T09:50:18Z', - ], - 'LockReason' => [ - 'description' => 'The reason why the cluster is locked.'."\n" - ."\n" - .'> This parameter is returned only when the cluster was locked. **instance_expire** is returned.'."\n", - 'type' => 'string', - 'example' => 'instance_expire', - ], - 'VPCId' => [ - 'description' => 'The virtual private cloud (VPC) ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp13h7uzhulpuxvnp****', - ], - 'RegionId' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ComputeResource' => [ - 'description' => 'The specifications of reserved computing resources. Each ACU is approximately equal to 1 core and 4 GB memory. Computing resources are used to compute data. The increase in the computing resources can accelerate queries. You can scale computing resources based on your business requirements.'."\n", - 'type' => 'string', - 'example' => '16ACU', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1syh8vvw8yech7n****', - ], - 'DBVersion' => [ - 'description' => 'The version number corresponding to the edition of the cluster. Only **5.0** is supported.'."\n", - 'type' => 'string', - 'example' => '5.0', - ], - 'DBClusterStatus' => [ - 'description' => 'The status of the cluster. Valid values:'."\n" - ."\n" - .'* **Preparing**'."\n" - .'* **Creating**'."\n" - .'* **Running**'."\n" - .'* **Deleting**'."\n" - .'* **Restoring**'."\n" - .'* **ClassChanging**'."\n" - .'* **NetAddressCreating**'."\n" - .'* **NetAddressDeleting**'."\n" - .'* **NetAddressModifying**'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'ResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmyiu4ekp****', - ], - 'DBClusterNetworkType' => [ - 'description' => 'The network type of the cluster. Only **VPC** is supported.'."\n", - 'type' => 'string', - 'example' => 'VPC', - 'default' => 'VPC', - ], - 'DBClusterDescription' => [ - 'description' => 'The description of the cluster.'."\n", - 'type' => 'string', - 'example' => 'adb_test', - ], - 'ZoneId' => [ - 'description' => 'The zone ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'Engine' => [ - 'description' => 'The engine of the cluster. **AnalyticDB** is returned.'."\n", - 'type' => 'string', - 'example' => 'AnalyticDB', - ], - 'ReservedACU' => [ - 'description' => 'The remaining reserved computing resources that are available in the cluster. Each ACU is approximately equal to 1 core and 4 GB memory.'."\n", - 'type' => 'string', - 'example' => '32ACU', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => 'The tags that are added to the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag that is added to the cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'> You can call the [TagResources](~~179253~~) operation to add tags to a cluster.'."\n", - 'type' => 'string', - 'example' => 'tag1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - ], - ], - ], - ], - ], - 'Category' => [ - 'description' => 'The mode of the cluster. This parameter is returned only for Data Warehouse Edition clusters. Valid values:'."\n" - ."\n" - .'* **BASIC**: reserved mode for Basic Edition.'."\n" - .'* **CLUSTER**: reserved mode for Cluster Edition.'."\n" - .'* **MIXED_STORAGE**: elastic mode for Cluster Edition.'."\n" - ."\n" - .'> For more information about cluster editions, see [Editions](~~205001~~).'."\n", - 'type' => 'string', - 'example' => 'MIXED_STORAGE', - ], - 'InnerPort' => [ - 'description' => 'The internal port of the cluster.'."\n", - 'type' => 'string', - 'example' => '3306', - ], - 'VPCCloudInstanceId' => [ - 'description' => 'The VPC endpoint.'."\n", - 'type' => 'string', - 'example' => 'am-bp163885f8q21****-controller', - ], - 'InnerIp' => [ - 'description' => 'The internal IP address of the cluster.'."\n", - 'type' => 'string', - 'example' => '10.1.xx.xx', - ], - 'DtsJobId' => [ - 'description' => 'The ID of the Data Transmission Service (DTS) synchronization job This parameter is returned only for MySQL analytic instances.'."\n", - 'type' => 'string', - 'example' => 'dtsb1578j90XXXX', - ], - 'ElasticIOResource' => [ - 'description' => 'The number of elastic I/O units (EIUs). For more information, see the "[EIUs](~~189505~~)" section of the Scale out elastic I/O resources topic.'."\n" - ."\n" - .'> This parameter is returned only for clusters in elastic mode.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RdsInstanceId' => [ - 'description' => 'The ID of the ApsaraDB RDS instance from which data is synchronized to the cluster. This parameter is returned only for MySQL analytic instances.'."\n", - 'type' => 'string', - 'example' => 'rm-bp11q28kvl688****', - ], - 'ExecutorCount' => [ - 'description' => 'The number of compute nodes that are used by the cluster in elastic mode.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'DBNodeClass' => [ - 'description' => 'The node specifications of the cluster. This parameter is returned only for Data Warehouse Edition clusters.'."\n", - 'type' => 'string', - 'example' => 'E8', - ], - 'DiskType' => [ - 'description' => 'The disk type of the cluster. Valid values:'."\n" - ."\n" - .'* **local_ssd**: local disk.'."\n" - .'* **cloud**: basic disk.'."\n" - .'* **cloud_ssd**: standard SSD.'."\n" - .'* **cloud_efficiency**: ultra disk.'."\n" - .'* **cloud_essd**: PL1 Enterprise SSD (ESSD).'."\n" - .'* **cloud_essd2**: PL2 ESSD.'."\n" - .'* **cloud_essd3**: PL3 ESSD.'."\n" - ."\n" - .'> For more information about ESSDs, see [ESSDs](~~122389~~).'."\n", - 'type' => 'string', - 'example' => 'cloud_essd', - ], - 'DBNodeStorage' => [ - 'description' => 'The storage capacity of the cluster. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - ], - 'DBNodeCount' => [ - 'description' => 'The number of node groups.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TaskInfo' => [ - 'description' => 'The information about the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'analyticDBFlexibleScaleOut', - ], - 'Status' => [ - 'description' => 'The status of the job. Valid values:'."\n" - ."\n" - .'* **NOT_RUN**'."\n" - .'* **RUNNING**'."\n" - .'* **SUCCEED**'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - 'enum' => [ - 'RUNNING', - 'SUCCEED', - 'NOT_RUN', - ], - ], - 'Progress' => [ - 'description' => 'The progress of the job. Unit: %.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'StepList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'StepList' => [ - 'description' => 'The job steps.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The job step.'."\n", - 'type' => 'object', - 'properties' => [ - 'StepName' => [ - 'description' => 'The name of the job step.'."\n", - 'type' => 'string', - 'example' => 'ApplyResource', - ], - 'StepDesc' => [ - 'description' => 'The description of the job step.'."\n", - 'type' => 'string', - 'example' => 'Apply resource', - ], - 'StepStatus' => [ - 'description' => 'The status of the job step. Valid values:'."\n" - ."\n" - .'* **NOT_RUN**'."\n" - .'* **RUNNING**'."\n" - .'* **SUCCEED**'."\n", - 'type' => 'string', - 'example' => 'SUCCEED', - 'enum' => [ - 'RUNNING', - 'SUCCEED', - 'NOT_RUN', - ], - ], - 'StepProgress' => [ - 'description' => 'The progress of the job step. Unit: %.'."\n", - 'type' => 'string', - 'example' => '50', - ], - 'StartTime' => [ - 'description' => 'The start time of the job step. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-03-10T09:28:34Z', - ], - 'EndTime' => [ - 'description' => 'The end time of the job step. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-03-10T10:28:34Z', - ], - ], - ], - ], - ], - ], - ], - ], - 'ProductForm' => [ - 'description' => 'The service type of the cluster. Valid values:'."\n" - ."\n" - .'* **LegacyForm**'."\n" - .'* **IntegrationForm**'."\n", - 'type' => 'string', - 'example' => 'IntegrationForm', - 'enum' => [ - 'IntegrationForm', - 'LegacyForm', - ], - ], - 'ProductVersion' => [ - 'description' => 'The edition of the cluster. Valid values:'."\n" - ."\n" - .'* **BasicVersion**: Basic Edition.'."\n" - .'* **EnterpriseVersion**: Enterprise Edition.'."\n", - 'type' => 'string', - 'example' => 'EnterpriseVersion', - ], - 'ReservedNodeSize' => [ - 'description' => 'The single-node specifications of reserved resources.'."\n", - 'type' => 'string', - 'example' => '8ACU', - ], - 'ReservedNodeCount' => [ - 'description' => 'The number of reserved resource nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AINodeSpec' => [ - 'type' => 'string', - ], - 'AINodeNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '86F92D26-B774-5FA1-8E53-82CBEEEBB012'], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Apply optimization suggestions in batches', + 'summary' => 'Applies optimization suggestions in batches.', + 'description' => 'For the endpoint of this service, refer to [Service registration](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-07-09T06:38:11.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchApplyAdviceByIdList'], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:BatchApplyAdviceByIdList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DescribeDBClusters', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86F92D26-B774-5FA1-8E53-82CBEEEBB012\\"\\n}","type":"json"}]', ], - 'CreateDBCluster' => [ - 'summary' => 'Creates an AnalyticDB for MySQL Data Lakehouse Edition cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BindAccount' => [ + 'summary' => 'Bind a Resource Access Management (RAM) user to a standard database account in a cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '130062', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'ID of the cluster. Applies to Enterprise Edition, Basic Edition, or Data Lakehouse Edition clusters.', 'type' => 'string', 'required' => true, 'example' => 'amv-wz99d9nh532****', 'title' => ''], ], [ - 'name' => 'ZoneId', + 'name' => 'RamUser', 'in' => 'query', - 'schema' => [ - 'description' => 'The zone ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent zone list.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-h', - ], + 'schema' => ['description' => 'ID of the Alibaba Cloud RAM user to bind.', 'type' => 'string', 'required' => false, 'example' => '1444832459****', 'title' => ''], ], [ - 'name' => 'DBClusterVersion', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the cluster. Set the value to **5.0**.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5.0', - ], + 'schema' => ['description' => 'A standard database account.', 'type' => 'string', 'required' => true, 'example' => 'test_accout', 'title' => ''], ], [ - 'name' => 'DBClusterNetworkType', + 'name' => 'RamUserList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The network type of the cluster. Set the value to **VPC**.', - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'ID of the Alibaba Cloud RAM user to bind.', 'type' => 'string', 'required' => false, 'example' => '20732900249392****', 'title' => ''], + 'description' => 'List of Alibaba Cloud RAM user IDs to bind. You can bind only one RAM user at a time. If you specify this parameter, the RamUser parameter is ignored.', 'required' => false, - 'docRequired' => true, - 'example' => 'VPC', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'DBClusterDescription', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The description of the cluster.'."\n" - ."\n" - .'* The description cannot start with `http://` or `https://`.'."\n" - .'* The description must be 2 to 256 characters in length', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'title' => '', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'ID of the request.', 'type' => 'string', 'example' => 'DFF27323-3868-5F8A-917D-5D1D06B6BC0D'], + ], + 'example' => '', ], ], - [ - 'name' => 'PayType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of the cluster. Valid values:'."\n" - ."\n" - .'* **Postpaid**: pay-as-you-go.'."\n" - .'* **Prepaid**: subscription.', - 'type' => 'string', - 'required' => true, - 'example' => 'Prepaid', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The AccountName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.Account.NotExist', 'errorMessage' => 'The account is not found.', 'description' => 'The specified RAM user does not exist.'], + ['errorCode' => 'ACS.Account.UserHasBind', 'errorMessage' => 'The user has been associated with another database account %s.', 'description' => 'The RAM user is associated with another database account.'], + ['errorCode' => 'ACS.User.DatabaseAccountHasBind', 'errorMessage' => 'The database account has been bound to %s.', 'description' => 'The database account is associated with a RAM user.'], + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DFF27323-3868-5F8A-917D-5D1D06B6BC0D\\"\\n}","type":"json"}]', + 'title' => 'BindAccount', + 'description' => 'For the current service endpoint, see [service endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2023-06-07T16:00:26.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-04-20T14:39:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-31T07:03:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:57.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindAccount'], ], + ], + 'ramActions' => [ [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription type of the subscription cluster. Valid values:'."\n" - ."\n" - .'* **Year**: subscription on a yearly basis.'."\n" - .'* **Month**: subscription on a monthly basis.'."\n" - ."\n" - .'> This parameter must be specified when PayType is set to Prepaid.', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:BindAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'AccountLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'BindDBResourceGroupWithUser' => [ + 'summary' => 'Associates a resource group with a database account.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'UsedTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription period of the subscription cluster.'."\n" - ."\n" - .'* Valid values when Period is set to Year: 1, 2, and 3 (integer)'."\n" - .'* Valid values when Period is set to Month: 1 to 9 (integer)'."\n" - ."\n" - .'> * This parameter is required if the PayType parameter is set to Prepaid.'."\n" - .'> * Longer subscription periods offer more savings. Purchasing a cluster for one year is more cost-effective than purchasing the cluster for 10 or 11 months.', - 'type' => 'string', - 'required' => false, - 'example' => '1'."\n", - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsYXZ2UA'], + ], + 'parameters' => [ [ - 'name' => 'VPCId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The virtual private cloud (VPC) ID of the cluster.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'vpc-bp1at5ze0t5u3xtqn****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-bp1ub9grke1****', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The vSwitch ID of the cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp1aadw9k19x6cis9****', - ], + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test'."\n", 'title' => ''], ], [ - 'name' => 'StorageResource', + 'name' => 'GroupUser', 'in' => 'query', + 'schema' => ['description' => 'The name of the database account. It can be a standard account or a privileged account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'accout'."\n", 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The amount of reserved storage resources. Valid values: 0ACU to 2064ACU. The value must be in increments of 24ACU. Each ACU is approximately equal to 1 core and 4 GB memory.'."\n" - ."\n" - .'> This parameter must be specified with a unit.', - 'type' => 'string', - 'required' => false, - 'example' => '24ACU', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidPoolName.Malformed', 'errorMessage' => 'The specified parameter PoolName is not valid.', 'description' => 'The PoolName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolUser.Malformed', 'errorMessage' => 'The specified parameter PoolUser is not valid.', 'description' => 'The PoolUser parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ], + ], + 'title' => 'BindDBResourceGroupWithUser', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindDBResourceGroupWithUser'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ComputeResource', - 'in' => 'query', - 'schema' => [ - 'description' => 'The amount of reserved computing resources. Valid values: 0ACU to 4096ACU. The value must be in increments of 16ACU. Each ACU is approximately equal to 1 core and 4 GB memory.'."\n" - ."\n" - .'> This parameter must be specified with a unit.', - 'type' => 'string', - 'required' => false, - 'example' => '16ACU', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:BindDBResourceGroupWithUser', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + ], + 'CancelSparkReplStatement' => [ + 'summary' => 'Terminates part of the code in a Spark job.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EnableDefaultResourcePool', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to allocate all reserved computing resources to the user_default resource group. Valid values:'."\n" - ."\n" - .'* **true** (default)'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-4690g37929****', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 's202411071444hzdvk486d9d2001****', 'default' => 'ADB-Spark-Application'], ], [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', + 'name' => 'StatementId', + 'in' => 'formData', + 'schema' => ['description' => 'The unique ID of the code block in the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The tags to add to the cluster.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of tag N to add to the cluster. You can use tags to filter clusters. Valid values of N: 1 to 20. The values that you specify for N must be unique and consecutive integers that start from 1. Each value of `Tag.N.Key` is paired with a value of `Tag.N.Value`.'."\n" - ."\n" - .'> The tag key can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.', - 'type' => 'string', - 'required' => false, - 'example' => 'testkey1', - ], - 'Value' => [ - 'description' => 'The value of tag N to add to the cluster. You can use tags to filter clusters. Valid values of N: 1 to 20. The values that you specify for N must be unique and consecutive integers that start from 1. Each value of `Tag.N.Key` is paired with a value of `Tag.N.Value`.'."\n" - ."\n" - .'> The tag value can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.', - 'type' => 'string', - 'required' => false, - 'example' => 'test1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'StatementId' => ['description' => 'The unique ID of the code block in the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Code' => ['description' => 'The code that is executed.'."\n", 'type' => 'string', 'example' => 'print(1+1)', 'title' => ''], + 'CodeType' => [ + 'description' => 'The code type. Valid values:'."\n" + ."\n" + .'* SCALA'."\n" + .'* PYTHON'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PYTHON', + 'title' => '', + ], + 'CodeState' => [ + 'description' => 'The code execution status. Valid values:'."\n" + ."\n" + .'* CANCELLED'."\n" + .'* RUNNING'."\n" + .'* SUCCEEDED'."\n" + .'* ERROR'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RUNNING', + 'title' => '', + ], + 'AliyunUid' => ['description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '190063530332****', 'title' => ''], + 'OutputType' => [ + 'description' => 'The execution result type, which is in the JSON format. Valid values:'."\n" + ."\n" + .'* TEXT: the text content that conforms to Apache Livy.'."\n" + .'* TABLE: the table content that conforms to Apache Livy.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'TEXT', + 'title' => '', + ], + 'Output' => ['description' => 'The code execution result, which is a JSON string that conforms to Apache Livy.'."\n", 'type' => 'string', 'example' => '{"text/plain": "2"}', 'title' => ''], + 'Columns' => [ + 'description' => 'The column names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The column name.'."\n", 'type' => 'string', 'example' => 'col1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Error' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'StackOverflow Exception：', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1730968056000', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1730968056000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, - 'maxItems' => 21, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'SourceDbClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp1r053byu48p****', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.App.ExceedQuotaLimitation', 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', 'description' => ''], + ['errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', 'description' => 'The AppType type is illegal, please refer to using the document to specify the AppType suitable for your business.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ResourceNegativeError', 'errorMessage' => 'The requested resource MUST be positive: %s', 'description' => ''], + ['errorCode' => 'Spark.Config.InvalidAppFilePath', 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', 'description' => 'The main driver file address must be a valid OSS address. The current address is %s.'], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidDiskConfig', 'errorMessage' => 'The requested disk mount parameter is invalid: %s', 'description' => 'The disk mount configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidHostAliasConfig', 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', 'description' => 'The domain name mapping configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidLogOssPath', 'errorMessage' => 'The OSS address for log storage is illegal: %s', 'description' => 'The OSS address for storing logs is invalid.'], + ['errorCode' => 'Spark.Config.InvalidRoleArnFormat', 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', 'description' => 'The configured RoleARN format is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidTimeZone', 'errorMessage' => 'Unable to parse time zone configuration %s : %s', 'description' => 'The time zone configuration is incorrect.'], + ['errorCode' => 'Spark.Config.MainAppFileNotExists', 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', 'description' => 'The main driver file is missing. The file or sqls configuration must not be empty.'], + ['errorCode' => 'Spark.Config.OSSPathAccessError', 'errorMessage' => 'The configured OSS address %s cannot be accessed.', 'description' => 'The configured OSS path is inaccessible.'], + ['errorCode' => 'Spark.Config.OSSPathNotExists', 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', 'description' => 'The OSS path does not exist or the current user does not have permission to access it.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Config.SecurityGroupNotFound', 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.'], + ['errorCode' => 'Spark.Config.VswitchNotFound', 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured vSwitch cannot be found, or the current account has insufficient permissions. %s.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.BlankError', 'errorMessage' => 'Input sql can not be blank string.', 'description' => 'The submitted SQL statement cannot be empty.'], + ['errorCode' => 'Spark.SQL.MultipleSQLError', 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', 'description' => 'The submitted Spark SQL contains multiple executable SQL statements.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], ], - [ - 'name' => 'BackupSetId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the backup set that you want to use to restore data.'."\n" - ."\n" - .'> You can call the [DescribeBackups](~~612318~~) operation to query the backup sets of the cluster.', - 'type' => 'string', - 'required' => false, - 'example' => '1880808684', - ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], ], [ - 'name' => 'RestoreToTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The point in time to which you want to restore data from the backup set.', - 'type' => 'string', - 'required' => false, - 'example' => '2023-09-20T03:13:56Z', - ], + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.App.NotFound', 'errorMessage' => 'The Spark application %s is not found.', 'description' => 'The specified Spark application was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], ], - [ - 'name' => 'RestoreType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method that you want to use to restore data. Valid values:'."\n" - ."\n" - .'* **backup**: restores data from a backup set. You must also specify the **BackupSetId** and **SourceDBClusterId** parameters.'."\n" - .'* **timepoint**: restores data to a point in time. You must also specify the **RestoreToTime** and **SourceDBClusterId** parameters.', - 'type' => 'string', - 'required' => false, - 'example' => 'backup', - ], + 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], + ], + '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' => 'CancelSparkReplStatement', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSparkReplStatement'], ], + ], + 'ramActions' => [ [ - 'name' => 'ProductForm', - 'in' => 'query', - 'schema' => [ - 'description' => 'The product form of the cluster. Valid values:'."\n" - ."\n" - .'* **IntegrationForm**: integrated.'."\n" - .'* **LegacyForm**: Data Lakehouse Edition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'LegacyForm', - 'default' => 'LegacyForm', - 'enum' => [ - 'IntegrationForm', - 'LegacyForm', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CancelSparkReplStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}/{#sparkStatmentId}'], ], ], ], + ], + ], + 'CancelSparkWarehouseBatchSQL' => [ + 'summary' => 'Cancels a Spark SQL execution.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ReservedNodeSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications of reserved resource nodes. Unit: ACUs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8ACU', - 'default' => '8ACU', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235570', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'ReservedNodeCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of reserved resource nodes.'."\n" - ."\n" - .'* For Enterprise Edition, the default value is 3 and the step size is 3.'."\n" - .'* For Basic Edition, the default value is 1.'."\n" - ."\n" - .'> This parameter must be specified only when ProductForm is set to IntegrationForm.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'name' => 'QueryId', + 'in' => 'formData', + 'schema' => ['description' => 'The execution ID of the Spark SQL.', 'type' => 'string', 'required' => true, 'example' => 'sq202501011001s****', 'title' => ''], ], [ - 'name' => 'KmsId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the key that is used to encrypt disk data.'."\n" - ."\n" - .'> This parameter must be specified only when disk encryption is enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'e1935511-cf88-1123-a0f8-1be8d251****'."\n", - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'amv-uf6485635f***', 'title' => ''], ], [ - 'name' => 'DiskEncryption', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable disk encryption.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'Agency', + 'in' => 'formData', + 'schema' => ['description' => 'The client name for auxiliary recording. The value is a meaningful string of up to 16 characters.', 'type' => 'string', 'required' => false, 'example' => 'DMS', 'title' => ''], ], - [ - 'name' => 'CloneSourceRegionId', - 'in' => 'query', - 'allowEmptyValue' => false, + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '克隆源实例所在区域，跨域克隆必填，同域克隆可不填。', - 'description' => 'The region ID of the source cluster.'."\n" - ."\n" - .'> This parameter must be specified for cloning clusters across regions.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '771C5FAA-530F-52F7-B84D-EBAD45***'], + 'Data' => ['description' => 'The returned result.', '$ref' => '#/components/schemas/SparkBatchSQL', 'example' => '123', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.BlankError', 'errorMessage' => 'Input sql can not be blank string.', 'description' => 'The submitted SQL statement cannot be empty.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + 404 => [ + ['errorCode' => 'Spark.App.NotFound', 'errorMessage' => 'The Spark application %s is not found.', 'description' => 'The specified Spark application was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Cancel spark SQL execution', + 'description' => '- Public endpoint of a region: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- VPC endpoint of a region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.'."\n" + .'> If you encounter a 409 error when initiating requests from China North 1 (Qingdao), China South 1 (Shenzhen), China South 3 (Guangzhou), or Hong Kong (China), contact technical support.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSparkWarehouseBatchSQL'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ProductVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The edition of the cluster. Valid values:'."\n" - ."\n" - .'* **BasicVersion**: Basic Edition.'."\n" - .'* **EnterpriseVersion**: Enterprise Edition.'."\n" - ."\n" - .'> This parameter must be specified only when ProductForm is set to IntegrationForm.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BasicVersion', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:CancelSparkWarehouseBatchSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771C5FAA-530F-52F7-B84D-EBAD45***\\",\\n \\"Data\\": {\\n \\"Uid\\": 0,\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"Query\\": \\"SELECT * FROM db.tb\\",\\n \\"QueryId\\": \\"sq172352176****\\",\\n \\"Schema\\": \\"default\\",\\n \\"QueryEndTime\\": 1723521767000,\\n \\"DBClusterId\\": \\"amv-bp17s73f016****\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"sq1723521767****-0001\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"+---+-----+\\\\n|age| name|\\\\n+---+-----+\\\\n| 14| Tom|\\\\n| 23|Alice|\\\\n+---+-----+\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\",\\n \\"QueryStartTime\\": 1723521767000,\\n \\"ResourceGroupName\\": \\"spark_rg\\"\\n }\\n}","type":"json"}]', + ], + 'CheckBindRamUser' => [ + 'summary' => 'Queries whether a database account of an AnalyticDB for MySQL cluster is associated with a Resource Access Management (RAM) user.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SecondaryZoneId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the secondary zone.'."\n" - ."\n" - .'> You cannot set this parameter to a value that is the same as that of the ZoneId parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing-h', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'SecondaryVSwitchId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the secondary vSwitch.'."\n" - ."\n" - .'> You cannot set this parameter to a value that is the same as that of the VSwitchId parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1aadw9k19x451gx****', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EnableSSL', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-wz9842849v6****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'ResourceGroupId' => [ - 'description' => 'The default resource group ID.', - 'type' => 'string', - 'example' => 'rg-4690g37929****', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.', - 'type' => 'string', - 'example' => 'amv-bp1r053byu48p****', - ], - 'OrderId' => [ - 'description' => 'The order ID.', - 'type' => 'string', - 'example' => '202353278****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FB9DCA3-DA56-5B43-A9A0-68E3D0E6AA84'], + 'Result' => ['description' => 'The returned result of the request. Valid values:'."\n" + ."\n" + .'* **true**: the database account is associated with a RAM user.'."\n" + .'* **false**: the database account is not associated with a RAM user.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'CheckBindRamUser', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2022-06-11T16:51:36.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'CreateDBCluster', - 'description' => 'CreateDBCluster', - ], - 'ModifyDBCluster' => [ - 'summary' => 'Changes the configurations of an AnalyticDB for MySQL Data Lakehouse Edition cluster.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckBindRamUser'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:CheckBindRamUser', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'CheckFormationSchemaExists' => [ + 'summary' => 'Checks whether a metadata discovery schema exists.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3897,109 +1731,35 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '132381', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'none', + 'abilityTreeCode' => '138512', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1r053byu48p****', - ], - ], [ 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'StorageResource', - 'in' => 'query', - 'schema' => [ - 'description' => 'The reserved storage resources. Valid values: 0ACU to 2064ACU. The value must be in increments of 24ACU. Each ACU is approximately equal to 1 core and 4 GB memory.'."\n" - ."\n" - .'> This parameter must be specified with a unit.', - 'type' => 'string', - 'required' => false, - 'example' => '24ACU', - ], - ], - [ - 'name' => 'ComputeResource', - 'in' => 'query', - 'schema' => [ - 'description' => 'The reserved computing resources. Valid values: 0ACU to 4096ACU. The value must be in increments of 16ACU. Each ACU is approximately equal to 1 core and 4 GB memory.'."\n" - ."\n" - .'> This parameter must be specified with a unit.', - 'type' => 'string', - 'required' => false, - 'example' => '16ACU', - ], - ], - [ - 'name' => 'EnableDefaultResourcePool', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to allocate all reserved computing resources to the user_default resource group. Valid values:'."\n" - ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'in' => 'formData', + 'schema' => ['description' => 'RegionId', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ProductForm', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'LegacyForm', - 'default' => 'LegacyForm', - 'enum' => [ - 'IntegrationForm', - 'LegacyForm', - ], - ], + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => ['description' => 'schema 。', 'type' => 'string', 'required' => true, 'example' => 'testdb01', 'title' => ''], ], [ - 'name' => 'ReservedNodeSize', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'LegacyForm', - ], + 'name' => 'PrefixMode', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable prefix mode. Valid values:'."\n" + ."\n" + .'- true: Enable prefix mode.'."\n" + .'- false: Disable prefix mode.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'ReservedNodeCount', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters in a region.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], ], 'responses' => [ @@ -4007,87 +1767,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0D6BF3E2-41D8-57F6-9A62-A13A70377952', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1r053byu48p****', - ], - 'OrderId' => [ - 'description' => 'The order ID.'."\n", - 'type' => 'string', - 'example' => '2035629****', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the schema exists.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '82C80833-BE26-424D-B485-1ABC8431E14', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message. OK is returned if the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Parameter.InputError', 'errorMessage' => 'The specified parameter is invalid. ', 'description' => ''], ], ], - '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' => 'ModifyDBCluster', - 'description' => '### [](#)'."\n" - ."\n" - .'* During a scaling event, you are not allowed to execute the `SUBMIT JOB` statement to submit asynchronous jobs. If your business requires asynchronous jobs, perform scaling during appropriate periods.'."\n" - .'* When you scale a cluster, data in the cluster is migrated for redistribution. The amount of time that is required to migrate data is proportional to the data volume. During a scaling event, the services provided by the cluster are not interrupted. When you downgrade cluster specifications, data migration may require up to dozens of hours to complete. Proceed with caution especially if your cluster contains a large amount of data.'."\n" - .'* If the cluster has a built-in dataset loaded, make sure that the cluster has reserved storage resources of at least 24 AnalyticDB compute units (ACUs). Otherwise, the built-in dataset cannot be used.'."\n" - .'* When the scaling process is about to end, transient connections may occur. We recommend that you scale your cluster during off-peak hours or make sure that your application is configured to automatically reconnect to your cluster.'."\n" - .'* You can change an AnalyticDB for MySQL cluster from Data Warehouse Edition to Data Lakehouse Edition, but not the other way around. For more information, see Change a cluster from Data Warehouse Edition to Data Lakehouse Edition.'."\n" - .'* For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DeleteDBCluster' => [ - 'summary' => 'Deletes an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Check whether a metadata discovery schema exists', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"false\\",\\n \\"RequestId\\": \\"82C80833-BE26-424D-B485-1ABC8431E14\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CheckSampleDataSet' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1r053byu48p****', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-wz9r8f67h4cqz41u', 'title' => ''], ], ], 'responses' => [ @@ -4095,583 +1816,287 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1r053byu48p****', - ], + 'Status' => ['description' => 'The status of the built-in dataset. Valid values:'."\n" + ."\n" + .'- **SUCCEED**: The dataset loaded successfully.'."\n" + ."\n" + .'- **INIT**: Loading in progress.'."\n" + ."\n" + .'- **FAILED**: Failed to load the dataset.'."\n" + ."\n" + .'- **UNINITIALIZED**: Not loaded.', 'type' => 'string', 'example' => 'UNINITIALIZED', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0CE655C3-C211-513D-A42F-D4AE2D1A867C', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + 'title' => 'CheckSampleDataSet', + 'description' => 'For the service endpoint, see [endpoint](~~612373~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSampleDataSet'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:CheckSampleDataSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DeleteDBCluster', - 'description' => '### [](#)'."\n" - ."\n" - .'* You can delete only pay-as-you-go clusters.'."\n" - .'* The cluster that you want to delete must be in the Running state.'."\n" - .'* For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"UNINITIALIZED\\",\\n \\"RequestId\\": \\"0CE655C3-C211-513D-A42F-D4AE2D1A867C\\"\\n}","type":"json"}]', + 'summary' => '', + 'translator' => 'machine', ], - 'DescribeDBClusterAttribute' => [ - 'summary' => 'Queries the information about an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ConfigureResultExport' => [ + 'summary' => 'Configures the export destination (SLS or OSS) at the instance level. The configuration is unique per instance and follows the "configure once, use multiple times" principle.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '130313', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'abilityTreeCode' => '254776', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the region where the instance resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen', 'title' => ''], + ], [ 'name' => 'DBClusterId', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], + ], + [ + 'name' => 'ExportType', + 'in' => 'formData', + 'schema' => ['description' => 'The export type. Valid values:'."\n" + ."\n" + .'* SLS: Specifies that the export destination is SLS.'."\n" + .'* OSS: Specifies that the export destination is OSS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SLS', 'title' => ''], + ], + [ + 'name' => 'SlsInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-wz9509beptiz****', + 'description' => 'The SLS configuration details if the destination is of the SLS type.'."\n", + 'type' => 'object', + 'properties' => [ + 'SlsProject' => ['description' => 'The name of the SLS project.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-project', 'title' => ''], + 'ResourceGroup' => ['description' => 'The name of the resource group that runs the job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aps', 'title' => ''], + 'LogstoreTtl' => ['description' => 'The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day, maximum: 30 days. Values outside this range will result in an error.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'OssInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The OSS configuration details if the destination is of the OSS type.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExportBasePath' => ['description' => 'The OSS path where the result sets are stored.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://testBucketName/data_result', 'title' => ''], + 'ResourceGroup' => ['description' => 'The name of the resource group that runs the job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aps', 'title' => ''], + 'ResultFileTtl' => ['description' => 'The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days. Values outside this range will result in an error.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'ResultData\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', - ], - 'Items' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* **true**: Succeeded.'."\n" + .'* **false**: Failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code. A value of 200 indicates that the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* OK is returned if the request is normal.'."\n" + .'* The specific error code is returned if the request is abnormal,'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The backend error code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The path where the result sets are stored.'."\n", 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'DBCluster' => [ - 'description' => 'The queried cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => 'The time when the cluster was created. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-07-01T09:50:18Z', - ], - 'Expired' => [ - 'description' => 'Indicates whether the subscription cluster has expired. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the cluster has expired, the system locks or releases the cluster within a period of time. We recommend that you renew the expired cluster. For more information, see [Renewal policy](~~135248~~).'."\n" - ."\n" - .'* This parameter is not returned for pay-as-you-go clusters.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'MaintainTime' => [ - 'description' => 'The maintenance window of the cluster. The time is displayed in the `HH:mmZ-HH:mmZ` format in UTC.'."\n" - ."\n" - .'> For more information about maintenance windows, see [Configure a maintenance window](~~122569~~).'."\n", - 'type' => 'string', - 'example' => '04:00Z-05:00Z', - ], - 'PayType' => [ - 'description' => 'The billing method of the cluster. Valid values:'."\n" - ."\n" - .'* **Postpaid**: pay-as-you-go.'."\n" - .'* **Prepaid**: subscription.'."\n", - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => 'The tags that are added to the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'> You can call the [TagResources](~~179253~~) operation to add tags to a cluster.'."\n", - 'type' => 'string', - 'example' => 'tag1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - ], - ], - ], - ], - ], - 'Mode' => [ - 'description' => 'The mode of the cluster. By default, **flexible** is returned, which indicates that the cluster is in elastic mode.'."\n", - 'type' => 'string', - 'example' => 'flexible', - ], - 'Port' => [ - 'description' => 'The port number that is used to connect to the cluster.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3306', - ], - 'LockMode' => [ - 'description' => 'The lock mode of the cluster. Valid values:'."\n" - ."\n" - .'* **Unlock**: The cluster is not locked.'."\n" - .'* **ManualLock**: The cluster is manually locked.'."\n" - .'* **LockByExpiration**: The cluster is automatically locked due to cluster expiration.'."\n", - 'type' => 'string', - 'example' => 'ManualLock', - ], - 'EngineVersion' => [ - 'description' => 'The minor version of the cluster.'."\n", - 'type' => 'string', - 'example' => '3.1.16', - 'default' => '3.1.7.0', - ], - 'StorageResource' => [ - 'description' => 'The specifications of reserved storage resources. Each AnalyticDB compute unit (ACU) is approximately equal to 1 core and 4 GB memory. Storage resources are used to read and write data. The increase in the storage resources can improve the read and write performance of the cluster.'."\n", - 'type' => 'string', - 'example' => '24ACU', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-wz9509beptiz****', - ], - 'ConnectionString' => [ - 'description' => 'The public endpoint that is used to connect to the cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-wz9509beptiz****.ads.aliyuncs.com', - ], - 'DBClusterType' => [ - 'description' => 'The type of the cluster. By default, **Common** is returned, which indicates a common cluster.'."\n", - 'type' => 'string', - 'example' => 'Common', - ], - 'CommodityCode' => [ - 'description' => 'The billing method of the cluster. Valid values:'."\n" - ."\n" - .'* **ads**: pay-as-you-go.'."\n" - .'* **ads_pre**: subscription.'."\n", - 'type' => 'string', - 'example' => 'ads_pre', - ], - 'ExpireTime' => [ - 'description' => 'The time when the cluster expires.'."\n" - ."\n" - .'* If the billing method of the cluster is subscription, the actual expiration time is returned.'."\n" - .'* If the billing method of the cluster is pay-as-you-go, null is returned.'."\n", - 'type' => 'string', - 'example' => '2022-10-01T09:50:18Z', - ], - 'LockReason' => [ - 'description' => 'The reason why the cluster is locked.'."\n" - ."\n" - .'> This parameter is returned only when the cluster was locked. **instance_expire** is returned.'."\n", - 'type' => 'string', - 'example' => 'instance_expire', - ], - 'VPCId' => [ - 'description' => 'The virtual private cloud (VPC) ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp13h7uzhulpu****', - ], - 'ComputeResource' => [ - 'description' => 'The specifications of reserved computing resources. Each ACU is approximately equal to 1 core and 4 GB memory. Computing resources are used to compute data. The increase in the computing resources can accelerate queries. You can scale computing resources based on your business requirements.'."\n", - 'type' => 'string', - 'example' => '16ACU', - ], - 'RegionId' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'vsw-uf629gydd54ld****', - ], - 'DBVersion' => [ - 'description' => 'The engine version of the AnalyticDB for MySQL Data Lakehouse Edition cluster. **5.0** is returned.'."\n", - 'type' => 'string', - 'example' => '5.0', - ], - 'DBClusterStatus' => [ - 'description' => 'The status of the cluster. Valid values:'."\n" - ."\n" - .'* **Preparing**'."\n" - .'* **Creating**'."\n" - .'* **Running**'."\n" - .'* **Deleting**'."\n" - .'* **Restoring**'."\n" - .'* **ClassChanging**'."\n" - .'* **NetAddressCreating**'."\n" - .'* **NetAddressDeleting**'."\n" - .'* **NetAddressModifying**'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'ResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmyiu4ekp****', - ], - 'DBClusterNetworkType' => [ - 'description' => 'The network type of the cluster. **VPC** is returned.'."\n", - 'type' => 'string', - 'example' => 'VPC', - 'default' => 'VPC', - ], - 'DBClusterDescription' => [ - 'description' => 'The description of the cluster.'."\n", - 'type' => 'string', - 'example' => 'adb_test', - ], - 'UserENIStatus' => [ - 'description' => 'Indicates whether Elastic Network Interface (ENI) is enabled. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ZoneId' => [ - 'description' => 'The zone ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'Engine' => [ - 'description' => 'The engine of the cluster. **AnalyticDB** is returned.'."\n", - 'type' => 'string', - 'example' => 'AnalyticDB', - ], - 'ReservedACU' => [ - 'description' => 'The amount of remaining reserved computing resources that are available in the cluster. Each ACU is approximately equal to 1 core and 4 GB memory.'."\n", - 'type' => 'string', - 'example' => '24ACU', - ], - 'ComputeResourceTotal' => [ - 'description' => 'The total amount of computing resources in the cluster. Each ACU is approximately equal to 1 core and 4 GB memory.'."\n", - 'type' => 'string', - 'example' => '48ACU', - ], - 'StorageResourceTotal' => [ - 'description' => 'The total amount of storage resources in the cluster. Each ACU is approximately equal to 1 core and 4 GB memory.'."\n", - 'type' => 'string', - 'example' => '24ACU', - ], - 'SupportedFeatures' => [ - 'description' => 'Reserved parameters.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'A reserved parameter.'."\n", - 'example' => 'N/A'."\n", - ], - ], - 'ProductForm' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'N/A', - 'enum' => [ - 'IntegrationForm', - 'LegacyForm', - ], - ], - 'ReservedNodeSize' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'N/A', - ], - 'ReservedNodeCount' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'N/A', - ], - 'ClickhouseEngineEnabled' => [ - 'description' => 'Indicates whether the ClickHouse wide table engine is enabled. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - ], - 'AINodeNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ProductVersion' => [ - 'description' => 'The edition of the cluster. Valid values:'."\n" - ."\n" - .'* **BasicVersion**: Basic Edition.'."\n" - .'* **EnterpriseVersion**: Enterprise Edition.'."\n", - 'type' => 'string', - 'example' => 'BasicVersion', - ], - 'KmsId' => [ - 'description' => 'The ID of the key that is used to encrypt disk data.'."\n" - ."\n" - .'> This parameter is returned only when disk encryption is enabled.'."\n", - 'type' => 'string', - 'example' => 'e1935511-cf88-1123-a0f8-1be8d251****', - ], - 'TaskInfo' => [ - 'description' => 'The job information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'ScaleUpDBCluster', - ], - 'Status' => [ - 'description' => 'The status of the job. Valid values:'."\n" - ."\n" - .'* NOT_RUN'."\n" - .'* RUNNING'."\n" - .'* SUCCEED'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - 'enum' => [ - 'RUNNING', - 'SUCCEED', - 'NOT_RUN', - ], - ], - 'Progress' => [ - 'description' => 'The progress of the job. Unit: %.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'StepList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'StepList' => [ - 'description' => 'The job steps.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The job step.'."\n", - 'type' => 'object', - 'properties' => [ - 'StepName' => [ - 'description' => 'The name of the job step.'."\n", - 'type' => 'string', - 'example' => 'PrepareResources', - ], - 'StepDesc' => [ - 'description' => 'The description of the job step.'."\n", - 'type' => 'string', - 'example' => 'Prepare resources', - ], - 'StepStatus' => [ - 'description' => 'The status of the job step. Valid values:'."\n" - ."\n" - .'* NOT_RUN'."\n" - .'* RUNNING'."\n" - .'* SUCCEED'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - 'enum' => [ - 'RUNNING', - 'SUCCEED', - 'NOT_RUN', - ], - ], - 'StepProgress' => [ - 'description' => 'The progress of the job step. Unit: %.'."\n", - 'type' => 'string', - 'example' => '50', - ], - 'StartTime' => [ - 'description' => 'The start time of the job step. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-03-10T09:28:34Z', - ], - 'EndTime' => [ - 'description' => 'The end time of the job step. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-03-10T10:28:34Z', - ], - ], - ], - ], - ], - ], - ], - ], - 'UserENIVpcId' => [ - 'description' => 'The VPC information of the ENI.'."\n", - 'type' => 'string', - 'example' => 'vpc-rj9hnedlfm645uj******', - ], - 'UserENIVSwitchOptions' => [ - 'description' => 'The vSwitch connected to the ENI. Separate multiple vSwitches with commas (,).'."\n", - 'type' => 'string', - 'example' => 'vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******', - ], - 'UserENIZoneOptions' => [ - 'description' => 'The zone associated with the ENI. Separate multiple zones with commas (,).'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-k,cn-hangzhou-h', - ], - 'SecondaryZoneId' => [ - 'type' => 'string', - ], - 'SecondaryVSwitchId' => [ - 'type' => 'string', - ], - 'DiskEncryption' => [ - 'type' => 'boolean', - ], - 'ClickhouseEngineCacheSize' => [ - 'description' => 'The cache size of the ClickHouse wide table engine. Unit: GB. If a value of -1 is returned, the ClickHouse wide table engine is disabled. If a value other than -1 is returned, this parameter indicates the disk cache size.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'AINodeSpec' => [ - 'type' => 'string', - ], - ], + 'ExportType' => ['description' => 'The export type. Valid values:'."\n" + ."\n" + .'* SLS: Indicates that the export destination is SLS.'."\n" + .'* OSS: Indicates that the export destination is OSS.'."\n", 'type' => 'string', 'example' => 'SLS', 'title' => ''], + 'SlsInfo' => [ + 'description' => 'The SLS configuration if the destination is of the SLS type.'."\n", + 'type' => 'object', + 'properties' => [ + 'SlsProject' => ['description' => 'The name of the SLS project.'."\n", 'type' => 'string', 'example' => 'test-project', 'title' => ''], + 'ResourceGroup' => ['description' => 'The name of the resource group that runs the job.'."\n", 'type' => 'string', 'example' => 'aps', 'title' => ''], + 'LogstoreTtl' => ['description' => 'The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day. Maximum value: 30 days.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + 'OssInfo' => [ + 'description' => 'The OSS configuration if the destination is of the OSS type.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExportBasePath' => ['description' => 'The OSS path where the result sets are stored.'."\n", 'type' => 'string', 'example' => 'oss://testBucketName/data_result', 'title' => ''], + 'ResourceGroup' => ['description' => 'The name of the resource group that runs the job.'."\n", 'type' => 'string', 'example' => 'aps', 'title' => ''], + 'ResultFileTtl' => ['description' => 'The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - '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 \\"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' => 'ConfigureResultExport', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfigureResultExport'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:ConfigureResultExport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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' => 'DescribeDBClusterAttribute', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", ], - 'DescribeKernelVersion' => [ - 'summary' => 'Queries the information about the minor version of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateAPSJob' => [ + 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) job.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '254101', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'abilityTreeCode' => '180008', + 'abilityTreeNodes' => ['FEATUREadsH8FO36'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-2ze918p6qf6h9****', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen', - ], + 'name' => 'SourceEndpointInstanceID', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the source instance or cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-xxxxx', 'title' => ''], + ], + [ + 'name' => 'SourceEndpointRegion', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID of the source instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'SourceEndpointUserName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database account of the source instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], + ], + [ + 'name' => 'SourceEndpointPassword', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the database account of the source instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + ], + [ + 'name' => 'DestinationEndpointInstanceID', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database account of the destination cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-xxxxx', 'title' => ''], + ], + [ + 'name' => 'DestinationEndpointPassword', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the database account of the destination cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + ], + [ + 'name' => 'DestinationEndpointUserName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database account of the destination cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + ], + [ + 'name' => 'DbList', + 'in' => 'formData', + 'schema' => ['description' => 'The objects to be synchronized.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"EntireInstance":true}', 'title' => ''], + ], + [ + 'name' => 'ApsJobName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the synchronization job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-xxxxx', 'title' => ''], + ], + [ + 'name' => 'PartitionList', + 'in' => 'formData', + 'schema' => ['description' => 'The partitions.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'TargetTableMode', + 'in' => 'formData', + 'schema' => ['description' => 'The mode of the destination table.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -4679,71 +2104,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'KernelVersion' => [ - 'description' => 'The minor version of the cluster. Example: **3.1.8**.'."\n", - 'type' => 'string', - 'example' => '3.1.8', - ], - 'ExpireDate' => [ - 'description' => 'The maintenance expiration time of the version. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. After the time arrives, the system no longer maintains the version. If any issues occur, update the minor version of the cluster to a later version.'."\n", - 'type' => 'string', - 'example' => '2025-01-12T16:00:00Z', - ], - 'AvailableKernelVersions' => [ - 'description' => 'The minor versions to which you can update the current minor version of the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The minor versions to which you can update the current minor version of the cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'KernelVersion' => [ - 'description' => 'The minor version. Example: **3.1.9**.'."\n", - 'type' => 'string', - 'example' => '3.1.9', - ], - 'ReleaseDate' => [ - 'description' => 'The time when the minor version was released. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-07-17T16:00:00Z'."\n", - ], - 'ExpireDate' => [ - 'description' => 'The maintenance expiration time of the version. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. After the time arrives, the system no longer maintains the version. If any issues occur, update the minor version of the cluster to a later version.'."\n", - 'type' => 'string', - 'example' => '2025-07-17T16:00:00Z', - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ApsJobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'aps-bj1xxxxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D1B8ED33-5E9B-512D-B188-1579ED6xxx', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => 'InvalidInput', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + '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' => 'CreateAPSJob', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAPSJob'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateAPSJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DescribeKernelVersion', ], - 'UpgradeKernelVersion' => [ - 'summary' => 'Updates the minor version of an AnalyticDB for MySQL cluster.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateAccount' => [ + 'summary' => 'Creates a database account for a cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4752,119 +2159,185 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'abilityTreeCode' => '130688', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database account. The name must meet the following requirements:'."\n" + .'- Starts with a lowercase letter and ends with a lowercase letter or digit.'."\n" + .'- Contains only lowercase letters, digits, or underscores (_).', 'type' => 'string', 'required' => true, 'example' => 'test_accout', 'title' => ''], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the database account.'."\n" + .'- Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'- Special characters include: `!@#$%^&*()_+-=`'."\n" + .'- Must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'Test_accout1', 'title' => ''], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the account.'."\n" + .'- Cannot start with `http://` or `https://`.'."\n" + .'- Cannot exceed 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => '数据库连接测试账号', 'title' => ''], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Warehouse Edition clusters within a region, including cluster IDs.'."\n", + 'description' => 'The type of the account. Valid values:'."\n" + .'- **Normal**: standard account.'."\n" + .'- **Super**: privileged account.', 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'am-uf6g8w25jacm7****', + 'enum' => ['Super', 'Normal'], + 'example' => 'Normal', + 'title' => '', ], ], [ - 'name' => 'DBVersion', + 'name' => 'Engine', 'in' => 'query', 'schema' => [ - 'description' => 'The minor version to which you want to update.'."\n" + 'description' => 'The database engine. Valid values:'."\n" ."\n" - .'> You can call the **DescribeKernelVersion** operation to query the supported minor versions.'."\n", + .'- **AnalyticDB** (default): AnalyticDB for MySQL engine.'."\n" + .'- **Clickhouse**: wide table engine.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => '3.1.9', + 'example' => 'Clickhouse', + 'title' => '', ], ], [ - 'name' => 'SwitchMode', + 'name' => 'RamUserList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The time when to perform the update. Valid values:'."\n" - ."\n" - .'* **0** (default): immediately performs the update.'."\n" - .'* **1**: performs the update during the maintenance window.'."\n" - ."\n" - .'> You can call the [ModifyDBClusterMaintainTime](~~612236~~) operation to modify the maintenance window of an AnalyticDB for MySQL cluster.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The list of Alibaba Cloud Resource Access Management (RAM) user IDs to attach. Currently, only one RAM user can be attached.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the Alibaba Cloud Resource Access Management (RAM) user to attach.', 'type' => 'string', 'required' => false, 'example' => '20732900249392****', 'title' => ''], 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', - ], + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A444FFFFFF', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The AccountName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => 'The AccountPassword parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => 'The AccountDescription parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidAccountType.Malformed', 'errorMessage' => 'The specified parameter AccountType is not valid.', 'description' => 'The AccountType parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.Sql.CannotConnect', 'errorMessage' => 'Cannot connect instance which type is %s.', 'description' => 'Cannot connect to a child instance of the given type.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A444FFFFFF\\"\\n}","type":"json"}]', - 'title' => 'UpgradeKernelVersion', - ], - 'DescribeDBClusterStatus' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', + 'title' => 'Create a database account', + 'description' => 'For information about the endpoint of this service, see [Service registration](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-06-13T14:53:43.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2023-03-31T07:03:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:52:03.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'CreateApsCopyWorkload' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '133754', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '186455', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD'], ], 'parameters' => [ [ 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1xxxxxxxx47', 'title' => ''], + ], + [ + 'name' => 'WorkloadType', + 'in' => 'formData', + 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => true, 'example' => 'SLS_INGESTION_ADB', 'title' => ''], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'dbName', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => ['description' => 'The data link task ID.', 'type' => 'string', 'required' => true, 'example' => 'aps-******', 'title' => ''], ], ], 'responses' => [ @@ -4872,172 +2345,225 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The queried cluster states.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cluster state. Valid values:'."\n" - ."\n" - .'* **Preparing**'."\n" - .'* **Creating**'."\n" - .'* **Restoring**'."\n" - .'* **Running**'."\n" - .'* **Deleting**'."\n" - .'* **ClassChanging**'."\n" - .'* **NetAddressCreating**'."\n" - .'* **NetAddressDeleting**'."\n" - .'* **NetAddressModifying**'."\n" - .'* **EngineVersionUpgrading**'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAU', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******-3EEC-******-9F06-******', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The API status or POP error code.', 'type' => 'string', 'example' => 'InvalidInput', 'title' => ''], + 'Message' => ['description' => 'The additional information about the result. Valid values:'."\n" + .'- If the request was successful, Success is returned.'."\n" + .'- If the request failed, a specific error code is returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Data' => ['description' => 'The deleted application information.', 'type' => 'object', 'example' => '-', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an APS replication task', + 'summary' => 'Creates an APS replication task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsCopyWorkload'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": [\\n \\"Running\\"\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAU\\"\\n}","type":"json"}]', - 'title' => 'DescribeDBClusterStatus', - 'summary' => 'Queries the statuses of AnalyticDB for MySQL clusters within a region.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'ModifyDBClusterDescription' => [ - 'summary' => 'Modifies the description of an AnalyticDB for MySQL cluster to facilitate the maintenance and management of the cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsCopyWorkload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'CreateApsDatasoure' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'abilityTreeCode' => '168860', + 'abilityTreeNodes' => ['FEATUREadsBIVU9O', 'FEATUREadsY28JLD', 'FEATUREads1II0UT'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1r053byu48p****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-xxxxx', 'title' => ''], ], [ - 'name' => 'DBClusterDescription', - 'in' => 'query', + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'DatasourceType', + 'in' => 'formData', + 'schema' => ['description' => 'The data source type.', 'type' => 'string', 'required' => true, 'example' => 'KAFKA', 'title' => ''], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'formData', + 'schema' => ['description' => 'The data source name.', 'type' => 'string', 'required' => true, 'example' => 'sls-******', 'title' => ''], + ], + [ + 'name' => 'DatasourceDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The data source description.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''], + ], + [ + 'name' => 'Mode', + 'in' => 'formData', + 'schema' => ['description' => 'The mode.', 'type' => 'string', 'required' => false, 'example' => 'ALI_CLOUD_INSTANCE', 'title' => ''], + ], + [ + 'name' => 'SlsInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The description of the cluster.'."\n" - ."\n" - .'* The description cannot start with `http://` or `https`.'."\n" - .'* The description must be 2 to 256 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'adb_test', + 'description' => 'The Simple Log Service (SLS) information for the data source to be created.', + 'type' => 'object', + 'properties' => [ + 'SourceRegionId' => ['description' => 'The region ID of the source cluster.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + 'Project' => ['description' => 'The Simple Log Service (SLS) project.', 'type' => 'string', 'required' => false, 'example' => 'test-project', 'title' => ''], + 'Store' => ['description' => 'sls logstore。', 'type' => 'string', 'required' => false, 'example' => 'test-store', 'title' => ''], + 'Across' => ['description' => 'Specifies whether cross-account access is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'AcrossUid' => ['description' => 'The UID of the cross-account.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], + 'AcrossRole' => ['description' => 'The role name for cross-account access.', 'type' => 'string', 'required' => false, 'example' => 'yyy', 'title' => ''], + ], + 'required' => false, + 'example' => '-', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'KafkaInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ + 'description' => 'The Kafka information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', - ], + 'KafkaClusterId' => ['description' => 'The Kafka instance ID.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + 'KafkaTopic' => ['description' => 'The assigned Kafka topic name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], + 'required' => false, + 'example' => '-', + 'title' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterDescription.Malformed', - 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', + [ + 'name' => 'HiveInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The Hive data source information.', + 'type' => 'object', + 'properties' => [ + 'MetaStoreUri' => ['description' => 'The MetaStore endpoint.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + 'Vswitch' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1*****k', 'title' => ''], + 'SecurityGroup' => ['description' => 'The security group.', 'type' => 'string', 'required' => false, 'example' => 'sg-uf*******h', 'title' => ''], + 'ClusterId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + 'HostConfig' => ['description' => 'The host configuration.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + ], + 'required' => false, + 'example' => '-', + 'title' => '', ], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + [ + 'name' => 'RdsMysqlInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The ApsaraDB RDS for MySQL data source information.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rm-xxxxxxx', 'title' => ''], + 'UserName' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => 'Username.', 'title' => ''], + 'Password' => ['description' => 'The password.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + 'ConnectUrl' => ['description' => 'The read-only instance endpoint.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + 'SecurityGroup' => ['description' => 'The security group.', 'type' => 'string', 'required' => false, 'example' => 'sg-******', 'title' => ''], + ], + 'required' => false, + 'example' => '-', + 'title' => '', ], ], - ], - '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' => 'ModifyDBClusterDescription', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeClusterAccessWhiteList' => [ - 'summary' => 'Queries the IP address whitelists of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsG383TB', + 'name' => 'PolarDBMysqlInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The PolarDB for MySQL data source information.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-bp*********', 'title' => ''], + 'UserName' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => 'test-user-name', 'title' => ''], + 'Password' => ['description' => 'The password.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + 'ConnectUrl' => ['description' => 'The custom RDS endpoint.', 'type' => 'string', 'required' => false, 'example' => '****', 'title' => ''], + 'SecurityGroup' => ['description' => 'The security group.', 'type' => 'string', 'required' => false, 'example' => 'sg-******', 'title' => ''], + 'Across' => ['description' => 'Specifies whether cross-account access is enabled. Valid values:'."\n" + ."\n" + .'- **true**: The current network instance is a cross-account resource.'."\n" + .'- **false**: The current network instance is a resource within the current account.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'AcrossUid' => ['description' => 'The UID of the cross-account.', 'type' => 'string', 'required' => false, 'example' => '123456789*', 'title' => ''], + 'AcrossRole' => ['description' => 'The cross-account role.', 'type' => 'string', 'required' => false, 'example' => 'test-role', 'title' => ''], + ], + 'required' => false, + 'example' => '-', + 'title' => '', + ], ], - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', + 'name' => 'PolarDBXInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp11q28kvl688****', + 'description' => 'The PolarDB-X data source information.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The OceanBase cluster ID.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + ], + 'required' => false, + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'RegionId', - 'in' => 'query', + 'name' => 'DatabricksInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The Databricks data source information.', + 'type' => 'object', + 'properties' => [ + 'AccessToken' => ['description' => 'The access token.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + 'WorkspaceURL' => ['description' => 'The workspace URL.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx', 'title' => ''], + ], 'required' => false, + 'example' => '-', + 'title' => '', ], ], ], @@ -5046,85 +2572,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '370D09FD-442A-5225-AAD3-7362CAE39177', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'IPArray' => [ - 'description' => 'The queried IP address whitelists.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried IP address whitelist.'."\n", - 'type' => 'object', - 'properties' => [ - 'DBClusterIPArrayAttribute' => [ - 'description' => 'The attribute of the IP address whitelist.'."\n" - ."\n" - .'> The IP address whitelists that have the **hidden** attribute are not displayed in the console. These IP address whitelists are used to access services such as Data Transmission Service (DTS) and PolarDB.'."\n", - 'type' => 'string', - 'example' => 'hidden', - ], - 'SecurityIPList' => [ - 'description' => 'The IP addresses in the IP address whitelist. Up to 500 IP addresses can be returned. Multiple IP addresses are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '127.0.xx.xx', - ], - 'DBClusterIPArrayName' => [ - 'description' => 'The name of the IP address whitelist.'."\n" - ."\n" - .'Each cluster supports up to 50 IP address whitelists.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The detailed resource usage of the cluster.', 'type' => 'string', 'example' => '69', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '65D2***-45C1-5C18-**********', 'title' => ''], + 'Success' => ['description' => 'The precheck result. Valid values:'."\n" + ."\n" + .'- **success**: The check passed.'."\n" + .'- **false**: The check failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The API status or POP error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The additional information of the call result. Valid values:'."\n" + .'- If the request was successful, **Success** is returned. '."\n" + .'- If the request failed, a specific error code is returned.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'amv-7xxxxx', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an APS data source', + 'summary' => 'Creates an APS data source.', + 'description' => 'For the service registration of this service, refer to [Endpoint](~~612373~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsDatasoure'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsDatasoure', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - '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' => 'DescribeClusterAccessWhiteList', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + '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"}]', ], - 'ModifyClusterAccessWhiteList' => [ - 'summary' => 'Modifies the IP address whitelist of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateApsHiveJob' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5133,1834 +2627,1168 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsG383TB', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '170254', + 'abilityTreeNodes' => ['FEATUREadsBIVU9O'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The AnalyticDB for MySQL cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-****', 'title' => ''], ], [ - 'name' => 'SecurityIps', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP addresses in an IP address whitelist of a cluster. Separate multiple IP addresses with commas (,). You can add a maximum of 500 different IP addresses to a whitelist. The entries in the IP address whitelist must be in one of the following formats:'."\n" - ."\n" - .'* IP addresses, such as 10.23.XX.XX.'."\n" - .'* CIDR blocks, such as 10.23.xx.xx/24. In this example, 24 indicates that the prefix of each IP address in the IP whitelist is 24 bits in length. You can replace 24 with a value within the range of 1 to 32.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10.23.xx.xx', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID of the O&M event.'."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the regions and zones supported by AnalyticDB for MySQL, including region IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DBClusterIPArrayName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the IP address whitelist. If you do not specify this parameter, the Default whitelist is modified.'."\n" - ."\n" - .'* The whitelist name must be 2 to 32 characters in length. The name can contain lowercase letters, digits, and underscores (\\_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" - .'* Each cluster supports up to 50 IP address whitelists.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'default' => 'default', - ], + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => ['description' => 'The workload name.', 'type' => 'string', 'required' => true, 'example' => 'xxx-20240224100253', 'title' => ''], ], [ - 'name' => 'DBClusterIPArrayAttribute', - 'in' => 'query', - 'schema' => [ - 'description' => 'The attribute of the IP address whitelist. By default, this parameter is empty.'."\n" - ."\n" - .'> IP address whitelists with the hidden attribute are not displayed in the console. Those whitelists are used to access Data Transmission Service (DTS) and PolarDB.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hidden', - ], + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'user_default', 'title' => ''], ], [ - 'name' => 'ModifyMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method used to modify the IP address whitelist. Valid values:'."\n" - ."\n" - .'* **Cover** (default)'."\n" - .'* **Append**'."\n" - .'* **Delete**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - 'default' => 'Cover', - 'enum' => [ - 'Cover', - 'Append', - 'Delete', - ], - ], + 'name' => 'FullComputeUnit', + 'in' => 'formData', + 'schema' => ['description' => 'The number of AnalyticDB compute units (ACUs) required for the migration.', 'type' => 'string', 'required' => true, 'example' => '16', 'title' => ''], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '40', 'title' => ''], + ], + [ + 'name' => 'SyncAllowExpression', + 'in' => 'formData', + 'schema' => ['description' => 'The expression that specifies the objects allowed for synchronization.', 'type' => 'string', 'required' => false, 'example' => '*', 'title' => ''], + ], + [ + 'name' => 'SyncDenyExpression', + 'in' => 'formData', + 'schema' => ['description' => 'The expression that specifies the objects allowed for synchronization.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'TargetType', + 'in' => 'formData', + 'schema' => ['description' => 'The destination type.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], + ], + [ + 'name' => 'OssLocation', + 'in' => 'formData', + 'schema' => ['description' => 'The destination lakehouse address, which is a full OSS path.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-test*/*0516/', 'title' => ''], + ], + [ + 'name' => 'ConflictStrategy', + 'in' => 'formData', + 'schema' => ['description' => 'The policy for handling databases and tables with the same name at the destination.', 'type' => 'string', 'required' => false, 'example' => 'Intercept: reports error and aborts.'."\n" + .'Ignore: ignores and continues.'."\n" + .'Skip: skips relevant tables.', 'title' => ''], + ], + [ + 'name' => 'AdvancedConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The advanced configuration.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + ], + [ + 'name' => 'Parallelism', + 'in' => 'formData', + 'schema' => ['description' => 'The number of parallel tasks.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1564657730', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '370D09FD-442A-5225-AAD3-7362CAE39177', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp11q28kvl688****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2895BB82-B2C1-408E-AA73-DB8D59******'], + 'Data' => ['description' => 'The data returned for the workload.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + .'- **True**: The request was successful.'."\n" + .'- **False**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The API status code or POP error code.', 'type' => 'string', 'example' => 'InvalidInput', 'title' => ''], + 'Message' => ['description' => 'The additional information about the result. Valid values:'."\n" + .'- If the request was successful, **Success** is returned.'."\n" + .'- If the request failed, the specific error code is returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - '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', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an APS hive task', + 'summary' => 'Creates an APS Hive task.', + 'description' => 'For information about the service registration of this service, see [Endpoint](~~612373~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsHiveJob'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsHiveJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'ModifyClusterAccessWhiteList', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see Endpoints.'."\n", + '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"}]', ], - 'ModifyClickhouseEngine' => [ - 'summary' => 'Enables the wide table engine feature for an AnalyticDB for MySQL cluster or modifies the disk cache size of the wide table engine of an AnalyticDB for MySQL cluster for which you enabled the wide table engine feature.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateApsKafkaHudiJob' => [ + 'summary' => 'Creates an APS Kafka to data lakehouse job.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', - 'abilityTreeCode' => '208236', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'abilityTreeCode' => '157674', + 'abilityTreeNodes' => ['FEATUREadsY28JLD'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> Call the [DescribeDBClusters](~~129857~~) operation to view the cluster IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters in the destination region.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'Enabled', - 'in' => 'query', + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PartitionSpecs', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'Specifies whether to enable the wide table engine feature. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', + 'description' => 'The partition information.', + 'type' => 'array', + 'items' => ['description' => '"SourceColumn": The name of the source partition field.'."\n" + .'"Strategy": The policy.'."\n" + ."\n" + .'1. Format date: "ParseAsTimeAndFormat".'."\n" + ."\n" + .'2. Specify partition field: "CustomSpecify".'."\n" + .' "SourceTypeFormat": The format of the source type.'."\n" + .' "TargetTypeFormat": The format of the destination type.'."\n" + .' "TargetColumn": The name of the destination partition field.'."\n" + ."\n" + .'The following list describes the enumeration values of SourceTypeFormat and their corresponding time precision.'."\n" + .'APSLiteralTimestampMilliSecond: Millisecond precision.'."\n" + .'APSLiteralTimestampMicroSecond: Microsecond precision.'."\n" + .'APSLiteralTimestampSecond: Second precision.'."\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" + .'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" }]', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CacheSize', - 'in' => 'query', + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The disk cache size of the wide table engine. Unit: GB. Default value: 100. Valid values: 100 to 1000.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', + 'description' => 'The column information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The column information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the source field.', 'type' => 'string', 'required' => false, 'example' => 'a', 'title' => ''], + 'MapName' => ['description' => 'The name of the destination field.', 'type' => 'string', 'required' => false, 'example' => 'b', 'title' => ''], + 'Type' => ['description' => 'The type of the source field.', 'type' => 'string', 'required' => false, 'example' => 'string', 'title' => ''], + 'MapType' => ['description' => 'The type of the destination field.', 'type' => 'string', 'required' => false, 'example' => 'string', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PrimaryKeyDefinition', + 'in' => 'formData', + 'schema' => ['description' => 'The primary key settings. This parameter supports the UUID policy and the mapping policy. The policies are described as follows.'."\n" + .'UUID policy: "Strategy": "uuid".'."\n" + .'Mapping policy:'."\n" + .'"Strategy": "mapping",'."\n" + .'"Values":\\['."\n" + .'"f1",'."\n" + .'"f2"'."\n" + .'],'."\n" + .'"RecordVersionField","xxx"'."\n" + .'\\`RecordVersionField\\` specifies the Hudi record version.', 'type' => 'string', 'required' => false, 'example' => '"Strategy": "mapping"', 'title' => ''], + ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workload.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'LakehouseId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the lakehouse.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'aps', 'title' => ''], + ], + [ + 'name' => 'HudiAdvancedConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The Hudi configuration for the destination.', 'type' => 'string', 'required' => false, 'example' => 'hoodie.keep.min.commits=20', 'title' => ''], + ], + [ + 'name' => 'AdvancedConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The advanced configuration.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + ], + [ + 'name' => 'FullComputeUnit', + 'in' => 'formData', + 'schema' => ['description' => 'The configuration for full synchronization.', 'type' => 'string', 'required' => false, 'example' => '2ACU', 'title' => ''], + ], + [ + 'name' => 'IncrementalComputeUnit', + 'in' => 'formData', + 'schema' => ['description' => 'The configuration for incremental synchronization.', 'type' => 'string', 'required' => true, 'example' => '2ACU', 'title' => ''], + ], + [ + 'name' => 'KafkaClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Kafka instance. Obtain the ID from the Kafka console.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'KafkaTopic', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Kafka topic. Obtain the ID from the Kafka console.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'StartingOffsets', + 'in' => 'formData', + 'schema' => ['description' => 'The initial consumer offset for Kafka.'."\n" + .'Valid values:'."\n" + .'begin\\_cursor, end\\_cursor, and timestamp.'."\n" + .'These values correspond to the earliest offset, the latest offset, and a specified time.', 'type' => 'string', 'required' => true, 'example' => 'begincursor', 'title' => ''], + ], + [ + 'name' => 'MaxOffsetsPerTrigger', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries to consume in a single batch.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50000', 'title' => ''], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['description' => 'The user-defined name of the database.', 'type' => 'string', 'required' => true, 'example' => 'testDB', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => ['description' => 'The user-defined name of the table.', 'type' => 'string', 'required' => true, 'example' => 'testTB', 'title' => ''], + ], + [ + 'name' => 'OutputFormat', + 'in' => 'formData', + 'schema' => ['description' => 'The output data format.', 'type' => 'string', 'required' => false, 'example' => 'HUDI', 'title' => ''], + ], + [ + 'name' => 'TargetType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the destination.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], + ], + [ + 'name' => 'TargetGenerateRule', + 'in' => 'formData', + 'schema' => ['description' => 'The generation rule for the destination.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'AcrossUid', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account to which the source Kafka instance belongs.', 'type' => 'string', 'required' => false, 'example' => '123************', 'title' => ''], + ], + [ + 'name' => 'AcrossRole', + 'in' => 'formData', + 'schema' => ['description' => 'The RAM role of a trusted entity that is an Alibaba Cloud account. For more information about how to create a RAM role, see Create a RAM role for a trusted Alibaba Cloud account.'."\n" + .'The Alibaba Cloud account that owns the AnalyticDB for MySQL cluster must be added as a trusted account to the RAM role.', 'type' => 'string', 'required' => false, 'example' => 'aps', 'title' => ''], + ], + [ + 'name' => 'SourceRegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'JsonParseLevel', + 'in' => 'formData', + 'schema' => ['description' => 'The number of nested JSON layers to parse. Valid values:'."\n" + .'0: No parsing is performed.'."\n" + .'1: One layer is parsed.'."\n" + .'2: Two layers are parsed.'."\n" + .'3: Three layers are parsed.'."\n" + .'4: Four layers are parsed.'."\n" + .'By default, one layer is parsed. For more information about the JSON parsing policy for nested data, see JSON parsing levels and schema field inference examples.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'DataOutputFormat', + 'in' => 'formData', + 'schema' => ['description' => 'The valid values and their descriptions are as follows:'."\n" + .'Single: The source is a single-line JSON record.'."\n" + .'Multi: The source is a JSON array. A single JSON record is returned as the output.', 'type' => 'string', 'required' => false, 'example' => 'Single', 'title' => ''], + ], + [ + 'name' => 'OssLocation', + 'in' => 'formData', + 'schema' => ['description' => 'The destination lakehouse address. This must be a complete OSS path.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-xx-zzz/yyy/', 'title' => ''], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DataFormatType', + 'in' => 'formData', + 'schema' => ['description' => 'The Kafka message type. Valid values: json, general\\_canal\\_json, mongo\\_canal\\_json, dataworks\\_json, and shareplex\\_json.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'json'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'D761DA51-12F8-5457-AAA9-F52B9F436D2D', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the created task.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1A943417-5B0E-1DB9-A8**-A566****C3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + .'True: The request was successful. False: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The same as the HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'CreateApsKafkaHudiJob', + 'changeSet' => [ + ['createdAt' => '2025-12-03T12:34:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-18T03:16:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsKafkaHudiJob'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsKafkaHudiJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D761DA51-12F8-5457-AAA9-F52B9F436D2D\\"\\n}","type":"json"}]', - 'title' => 'ModifyClickhouseEngine', + 'translator' => 'machine', ], - 'DescribeResourceGroupSpec' => [ - 'summary' => 'Queries the information about resource group specifications.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateApsSlsADBJob' => [ + 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) job from Simple Log Service (SLS) to an AnalyticDB for MySQL Data Warehouse Edition cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235394', - 'abilityTreeNodes' => [ - 'FEATUREadsYXZ2UA', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '207599', + 'abilityTreeNodes' => ['FEATUREads1II0UT'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-8vbo40tl1dxxxxxx', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-*********', 'title' => ''], ], [ - 'name' => 'ResourceGroupType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ai', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', + 'name' => 'PartitionSpecs', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', + 'description' => 'The information about partition.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The information about partition.'."\n", 'type' => 'object', 'required' => false, 'example' => '-', 'title' => ''], 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => '-', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10226189-4391-5B10-97AF-5CA5XXXXXXX', - ], - 'Specs' => [ - 'description' => 'The queried specifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The specifications.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the specification.'."\n", - 'type' => 'string', - 'example' => 'xlarge', - ], - 'AllocateUnits' => [ - 'description' => 'The allocation units supported by this specification.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The allocation units.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - 'MaxQuantity' => [ - 'description' => 'The maximum number of resource groups that can be used with this specification.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'Type' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'example' => 'GPU', - 'default' => 'GPU', - 'enum' => [ - 'CPU', - 'GPU', - ], - ], - ], - ], + 'description' => 'The information about columns.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about columns.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the column.'."\n", 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], + 'MapName' => ['description' => 'The name of the mapping.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'The data type of the column.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bigint', 'title' => ''], + 'MapType' => ['description' => 'The type of the mapping.'."\n", 'type' => 'string', 'required' => false, 'example' => 'int', 'title' => ''], ], + 'required' => false, + 'example' => '-', + 'title' => '', ], + 'required' => true, + 'example' => '-', + 'title' => '', ], ], - ], - '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.', - ], + [ + 'name' => 'PrimaryKeyDefinition', + 'in' => 'formData', + 'schema' => ['description' => 'The definition of the primary key.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], - 408 => [ - [ - 'errorCode' => 'AcsServerTimeOut', - 'errorMessage' => 'The request has failed due to Adb Cloud Service time out.', - ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workload.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sls-******', 'title' => ''], ], - ], - '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' => 'DescribeResourceGroupSpec', - 'description' => '### [](#)'."\n" - ."\n" - .'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'CreateDBResourceGroup' => [ - 'summary' => 'Creates a resource group for a specified Enterprise Edition, Basic Edition, or Lake Warehouse Edition cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'LakehouseId', + 'in' => 'formData', + 'schema' => ['description' => 'The lakehouse ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '136449', - 'abilityTreeNodes' => [ - 'FEATUREadsYXZ2UA', + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'name' => 'AdvancedConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The advanced configurations.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'* The name can be up to 255 characters in length.'."\n" - .'* The name must start with a letter or a digit.'."\n" - .'* The name can contain letters, digits, hyphens (\\_), and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_group', - ], + 'name' => 'HudiAdvancedConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The advanced configurations of Hudi.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ - 'name' => 'GroupType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource group. Valid values:'."\n" - ."\n" - .'* **Interactive**'."\n" - .'* **Job**'."\n" - ."\n" - .'> For more information about resource groups, see [Resource group overview](~~428610~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Job', - 'enum' => [], - ], + 'name' => 'FullComputeUnit', + 'in' => 'formData', + 'schema' => ['description' => 'The number of full AnalyticDB compute units (ACUs).'."\n", 'type' => 'string', 'required' => false, 'example' => '16', 'title' => ''], ], [ - 'name' => 'MinComputeResource', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The minimum reserved computing resources.'."\n" - ."\n" - .'* When GroupType is set to Interactive, set this parameter to 16ACU.'."\n" - .'* When GroupType is set to Job, set this parameter to 0ACU.', - 'type' => 'string', - 'required' => false, - 'example' => '0ACU', - ], + 'name' => 'IncrementalComputeUnit', + 'in' => 'formData', + 'schema' => ['description' => 'The number of increment ACUs.'."\n", 'type' => 'string', 'required' => false, 'example' => '168', 'title' => ''], ], [ - 'name' => 'MaxComputeResource', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum reserved computing resources.'."\n" - ."\n" - .'* If GroupType is set to Interactive, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 16ACU.'."\n" - .'* If GroupType is set to Job, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 8ACU.', - 'type' => 'string', - 'required' => false, - 'example' => '48ACU', - ], + 'name' => 'Project', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the SLS project.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'ClusterSizeResource', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'N/A'."\n", - ], + 'name' => 'Store', + 'in' => 'formData', + 'schema' => ['description' => 'The SLS Logstore.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'MinClusterCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'N/A'."\n", - ], + 'name' => 'StartingOffsets', + 'in' => 'formData', + 'schema' => ['description' => 'The start offset.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'MaxClusterCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'N/A'."\n", - ], + 'name' => 'MaxOffsetsPerTrigger', + 'in' => 'formData', + 'schema' => ['description' => 'The latest offset.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-', 'title' => ''], ], [ - 'name' => 'ClusterMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'N/A'."\n", - ], + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dbName', 'title' => ''], ], [ - 'name' => 'EnableSpot', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the spot instance feature for the resource group. After you enable the spot instance feature, you are charged for resources at a lower unit price but the resources are probably released. You can enable the spot instance feature only for job resource groups. Valid values:'."\n" - ."\n" - .'* **True**'."\n" - .'* **False**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'True', - ], + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~612393~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'name' => 'OutputFormat', + 'in' => 'formData', + 'schema' => ['description' => 'The format of the output file.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ - 'name' => 'Rules', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The job resubmission rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The job resubmission rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'* The name can be up to 255 characters in length.'."\n" - .'* The name must start with a letter or digit.'."\n" - .'* The name can contain letters, digits, hyphens (-), and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_group', - ], - 'QueryTime' => [ - 'description' => 'The execution duration of the query. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '180000'."\n", - ], - 'TargetGroupName' => [ - 'description' => 'The name of the resource group to which you want to resubmit the query job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'job'."\n", - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'name' => 'TargetType', + 'in' => 'formData', + 'schema' => ['description' => 'The destination type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ADB', 'title' => ''], ], [ - 'name' => 'Engine', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SparkWarehouse', - ], + 'name' => 'TargetGenerateRule', + 'in' => 'formData', + 'schema' => ['description' => 'The rules for generating the destination database.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ - 'name' => 'EngineParams', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', - ], + 'name' => 'AcrossUid', + 'in' => 'formData', + 'schema' => ['description' => 'The cross-account UID.'."\n", 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'AutoStopInterval', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5m', - ], + 'name' => 'AcrossRole', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the cross-account role.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-role', 'title' => ''], ], [ - 'name' => 'SpecName', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'SourceRegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID of the source cluster.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'MinGpuQuantity', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '', - ], + 'name' => 'OssLocation', + 'in' => 'formData', + 'schema' => ['description' => 'The Object Storage Service (OSS) URL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://test*', 'title' => ''], ], [ - 'name' => 'MaxGpuQuantity', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '', - ], + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '327', 'title' => ''], ], [ - 'name' => 'TargetResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'DirtyDataProcessPattern', + 'in' => 'formData', + 'schema' => ['description' => 'The dirty data processing mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'STOP', 'title' => ''], ], [ - 'name' => 'RayConfig', - 'in' => 'query', + 'name' => 'ExactlyOnce', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the consistency check.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'UnixTimestampConvert', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The timestamp conversion.'."\n", 'type' => 'object', 'properties' => [ - 'EnableUserEni' => [ - 'type' => 'boolean', - ], - 'HeadSpecType' => [ - 'type' => 'string', - 'default' => 'CPU', - 'enum' => [ - 'CPU', - 'GPU', - ], - ], - 'HeadSpec' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xlarge', - ], - 'HeadAllocateUnit' => [ - 'type' => 'string', - ], - 'HeadDiskCapacity' => [ - 'type' => 'string', - ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'BASIC', - 'enum' => [ - 'BASIC', - 'HIGH_AVAILABILITY', - ], - ], - 'WorkerGroups' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'AllocateUnit' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'MaxWorkerQuantity' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'MinWorkerQuantity' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'WorkerDiskCapacity' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100G', - ], - 'WorkerSpecName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xlarge', - ], - 'WorkerSpecType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GPU', - 'enum' => [ - 'CPU', - 'GPU', - ], - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'Convert' => ['description' => 'Specifies whether to enable the conversion of timestamps.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false。', 'title' => ''], + 'Format' => ['description' => 'The format of the timestamp.'."\n", 'type' => 'string', 'required' => false, 'example' => "\0".'APSyyyyMMdd', 'title' => ''], + 'Transform' => ['description' => 'Specifies whether to enable the timestamp conversion.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], 'required' => false, + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'GpuElasticPlan', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Enabled' => [ - 'type' => 'boolean', - ], - 'Rules' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StartCronExpression' => [ - 'type' => 'string', - ], - 'EndCronExpression' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'user_test', 'title' => ''], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_user', 'title' => ''], + ], + [ + 'name' => 'DirtyDataHandleMode', + 'in' => 'formData', + 'schema' => ['description' => 'The dirty data processing mode.'."\n", 'type' => 'string', 'required' => true, 'example' => '-', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD5', - ], + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-******-9F06-******', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the dry run succeeds. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => 'InvalidInput', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.'."\n" + .'* If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], + 'description' => 'The response parameters.', + 'title' => '', + '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.', - ], - [ - 'errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', - 'errorMessage' => 'The state of this resource group does not support this operation.', + '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' => 'CreateApsSlsADBJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsSlsADBJob'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsSlsADBJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'CreateDBResourceGroup', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see Endpoints.'."\n", ], - 'DescribeDBResourceGroup' => [ - 'summary' => 'Queries the information about resource groups of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateApsWebhook' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '136430', - 'abilityTreeNodes' => [ - 'FEATUREadsYXZ2UA', - ], + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsBIVU9O', 'FEATUREadsY28JLD'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> If you do not specify this parameter, the information about all resource groups in the cluster is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_group', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GroupType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource group. Valid values:'."\n" - ."\n" - .'* **Interactive**'."\n" - .'* **Job**'."\n" - ."\n" - .'> For more information about resource groups, see [Resource group overview](~~428610~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Job', - ], + 'name' => 'JobType', + 'in' => 'formData', + 'schema' => ['description' => 'The task type. Valid values:'."\n" + ."\n" + .'ResultExport: SLS/OSS export task.', 'type' => 'string', 'required' => true, 'example' => 'ResultExport', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', + 'name' => 'Webhook', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~612393~~) operation to query the most recent region list.'."\n", - 'type' => 'string', + 'description' => 'The webhook array.', + 'type' => 'array', + 'items' => [ + 'description' => 'The webhook information.', + 'type' => 'object', + 'properties' => [ + 'WebhookType' => ['description' => 'The notification method. Valid values:'."\n" + ."\n" + .'- dingtalk: DingTalk.'."\n" + .'- lark: Lark.', 'type' => 'string', 'required' => true, 'example' => 'dingtalk', 'title' => ''], + 'Url' => ['description' => 'The request URL.', 'type' => 'string', 'required' => true, 'example' => 'https://example.com/webhook', 'title' => ''], + 'Key' => ['description' => 'The signing key.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + 'Name' => ['description' => 'The webhook name.', 'type' => 'string', 'required' => false, 'example' => 'MyWebhookName', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD3', - ], - 'GroupsInfo' => [ - 'description' => 'The queried resource groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupType' => [ - 'description' => 'The type of the resource group. Valid values:'."\n" - ."\n" - .'* **Interactive**'."\n" - .'* **Job**'."\n" - ."\n" - .'> For more information about resource groups, see [Resource groups](~~428610~~).'."\n", - 'type' => 'string', - 'example' => 'Job', - ], - 'GroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'MinComputeResource' => [ - 'description' => 'The minimum amount of reserved computing resources.', - 'type' => 'string', - 'example' => '0ACU', - ], - 'MaxComputeResource' => [ - 'description' => 'The maximum amount of reserved computing resources.', - 'type' => 'string', - 'example' => '512ACU', - ], - 'ClusterSizeResource' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'N/A'."\n", - ], - 'MinClusterCount' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'N/A'."\n", - ], - 'MaxClusterCount' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'N/A'."\n", - ], - 'RunningClusterCount' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'N/A'."\n", - ], - 'ClusterMode' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'N/A'."\n", - ], - 'ElasticMinComputeResource' => [ - 'description' => 'The minimum amount of elastic computing resources.', - 'type' => 'string', - 'example' => '16ACU', - ], - 'EnableSpot' => [ - 'description' => 'Indicates whether the preemptible instance feature is enabled for the resource group. After the preemptible instance feature is enabled, you are charged for resources at a lower unit price but the resources are probably released. Valid values:'."\n" - ."\n" - .'* **True**'."\n" - .'* **False**'."\n" - ."\n" - .'The True value is returned only for job resource groups.'."\n", - 'type' => 'string', - 'example' => 'True', - ], - 'GroupUsers' => [ - 'description' => 'The Resource Access Management (RAM) user that is associated with the resource group.'."\n", - 'type' => 'string', - 'example' => 'testb,testc', - ], - 'CreateTime' => [ - 'description' => 'The time when the resource group was created. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-08-29T03:34:30Z', - ], - 'UpdateTime' => [ - 'description' => 'The time when the resource group was updated. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-08-31T03:34:30Z', - ], - 'Status' => [ - 'description' => 'The status of the resource group. Valid values:'."\n" - ."\n" - .'* **creating**: The resource group is being created.'."\n" - .'* **ok**: The resource group is created.'."\n" - .'* **pendingdelete**: The resource group is pending to be deleted.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'Rules' => [ - 'description' => 'The job resubmission rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'user_default', - ], - 'QueryTime' => [ - 'description' => 'The execution duration of the query. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '180000', - ], - 'TargetGroupName' => [ - 'description' => 'The name of the destination resource group.'."\n", - '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' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'type' => 'string', - 'title' => 'Ray Worker组名', - 'example' => 'g01', - ], - 'AllocateUnit' => [ - 'type' => 'string', - 'title' => '分配单元', - 'example' => '1', - ], - 'MaxWorkerQuantity' => [ - 'type' => 'integer', - 'format' => 'int32', - 'title' => '最大Worker个数', - 'example' => '1', - ], - 'MinWorkerQuantity' => [ - 'type' => 'integer', - 'format' => 'int32', - 'title' => '最小Worker个数', - 'example' => '1', - ], - 'WorkerDiskCapacity' => [ - 'type' => 'string', - 'title' => '每个Worker磁盘大小', - 'example' => '100G', - ], - 'WorkerSpecName' => [ - 'type' => 'string', - 'title' => 'Worker资源型号', - 'example' => 'large', - ], - 'WorkerSpecType' => [ - 'type' => 'string', - 'enum' => [ - 'CPU', - 'GPU', - ], - 'title' => 'Ray Worker资源类型', - 'example' => 'CPU', - ], - ], - ], - 'title' => 'Ray Worker组列表', - ], - 'RayClusterAddress' => [ - 'type' => 'string', - 'title' => 'Ray Cluster地址', - 'example' => 'http://ray-cluster-address.example.com', - ], - 'RayDashboardAddress' => [ - 'type' => 'string', - 'title' => 'Ray Dashboard地址', - 'example' => 'http://ray-dashboard-address.example.com', - ], - 'RayGrafanaAddress' => [ - 'type' => 'string', - 'title' => 'Ray Grafana地址', - 'example' => 'http://ray-grafana-address.example.com', - ], - 'AppConfig' => [ - 'title' => 'Ray应用配置', - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'title' => 'Ray应用名', - 'type' => 'string', - 'example' => 'app01', - ], - 'AppType' => [ - 'title' => 'Ray应用类型', - 'type' => 'string', - 'example' => 'IsaacLab', - ], - 'ImageSelector' => [ - 'title' => '镜像配置', - 'type' => 'object', - 'properties' => [ - 'Image' => [ - 'title' => '镜像', - 'type' => 'string', - 'example' => 'lab2.10.0-ray2.43.0', - ], - 'InferenceEngine' => [ - 'title' => '推理引擎', - 'type' => 'string', - 'example' => 'vLLM', - ], - 'LlmModel' => [ - 'title' => 'LLM模型', - 'type' => 'string', - 'example' => 'Deepseek-R1', - ], - ], - ], - ], - ], - 'StorageMounts' => [ - 'title' => '挂载存储列表', - 'type' => 'array', - 'items' => [ - 'title' => '挂载存储', - 'type' => 'object', - 'properties' => [ - 'StorageId' => [ - 'title' => '存储ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MountPath' => [ - 'title' => '挂载路径', - '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' => [ - 'type' => 'object', - 'required' => false, - 'title' => '引擎参数', - 'additionalProperties' => [ - 'title' => '引擎参数', - 'type' => 'any', - 'example' => '', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890abcdef'], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + '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.', - ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a webhook', + 'summary' => 'Creates a webhook for a specified database cluster and task type.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsWebhook'], ], - 408 => [ - [ - 'errorCode' => 'AcsServerTimeOut', - 'errorMessage' => 'The request has failed due to Adb Cloud Service time out.', + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsWebhook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DescribeDBResourceGroup', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890abcdef\\",\\n \\"Data\\": \\"[]\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'ModifyDBResourceGroup' => [ - 'summary' => 'Modifies the amount of reserved computing resources for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateBackup' => [ + 'summary' => 'Creates a backup set immediately.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', - 'abilityTreeCode' => '136445', - 'abilityTreeNodes' => [ - 'FEATUREadsYXZ2UA', - ], + 'abilityTreeCode' => '246050', + 'abilityTreeNodes' => ['FEATUREadsM6VDCK'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1r053byu48p****', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-wz9or2xawpnc****', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the name of a resource group in a cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '421794A3-72A5-5D27-9E8B-A75A4C50****'], + ], + 'example' => '', ], ], + ], + '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.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Create a temporary backup immediately', + 'description' => '**Before you use this operation, make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/ads/detail/ads_pre) of AnalyticDB for MySQL.** Temporary backups and regular backups have the same pricing and backup set retention period.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'], + ], + ], + 'ramActions' => [ [ - 'name' => 'GroupType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource group. Valid values:'."\n" - ."\n" - .'* **Interactive**'."\n" - .'* **Job**'."\n" - ."\n" - .'> For information about resource groups of Data Lakehouse Edition, see [Resource groups](~~428610~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Interactive', - 'enum' => [], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateBackup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C50****\\"\\n}","type":"json"}]', + ], + 'CreateDBCluster' => [ + 'summary' => 'Creates a Data Lakehouse Edition cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MinComputeResource', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The minimum amount of reserved computing resources.'."\n" - ."\n" - .'* If the GroupType parameter is set to Interactive, set the value to 16ACU.'."\n" - .'* If GroupType is set to Job, set the value to 0ACU.', - 'type' => 'string', - 'required' => false, - 'example' => '0ACU', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '130062', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], + ], + 'parameters' => [ [ - 'name' => 'MaxComputeResource', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum amount of reserved computing resources.'."\n" - ."\n" - .'* If GroupType is set to Interactive, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 16ACU.'."\n" - .'* If GroupType is set to Job, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 8ACU.', - 'type' => 'string', - 'required' => false, - 'example' => '48ACU', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the region ID of a specific Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClusterSizeResource', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'N/A'."\n", - ], + 'schema' => ['description' => 'The zone ID.'."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the zone ID of a specific Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-h', 'title' => ''], ], [ - 'name' => 'MinClusterCount', + 'name' => 'DBClusterVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'N/A'."\n", - ], + 'schema' => ['description' => 'The version of the Data Lakehouse Edition cluster. Valid values: **5.0**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.0', 'title' => ''], ], [ - 'name' => 'MaxClusterCount', + 'name' => 'DBClusterNetworkType', 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'N/A'."\n", - ], + 'schema' => ['description' => 'The network type of the cluster. Only **VPC** (Virtual Private Cloud) is supported.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'VPC', 'title' => ''], ], [ - 'name' => 'ClusterMode', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'N/A'."\n", - ], + 'schema' => ['description' => 'The description of the cluster.'."\n" + .'- The description cannot start with `http://` or `https://`.'."\n" + .'- The description must be 2 to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'EnableSpot', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the spot instance feature for the resource group. After you enable the spot instance feature, you are charged for resources at a lower unit price but the resources are probably released. You can enable the spot instance feature only for job resource groups. Valid values:'."\n" - ."\n" - .'* **True**'."\n" - .'* **False**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + .'- **Prepaid**: subscription.', 'type' => 'string', 'required' => true, 'example' => 'Prepaid', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The subscription type of the subscription cluster. Valid values:'."\n" + .'- **Year**: subscription on a yearly basis.'."\n" + .'- **Month**: subscription on a monthly basis.'."\n" + ."\n" + .'> This parameter is required when PayType is set to Prepaid.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ - 'name' => 'Rules', + 'name' => 'UsedTime', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The subscription duration of the subscription cluster. Valid values:'."\n" + .'- When **Period** is set to Year, the value of UsedTime ranges from 1 to 3 (integer).'."\n" + .'- When **Period** is set to Month, the value of UsedTime ranges from 1 to 9 (integer).'."\n" + ."\n" + .'> This parameter is required when PayType is set to **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1at5ze0t5u3xtqn****', 'title' => ''], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1aadw9k19x6cis9****', 'title' => ''], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + 'schema' => ['description' => 'The storage reserved resources. Valid values: 0 ACU to 2064 ACU, in increments of 24. 1 ACU is approximately equivalent to 1 core and 4 GB of memory.'."\n" + .'> Include the unit when specifying this parameter.', 'type' => 'string', 'required' => false, 'example' => '24ACU', 'title' => ''], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'schema' => ['description' => 'The compute reserved resources. Valid values: 0 ACU to 4096 ACU, in increments of 16. 1 ACU is approximately equivalent to 1 core and 4 GB of memory.'."\n" + .'> Include the unit when specifying this parameter.', 'type' => 'string', 'required' => false, 'example' => '16ACU', 'title' => ''], + ], + [ + 'name' => 'EnableDefaultResourcePool', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to allocate all compute reserved resources to the default resource group (user_default). Valid values:'."\n" + .'- **true** (default): All compute reserved resources are allocated to the default resource group.'."\n" + .'- **false**: Not all compute reserved resources are allocated to the default resource group.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', 'title' => ''], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The job resubmission rules.'."\n", + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'GroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user_default', - ], - 'QueryTime' => [ - 'description' => 'The execution duration of the query. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '180000'."\n", - ], - 'TargetGroupName' => [ - 'description' => 'The name of the destination resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'job'."\n", - ], + 'Key' => ['description' => 'The tag key. You can use tags to filter the cluster list. You can specify up to 20 tag pairs. The value of N for each tag pair must be unique and must be a consecutive integer that starts from 1. The value of `Tag.N.Key` corresponds to the value of `Tag.N.Value`.'."\n" + ."\n" + .'> The tag key can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'testkey1', 'title' => ''], + 'Value' => ['description' => 'The tag value. You can use tags to filter the cluster list. You can specify up to 20 tag pairs. The value of N for each tag pair must be unique and must be a consecutive integer that starts from 1. The value of `Tag.N.Key` corresponds to the value of `Tag.N.Value`.'."\n" + ."\n" + .'> The tag value can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EngineParams', + 'name' => 'SourceDbClusterId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', - ], + 'schema' => ['description' => 'The instance ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster. If this parameter is specified, the Data Lakehouse Edition cluster is used to recover from the Data Warehouse Edition cluster.', 'type' => 'string', 'required' => false, 'example' => 'amv-bp1r053byu48p****', 'title' => ''], ], [ - 'name' => 'AutoStopInterval', + 'name' => 'BackupSetId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5m', - ], + 'schema' => ['description' => 'The ID of the backup set used for restoration from a backup set.'."\n" + ."\n" + .'> You can call the [DescribeBackups](~~612318~~) operation to query the backup list of the cluster.', 'type' => 'string', 'required' => false, 'example' => '1880808684', 'title' => ''], ], [ - 'name' => 'SpecName', + 'name' => 'RestoreToTime', + 'in' => 'query', + 'schema' => ['description' => 'The point in time to which you want to restore data from the backup set.', 'type' => 'string', 'required' => false, 'example' => '2023-09-20T03:13:56Z', 'title' => ''], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => ['description' => 'The restoration method. Valid values:'."\n" + .'* **backup**: restores data from a backup set. You must also specify the **BackupSetId** and **SourceDBClusterId** parameters.'."\n" + .'* **timepoint**: restores data to a specific point in time. You must also specify the **RestoreToTime** and **SourceDBClusterId** parameters.', 'type' => 'string', 'required' => false, 'example' => 'backup', 'title' => ''], + ], + [ + 'name' => 'ProductForm', 'in' => 'query', 'schema' => [ + 'description' => 'The product form. Valid values:'."\n" + .'- **IntegrationForm**: integrated form.'."\n" + .'- **LegacyForm**: Data Lakehouse Edition.', 'type' => 'string', 'required' => false, + 'example' => 'LegacyForm', + 'default' => 'LegacyForm', + 'enum' => ['IntegrationForm', 'LegacyForm'], + 'title' => '', ], ], [ - 'name' => 'MinGpuQuantity', + 'name' => 'ReservedNodeSize', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['description' => 'The node specifications of reserved nodes, in ACUs.', 'type' => 'string', 'default' => '8ACU', 'required' => false, 'example' => '8ACU', 'title' => ''], ], [ - 'name' => 'MaxGpuQuantity', + 'name' => 'ReservedNodeCount', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['description' => 'The number of reserved nodes. '."\n" + .'- Enterprise Edition uses 3 nodes by default, in increments of 3.'."\n" + .'- Basic Edition uses 1 node by default.'."\n" + .'> This parameter is required only when ProductForm is set to IntegrationForm.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'TargetResourceGroupName', + 'name' => 'KmsId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the key used to encrypt cloud disk data.'."\n" + .'> This parameter is used only when cloud disk encryption is enabled for the AnalyticDB for MySQL cluster.', 'type' => 'string', 'required' => false, 'example' => 'e1935511-cf88-1123-a0f8-1be8d251****'."\n", 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'DiskEncryption', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'starting', - ], + 'schema' => ['description' => 'Specifies whether to enable cloud disk encryption.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'RayConfig', + 'name' => 'CloneSourceRegionId', 'in' => 'query', - 'style' => 'json', + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The region of the source cluster.'."\n" + .'> This parameter is required for cross-region cloning.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ProductVersion', + 'in' => 'query', + 'schema' => ['description' => 'The product version. Valid values:'."\n" + .'- **BasicVersion**: Basic Edition.'."\n" + .'- **EnterpriseVersion**: Enterprise Edition.'."\n" + .'> This parameter is required only when ProductForm is set to IntegrationForm.', 'type' => 'string', 'required' => false, 'example' => 'BasicVersion', 'title' => ''], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => ['description' => 'The secondary zone ID.'."\n" + .'> The value of this parameter must be different from the value of the ZoneId parameter.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-h', 'title' => ''], + ], + [ + 'name' => 'SecondaryVSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The secondary vSwitch ID.'."\n" + .'> The value of this parameter must be different from the value of the VSwitchId parameter.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1aadw9k19x451gx****', 'title' => ''], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable SSL encryption. Valid values:'."\n" + ."\n" + .'- **true**: SSL encryption is enabled.'."\n" + .'- **false**: SSL encryption is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'AINodeSpec', + 'in' => 'query', + 'schema' => ['title' => '', 'type' => 'string', 'example' => 'ADB.MLPlus.4', 'description' => ''], + ], + [ + 'name' => 'AINodeNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EnableUserEni' => [ - 'type' => 'boolean', - ], - 'HeadSpecType' => [ - 'type' => 'string', - 'default' => 'CPU', - 'enum' => [ - 'CPU', - 'GPU', - ], - ], - 'HeadSpec' => [ - 'type' => 'string', - 'required' => false, - ], - 'HeadAllocateUnit' => [ - 'type' => 'string', - ], - 'HeadDiskCapacity' => [ - 'type' => 'string', - ], - 'Category' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'BASIC', - 'HIGH_AVAILABILITY', - ], - ], - 'WorkerGroups' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AllocateUnit' => [ - 'type' => 'string', - 'required' => false, - ], - 'GroupName' => [ - 'type' => 'string', - 'required' => false, - ], - 'MaxWorkerQuantity' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'MinWorkerQuantity' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'WorkerDiskCapacity' => [ - 'type' => 'string', - 'required' => false, - ], - 'WorkerSpecName' => [ - 'type' => 'string', - 'required' => false, - ], - 'WorkerSpecType' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'CPU', - 'GPU', - ], - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'AppConfig' => [ - 'title' => 'Ray应用配置', - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'title' => '应用名称', - 'type' => 'string', - 'example' => 'app01', - ], - 'AppType' => [ - 'title' => '应用类型', - 'type' => 'string', - 'example' => 'IsaacLab', - ], - 'ImageSelector' => [ - 'title' => '镜像配置', - 'type' => 'object', - 'properties' => [ - 'Image' => [ - 'title' => '镜像名', - 'type' => 'string', - 'example' => 'lab2.10.0-ray2.43.0', - ], - 'InferenceEngine' => [ - 'title' => '推理引擎', - 'type' => 'string', - 'example' => 'vLLM', - ], - 'LlmModel' => [ - 'title' => 'LLM模型', - 'type' => 'string', - 'example' => 'Deepseek-R1', - ], - ], - ], - ], - ], - 'StorageMounts' => [ - 'title' => '存储挂载列表', - 'type' => 'array', - 'items' => [ - 'title' => '存储挂载', - 'type' => 'object', - 'properties' => [ - 'StorageId' => [ - 'title' => '存储ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MountPath' => [ - 'title' => '挂载路径', - 'type' => 'string', - 'example' => '/mnt/data01', - ], - ], - ], - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GpuElasticPlan', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Enabled' => [ - 'type' => 'boolean', - ], - 'Rules' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StartCronExpression' => [ - 'type' => 'string', - ], - 'EndCronExpression' => [ - 'type' => 'string', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the default resource group.', 'type' => 'string', 'example' => 'rg-4690g37929****', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', 'type' => 'string', 'example' => 'amv-bp1r053byu48p****', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '202353278****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '805F14E1-0186-520E-A6D5-30188D94E8DA', - ], - ], - ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Create a cluster', + 'description' => 'For the service registration of this service, see [Endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-09-23T08:52:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-17T08:45:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-12T03:04:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-27T02:22:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-24T09:29:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-23T06:30:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-09T03:29:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-28T06:20:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-27T11:22:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-07T06:19:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-03T03:01:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-11T16:52:03.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBCluster'], ], ], - '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.', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateDBCluster', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'adb:DiskEncryption', 'validationType' => 'always'], + ['conditionKey' => 'adb:EnableSSL', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'ModifyDBResourceGroup', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"ResourceGroupId\\": \\"rg-4690g37929****\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\",\\n \\"OrderId\\": \\"202353278****\\"\\n}","type":"json"}]', ], - 'DeleteDBResourceGroup' => [ - 'summary' => 'Deletes a resource group from an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateDBResourceGroup' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6969,541 +3797,391 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '136447', - 'abilityTreeNodes' => [ - 'FEATUREadsYXZ2UA', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '136449', + 'abilityTreeNodes' => ['FEATUREadsYXZ2UA'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'schema' => ['description' => 'The ID of the Dedicated Edition, Basic Edition, or Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ 'name' => 'GroupName', 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n" + .'- The name can be up to 255 characters in length.'."\n" + .'- The name must start with a digit, an uppercase letter, or a lowercase letter.'."\n" + .'- The name can contain digits, uppercase letters, lowercase letters, hyphens (-), and underscores (_).', 'type' => 'string', 'required' => true, 'example' => 'test_group', 'title' => ''], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> You can call the [DescribeDBResourceGroup](~~612410~~) operation to query the information about resource groups of an AnalyticDB for MySQL cluster, including resource group names.'."\n", + 'description' => 'The type of the resource group. Valid values:'."\n" + .'- **Interactive**'."\n" + .'- **Job**'."\n" + .'> For more information about Data Lakehouse Edition resource groups, see [Resource group overview (Data Lakehouse Edition)](~~428610~~).', 'type' => 'string', 'required' => true, - 'example' => 'test_group', + 'docRequired' => true, + 'enum' => [], + 'example' => 'Job', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD3', - ], - ], - ], + [ + 'name' => 'MinComputeResource', + 'in' => 'query', + 'schema' => ['description' => 'The minimum amount of reserved computing resources. Unit: ACUs.'."\n" + .'- If the resource group type is Interactive, the minimum reserved computing resources is 16 ACUs.'."\n" + .'- If the resource group type is Job, the minimum reserved computing resources is 0 ACUs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '0ACU'], ], - ], - '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).', - ], + [ + 'name' => 'MaxComputeResource', + 'in' => 'query', + 'schema' => ['description' => 'The maximum amount of reserved computing resources. Unit: ACUs.'."\n" + .'- If the resource group type is Interactive, the maximum reserved computing resources is the current unallocated resources of the cluster, in increments of 16 ACUs.'."\n" + .'- If the resource group type is Job, the maximum reserved computing resources is the current unallocated resources of the cluster, in increments of 8 ACUs.', 'type' => 'string', 'required' => false, 'example' => '48ACU', 'title' => ''], ], - ], - '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' => 'DeleteDBResourceGroup', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'BindDBResourceGroupWithUser' => [ - 'summary' => 'Associates a resource group with a database account.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => ['description' => 'A reserved parameter (not applicable).', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsYXZ2UA', + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => ['description' => 'A reserved parameter (not applicable).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-'."\n", 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'MaxClusterCount', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1ub9grke1****', - ], + 'schema' => ['description' => 'A reserved parameter (not applicable).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'ClusterMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test'."\n", - ], + 'schema' => ['description' => 'A reserved parameter (not applicable).', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ - 'name' => 'GroupUser', + 'name' => 'EnableSpot', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account. It can be a standard account or a privileged account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'accout'."\n", - ], + 'schema' => ['description' => 'Specifies whether to enable the spot instance feature for the resource group. After the spot instance feature is enabled, the unit price of resources is reduced, but the resources may be released. Only Job resource groups support this feature. Valid values:'."\n" + .'- **True**: enables the spot instance feature.'."\n" + .'- **False**: disables the spot instance feature.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~612393~~) operation to query the region IDs of AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'description' => 'The job routing rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of rules.', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The name of the resource group.'."\n" + .'- The name can be up to 255 characters in length.'."\n" + .'- The name must start with a digit, an uppercase letter, or a lowercase letter.'."\n" + .'- The name can contain digits, uppercase letters, lowercase letters, hyphens (-), and underscores (_).', 'type' => 'string', 'required' => false, 'example' => 'test_group', 'title' => ''], + 'QueryTime' => ['description' => 'The query execution time threshold. Unit: milliseconds (ms).', 'type' => 'string', 'required' => false, 'example' => '180000'."\n", 'title' => ''], + 'TargetGroupName' => ['description' => 'The name of the destination resource group.', 'type' => 'string', 'required' => false, 'example' => 'job'."\n", 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + '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.', - ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => ['description' => 'The database engine. Valid values:'."\n" + ."\n" + .'- **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" + .'- **SparkWarehouse**: the SparkWarehouse engine.', 'type' => 'string', 'required' => false, 'example' => 'SparkWarehouse', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', - 'title' => 'BindDBResourceGroupWithUser', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'UnbindDBResourceGroupWithUser' => [ - 'summary' => 'Disassociates a database account from a resource group of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The engine configuration.', 'type' => 'object', 'required' => false, 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsYXZ2UA', + [ + 'name' => 'AutoStopInterval', + 'in' => 'query', + 'schema' => ['description' => 'The automatic stop interval. Unit: minutes (m).', 'type' => 'string', 'required' => false, 'example' => '5m', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'SpecName', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1ub9grke1****', - ], + 'schema' => ['description' => 'The specification name.', 'type' => 'string', 'required' => false, 'example' => 'ADB.MLLarge.2', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'MinGpuQuantity', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The minimum number of GPUs.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'GroupUser', + 'name' => 'MaxGpuQuantity', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user1', - ], + 'schema' => ['description' => 'The maximum number of GPUs.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'TargetResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the destination resource group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'RayConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The Ray configuration.'."\n" + .'> This parameter is required when the resource group is an AI resource group and the corresponding engine is RayCluster.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", + 'EnableUserEni' => ['description' => 'Specifies whether to enable user ENI connectivity.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + 'HeadSpecType' => [ + 'description' => 'The resource type of the head node.', 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'default' => 'CPU', + 'enum' => ['CPU', 'GPU'], + 'required' => false, + 'example' => 'CPU', + 'title' => '', ], - ], - ], - ], - ], - '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' => 'UnbindDBResourceGroupWithUser', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).', - ], - 'DescribeComputeResourceUsage' => [ - 'summary' => 'Queries the computing resource usage of a resource group in an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'HeadSpec' => ['description' => 'The node specifications of the head node.', 'type' => 'string', 'required' => false, 'example' => 'xlarge', 'title' => ''], + 'HeadAllocateUnit' => ['description' => 'The allocation unit of the head node.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'HeadDiskCapacity' => ['description' => 'The disk size of the head node.', 'type' => 'string', 'required' => false, 'example' => '100G', 'title' => ''], + 'Category' => [ + 'description' => 'The Ray cluster type. Valid values:'."\n" + ."\n" + .'- BASIC: basic type, non-high-availability'."\n" + .'- HIGH_AVAILABILITY: high-availability type', + 'type' => 'string', + 'enum' => ['BASIC', 'HIGH_AVAILABILITY'], + 'required' => false, + 'example' => 'BASIC', + 'title' => '', + ], + 'WorkerGroups' => [ + 'description' => 'The list of Ray worker group configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Ray worker group configuration.', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The name of the worker group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'AllocateUnit' => ['description' => 'The allocation unit.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'MaxWorkerQuantity' => ['description' => 'The maximum number of workers.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'MinWorkerQuantity' => ['description' => 'The minimum number of workers.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'WorkerDiskCapacity' => ['description' => 'The disk size of the worker node.', 'type' => 'string', 'required' => false, 'example' => '100G', 'title' => ''], + 'WorkerSpecName' => ['description' => 'The node specifications of the worker node.', 'type' => 'string', 'required' => false, 'example' => 'xlarge', 'title' => ''], + 'WorkerSpecType' => [ + 'description' => 'The resource type of the worker node.', + 'type' => 'string', + 'enum' => ['CPU', 'GPU'], + 'required' => false, + 'example' => 'GPU', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'UserDefinedRequirements' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'GpuElasticPlan', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1xxxxxxxx47', + 'description' => 'The GPU time-sharing elastic plan.', + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['description' => 'Specifies whether to enable the elastic plan immediately after creation. Valid values:'."\n" + .'- true: enables the elastic plan immediately.'."\n" + .'- false: does not enable the elastic plan.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Rules' => [ + 'description' => 'The list of rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule.', + 'type' => 'object', + 'properties' => [ + 'StartCronExpression' => ['description' => 'The start time as a cron expression. The interval must be at least 1 hour.', 'type' => 'string', 'required' => false, 'example' => '0 0 2 * * ?', 'title' => ''], + 'EndCronExpression' => ['description' => 'The end time as a cron expression. The interval must be at least 1 hour.', 'type' => 'string', 'required' => false, 'example' => '0 0 3 * * ?', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'ScalePolicy', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the resource group.'."\n", + 'description' => 'The scaling policy of the resource group. Valid values:'."\n" + .'- AutoScaling: enables the AutoScaling automatic scaling policy.'."\n" + .'- Disable: disables automatic scaling.'."\n" + .'- MultiCluster: enables the MultiCluster automatic scaling policy.', 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'enum' => ['AutoScaling', 'Disable', 'MultiCluster'], + 'required' => false, + 'example' => 'AutoScaling', + 'title' => '', ], ], [ - 'name' => 'StartTime', + 'name' => 'Classification', 'in' => 'query', 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'description' => 'The classification of the resource group. Valid values:'."\n" + .'- SQL'."\n" + .'- SparkSQL'."\n" + .'- MultiCluster'."\n" + .'- AI', 'type' => 'string', - 'required' => true, - 'example' => '2023-02-04T03:45:00Z', + 'enum' => ['SQL', 'SparkSQL', 'Job', 'AI'], + 'required' => false, + 'example' => 'SQL', + 'title' => '', ], ], [ - 'name' => 'EndTime', + 'name' => 'AtmConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-02-05T03:45:00Z', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'PlainResponse', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", + 'SelectNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'description' => '', 'title' => ''], + 'SelectNodeNum' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], + 'SelectNodeCacheSize' => ['type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => '', 'title' => ''], + 'StorageNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'description' => '', 'title' => ''], + 'StorageNodeNum' => ['type' => 'integer', 'format' => 'int32', 'example' => '2', 'description' => '', 'title' => ''], + 'StorageNodeDiskSize' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], + 'StorageNodeDiskType' => [ 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The queried resource usage.'."\n", - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-clusterxxx', - ], - 'ResourceGroupType' => [ - 'description' => 'The type of the resource group.'."\n", - 'type' => 'string', - 'example' => 'interative', - ], - 'ResourceGroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-24T07:00:00Z', - ], - 'EndTime' => [ - 'description' => 'The end time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-06-07T02:37:00Z', - ], - 'AcuInfo' => [ - 'description' => 'The AnalyticDB compute unit (ACU) usage of the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The resource usage metric. Valid values:'."\n" - ."\n" - .'* `TotalAcuNumber`: the total number of ACUs.'."\n" - .'* `ReservedAcuNumber`: the number of ACUs for the reserved resources.'."\n" - .'* `ReservedAcuUsageNumber`: the number of ACUs for the reserved resources that are used.'."\n", - 'type' => 'string', - 'example' => 'TotalAcuNumber', - ], - 'Values' => [ - 'description' => 'The values of the metric at specific points in time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the metric at a specific point in time.'."\n", - 'type' => 'string', - 'example' => '16.0', - ], - ], - ], - ], - ], - ], + 'example' => 'essd_pl1', + 'enum' => ['essd_pl1', 'essd_pl2'], + 'description' => '', + 'title' => '', ], + 'InsertNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'description' => '', 'title' => ''], + 'InsertNodeNum' => ['type' => 'integer', 'format' => 'int32', 'example' => '2', 'description' => '', 'title' => ''], + 'AuthNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'description' => '', 'title' => ''], + 'AuthNodeNum' => ['type' => 'integer', 'format' => 'int32', 'example' => '2', 'description' => '', 'title' => ''], ], - ], - ], - ], - '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' => 'DescribeComputeResourceUsage', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeUserQuota' => [ - 'summary' => 'Queries available quotas.', - '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' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1qjt3o18d86987', - 'enum' => [], - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0322C7FB-4584-5D2A-BF7F-F9036E940C35', - ], - 'ElasticACU' => [ - 'description' => 'The available elastic AnalyticDB compute units (ACUs).'."\n", - 'type' => 'string', - 'example' => '512ACU', - ], - 'ResourceGroupCount' => [ - 'description' => 'The number of available resource groups.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ReserverdCompteACU' => [ - 'description' => 'The available reserved computing resources.'."\n", - 'type' => 'string', - 'example' => '48ACU', - ], - 'ReserverdStorageACU' => [ - 'description' => 'The available reserved storage resources.'."\n", - 'type' => 'string', - 'example' => '24ACU', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD5'], ], + 'example' => '', ], ], ], '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' => 'InvalidPoolName.Malformed', 'errorMessage' => 'The specified parameter PoolName is not valid.', 'description' => 'The PoolName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolUser.Malformed', 'errorMessage' => 'The specified parameter PoolUser is not valid.', 'description' => 'The PoolUser parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolType.Malformed', 'errorMessage' => 'The specified parameter PoolType is not valid.', 'description' => 'The PoolType parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMinComputeResource.Malformed', 'errorMessage' => 'The specified parameter MinComputeResource is not valid.', 'description' => 'The MinComputeResource parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMaxComputeResource.Malformed', 'errorMessage' => 'The specified parameter MaxComputeResource is not valid.', 'description' => 'The MaxComputeResource parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', 'errorMessage' => 'The state of this resource group does not support this operation.', 'description' => 'This operation is not supported due to the current state of the resource group.'], + ], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Create a resource group', + 'summary' => 'Creates a resource group for a specified Dedicated Edition, Basic Edition, or Data Lakehouse Edition cluster.', + 'description' => 'For information about the service registration of this service, see [Endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-12-02T15:07:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-20T12:54:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-31T12:12:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-15T17:29:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-13T16:32:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-25T02:12:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-26T02:37:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-19T08:51:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-25T10:08:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-13T11:20:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-31T07:03:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:36.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBResourceGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DescribeUserQuota', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD5\\"\\n}","type":"json"}]', ], 'CreateElasticPlan' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7512,1683 +4190,1386 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeNodes' => [ - 'FEATUREadsL7JFYD', - ], + 'abilityTreeNodes' => ['FEATUREadsL7JFYD'], ], 'parameters' => [ [ 'name' => 'ElasticPlanName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the scaling plan.'."\n" - ."\n" - .'> The name must be 2 to 30 characters in length and can contain letters, digits, and underscores (\\_). The name must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the scaling plan.'."\n" + ."\n" + .'> The name must be 2 to 30 characters in length and can contain letters, digits, and underscores (\\_). The name must start with a letter.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ResourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you want to create a scaling plan that uses interactive resource groups, you must specify this parameter. If you want to create a scaling plan that uses elastic I/O units (EIUs), you do not need to specify this parameter.'."\n" - ."\n" - .'* You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the resource group name for a cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you want to create a scaling plan that uses interactive resource groups, you must specify this parameter. If you want to create a scaling plan that uses elastic I/O units (EIUs), you do not need to specify this parameter.'."\n" + ."\n" + .'* You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the resource group name for a cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the scaling plan.'."\n" - ."\n" - .'> Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-01T12:01:00Z', - ], + 'schema' => ['description' => 'The start time of the scaling plan.'."\n" + ."\n" + .'> Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-01-01T12:01:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the scaling plan.'."\n" - ."\n" - .'> Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-01T12:01:00Z', - ], + 'schema' => ['description' => 'The end time of the scaling plan.'."\n" + ."\n" + .'> Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2025-01-01T12:01:00Z', 'title' => ''], ], [ 'name' => 'Enabled', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to immediately enable the scaling plan after the plan is created. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to immediately enable the scaling plan after the plan is created. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'CronExpression', 'in' => 'query', - 'schema' => [ - 'description' => 'A CORN expression that specifies the scaling cycle and time for the scaling plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0 20 14 * * ?', - ], + 'schema' => ['description' => 'A CORN expression that specifies the scaling cycle and time for the scaling plan.'."\n", 'type' => 'string', 'required' => false, 'example' => '0 20 14 * * ?', 'title' => ''], ], [ 'name' => 'TargetSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The desired specifications of elastic resources after scaling.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the scaling plan uses **EIUs** and **Default Proportional Scaling for EIUs** is enabled, you do not need to specify this parameter. In other cases, you must specify this parameter.'."\n" - ."\n" - .'* You can call the [DescribeElasticPlanSpecifications](~~601278~~) operation to query the specifications that are supported for scaling plans.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '32ACU', - ], + 'schema' => ['description' => 'The desired specifications of elastic resources after scaling.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If the scaling plan uses **EIUs** and **Default Proportional Scaling for EIUs** is enabled, you do not need to specify this parameter. In other cases, you must specify this parameter.'."\n" + ."\n" + .'* You can call the [DescribeElasticPlanSpecifications](~~601278~~) operation to query the specifications that are supported for scaling plans.'."\n", 'type' => 'string', 'required' => false, 'example' => '32ACU', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the scaling plan. Valid values:'."\n" - ."\n" - .'* EXECUTOR: the interactive resource group type, which indicates the computing resource type.'."\n" - .'* WORKER: the EIU type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'EXECUTOR', - ], + 'schema' => ['description' => 'The type of the scaling plan. Valid values:'."\n" + ."\n" + .'* EXECUTOR: the interactive resource group type, which indicates the computing resource type.'."\n" + .'* WORKER: the EIU type.'."\n", 'type' => 'string', 'required' => true, 'example' => 'EXECUTOR', 'title' => ''], ], [ 'name' => 'AutoScale', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable **Default Proportional Scaling for EIUs**. Valid values:'."\n" - ."\n" - .'* true. In this case, storage resources are scaled along with computing resources, and the TargetSize and CronExpression parameters are not supported.'."\n" - .'* false'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter must be specified when Type is set to WORKER. This parameter is not required when Type is set to EXECUTOR.'."\n" - ."\n" - .'* You can enable Default Proportional Scaling for EIUs for only a single scaling plan of a cluster.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to enable **Default Proportional Scaling for EIUs**. Valid values:'."\n" + ."\n" + .'* true. In this case, storage resources are scaled along with computing resources, and the TargetSize and CronExpression parameters are not supported.'."\n" + .'* false'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter must be specified when Type is set to WORKER. This parameter is not required when Type is set to EXECUTOR.'."\n" + ."\n" + .'* You can enable Default Proportional Scaling for EIUs for only a single scaling plan of a cluster.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz9509beptiz****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'ACS.ElasticPlan.InvalidEndTime', 'errorMessage' => 'The end time should be later than current time.', 'description' => 'The end time of scheduled scaling must be later than the current time.'], + ['errorCode' => 'ACS.ElasticPlan.NameAlreadyExists', 'errorMessage' => 'The name already exists.', 'description' => 'A scaling plan with the same name exists.'], + ['errorCode' => 'ACS.ElasticPlan.WorkerNotFound', 'errorMessage' => 'Worker not found.', 'description' => 'The cluster cannot have storage scaling plans configured because it does not have reserved storage resources.'], + ['errorCode' => 'ACS.ElasticPlan.AutoWorkerPlanExists', 'errorMessage' => 'Failed to enable the elastic plan. The instance already has an active elastic plan.', 'description' => 'Failed to enable the storage scaling plan because the cluster has another storage scaling plan enabled.'], + ['errorCode' => 'ACS.ElasticPlan.WorkerPlanExists', 'errorMessage' => 'Failed to enable the elastic plan. At least one active elastic plan already exists.', 'description' => 'Failed to enable the storage scaling plan because another storage scaling plan has been enabled.'], + ['errorCode' => 'ACS.ElasticPlan.InvalidStartTimeInterval', 'errorMessage' => 'The start time of this elastic plan is too closed to another one.', 'description' => 'The effective time of the scaling plan is close to that of another scaling plan.'], + ['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.', 'description' => 'Failed to enable the elastic plan. The elastic scaling operation cannot be triggered at the configured time today. Make sure that the configured time is later than the earliest available time (current time plus %s minutes for resource preparation).'], + ['errorCode' => 'ACS.ElasticPlan.InvalidTargetSize', 'errorMessage' => 'Invalid target size.', 'description' => 'The target specification is invalid.'], + ['errorCode' => 'ACS.ElasticPlan.InvalidStartTime', 'errorMessage' => 'Invalid start time.', 'description' => 'The start time of the elastic plan is invalid.'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - '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' => 'CreateElasticPlan', 'summary' => 'Creates a scaling plan for an AnalyticDB for MySQL cluster.', 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeElasticPlans' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-06-30T02:18:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-04-14T08:51:07.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-04-13T11:20:17.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateElasticPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + ], + 'CreateFormationCrawler' => [ + 'summary' => 'Creates a Formation Crawler metadata discovery task in an AnalyticDB for MySQL instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', + 'abilityTreeCode' => '136903', + 'abilityTreeNodes' => ['FEATUREadsQO9FPM'], ], 'parameters' => [ [ - 'name' => 'ElasticPlanName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the scaling plan.'."\n" - ."\n" - .'> If you do not specify this parameter, all scaling plans are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> * If you do not specify this parameter, the scaling plans of all resource groups are queried, covering the interactive resource group type and the elastic I/O unit (EIU) type.'."\n" - .'>* You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the name of a resource group within a cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'Enabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query the scaling plans that are immediately enabled after the plans are created. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '10', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'CrawlerInfo', + 'in' => 'formData', + 'schema' => ['description' => 'The JSON string that contains the complete crawler configuration. This is the most important parameter. For more information about the internal JSON structure, see the CrawlerInfo structure definition section.', 'type' => 'string', 'required' => true, 'example' => '{"sourceType":"OSSWAREHOUSE","dbName":"sales_db","sourceInfo":{"ossSourceInfo":{"sourceMode":"WAREHOUSE","ossLocations":"oss://test-bucket/***/***/","inclusions":[],"exclusions":[]}},"classifiers":"[]","frequency":{"type":"run_on_demand","cron":""},"configuration":"","schemaChangePolicy":{"updateRule":"ONLY_ADD_COLUMN","deleteRule":"IGNORE"}}', 'title' => ''], ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz9509beptiz****', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the scaling plan. Valid values:'."\n" - ."\n" - .'* **EXECUTOR**: the interactive resource group type, which specifies the computing resource type.'."\n" - .'* **WORKER**: the EIU type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'EXECUTOR', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL instance on which the operation is performed.', 'type' => 'string', 'required' => true, 'example' => 'am-bp*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PaginationResponse>', - 'description' => 'PaginationResponse\\'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ElasticPlans' => [ - 'description' => 'The queried scaling plans.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried scaling plan.'."\n", - 'type' => 'object', - 'properties' => [ - 'ElasticPlanName' => [ - 'description' => 'The name of the scaling plan.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The type of the scaling plan. Valid values:'."\n" - ."\n" - .'* **EXECUTOR**: the interactive resource group type, which specifies the computing resource type.'."\n" - .'* **WORKER**: the EIU type.'."\n", - 'type' => 'string', - 'example' => 'EXECUTOR', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the scaling plan is immediately enabled after the plan is created. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ResourceGroupName' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the name of a resource group within a cluster.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'TargetSize' => [ - 'description' => 'The amount of elastic resources after scaling.'."\n", - 'type' => 'string', - 'example' => '32ACU', - ], - 'NextScheduleTime' => [ - 'description' => 'The time when the next scheduling is performed.'."\n" - ."\n" - .'> The time is in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", - 'type' => 'string', - 'example' => '2022-01-01T12:01:00Z', - ], - 'AutoScale' => [ - 'description' => 'Indicates whether **Proportional Default Scaling for EIUs** is enabled. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code. The value 200 indicates a success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request is processed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '019F3BE7-E8FA-3DC5-8EE7-501A90B5A54D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message. The value OK indicates a success.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'TaskId' => ['description' => 'The operation result. The value true indicates that the task is created.', 'type' => 'string', 'example' => '241', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DescribeElasticPlans', - 'summary' => 'Queries scaling plans of an AnalyticDB for MySQL cluster.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 409 => [ + ['errorCode' => 'AlreadyExists', 'errorMessage' => 'The formation task already exists. ', 'description' => ''], + ], + ], + 'title' => 'Create a metadata discovery task', + 'description' => '## Operation description'."\n" + .'- This operation creates a Formation Crawler metadata discovery task in an AnalyticDB for MySQL instance.'."\n" + .'- The created task is not immediately executed. Call `StartFormationCrawler` to start the task.'."\n" + .'- The `CrawlerInfo` parameter is a JSON string that contains the core configuration of the task, such as the destination database name and data source type.'."\n" + .'- Some parameters, such as `classifiers` and `frequency`, require double JSON encoding.'."\n" + .'- The `dbName` value is automatically converted to lowercase by the server.'."\n" + .'- `schemaChangePolicy` is required. You must specify both `updateRule` and `deleteRule`.'."\n" + .'- Use the `RUN_ON_DEMAND` scheduling mode to avoid unnecessary repeated scans.'."\n" + .'- Make sure the product name is `adb` and the endpoint is in the format of `adb.{regionId}.aliyuncs.com`.'."\n" + .'- After the task is created, manually call `StartFormationCrawler` to trigger the first metadata discovery.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"019F3BE7-E8FA-3DC5-8EE7-501A90B5A54D\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\",\\n \\"TaskId\\": \\"241\\"\\n}","type":"json"}]', ], - 'ModifyElasticPlan' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateLakeStorage' => [ + 'summary' => 'Creates a lake storage.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216925', + 'abilityTreeNodes' => ['FEATUREadsQO9FPM'], ], 'parameters' => [ [ - 'name' => 'ElasticPlanName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the scaling plan.'."\n" - ."\n" - .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the scaling plan.'."\n" - ."\n" - .'> Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-01T12:01:00Z', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'RegionId', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the scaling plan.'."\n" - ."\n" - .'> Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-01T12:01:00Z', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The description of the lake storage.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'CronExpression', - 'in' => 'query', - 'schema' => [ - 'description' => 'A CORN expression that specifies the scaling cycle and time for the scaling plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0 20 14 * * ?', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The instance ID of the ADB instance attached to the lake storage.', 'type' => 'string', 'required' => false, 'example' => 'amv-******'], ], [ - 'name' => 'TargetSize', - 'in' => 'query', + 'name' => 'Permissions', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The desired specifications of elastic resources after scaling.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the scaling plan uses **EIUs** and **Default Proportional Scaling for EIUs** is enabled, you do not need to specify this parameter. In other cases, you must specify this parameter.'."\n" - ."\n" - .'* You can call the [DescribeElasticPlanSpecifications](~~601278~~) operation to query the specifications that are supported for scaling plans.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'When lake storage is created, permissions are automatically granted to the Resource Access Management (RAM) users performing the operation and the Alibaba Cloud account. You can increase additional Alibaba Cloud account authorizations here.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The permission item.', + 'type' => 'object', + 'properties' => [ + 'Read' => ['title' => '', 'description' => 'The read permission.', 'type' => 'boolean', 'required' => false, 'example' => '-'], + 'Write' => ['title' => '', 'description' => 'The write permission.', 'type' => 'boolean', 'required' => false, 'example' => '-'], + 'Account' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'pattern' => '^\\d+$', 'default' => '', 'required' => false, 'example' => '-'], + 'Type' => [ + 'title' => '', + 'description' => 'The account type.', + 'type' => 'string', + 'enum' => ['CUSTOMER', 'SUB', 'STS'], + 'required' => false, + 'example' => '-', + ], + ], + 'required' => false, + 'example' => '', + ], 'required' => false, - 'example' => '32ACU', + 'example' => '-', ], ], [ - 'name' => 'DBClusterId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz9509beptiz****', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => '-', 'type' => 'string', 'required' => false, 'example' => '******'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '******'], + 'Message' => ['title' => '', 'description' => 'If the creation operation is implemented asynchronously, a specific JobId is returned.', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The API status or POP error code.', 'type' => 'string', 'example' => 'InvalidInput', 'title' => ''], + 'Data' => ['description' => 'The resource usage details of the cluster.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 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.', 'description' => ''], ], ], - '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' => 'ModifyElasticPlan', - 'summary' => 'Modifies a scaling plan for an AnalyticDB for MySQL cluster.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see Endpoints.'."\n", - ], - 'EnableElasticPlan' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create lake storage', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLakeStorage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateLakeStorageBucket', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'CreateMaterializedViewRecommend' => [ + 'summary' => 'Creates an automatic materialized view recommendation task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsTYGUV3'], ], 'parameters' => [ [ - 'name' => 'ElasticPlanName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the scaling plan.'."\n" - ."\n" - .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-8vbwm***', 'title' => ''], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the recommendation task.', 'type' => 'string', 'required' => true, 'example' => 'task_n1'], + ], + [ + 'name' => 'SchedulingPolicy', + 'in' => 'query', 'schema' => [ - 'description' => 'The cluster ID.'."\n" + 'title' => '', + 'description' => 'The recommendation policy. Valid values:'."\n" ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", + .'daily: scheduled on a daily basis.'."\n" + ."\n" + .'weekly: scheduled on a weekly basis.', 'type' => 'string', 'required' => true, - 'example' => 'amv-wz9509beptiz****', + 'enum' => ['daily', 'weekly'], + 'example' => 'weekly', ], ], + [ + 'name' => 'SchedulingDay', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Valid only when SchedulingPolicy is set to weekly. Valid values:'."\n" + ."\n" + .'- Monday'."\n" + .'- Tuesday'."\n" + .'- Wednesday'."\n" + .'- Thursday'."\n" + .'- Friday'."\n" + .'- Saturday'."\n" + .'- Sunday'."\n" + ."\n" + .'Separate multiple days with commas.', 'type' => 'string', 'required' => false, 'example' => 'Monday;Wednesday'], + ], + [ + 'name' => 'SpecifiedTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The execution time of the task. Format: HH:MM:SS.', 'type' => 'string', 'required' => true, 'example' => '10:00:00'], + ], + [ + 'name' => 'ScanQueriesRange', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The scan time range. Unit: days. Default value: 3.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The description of the recommendation task.', 'type' => 'string', 'required' => false, 'example' => 'task desc'], + ], + [ + 'name' => 'SlowQueryThreshold', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The slow query threshold.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'MinRewriteQueryPattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The minimum number of patterns that can be accelerated.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'MinRewriteQueryCount', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The minimum number of slow queries matched by a pattern.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '3'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], ], + 'example' => '', ], ], ], - '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.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an automatic materialized view recommendation task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMaterializedViewRecommend'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateMaterializedViewRecommend', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'EnableElasticPlan', - 'summary' => 'Enables a scaling plan for an AnalyticDB for MySQL cluster.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'DisableElasticPlan' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateOssSubDirectory' => [ + 'summary' => 'Creates a subdirectory in Object Storage Service (OSS).', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '125729', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ [ - 'name' => 'ElasticPlanName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the scaling plan.'."\n" - ."\n" - .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'name' => 'Path', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The full OSS path of the directory to create.', 'type' => 'string', 'required' => true, 'example' => 'oss://testBucketName/das_lakehouse'], ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz9509beptiz****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'>You can call the [DescribeDBClusters](~~612397~~) operation to query the information about all clusters in a region, including cluster IDs.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp149vz49b36t****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse', - 'description' => 'BaseResponse'."\n", + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3A0DE2E0-A37B-5EE4-9136-C4C473714802', 'title' => ''], + 'Message' => ['description' => 'The additional information about the call result. Valid values:'."\n" + .'- If the request was successful, **Success** is returned. '."\n" + .'- If the request failed, a specific error code is returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'ClientCRC' => ['description' => 'The client CRC check value.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ETag' => ['description' => 'The ETag of the OSS path.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3A0DE2E0-A37B-5EE4-9136-C4C473714802', 'title' => ''], + 'ServerCRC' => ['description' => 'The CRC-64 value of the Alibaba Cloud OSS bucket.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'title' => 'Create an OSS directory', + 'description' => '- Central public endpoint: `adb.aliyuncs.com`.'."\n" + .'- Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- Regional VPC endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.', + 'changeSet' => [ + ['createdAt' => '2024-05-10T06:05:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T08:51:54.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOssSubDirectory'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateOssSubDirectory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DisableElasticPlan', - 'summary' => 'Disables a scaling plan for an AnalyticDB for MySQL cluster.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'DeleteElasticPlan' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreatePerformanceView' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['Perth'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221254', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ElasticPlanName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the scaling plan.'."\n" - ."\n" - .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1ub9grke1****', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the supported regions and zones, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'ViewDetail', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', + 'description' => 'The details of the monitoring dashboard.', + 'type' => 'object', + 'properties' => [ + 'ChartsPerLine' => ['description' => 'The number of charts displayed per row.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'ChartLinked' => ['description' => 'Indicates whether the linkage chart is enabled. Valid values:'."\n" + .'- **true**'."\n" + .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Categories' => [ + 'description' => 'The list of metric categories.', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric category.', + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => 'The name of the metric category. Valid values:'."\n" + .'* **Node**: node resource metrics.'."\n" + .'* **DiskData**: disk metrics.'."\n" + .'* **WorkLoad**: workload metrics.'."\n" + .'* **ResourceGroup**: resource group metrics.', 'type' => 'string', 'required' => false, 'example' => 'Node', 'title' => ''], + 'Keys' => [ + 'description' => 'The list of metrics.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of a single metric.', + 'type' => 'object', + 'properties' => [ + 'KeyName' => ['description' => 'The key of the metric.', 'type' => 'string', 'required' => false, 'example' => 'AnalyticDB_CPU', 'title' => ''], + 'Selected' => ['description' => 'Specifies whether the metric is selected. Valid values:'."\n" + .'- **true**'."\n" + .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => 'amv-wz9509beptiz****', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring dashboard.', 'type' => 'string', 'required' => true, 'example' => 'Custom-All metrics-2 columns-Linked', 'title' => ''], + ], + [ + 'name' => 'CreateFromViewType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the original monitoring dashboard from which the current monitoring dashboard is copied. Valid values:'."\n" + ."\n" + .'- **Basic**: basic dashboard.'."\n" + .'- **Advanced**: advanced dashboard.', 'type' => 'string', 'required' => false, 'example' => 'Basic', 'title' => ''], + ], + [ + 'name' => 'FillOriginViewKeys', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to populate the keys from the original monitoring dashboard when viewing the monitoring dashboard. Valid values:'."\n" + .'- **true**'."\n" + .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', 'title' => ''], + 'CreateStatus' => ['description' => 'The creation result. Valid values:'."\n" + ."\n" + .'- **SUCCESS**: succeeded.'."\n" + .'- **FAILED**: failed.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details of the access denial. This field is returned only when RAM authentication fails.', '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" + .'}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - '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' => 'DeleteElasticPlan', - 'summary' => 'Deletes a scaling plan from an AnalyticDB for MySQL cluster.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeElasticPlanJobs' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a custom monitoring dashboard', + 'summary' => 'Creates a custom monitoring dashboard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePerformanceView'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreatePerformanceView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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"}]', + ], + 'CreateSemanticView' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsTYGUV3'], ], 'parameters' => [ [ - 'name' => 'ElasticPlanName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the scaling plan.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you do not specify this parameter, all scaling plans of the cluster are queried.'."\n" - ."\n" - .'* You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'ADB cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp198m028ih55****'], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you do not specify this parameter, the scaling plans of all resource groups are queried, including the interactive resource group and elastic I/O unit (EIU) types.'."\n" - ."\n" - .'* You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the resource group name for a cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'Schema name.'."\n" + .' '."\n", 'type' => 'string', 'required' => true, 'example' => 'adb_demo'], ], [ - 'name' => 'Status', + 'name' => 'ViewName', 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the scaling plan job. Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* SUCCESSFUL'."\n" - .'* FAILED'."\n" - ."\n" - .'> If you do not specify this parameter, the scaling plans in all states are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESSFUL', - ], + 'schema' => ['title' => '', 'description' => 'Semantic view name.', 'type' => 'string', 'required' => true, 'example' => 'adb_sv_name'], ], [ - 'name' => 'StartTime', + 'name' => 'Definition', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'YAML definition of the semantic view.', 'type' => 'string', 'required' => true, 'example' => 'YAML 内容'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-01T12:01:00Z', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.CatalogAlreadyExist', 'errorMessage' => 'The catalog already exists.', 'description' => 'Catalog already exists'], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ['errorCode' => 'MDS.SemanticViewAlreadyExist', 'errorMessage' => 'The semantic view already exists.', 'description' => 'Semantic view already exists'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + ['errorCode' => 'MDS.InstanceNotExist', 'errorMessage' => 'ADB instance does not exist.', 'description' => 'ADB instance does not exist'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a semantic view', + 'summary' => 'Creates a semantic view.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateSparkTemplate' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '132061', + 'abilityTreeNodes' => ['FEATUREadsCQJTKP'], + ], + 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'maxLength' => 64], + ], + [ + 'name' => 'ParentId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the folder to which the application template belongs.'."\n" + .'> Call the [GetSparkTemplateFolderTree](~~456218~~) operation to query the folder ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '10'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the application template. The name can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'batchfile', 'maxLength' => 64], + ], + [ + 'name' => 'Type', + 'in' => 'formData', 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", + 'title' => '', + 'description' => 'The templatetype of the application template. Valid values:'."\n" + .'- **folder**: folder'."\n" + .'- **file**: application', 'type' => 'string', 'required' => true, - 'example' => 'amv-wz9509beptiz****', + 'example' => 'file', + 'enum' => [], ], ], + [ + 'name' => 'AppType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The templatetype of the application. Valid values:'."\n" + .'- **SQL**: SQL application'."\n" + .'- **STREAMING**: streaming application'."\n" + .'- **BATCH**: batch application'."\n" + ."\n" + .'> You do not need to configure this parameter when the application template type is folder.', 'type' => 'string', 'example' => 'SQL', 'default' => 'UNDEFINED', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PaginationResponse>', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of scaling plan jobs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Jobs' => [ - 'description' => 'The queried scaling plan jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ElasticPlanName' => [ - 'description' => 'The name of the scaling plan.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'description' => 'The state of the scaling plan job. Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* SUCCESSFUL'."\n" - .'* FAILED'."\n", - 'type' => 'string', - 'example' => 'SUCCESSFUL', - ], - 'Type' => [ - 'description' => 'The type of the scaling plan job. Valid values:'."\n" - ."\n" - .'* EXECUTOR: the interactive resource group type, which indicates the computing resource type.'."\n" - .'* WORKER: the EIU type.'."\n", - 'type' => 'string', - 'example' => 'EXECUTOR', - ], - 'ResourceGroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'StartTime' => [ - 'description' => 'The start time of the scaling plan job.'."\n" - ."\n" - .'> The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-01-01T11:01:00Z', - ], - 'EndTime' => [ - 'description' => 'The end time of the scaling plan job.'."\n" - ."\n" - .'> The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-01-01T12:01:00Z', - ], - 'TargetSize' => [ - 'description' => 'The desired specifications of elastic resources after scaling.'."\n", - 'type' => 'string', - 'example' => '32ACU', - ], - 'TotalAcu' => [ - 'description' => 'The total amount of resources.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If Type is set to EXECUTOR, TotalAcu indicates the total amount of computing resources in the current resource group.'."\n" - ."\n" - .'* If Type is set to WORKER, TotalAcu indicates the total amount of storage resources in the cluster.'."\n", - 'type' => 'string', - 'example' => '32ACU', - ], - 'ReserveAcu' => [ - 'description' => 'The amount of reserved resources.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If Type is set to EXECUTOR, ReserveAcu indicates the amount of reserved resources in the current resource group.'."\n" - ."\n" - .'* If Type is set to WORKER, ReserveAcu indicates the total amount of reserved storage resources in the current cluster.'."\n", - 'type' => 'string', - 'example' => '16ACU', - ], - 'ElasticAcu' => [ - 'description' => 'The amount of elastic resources.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If Type is set to EXECUTOR, ElasticAcu indicates the amount of elastic resources in the current resource group.'."\n" - ."\n" - .'* If Type is set to WORKER, ElasticAcu indicates the total amount of elastic storage resources in the current cluster.'."\n", - 'type' => 'string', - 'example' => '16ACU', - ], - 'InstanceSize' => [ - 'description' => 'The number of compute nodes or storage replica sets.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If Type is set to EXECUTOR, InstanceSize indicates the number of compute nodes in the cluster.'."\n" - ."\n" - .'* If Type is set to EXECUTOR, InstanceSize indicates the number of storage replica sets in the cluster.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => [ + 'description' => 'The result of creating the application template.', + 'type' => 'object', + 'properties' => [ + 'Succeeded' => ['title' => '', 'description' => 'Indicates whether the creation is successful. Valid values:'."\n" + .'- **True**: Successful.'."\n" + .'- **False**: Failed.', 'type' => 'boolean', 'example' => 'True'], ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.TemplateFile.BadFileType', 'errorMessage' => 'The requested template %s is not a file.', 'description' => 'The specified template file ID is not of the file type.'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'DescribeElasticPlanJobs', - 'summary' => 'Queries a list of scaling plan jobs for an AnalyticDB for MySQL cluster.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see Endpoints.'."\n", - ], - 'DescribeElasticPlanAttribute' => [ - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'title' => 'Create a spark application template', + 'summary' => 'Creates a Spark application template.', + 'description' => '- Public endpoint of a region: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- VPC endpoint of a region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.'."\n" + .'> If you encounter a 409 fault when sending requests from Hong Kong (China), contact technical support.', + 'changeSet' => [ + ['createdAt' => '2023-06-28T01:10:39.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSparkTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateSparkTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"Succeeded\\": true\\n }\\n}","type":"json"}]', + ], + 'DeleteAccount' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130690', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ - 'name' => 'ElasticPlanName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the scaling plan.'."\n" - ."\n" - .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database account.'."\n" + ."\n" + .'> You can call the [DescribeAccounts](~~612430~~) operation to query the information about database accounts for a cluster, including the account name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_accout', 'title' => ''], + ], + [ + 'name' => 'Engine', 'in' => 'query', 'schema' => [ - 'description' => 'The cluster ID.'."\n" + 'description' => 'The database engine of the cluster. Valid values:'."\n" ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", + .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" + .'* **Clickhouse**: the wide table engine.'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz9509beptiz****', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Clickhouse', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PlainResponse', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'ElasticPlan' => [ - 'description' => 'The queried scaling plan.'."\n", - 'type' => 'object', - 'properties' => [ - 'ElasticPlanName' => [ - 'description' => 'The name of the scaling plan.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The type of the scaling plan.'."\n", - 'type' => 'string', - 'example' => 'EXECUTOR', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the scaling plan is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ResourceGroupName' => [ - 'description' => 'The name of the resource group used by the scaling plan.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'TargetSize' => [ - 'description' => 'The amount of elastic resources after scaling.'."\n", - 'type' => 'string', - 'example' => '32ACU', - ], - 'StartTime' => [ - 'description' => 'The start time of the scaling plan.'."\n" - ."\n" - .'> The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-01-01T12:01:00Z', - ], - 'EndTime' => [ - 'description' => 'The end time of the scaling plan.'."\n" - ."\n" - .'> The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2025-01-01T12:01:00Z', - ], - 'CronExpression' => [ - 'description' => 'A CORN expression that indicates the scaling cycle and time for the scaling plan.'."\n", - 'type' => 'string', - 'example' => '0 20 14 * * ?', - ], - 'AutoScale' => [ - 'description' => 'Indicates whether **Default Proportional Scaling for EIUs** is enabled. Valid values: true: Default Proportional Scaling for EIUs is enabled. If you set this parameter to true, storage resources are scaled along with computing resources. false: Default Proportional Scaling for EIUs is not enabled.'."\n" - ."\n" - .'> You can enable Default Proportional Scaling for EIUs for only a single scaling plan of a cluster. After you enable a scaling plan of the Default Proportional Scaling for EIUs type, you cannot enable scaling plans of other types.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], + 'example' => '', ], ], ], '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.', - ], + 400 => [ + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The AccountName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], ], ], - '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' => 'DescribeElasticPlanAttribute', - 'summary' => 'Queries the information about a scaling plan for an AnalyticDB for MySQL cluster.', + 'title' => 'DeleteAccount', + 'summary' => 'Deletes a database account from an AnalyticDB for MySQL cluster.', 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeElasticPlanSpecifications' => [ - 'summary' => 'Queries the resource specifications that are supported by different types of scaling plans of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-13T13:53:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-31T07:03:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:52:03.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n","errorExample":""}]', + ], + 'DeleteApsDatasoure' => [ + 'summary' => 'Deletes an AnalyticDB Pipeline Service (APS) data source.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', + 'abilityTreeCode' => '168866', + 'abilityTreeNodes' => ['FEATUREadsQO9FPM'], ], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the scaling plan. Valid values:'."\n" - ."\n" - .'* EXECUTOR: the interactive resource group type, which specifies the computing resource type.'."\n" - .'* WORKER: the elastic I/O unit (EIU) type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'EXECUTOR', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-******', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This parameter must be specified only when you query the resource specifications that are supported by an interactive resource group.'."\n" - ."\n" - .'* You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the name of a resource group within a cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz9509beptiz****', - ], + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PaginationResponse>', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Specifications' => [ - 'description' => 'The queried resource specifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried resource specification.'."\n", - 'type' => 'string', - 'example' => '16ACU', - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FAE98A4F-****-****-BF6D-67EEAC9C39DE'], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'string', 'example' => '7', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **True**'."\n" + .'* **False**'."\n", 'type' => 'string', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + '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' => 'DeleteApsDatasoure', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApsDatasoure'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DeleteApsDatasoure', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DescribeElasticPlanSpecifications', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", ], - 'DescribeAuditLogRecords' => [ - 'summary' => 'Queries the SQL audit logs of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteApsJob' => [ + 'summary' => 'Deletes an AnalyticDB Pipeline Service (APS) job.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', + 'operationType' => 'none', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeCode' => '132363', - 'abilityTreeNodes' => [ - 'FEATUREadsGAMOR7', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '183073', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD'], ], 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-t4nj8619bz2w3****', - ], - ], [ 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n" - ."\n" - .'> SQL audit logs can be queried only when SQL audit is enabled. Only SQL audit logs within the last 30 days can be queried. If SQL audit was disabled and re-enabled, only SQL audit logs from the time when SQL audit was re-enabled can be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-08-12T04:17Z', - ], + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-*****', 'title' => ''], ], - [ - 'name' => 'EndTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The end time must be later than the start time.'."\n" - ."\n" - .'* The maximum time range that can be specified is 24 hours.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-08-12T17:08Z', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ApsJobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'aps-*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '****-****-5D14-AC9F-*********', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ErrCode' => ['description' => 'The error code returned when the request fails.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'ErrMessage' => ['description' => 'The error code returned when the request fails.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database on which the SQL statement was executed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], + ], + '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' => 'DeleteApsJob', + 'description' => '* Deleting backup sets is an asynchronous operation and may require 10 to 20 minutes to complete.'."\n" + .'* You can delete up to 100 backup sets at a time. If you want to delete more than 100 backup sets, call this operation twice.'."\n" + .'* To ensure data security, the system forcibly retains one valid backup set. If you want to delete the last backup set, the system prohibits your operation.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApsJob'], ], + ], + 'ramActions' => [ [ - 'name' => 'QueryKeyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword based on which audit logs are queried. You can set this parameter to a value of the STRING type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DeleteApsJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + ], + 'DeleteApsWebhook' => [ + 'summary' => 'Deletes a specific webhook in a specified cluster.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SqlType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the SQL statement. Valid values:'."\n" - ."\n" - .'* **DELETE**'."\n" - .'* **SELECT**'."\n" - .'* **UPDATE**'."\n" - .'* **INSERT INTO SELECT**'."\n" - .'* **ALTER**'."\n" - .'* **DROP**'."\n" - .'* **CREATE**'."\n" - ."\n" - .'> You can query only a single type of SQL statements at a time. If you leave this parameter empty, all types of SQL statements are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsBIVU9O', 'FEATUREadsY28JLD'], + ], + 'parameters' => [ [ - 'name' => 'Succeed', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the execution of the SQL statement succeeds. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-uf63i4ij56b***', 'title' => ''], ], [ - 'name' => 'HostAddress', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address and port number of the client that is used to execute the SQL statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.104.XX.XX:43908', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OrderType', - 'in' => 'query', + 'name' => 'WebhookId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the webhook to be deleted.'."\n", 'type' => 'string', 'required' => true, 'example' => '***1*595*', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The sorting order of the retrieved entries. Valid values:'."\n" - ."\n" - .'* **asc**: sorts the retrieved entries by time in ascending order.'."\n" - .'* **desc**: sorts the retrieved entries by time in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asc', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => 'exampleRequestId'], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'string', 'example' => '[]', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Operation succeeded', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-uf63i4ij56b***'."\n", 'title' => ''], + 'Code' => ['description' => 'API status or POP error code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"exampleRequestId\\",\\n \\"Data\\": \\"[]\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Operation succeeded\\",\\n \\"DBClusterId\\": \\"amv-uf63i4ij56b***\\\\n\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteApsWebhook', + 'description' => 'This API allows users to delete an existing webhook configuration by providing `RegionId`, `DBClusterId`, and `WebhookId`. Make sure that the provided parameter values are accurate to avoid deleting important settings by mistake.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApsWebhook'], + ], + ], + 'ramActions' => [ [ - 'name' => 'User', - 'in' => 'query', - 'schema' => [ - 'description' => 'The username that is used to execute the SQL statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteApsWebhook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteBackups' => [ + 'summary' => 'Manually deletes backup sets.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which to sort the retrieved entries by field. Specify this parameter in the JSON format. The value is an ordered array that uses the order of the input array and contains `Field` and `Type`. Example: `[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]`. Fields:'."\n" - ."\n" - .'* `Field`: the field that is used to sort the retrieved entries. Valid values:'."\n" - ."\n" - .' * **HostAddress**: the IP address of the client that is used to connect to the database.'."\n" - .' * **UserName**: the username.'."\n" - .' * **ExecutionStartTime**: the start time of the query execution.'."\n" - .' * **QueryTime**: the amount of time consumed to execute the SQL statement.'."\n" - .' * **PeakMemoryUsage**: the maximum memory usage when the SQL statement is executed.'."\n" - .' * **ScanRows**: the number of rows to be scanned from a data source in the task.'."\n" - .' * **ScanSize**: the amount of data to be scanned.'."\n" - .' * **ScanTime**: the total amount of time consumed to scan data.'."\n" - .' * **PlanningTime**: the amount of time consumed to generate execution plans.'."\n" - .' * **WallTime**: the accumulated CPU Time values of all operators in the query on each node.'."\n" - .' * **ProcessID**: the process ID.'."\n" - ."\n" - .'* `Type`: the sorting type of the retrieved entries. Valid values:'."\n" - ."\n" - .' * **Desc**: descending order.'."\n" - .' * **Asc**: ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '246050', + 'abilityTreeNodes' => ['FEATUREadsM6VDCK'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **10** (default)'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-uf6g8w25jacm7****', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'BackupIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the backup set that you want to delete. Separate multiple backup set IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '763,764', 'title' => ''], ], [ - 'name' => 'ProxyUser', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'none', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '6974', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8A564B7F-8C00-43C0-8EC5-919FBB70573', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-t4nj8619bz2w3****', - ], - 'Items' => [ - 'description' => 'The queried SQL audit logs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried SQL audit log.'."\n", - 'type' => 'object', - 'properties' => [ - 'HostAddress' => [ - 'description' => 'The IP address and port number of the client that is used to execute the SQL statement.'."\n", - 'type' => 'string', - 'example' => '100.104.XX.XX:43908', - ], - 'Succeed' => [ - 'description' => 'Indicates whether the SQL statement was successfully executed. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'SQLText' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'example' => 'SELECT * FROM adb_hdfs_import_source', - ], - 'TotalTime' => [ - 'description' => 'The amount of time that is consumed to execute the SQL statement. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '216', - ], - 'ConnId' => [ - 'description' => 'The connection ID.'."\n", - 'type' => 'string', - 'example' => '14356****', - ], - 'DBName' => [ - 'description' => 'The name of the database on which the SQL statement was executed.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - 'SQLType' => [ - 'description' => 'The type of the SQL statement.'."\n", - 'type' => 'string', - 'example' => 'SELECT', - ], - 'ExecuteTime' => [ - 'description' => 'The start time of the execution of the SQL statement. The time is displayed in the ISO 8601 standard in the yyyy-MM-dd HH:mm:ss format. The time must be in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-08-12 10:10:00', - ], - 'ExecuteTimestamp' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ProcessID' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'example' => '202106081752021720161662490345362390', - ], - 'User' => [ - 'description' => 'The username that is used to execute the SQL statement.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'HasDiagnosticInfo' => [ - 'type' => 'boolean', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '771C5FAA-530F-52F7-B84D-EBAD4561D590'], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 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.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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' => 'DescribeAuditLogRecords', - 'description' => '* SQL audit logs can be queried only when SQL audit is enabled. Only SQL audit logs within the last 30 days can be queried. If SQL audit was disabled and re-enabled, only SQL audit logs from the time when SQL audit was re-enabled can be queried. The following operations are not recorded in SQL audit logs: **INSERT INTO VALUES**, **REPLACE INTO VALUES**, and **UPSERT INTO VALUES**.'."\n" - .'* For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'ModifyAuditLogConfig' => [ - 'summary' => 'Modifies the SQL audit settings of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteBackups', + 'description' => '* You can delete up to 100 backup sets at a time. If you want to delete more than 100 backup sets, call this operation twice.'."\n" + .'* To ensure data security, the system forcibly retains one valid backup set. If you want to delete the last backup set, the system prohibits your operation.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackups'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteBackups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771C5FAA-530F-52F7-B84D-EBAD4561D590\\"\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + ], + 'DeleteDBCluster' => [ + 'summary' => 'Deletes an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9197,799 +5578,497 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '132366', - 'abilityTreeNodes' => [ - 'FEATUREadsGAMOR7', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-t4nj8619bz2w3****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AuditLogStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status to which you want to change the SQL audit feature. Valid values:'."\n" - ."\n" - .'* **on**'."\n" - .'* **off**'."\n" - ."\n" - .'> After you disable the SQL audit feature, all SQL audit logs are deleted. You must query and export SQL audit logs before you disable SQL audit. For more information, see [DescribeAuditLogRecords](~~612426~~). When you re-enable SQL audit, audit logs that are generated from the time when SQL audit was last enabled are available for queries.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'on', - ], - ], - [ - 'name' => 'EngineType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the compute engine. Valid values:'."\n" - ."\n" - .'* XIHE (**default**)'."\n" - .'* SPARK'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'XIHE', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1r053byu48p****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CDC59E56-BD07-56CA-A05F-B7907DE5C862', - ], - 'UpdateSucceed' => [ - 'description' => 'Indicates whether the status of SQL audit is updated. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp1r053byu48p****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ACS.Cluster.InvalidWorkerState', 'errorMessage' => 'The state of the worker does not support this operation.', 'description' => 'This operation is not supported due to the current state of the storage node.'], + ['errorCode' => 'ACS.Cluster.ElasticPlanJobsExists', 'errorMessage' => 'Operation failed. Ongoing elastic plan jobs exist.', 'description' => 'Failed to perform this operation because a storage scaling plan job is running.'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'DeleteDBCluster', + 'description' => '### [](#)'."\n" + ."\n" + .'* You can delete only pay-as-you-go clusters.'."\n" + .'* The cluster that you want to delete must be in the Running state.'."\n" + .'* For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-04-13T11:20:16.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ['createdAt' => '2022-11-16T06:05:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-03T03:01:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-11T16:51:57.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'ModifyAuditLogConfig', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeSparkAuditLogRecords' => [ - 'summary' => 'Queries the SQL audit logs for a Spark Interactive resource group.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBCluster'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteDBCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'DeleteDBResourceGroup' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235459', - 'abilityTreeNodes' => [ - 'FEATUREadsGAMOR7', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136447', + 'abilityTreeNodes' => ['FEATUREadsYXZ2UA'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can call the [DescribeDBClusters](~~454250~~) operation to query cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1j7******78j8i', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'GroupName', 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~612410~~) operation to query the information about resource groups of an AnalyticDB for MySQL cluster, including resource group names.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_group', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~612293~~) operation to query the available regions and zones, including region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD3'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidPoolName.Malformed', 'errorMessage' => 'The specified parameter PoolName is not valid.', 'description' => 'The PoolName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolUser.Malformed', 'errorMessage' => 'The specified parameter PoolUser is not valid.', 'description' => 'The PoolUser parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.ResourceGroup.ElasticPlanExists', 'errorMessage' => 'This resource group does not support this operation. Elastic plans that have been enabled already exist.', 'description' => 'This operation is not supported for the current resource group because a scaling plan has been enabled.'], + ['errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', 'errorMessage' => 'The state of this resource group does not support this operation.', 'description' => 'This operation is not supported due to the current state of the resource group.'], + ['errorCode' => 'ACS.ResourceGroup.OngoingJobExists', 'errorMessage' => 'Resource group has ongoing job(s).', 'description' => 'The resource group has jobs in progress.'], + ], + ], + 'title' => 'DeleteDBResourceGroup', + 'summary' => 'Deletes a resource group from an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-06-07T16:00:26.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-04-13T11:20:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-31T07:03:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:36.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBResourceGroup'], + ], + ], + 'ramActions' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'Query start time. Format: *yyyy-MM-ddTHH:mmZ* (UTC time).'."\n" - ."\n" - .'> We recommend that you set the query start time to any point in time within 30 days.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2025-09-25T00:00Z', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A94B6C02-7BD4-5D67-9776-3AC8317E8DD3\\n","errorExample":""}]', + ], + 'DeleteElasticPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'Query end time. The end time must be later than the start time, and the interval between them must be less than 1 day. Format: yyyy-MM-ddTHH:mmZ (UTC time).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2025-09-25T01:00Z', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'User', + 'name' => 'ElasticPlanName', 'in' => 'query', - 'schema' => [ - 'description' => 'The username that is used to execute SQL statements.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_user', - ], + 'schema' => ['description' => 'The name of the scaling plan.'."\n" + ."\n" + .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Sort the SQL statements based on specified fields. The format is a JSON array that preserves order, and composite sorting is performed according to the sequence of objects in the array. Each object contains two fields: `Field` and `Type`. For example:`[{"Field":"CreateTime", "Type": "desc" }]`. Where:'."\n" - ."\n" - .'* `Field` specifies the field that is used to sort the SQL statements. Valid values:'."\n" - ."\n" - .' * `ResourceGroupName`: The name of the resource group.'."\n" - .' * `Status` :SQL execution status.'."\n" - .' * `User`: The username that is used to execute the SQL statement.'."\n" - .' * `ExecuteTime`: The start time of SQL execution.'."\n" - .' * `TotalTime`: The amount of time consumed to execute the SQL statement.'."\n" - .' * `ProcessId`: Query ID.'."\n" - .' * `ClientIp`: The source IP address.'."\n" - .' * `StatementSource`: The source from which the query was initiated.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values (case-insensitive):'."\n" - ."\n" - .' * `Desc`: Descending order.'."\n" - .' * `Asc`: Ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"Field\\":\\"ExecuteTime\\",\\"Type\\":\\"Desc\\"}]', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + 'title' => 'DeleteElasticPlan', + 'summary' => 'Deletes a scaling plan from an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-12-12T10:09:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-13T11:20:16.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteElasticPlan'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '30', - 'default' => '10', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + ], + 'DeleteFormationCrawler' => [ + 'summary' => 'Deletes a metadata discovery task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '138243', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], + ], + 'parameters' => [ [ - 'name' => 'ProxyUser', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~143074~~) operation to query available region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group name.'."\n" - ."\n" - .'> You can call the [DescribeDBResourceGroup](~~612410~~) operation to query the resource group ID within a cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_job', - ], + 'name' => 'CrawlerTaskId', + 'in' => 'formData', + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '247', 'title' => ''], ], [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution status of the SQL statement.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cancel: The task is canceled .'."\n" - .'* finished: The execution succeeds .'."\n" - .'* error:The execution fails .'."\n" - .'* timeout: The execution timed out .'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cancel' => '', - 'finish' => '', - 'error' => '', - 'timeout' => '', - ], - 'example' => 'finish', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-8vbc***', 'title' => ''], ], [ - 'name' => 'StatementId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fbd22066-1c03-xxxx-aa16-6ae28288****', - ], + 'name' => 'CrawlerTaskName', + 'in' => 'formData', + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'example' => 'wz_log', 'title' => ''], ], - [ - 'name' => 'TotalTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The duration of the SQL statement. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3000', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the task is deleted. Valid values:'."\n" + .'- true: The task is deleted.'."\n" + .'- false: The task failed to be deleted.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E8DA77FA-FF0F-5516-A551-86C6E2D4BE92', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'InvalidInput', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid. ', 'description' => ''], + ['errorCode' => 'NotExists', 'errorMessage' => 'The formation task does not exist. ', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerStoreError', 'errorMessage' => 'A server storage error occurred.', 'description' => ''], + ], + ], + 'title' => 'Delete a metadata discovery task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E8DA77FA-FF0F-5516-A551-86C6E2D4BE92\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'DeleteLakeStorage' => [ + 'summary' => 'Deletes a lake storage.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SQLText', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword in the SQL statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_name', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '216926', + 'abilityTreeNodes' => ['FEATUREadsQO9FPM'], + ], + 'parameters' => [ [ - 'name' => 'ProcessId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '999f2439-6b10-xxxx-a5d3-daf3b35c****', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'ClientIp', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', - ], + 'name' => 'LakeStorageId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the lake storage.'."\n", 'type' => 'string', 'required' => true, 'example' => '-'], ], [ - 'name' => 'StatementSource', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The source from which the query was initiated.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SQL_EDITOR: SQL_EDITOR.'."\n" - .'* JDBC: JDBC.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SQL_EDITOR' => 'SQL_EDITOR', - 'JDBC' => 'JDBC', - ], - 'example' => 'SQL_EDITOR', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-bp*********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'PageSize' => [ - 'description' => 'The number of entries to return per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2D5867CF-423F-559F-BBB1-199A289E****', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1j7******78j8i', - ], - 'Items' => [ - 'description' => 'The list of SQL audit logs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details.'."\n", - 'type' => 'object', - 'properties' => [ - 'SQLText' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'example' => 'SELECT * FROM adb_hdfs_import_source', - ], - 'TotalTime' => [ - 'description' => 'The duration of the SQL statement. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40000', - ], - 'ExecuteTime' => [ - 'description' => 'The start time of the SQL statement. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-01-23T16:05:08Z', - ], - 'User' => [ - 'description' => 'The username that is used to execute SQL statements.'."\n", - 'type' => 'string', - 'example' => 'test_user', - ], - 'StatementId' => [ - 'description' => 'The ID of the statement.'."\n", - 'type' => 'string', - 'example' => 'fbd22066-1c03-xxxx-aa16-6ae28288****', - ], - 'Status' => [ - 'description' => 'The execution status of the SQL statement.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cancel: The task is canceled .'."\n" - .'* finished: The execution succeeds .'."\n" - .'* error: The execution fails .'."\n" - .'* timeout: The execution of the command timed out.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'cancel' => '', - 'finish' => '', - 'error' => '', - 'timeout' => '', - ], - 'example' => 'finish', - ], - 'ResourceGroupName' => [ - 'description' => 'The resource group name.'."\n", - 'type' => 'string', - 'example' => 'test_job', - ], - 'AppId' => [ - 'description' => 'The Spark application ID.'."\n", - 'type' => 'string', - 'example' => 's202411061011hzc5d6476000****', - ], - 'InnerQueryId' => [ - 'description' => 'The ID of the query executed within the Spark application.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'IsDiagnosable' => [ - 'description' => 'Whether it can be diagnosed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ClientIp' => [ - 'description' => 'The source IP address.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'ProcessId' => [ - 'description' => 'The query ID.'."\n", - 'type' => 'string', - 'example' => '999f2439-6b10-xxxx-a5d3-daf3b35c****', - ], - 'StatementSource' => [ - 'description' => 'The source from which the query was initiated.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SQL_EDITOR: SQL_EDITOR.'."\n" - .'* JDBC: JDBC.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SQL_EDITOR' => 'SQL_EDITOR', - 'JDBC' => 'JDBC', - ], - 'example' => 'SQL_EDITOR', - ], - 'ErrorMsg' => [ - 'description' => 'The SQL execution error message.'."\n", - 'type' => 'string', - 'example' => 'notFoundIp', - ], - 'ErrorTrace' => [ - 'description' => 'The SQL execution error stack trace.'."\n", - 'type' => 'string', - 'example' => 'notFoundIpException', - ], - ], - ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", - '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" - .'}', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2******-B2C1-408E-AA73-DB8D59******'], + 'Message' => ['title' => '', 'description' => 'The returned message. If the operation is asynchronously implemented, the job ID is returned.'."\n", 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the delete operation was successful.'."\n", 'type' => 'string', 'example' => 'True', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 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.', 'description' => ''], ], ], - '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' => 'DescribeSparkAuditLogRecords', - 'description' => 'SQL audit logs can be queried only when SQL audit is enabled. Only SQL audit logs within the last 30 days can be queried. If SQL auditing is turned off midway, when it is re-enabled, you can only query the SQL audit logs generated after it was turned back on.'."\n" - ."\n" - .'> You can query only SQL audit logs that are executed by using Spark Interactive Resource Group.'."\n", - ], - 'DescribeClusterNetInfo' => [ - 'summary' => 'Queries the network information about an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + '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' => 'DeleteLakeStorage', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLakeStorage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteLakeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteMaterializedViewRecommend' => [ + 'summary' => 'Deletes a materialized view recommendation task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '133667', - 'abilityTreeNodes' => [ - 'FEATUREads4DZDZG', - ], + 'abilityTreeNodes' => ['FEATUREadsTYGUV3'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-wz9dqvn0o7****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-uf66*****', 'title' => ''], ], [ - 'name' => 'Engine', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Clickhouse', - ], + 'schema' => ['title' => '', 'description' => 'The name of the recommendation task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'my_task_1'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'ClusterNetworkType' => [ - 'description' => 'The network type of the cluster. Only the Virtual Private Cloud (VPC) network type is supported. **VPC** is returned.'."\n", - 'type' => 'string', - 'example' => 'VPC', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '69A29B65-CD0C-52B1-BE42-8B454569747F', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Address' => [ - 'description' => 'The queried network information about the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The network information about the cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'VSwitchId' => [ - 'description' => 'The vSwitch ID of the cluster.'."\n" - ."\n" - .'> If NetType is set to Public, an empty string is returned.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1syh8vvw8yec****', - ], - 'ConnectionString' => [ - 'description' => 'The endpoint of the cluster.'."\n" - ."\n" - .'* If NetType is set to VPC, the VPC endpoint of the cluster is returned.'."\n" - .'* If NetType is set to Public, the public endpoint of the cluster is returned.'."\n", - 'type' => 'string', - 'example' => 'amv-wz9dqvn0o7****.ads.aliyuncs.com', - ], - 'NetType' => [ - 'description' => 'The network type of the cluster. Valid values:'."\n" - ."\n" - .'* **Public**: Internet.'."\n" - .'* **VPC**: VPC.'."\n", - 'type' => 'string', - 'example' => 'VPC', - ], - 'Port' => [ - 'description' => 'The port number that is used to connect to the cluster. **3306** is returned.'."\n", - 'type' => 'string', - 'example' => '3306', - ], - 'VPCId' => [ - 'description' => 'The VPC ID.'."\n" - ."\n" - .'> If NetType is set to Public, an empty string is returned.'."\n", - 'type' => 'string', - 'example' => 'vpc-8vbhucmd5b****', - ], - 'IPAddress' => [ - 'description' => 'The IP address of the endpoint.'."\n" - ."\n" - .'* If NetType is set to VPC, the private IP address of the cluster is returned.'."\n" - .'* If NetType is set to Public, the public IP address of the cluster is returned.'."\n", - 'type' => 'string', - 'example' => '192.168.xx.xx', - ], - 'ConnectionStringPrefix' => [ - 'description' => 'The prefix of the endpoint.'."\n" - ."\n" - .'* If NetType is set to VPC, the prefix of the VPC endpoint is returned.'."\n" - .'* If NetType is set to Public, the prefix of the public endpoint is returned.'."\n", - 'type' => 'string', - 'example' => 'amv-wz9dqvn0o7****', - ], - 'Ports' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ports' => [ - 'description' => 'The ports.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the port.'."\n", - 'type' => 'object', - 'properties' => [ - 'Port' => [ - 'description' => 'The port.'."\n", - 'type' => 'string', - 'example' => '3306', - ], - 'Protocol' => [ - 'description' => 'The type of the protocol. Valid values:'."\n" - ."\n" - .'* **tcp**'."\n" - .'* **http**'."\n" - .'* **https**'."\n" - .'* **mysql**'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '7B081A85-0568-5E54-82EF-6958C4A3D4B4'], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ACS.InvalidParameter.%s', - 'errorMessage' => 'Parameter %s is invalid.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteMaterializedViewRecommend', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMaterializedViewRecommend'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteMaterializedViewRecommend', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DescribeClusterNetInfo', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B081A85-0568-5E54-82EF-6958C4A3D4B4\\"\\n}","type":"json"}]', ], - 'AllocateClusterPublicConnection' => [ - 'summary' => 'Applies for a public endpoint for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeletePerformanceView' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['Perth'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '131191', - 'abilityTreeNodes' => [ - 'FEATUREads4DZDZG', - ], + 'abilityTreeCode' => '221469', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1z5d2q71is2****', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-uf6wjk5xxxxxxxxxx', 'title' => ''], ], [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The prefix of the public endpoint.'."\n" - ."\n" - .'* The prefix can contain lowercase letters, digits, and hyphens (-). It must start with a lowercase letter.'."\n" - .'* The prefix can be up to 30 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test12', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the supported regions and zones, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Engine', + 'name' => 'ViewName', 'in' => 'query', - 'schema' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AnalyticDB' => 'AnalyticDB', - 'Clickhouse' => 'Clickhouse', - ], - 'example' => 'Clickhouse', - ], + 'schema' => ['description' => 'The name of the monitoring view.', 'type' => 'string', 'required' => true, 'example' => 'Custom-All metrics-2 columns-Linked', 'title' => ''], ], ], 'responses' => [ @@ -9997,93 +6076,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '868EF07F-D0B2-5043-B092-0C14CD00B65A', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'DeleteStatus' => ['description' => 'The deletion result. Valid values:'."\n" + ."\n" + .'- **SUCCESS**: Succeeded.'."\n" + .'- **FAILED**: Failed.', 'type' => 'boolean', 'example' => 'SUCCESS', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n" + .'> This field is returned only when RAM authentication fails.', '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" + .'}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'PerformanceViewNotFound', 'errorMessage' => 'Performance view not found.', 'description' => 'Specified monitoring view name not found'], ], ], - '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' => 'AllocateClusterPublicConnection', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'ReleaseClusterPublicConnection' => [ - 'summary' => 'Releases the public endpoint of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a monitoring view', + 'summary' => 'Deletes a monitoring view.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePerformanceView'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeletePerformanceView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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"}]', + ], + 'DeleteSemanticView' => [ + 'summary' => 'Deletes the specified semantic view.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '131192', - 'abilityTreeNodes' => [ - 'FEATUREads4DZDZG', - ], + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'schema' => ['description' => 'The ID of the ADB cluster.', 'type' => 'string', 'required' => true, 'example' => 'am-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'Engine', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AnalyticDB' => 'AnalyticDB', - 'Clickhouse' => 'Clickhouse', - ], - 'example' => 'Clickhouse', - ], + 'schema' => ['description' => 'The name of the schema.', 'type' => 'string', 'required' => true, 'example' => 'adb_demo', 'title' => ''], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the semantic view.', 'type' => 'string', 'required' => true, 'example' => 'adb_sv_name', 'title' => ''], ], ], 'responses' => [ @@ -10091,38 +6167,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD5', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'MDS.CatalogAlreadyExist', 'errorMessage' => 'The catalog already exists.', 'description' => 'Catalog already exists'], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ['errorCode' => 'MDS.SemanticViewNotExist', 'errorMessage' => 'This semantic view does not exist.', 'description' => 'This semantic view does not exist'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + [ + ['errorCode' => 'MDS.InstanceNotExist', 'errorMessage' => 'ADB instance does not exist.', 'description' => 'ADB instance does not exist'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - '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' => 'ReleaseClusterPublicConnection', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'AttachUserENI' => [ - 'summary' => 'Attaches an elastic network interface (ENI) to an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteSemanticView', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteSparkTemplate' => [ + 'summary' => 'Deletes Spark template files.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10131,26 +6219,26 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsPOF80W', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '132062', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The directory ID or application ID of the template files that you want to delete.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [GetSparkTemplateFullTree](~~612467~~) operation to query the directory ID or application ID.'."\n" + ."\n" + .'* When you specify a directory ID, the directory and all template files that are included in the directory are deleted.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '725204'], + ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-bp11q28kvl688****', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'maxLength' => 64], ], ], 'responses' => [ @@ -10158,64 +6246,121 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Succeeded' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **True**'."\n" + .'* **False**'."\n", 'type' => 'boolean', 'example' => 'True'], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 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.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.KillOperationFailed', 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', 'description' => 'Failed to kill the Spark application. Try again later.'], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.Log.IllegalPath', 'errorMessage' => 'Invalid job log URI: %s.', 'description' => 'The Spark log path is invalid.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.Oss.InternalError', 'errorMessage' => 'An OSS internal error occurred: %s', 'description' => 'OSS internal error. The request failed.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ['errorCode' => 'Spark.TemplateFile.BadFileType', 'errorMessage' => 'The requested template %s is not a file.', 'description' => 'The specified template file ID is not of the file type.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.Log.PodLogNotFound', 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', 'description' => 'Unable to find log [%s] for corresponding pod via podName.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], + ], + 406 => [ + ['errorCode' => 'Spark.App.KillNotAcceptable', 'errorMessage' => 'Can\'t kill the application %s in %s state.', 'description' => 'A Spark application in a non-deletable state cannot be deleted.'], + ], + 500 => [ + ['errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', 'errorMessage' => 'Can\'t load the content from file: %s', 'description' => 'Failed to load the resource file.'], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', - 'title' => 'AttachUserENI', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DetachUserENI' => [ - 'summary' => '解绑用户弹性网卡', - 'methods' => [ - 'post', - 'get', + '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' => 'DeleteSparkTemplate', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-06-28T01:10:39.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSparkTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteSparkTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/template/{#TemplateId}'], + ], + ], + ], ], + ], + 'DeleteSparkTemplateFile' => [ + 'summary' => 'Deletes Spark template files.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsPOF80W', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '123240', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the template file to be deleted.'."\n" + ."\n" + .'> You can call the [GetSparkTemplateFullTree](~~456205~~) operation to query all template file IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '284'], + ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-bp11q28kvl688****', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1y769u11748****', 'maxLength' => 64], ], ], 'responses' => [ @@ -10223,395 +6368,469 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C'], + 'Data' => [ + 'description' => 'The deletion result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Succeeded' => ['description' => 'Indicates whether the template file is deleted. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.KillOperationFailed', 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', 'description' => 'Failed to kill the Spark application. Try again later.'], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Log.IllegalPath', 'errorMessage' => 'Invalid job log URI: %s.', 'description' => 'The Spark log path is invalid.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.Oss.InternalError', 'errorMessage' => 'An OSS internal error occurred: %s', 'description' => 'OSS internal error. The request failed.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ['errorCode' => 'Spark.TemplateFile.BadFileType', 'errorMessage' => 'The requested template %s is not a file.', 'description' => 'The specified template file ID is not of the file type.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.Log.PodLogNotFound', 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', 'description' => 'Unable to find log [%s] for corresponding pod via podName.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], + ], + 406 => [ + ['errorCode' => 'Spark.App.KillNotAcceptable', 'errorMessage' => 'Can\'t kill the application %s in %s state.', 'description' => 'A Spark application in a non-deletable state cannot be deleted.'], + ], + 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ['errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', 'errorMessage' => 'Can\'t load the content from file: %s', 'description' => 'Failed to load the resource file.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', - 'title' => 'DetachUserENI', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).', - ], - 'ModifyUserEniVswitchOptions' => [ - 'summary' => 'Modifies the vSwitches that are connected to elastic network interfaces (ENIs).', - 'path' => '', - 'methods' => [ - 'post', + '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' => 'DeleteSparkTemplateFile', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-06-28T01:10:38.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSparkTemplateFile'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteSparkTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/template/{#TemplateId}'], + ], + ], + ], ], + ], + 'DescribeAPSADBInstances' => [ + 'summary' => 'Queries a list of AnalyticDB for MySQL clusters for AnalyticDB Pipeline Service (APS) federated analytics.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads3N2V5J', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '204210', + 'abilityTreeNodes' => ['FEATUREadsH8FO36'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'DbClusterId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '30', 'title' => ''], ], [ - 'name' => 'VSwitchOptions', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The vSwitches that you want to use. The vSwitches must reside in the same virtual private cloud (VPC) and zone as ENIs. You can specify up to three vSwitches. Separate multiple vSwitches with commas (,).'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The vSwitches that you specify overwrite the existing vSwitches that are connected to ENIs.'."\n" - ."\n" - .'* You can call the [DescribeDBClusterAttribute](~~612399~~) operation to query the network information about ENIs in a cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******'."\n", - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******'], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'Items' => [ + 'description' => 'The queried clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried cluster.', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'am-bp1********', 'title' => ''], + 'DBClusterDescription' => ['description' => 'The description of the cluster.'."\n", 'type' => 'string', 'example' => 'adb_test', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID of the cluster.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'ComputeResource' => ['description' => 'The specifications of the reserved computing resources.'."\n", 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'StorageResource' => ['description' => 'The specifications of the reserved storage resources.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24ACU', 'title' => ''], + 'ReservedACU' => ['description' => 'The amount of remaining reserved computing resources that are available in the cluster.'."\n", 'type' => 'string', 'example' => '24ACU', 'title' => ''], + 'DBClusterStatus' => ['description' => 'The status of the cluster.'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '-', + 'title' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ], ], - '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' => 'ModifyUserEniVswitchOptions', - ], - 'ModifyDBClusterVip' => [ - 'summary' => 'Changes the virtual IP address (VIP) that is used to connect to an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeAPSADBInstances', + 'description' => 'You can call this operation to query the performance data of a cluster over a time range based on performance metrics. The collection granularity is 30 seconds. This operation allows you to query information about slow queries, such as the SQL query duration, number of scanned rows, and amount of scanned data.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAPSADBInstances'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeAPSADBInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeAbnormalPatternDetection' => [ + 'summary' => 'Queries abnormal SQL patterns within a time range.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '212368', - 'abilityTreeNodes' => [ - 'FEATUREads3N2V5J', - ], + 'abilityTreeCode' => '194346', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-2ze8mbuai97*****', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-xxx', 'title' => ''], ], [ - 'name' => 'VPCId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The VPC ID.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The new **VPC** must reside in the same region as the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp1at5ze0t5u3xtqn****', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-zhangjiakou', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The vSwitch ID.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The new vSwitch must reside in the same zone as the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp1aadw9k19x6cis9****', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2021-09-30T00:10Z', 'title' => ''], ], [ - 'name' => 'ConnectString', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The endpoint of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-2ze8mbuai974s4y2500000169.ads.aliyuncs.com', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2024-11-17T02:16Z', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'* **zh** (default): simplified Chinese.'."\n" + .'* **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-****-4A42-BF6D-8A4442913CEF', + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '15', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '19B824E0-690D-5A78-9992-5398C2F43694', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'amv-xxxx', 'title' => ''], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried detection item and detection result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the detection item.', 'type' => 'string', 'example' => 'Cost', 'title' => ''], + 'Results' => [ + 'description' => 'The detection result items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detection result item.'."\n", + 'type' => 'object', + 'properties' => [ + 'PatternId' => ['description' => 'The SQL pattern ID.'."\n", 'type' => 'string', 'example' => '2803084667741875187', 'title' => ''], + 'SQLPattern' => ['description' => 'The SQL statement that represents the SQL pattern.', 'type' => 'string', 'example' => 'SELECT `tsid`nFROM `prod_ods_marketing_engine_material`nWHERE `tsid` = ?nLIMIT ?', 'title' => ''], + 'Detail' => ['description' => 'The description of the detection result.', 'type' => 'string', 'example' => 'Two SQL patterns that have abnormal totalTime metric values are detected. This may cause high CPU usage or slow queries, which affects system stability. Go to the monitoring page and use one-click diagnostics to view details and optimize the queries.', 'title' => ''], + 'RelatedMetrics' => ['description' => 'The metrics related to the SQL pattern.'."\n", 'type' => 'string', 'example' => 'Maximum query duration: 1.43s'."\n" + .'Maximum peak memory: 20.73 MB'."\n" + .'Maximum table read data volume: 10.12 MB', 'title' => ''], + 'User' => ['description' => 'The name of the database account that is used to submit the query.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AccessIp' => ['description' => 'The IP address of the SQL client that submits the SQL pattern.', 'type' => 'string', 'example' => '172.16.133.168', 'title' => ''], + 'Tables' => ['description' => 'The names of tables.', 'type' => 'string', 'example' => 'dw_student_exam.ods_school_queanal', 'title' => ''], + 'QueryCount' => ['description' => 'The number of queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '72', 'title' => ''], + 'FailedCount' => ['description' => 'The number of failed SQL patterns within the time range.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'ACS.ServerError', - 'errorMessage' => 'ADB Cloud Service failed to process your request.', - ], + ], + '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\\": \\"Two SQL patterns that have abnormal totalTime metric values are detected. This may cause high CPU usage or slow queries, which affects system stability. Go to the monitoring page and use one-click diagnostics to view details and optimize the queries.\\",\\n \\"RelatedMetrics\\": \\"Maximum query duration: 1.43s\\\\nMaximum peak memory: 20.73 MB\\\\nMaximum table read data volume: 10.12 MB\\",\\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' => 'DescribeAbnormalPatternDetection', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAbnormalPatternDetection'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAbnormalPatternDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-****-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', - 'title' => 'ModifyDBClusterVip', ], - 'ModifyDBClusterSSL' => [ - 'summary' => 'Modifies the SSL link configuration of a cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeAccountAllPrivileges' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '216076', - 'abilityTreeNodes' => [ - 'FEATUREadsG383TB', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'list', + 'abilityTreeCode' => '162785', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-************', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EnableSSL', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable SSL encryption. Valid values:'."\n" - ."\n" - .'* **true**: enabled'."\n" - .'* **false**: disabled'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The cluster ID for the Enterprise Edition, Basic Edition, or Data Lakehouse Edition.'."\n" + .'The cluster ID for the Data Lakehouse Edition.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp14t95lun0w****', 'title' => ''], ], [ - 'name' => 'ConnectionString', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'The private or public endpoint for which the server certificate needs to be created or updated.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'amv-***********.ads.aliyuncs.com', - ], + 'schema' => ['description' => 'The database account name for the cluster.', 'type' => 'string', 'required' => true, 'example' => 'account1', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Marker', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'If the response is truncated, use the `Marker` value from the response in this field to retrieve the next set of results.', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'BaseResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3BB185E9-BB54-1727-B876-13243E4C0EB5', 'title' => ''], + 'Data' => [ + 'description' => 'Permission details.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'List of permissions.', + 'type' => 'array', + 'items' => [ + 'description' => 'Permission details.', + 'type' => 'object', + 'properties' => [ + 'PrivilegeType' => ['description' => 'The permission level, returned by the `DescribeEnabledPrivileges` operation.', 'type' => 'string', 'example' => 'Global', 'title' => ''], + 'PrivilegeObject' => [ + 'description' => 'The permission object, represented as a trituple of database, table, and column. All fields are empty for Global-level permissions.', + 'type' => 'object', + 'properties' => [ + 'Database' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'tdb1', 'title' => ''], + 'Table' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'table1', 'title' => ''], + 'Column' => ['description' => 'The column name.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'Description' => ['description' => 'Description of the permission object.', 'type' => 'string', 'example' => 'id of table', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Privileges' => [ + 'description' => 'List of permissions.', + 'type' => 'array', + 'items' => ['description' => 'The permission name, consistent with the names returned by the `DescribeEnabledPrivileges` operation.', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Marker' => ['description' => 'If the `Truncated` field in the response is `true`, pass this value in subsequent calls to retrieve the next set of results.', 'type' => 'string', 'example' => '0573e74fd1ccb01739993a691e876074db6e1b6ad79f54115f0e98528432ba6a523cfec5780ade5189299cc3396f6ff7', 'title' => ''], + 'Truncated' => ['description' => 'If the response is truncated, this field is `true`. Continue calling this operation until this field becomes `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'ACS.Account.NotExist', 'errorMessage' => 'The account is not found.', 'description' => 'The specified RAM user does not exist.'], + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => ''], + ['errorCode' => 'ACS.User.NotBindDatabaseAccount', 'errorMessage' => 'The user has not been associated with a database account.', 'description' => 'The user is not associated with the database account.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'DescribeAccountAllPrivileges', + 'summary' => 'Retrieves all permissions granted to a specified account, including permissions at the global, database, table, and column levels.', + 'description' => 'For the endpoint of this service, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2023-12-06T02:33:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-04-20T14:39:17.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-24T06:25:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', - 'title' => 'ModifyDBClusterSSL', - ], - 'DescribeDBClusterSSL' => [ - 'summary' => 'Queries the SSL configurations of a cluster.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountAllPrivileges'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAccountAllPrivileges', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeAccountPrivilegeObjects' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10620,95 +6839,134 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '220651', - 'abilityTreeNodes' => [ - 'FEATUREadsG383TB', - ], + 'abilityTreeCode' => '160215', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~612393~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'ch-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-************', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp1k3wdmt139****', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database account.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'PrivilegeType', + 'in' => 'query', + 'schema' => ['description' => 'The permission level. Valid values: Database, Table, and Column. Global is not supported.', 'type' => 'string', 'required' => false, 'default' => 'Database', 'example' => 'Column', 'title' => ''], + ], + [ + 'name' => 'DatabasePrivilegeObject', + 'in' => 'query', + 'schema' => ['description' => 'The database name that is used to filter databases.', 'type' => 'string', 'required' => false, 'example' => 'database1', 'title' => ''], + ], + [ + 'name' => 'TablePrivilegeObject', + 'in' => 'query', + 'schema' => ['description' => 'The table name that is used to filter tables.', 'type' => 'string', 'required' => false, 'example' => 'table1', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'ColumnPrivilegeObject', + 'in' => 'query', + 'schema' => ['description' => 'The column name that is used to filter columns.', 'type' => 'string', 'required' => false, 'example' => 'col1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => '348303D8-6F42-5141-9B00-A6EECA1E37B6', - ], - 'ExpireTime' => [ - 'description' => 'The validity period of the SSL certificate. Format: yyyy-MM-ddTHH:mm:ssZ(UTC time).'."\n", - 'type' => 'string', - 'example' => '2022-10-11T08:16:43Z', - ], - 'ConnectionString' => [ - 'description' => 'The endpoint that is protected by SSL encryption.'."\n", - 'type' => 'string', - 'example' => 'amv-*********.ads.aliyuncs.com', - ], - 'SSLEnabled' => [ - 'description' => 'Indicates whether SSL encryption is enabled. Default value: true. Valid values:'."\n" - ."\n" - .'* true: enabled'."\n" - .'* false: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '34B2AD29-682F-1C14-B3AA-9EF1A96084B8'], + 'Data' => [ + 'description' => 'The permissions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The permission objects, including the database, table, and column.', + 'type' => 'object', + 'properties' => [ + 'Database' => ['description' => 'The name of the database. This parameter is returned when PrivilegeType is set to Database, Table, or Column.', 'type' => 'string', 'example' => 'tdb1', 'title' => ''], + 'Table' => ['description' => 'The name of the table. This parameter is returned when PrivilegeType is set to Table or Column.', 'type' => 'string', 'example' => 'table1', 'title' => ''], + 'Column' => ['description' => 'The name of the column. This parameter is returned when PrivilegeType is set to Column.', 'type' => 'string', 'example' => 'column1', 'title' => ''], + 'Description' => ['description' => 'The description that is specified when you create a table or column. This parameter is returned only when PrivilegeType is set to Database or Table, indicating the database description or table description.', 'type' => 'string', 'example' => 'a test db', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'ACS.Account.NotExist', 'errorMessage' => 'The account is not found.', 'description' => 'The specified RAM user does not exist.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => ''], + ['errorCode' => 'ACS.User.NotBindDatabaseAccount', 'errorMessage' => 'The user has not been associated with a database account.', 'description' => 'The user is not associated with the database account.'], ], ], - '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' => 'DescribeDBClusterSSL', - ], - 'DownloadInstanceCACertificate' => [ - 'summary' => 'Queries the Object Storage Service (OSS) URL of the downloaded certificate authority (CA) certificate that is used to connect to the wide table engine.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeAccountPrivilegeObjects', + 'summary' => 'Queries the databases, tables, and columns on which a database account has permissions.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2023-12-06T02:33:11.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2023-04-20T14:39:17.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-24T06:25:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountPrivilegeObjects'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAccountPrivilegeObjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeAccountPrivileges' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10717,111 +6975,152 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '208235', - 'abilityTreeNodes' => [ - 'FEATUREads4DZDZG', - ], + 'abilityTreeCode' => '159083', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz9842849v6****', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Lakehouse Edition cluster.'."\n" + .'The ID of the Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp1k5p066e1a****', 'title' => ''], ], [ - 'name' => 'Engine', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Clickhouse', - ], + 'schema' => ['description' => 'The name of the database account whose privileges you want to query.', 'type' => 'string', 'required' => true, 'example' => 'account1', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'PrivilegeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The privilege level to query. To obtain the valid values for this parameter, call the `DescribeEnabledPrivileges` operation.', 'type' => 'string', 'required' => false, 'default' => 'Database', 'example' => 'Global', 'title' => ''], + ], + [ + 'name' => 'DatabasePrivilegeObject', + 'in' => 'query', + 'schema' => ['description' => 'Filters the results by database name. This parameter is used only when `PrivilegeType` is set to `Database`, `Table`, or `Column`.', 'type' => 'string', 'required' => false, 'example' => 'db1', 'title' => ''], + ], + [ + 'name' => 'TablePrivilegeObject', + 'in' => 'query', + 'schema' => ['description' => 'Filters the results by table name. You can use this parameter with `DatabasePrivilegeObject` to refine the search. This parameter is used only when `PrivilegeType` is set to `Table` or `Column`.', 'type' => 'string', 'required' => false, 'example' => 'table1', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start at 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ColumnPrivilegeObject', + 'in' => 'query', + 'schema' => ['description' => 'Filters the results by column name. This parameter is used only when `PrivilegeType` is set to `Column`.', 'type' => 'string', 'required' => false, 'example' => 'col1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF', - ], - 'DownloadUrl' => [ - 'description' => 'The OSS URL of the downloaded certificate.'."\n", - 'type' => 'string', - 'example' => 'https://***/ca.crt', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DA32480A-E3E5-1BE7-BA98-724551DC04C8'], + 'Data' => [ + 'description' => 'A list of privilege details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a privilege.', + 'type' => 'object', + 'properties' => [ + 'PrivilegeType' => ['description' => 'The privilege level. Valid values: `Global`, `Database`, `Table`, and `Column`. The `DescribeEnabledPrivileges` API returns this value.', 'type' => 'string', 'example' => 'Column', 'title' => ''], + 'PrivilegeObject' => [ + 'description' => 'The privilege object, which specifies the database, table, column, and description.', + 'type' => 'object', + 'properties' => [ + 'Database' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'db1', 'title' => ''], + 'Table' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'tabl1', 'title' => ''], + 'Column' => ['description' => 'The column name.', 'type' => 'string', 'example' => 'column1', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'a test column', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Privileges' => [ + 'description' => 'A list of privileges.', + 'type' => 'array', + 'items' => ['description' => 'The privilege name. The `DescribeEnabledPrivileges` API returns this value.', 'type' => 'string', 'example' => 'insert,select', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total count of privileges at the specified privilege level.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. This value matches the `PageNumber` input parameter.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. This value matches the `PageSize` input parameter.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'ACS.Account.NotExist', 'errorMessage' => 'The account is not found.', 'description' => 'The specified RAM user does not exist.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => ''], + ['errorCode' => 'ACS.User.NotBindDatabaseAccount', 'errorMessage' => 'The user has not been associated with a database account.', 'description' => 'The user is not associated with the database account.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'DescribeAccountPrivileges', + 'summary' => 'Retrieves the permissions of a specified database account at a specific level.', + 'description' => 'See [service endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2023-12-06T02:33:11.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2023-04-20T14:39:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-24T06:25:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountPrivileges'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"DownloadUrl\\": \\"https://***/ca.crt\\"\\n}","type":"json"}]', - 'title' => 'DownloadInstanceCACertificate', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAccountPrivileges', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', ], 'DescribeAccounts' => [ - 'summary' => 'Queries the database accounts of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries the database accounts of a cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10834,436 +7133,441 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '131026', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n" - ."\n" - .'> If you do not specify this parameter, the information about all database accounts in the cluster is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_accout', - ], + 'schema' => ['description' => 'The database account.'."\n" + ."\n" + .'> If you do not specify this parameter, information about all database accounts is returned.', 'type' => 'string', 'required' => false, 'example' => 'test_accout', 'title' => ''], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" + 'description' => 'The database engine. Valid values:'."\n" ."\n" - .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", + .'- **AnalyticDB** (default): the AnalyticDB for MySQL engine'."\n" + ."\n" + .'- **Clickhouse**: the LindormTable engine', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [], 'example' => 'Clickhouse', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The list of database accounts.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF'], 'AccountList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBAccount' => [ - 'description' => 'The queried database accounts.'."\n", + 'description' => 'The list of database accounts.', 'type' => 'array', 'items' => [ - 'description' => 'The queried database account.'."\n", + 'description' => 'The details of the account.', 'type' => 'object', 'properties' => [ - 'AccountName' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'example' => 'test_accout', - ], - 'AccountStatus' => [ - 'description' => 'The status of the database account. Valid values:'."\n" - ."\n" - .'* **Creating**'."\n" - .'* **Available**'."\n" - .'* **Deleting**'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'AccountDescription' => [ - 'description' => 'The description of the database account.'."\n", - 'type' => 'string', - 'example' => 'test_accout_des', - ], - 'RamUsers' => [ - 'description' => 'The ID of the Resource Access Management (RAM) user.'."\n", - 'type' => 'string', - 'example' => '1958134230****', - ], - 'AccountType' => [ - 'description' => 'The type of the database account. Valid values:'."\n" - ."\n" - .'* **Normal**: standard account.'."\n" - .'* **Super**: privileged account.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Engine' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* **AnalyticDB**: the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", - 'type' => 'string', - 'example' => 'Clickhouse', - ], + 'AccountName' => ['description' => 'The database account.', 'type' => 'string', 'example' => 'test_accout', 'title' => ''], + 'AccountStatus' => ['description' => 'The status of the account. Valid values:'."\n" + ."\n" + .'- **Creating**: The account is being created.'."\n" + ."\n" + .'- **Available**: The account is active.'."\n" + ."\n" + .'- **Deleting**: The account is being deleted.', 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'AccountDescription' => ['description' => 'The description of the account.', 'type' => 'string', 'example' => 'Test database account', 'title' => ''], + 'RamUsers' => ['description' => 'The ID of the RAM user.', 'type' => 'string', 'example' => '1958134230****', 'title' => ''], + 'AccountType' => ['description' => 'The type of the account. Valid values:'."\n" + ."\n" + .'- **Normal**: standard account.'."\n" + ."\n" + .'- **Super**: privileged account.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Engine' => ['description' => 'The database engine. Valid values:'."\n" + ."\n" + .'- **AnalyticDB**: The AnalyticDB for MySQL engine.'."\n" + ."\n" + .'- **ClickHouse**: The wide-table engine.', 'type' => 'string', 'example' => 'Clickhouse', 'title' => ''], 'RamUserList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RamUserList' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['description' => 'The ID of an attached Alibaba Cloud RAM user.', 'type' => 'string', 'example' => '20732900249392****', 'title' => ''], + 'description' => 'A list of IDs of the attached Alibaba Cloud RAM users.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.Sql.CannotConnect', 'errorMessage' => 'Cannot connect instance which type is %s.', 'description' => 'Cannot connect to a child instance of the given type.'], ], ], - '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":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"AccountList\\": {\\n \\"DBAccount\\": [\\n {\\n \\"AccountName\\": \\"test_accout\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountDescription\\": \\"Test database account\\",\\n \\"RamUsers\\": \\"1958134230****\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"Engine\\": \\"Clickhouse\\",\\n \\"RamUserList\\": {\\n \\"RamUserList\\": [\\n \\"20732900249392****\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeAccounts', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'CreateAccount' => [ - 'summary' => 'Creates a database account for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', + 'description' => 'For the endpoint of this service, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-06-13T13:53:52.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-31T07:03:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccounts'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '130688', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', + 'translator' => 'machine', + ], + 'DescribeAdbMySqlColumns' => [ + 'summary' => 'Queries the information about table columns for an AnalyticDB for MySQL cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AccountName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n" - ."\n" - .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" - .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" - .'* The name must be 2 to 16 characters in length.'."\n" - .'* Reserved account names such as root, admin, and opsadmin cannot be used.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_accout', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1r053byu48p****'], ], [ - 'name' => 'AccountPassword', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the database account.'."\n" - ."\n" - .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" - .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n" - .'* The password must be 8 to 32 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Test_accout1', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'default' => 'INFORMATION_SCHEMA', 'title' => ''], ], [ - 'name' => 'AccountDescription', + 'name' => 'TableName', 'in' => 'query', + 'schema' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'default' => 'COLUMNS', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The description of the account.'."\n" - ."\n" - .'* The description cannot start with `http://` or `https://`.'."\n" - .'* The description can be up to 256 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The message returned for the operation. Valid values:'."\n" + ."\n" + .'* **Success** is returned if the operation is successful.'."\n" + .'* An error message is returned if the operation fails.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A9F013CD-0222-595E-8157-445969B97F03', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* **true**: The operation is successful.'."\n" + .'* **false**: The operation fails.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ColumnCount' => ['description' => 'The total number of columns.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Columns' => [ + 'description' => 'Details of the columns.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The data type of the column.'."\n", 'type' => 'string', 'example' => 'bigint', 'title' => ''], + 'Name' => ['description' => 'The name of the column.'."\n", 'type' => 'string', 'example' => 'id', 'title' => ''], + 'Comment' => ['description' => 'The comments of the column.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'DescribeAdbMySqlColumns', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-11-02T03:45:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlColumns'], + ], + ], + 'ramActions' => [ [ - 'name' => 'AccountType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the database account. Valid values:'."\n" - ."\n" - .'* **Normal**: standard account.'."\n" - .'* **Super**: privileged account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Normal', - 'enum' => [ - 'Super', - 'Normal', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlColumns', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'DescribeAdbMySqlIndexes' => [ + 'summary' => 'Queries the information about table indexes.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'Engine', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Clickhouse', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~612393~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RamUserList', + 'name' => 'DBClusterId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'schema' => ['title' => '', 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-uf6wjk5xxxxxxxxxx'], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tpch_oss', 'default' => 'INFORMATION_SCHEMA', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table.'."\n" + ."\n" + .'> If you leave this parameter empty, the information about all the current tables in the cluster is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'orders', 'default' => 'COLUMNS', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Schema' => ['description' => 'The name of the database.'."\n" + ."\n" + .'**'."\n" + ."\n" + .'****\\'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'IndexCount' => ['description' => 'The number of indexes.````'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Indexes' => [ + 'description' => 'The queried indexes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The index type.'."\n", 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'Name' => ['description' => 'The name of the index.'."\n", 'type' => 'string', 'example' => 'ttl', 'title' => ''], + 'Column' => ['description' => 'The name of the column.'."\n", 'type' => 'string', 'example' => 'preclcu', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', + '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' => 'DescribeAdbMySqlIndexes', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlIndexes'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlIndexes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'CreateAccount', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).', ], - 'DeleteAccount' => [ - 'summary' => 'Deletes a database account from an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAdbMySqlSchemas' => [ + 'summary' => 'Queries a list of databases for an AnalyticDB for MySQL cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '130690', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], - ], - [ - 'name' => 'AccountName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n" - ."\n" - .'> You can call the [DescribeAccounts](~~612430~~) operation to query the information about database accounts for a cluster, including the account name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_accout', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Engine', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Clickhouse', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1r053byu48p****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + 'Message' => ['description' => 'The returned message.'."\n" + ."\n" + .'* If the request was successful, a **success** message is returned.'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Schemas' => [ + 'description' => 'The queried databases.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo,adb_test,mysql', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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 \\"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' => 'DescribeAdbMySqlSchemas', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlSchemas'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlSchemas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'DeleteAccount', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", ], - 'ModifyAccountDescription' => [ - 'summary' => 'Modifies the description of a database account for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAdbMySqlTableMeta' => [ + 'summary' => 'Queries the information about table metadata.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11271,1415 +7575,1260 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '130693', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AccountName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n" - ."\n" - .'> You can call the [DescribeAccounts](~~612430~~) operation to query the information about database accounts of an AnalyticDB for MySQL cluster, including database account names.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-bp11q28kvl688****'], ], [ - 'name' => 'AccountDescription', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the database account.'."\n" - ."\n" - .'* The description cannot start with `http://` or `https://`.'."\n" - .'* The description must be 2 to 256 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AccDesc', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adb_demo', 'title' => ''], ], [ - 'name' => 'Engine', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Clickhouse', - ], + 'schema' => ['description' => 'The name of the table.'."\n" + ."\n" + .'> If you leave this parameter empty, the information about all the current tables in the cluster is returned.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TableMeta' => [ + 'description' => 'The queried table metadata.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableSchema' => ['description' => 'The database to which the table belongs.'."\n", 'type' => 'string', 'example' => 'tpch', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n" + ."\n" + .'**'."\n" + ."\n" + .'****'."\n", 'type' => 'string', 'example' => 'external_supplier', 'title' => ''], + 'TableType' => ['description' => 'The type of the table.'."\n", 'type' => 'string', 'example' => 'fact_table', 'title' => ''], + 'DistributeType' => ['description' => 'The distribution type.'."\n", 'type' => 'string', 'example' => 'hash', 'title' => ''], + 'DistributeColumn' => ['description' => 'The distribution key column.'."\n", 'type' => 'string', 'example' => 'customer_id', 'title' => ''], + 'PartitionType' => ['description' => 'The type of the partition.'."\n", 'type' => 'string', 'example' => 'value', 'title' => ''], + 'PartitionColumn' => ['description' => 'The partition key column.'."\n", 'type' => 'string', 'example' => 'DATE_FORMAT(login_time, \'%Y%m%d\')', 'title' => ''], + 'PrimaryKeyColumn' => ['description' => 'The primary key column.'."\n", 'type' => 'string', 'example' => 'login_time,customer_id,phone_num', 'title' => ''], + 'TableEngine' => ['description' => 'The table engine.'."\n", 'type' => 'string', 'example' => 'XUANWU', 'title' => ''], + 'IsDictEncode' => ['description' => 'Indicates whether dictionary encoding is used.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'IsHidden' => ['description' => 'Indicates whether pages are hidden.'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'IsAllIndex' => ['description' => 'Indicates whether full-column indexes are used.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'IsFullTextDict' => ['description' => 'Indicates whether full-text indexes are used.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the table was created.'."\n", 'type' => 'string', 'example' => '2025-03-14 02:18:08.0', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the table was updated.'."\n", 'type' => 'string', 'example' => '2024-07-25 02:07:23.0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', + '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' => 'DescribeAdbMySqlTableMeta', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlTableMeta'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlTableMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'ModifyAccountDescription', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", ], - 'ResetAccountPassword' => [ - 'summary' => 'Resets the password of a database account for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAdbMySqlTables' => [ + 'summary' => 'Lists information about all tables in a specified database of a cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '130691', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n" - ."\n" - .'> You can call the [DescribeAccounts](~~612430~~) operation to query the information about database accounts of an AnalyticDB for MySQL cluster, including database account names.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_accout', - ], - ], - [ - 'name' => 'AccountPassword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the database account.'."\n" - ."\n" - .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" - .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n" - .'* The password must be 8 to 32 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Test_accout1', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n" + ."\n" + .'> Call the [DescribeRegions](~~454314~~) operation to query the region ID of a cluster.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AccountDescription', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the database account.'."\n" - ."\n" - .'* The description cannot start with `http://` or `https://`.'."\n" - .'* The description must be 2 to 256 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AccDesc', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'amv-bp11q28kvl688****'], ], [ - 'name' => 'Engine', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" - .'* **Clickhouse**: the wide table engine.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Clickhouse', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'default' => 'INFORMATION_SCHEMA', 'example' => 'adb_demo', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'Message' => ['description' => 'Additional information about the call. Valid values:'."\n" + ."\n" + .'- **Success** is returned if the request is successful.'."\n" + ."\n" + .'- A specific error code is returned if the request fails.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7A7D49E3-5585-5DF8-B62C-75C46B4991DC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Schema' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'Tables' => [ + 'description' => 'Information about the tables.', + 'type' => 'array', + 'items' => ['description' => 'The name of the table.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"7A7D49E3-5585-5DF8-B62C-75C46B4991DC\\",\\n \\"Success\\": true,\\n \\"Schema\\": \\"adb_demo\\",\\n \\"Tables\\": [\\n \\"test\\"\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeAdbMySqlTables', + 'description' => '- Public endpoint for a region: `adb..aliyuncs.com`. For example, `adb.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'- VPC endpoint for a region: `adb-vpc..aliyuncs.com`. For example, `adb-vpc.cn-hangzhou.aliyuncs.com`.', + 'changeSet' => [ + ['createdAt' => '2023-11-02T03:45:47.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlTables'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlTables', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'ResetAccountPassword', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'translator' => 'machine', ], - 'CheckBindRamUser' => [ - 'summary' => 'Queries whether a database account of an AnalyticDB for MySQL cluster is associated with a Resource Access Management (RAM) user.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAdviceServiceEnabled' => [ + 'summary' => 'Queries whether the suggestion feature is enabled.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-2ze0vp0j6t3to****', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-wz9842849v6****', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2FB9DCA3-DA56-5B43-A9A0-68E3D0E6AA84', - ], - 'Result' => [ - 'description' => 'The returned result of the request. Valid values:'."\n" - ."\n" - .'* **true**: the database account is associated with a RAM user.'."\n" - .'* **false**: the database account is not associated with a RAM user.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['title' => '', 'description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a **Success** message is returned.'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', 'title' => ''], + 'Result' => ['title' => '', 'description' => 'Indicates whether the suggestion feature is enabled. Valid values:'."\n" + ."\n" + .'* **True**'."\n" + .'* **False**'."\n", 'type' => 'boolean', 'example' => 'False'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'CheckBindRamUser', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'DescribeAdviceServiceEnabled', 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'BindAccount' => [ - 'summary' => 'Associates a standard account of an AnalyticDB for MySQL cluster with a Resource Access Management (RAM) user.', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdviceServiceEnabled'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAdviceServiceEnabled', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeAllDataSource' => [ + 'summary' => 'Queries a list of databases, tables, and columns in an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], + 'abilityTreeCode' => '190495', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz99d9nh532****', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RamUser', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the RAM user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1444832459****', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1pke2pcfavw****', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The standard account of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_accout', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], ], [ - 'name' => 'RamUserList', + 'name' => 'TableName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'schema' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DFF27323-3868-5F8A-917D-5D1D06B6BC0D', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******'], + 'Tables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => 'The queried tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried table.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The logical name of the table.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp1pke2pcfavw****', 'title' => ''], + 'SchemaName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - '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' => 'BindAccount', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'UnbindAccount' => [ - 'summary' => 'Disassociates a standard account of an AnalyticDB for MySQL cluster from a Resource Access Management (RAM) user.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'Columns' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => 'The queried columns.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried column.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The data type of the column.'."\n", 'type' => 'string', 'example' => 'bigint', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the column.'."\n", 'type' => 'string', 'example' => 'id', 'title' => ''], + 'TableName' => ['description' => 'The logical name of the table.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AutoIncrementColumn' => ['description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp1pke2pcfavw****', 'title' => ''], + 'PrimaryKey' => ['description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SchemaName' => ['description' => 'The logical name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Schemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => 'The queried databases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried database.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp1pke2pcfavw****', 'title' => ''], + 'SchemaName' => ['description' => 'The logical name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the 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' => 'DescribeAllDataSource', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:07.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-25T03:37:06.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAllDataSource'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:describeAllDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeAppliedAdvices' => [ + 'summary' => 'Shows applied recommendations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193678', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz99d9nh5****', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-uf6g8w25jacm7****', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n" - ."\n" - .'> You can call the [DescribeAccounts](~~612430~~) operation to query the information about database accounts of an AnalyticDB for MySQL cluster, including database account names.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_accout', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '93E85E5C-C805-5837-8713-05B69A504EE5', - ], - ], - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The start date of the query. The date is in the `yyyyMMdd` format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20220811'], ], - ], - '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.', - ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end date of the query. The date is in the `yyyyMMdd` format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20220824'], ], - ], - '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' => 'UnbindAccount', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'ModifyAccountPrivileges' => [ - 'summary' => 'Modifies the permissions of a database account.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language of the query results. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English'."\n" + ."\n" + .'- **ja**: Japanese'."\n" + ."\n" + .'- **zh-tw**: Traditional Chinese', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '159109', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30** (default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], ], - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The page number. The value must be an integer that is greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DBClusterId', + 'name' => 'AdviceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1k5p066e1a****', - ], + 'schema' => ['description' => 'The type of the advice. Valid values:'."\n" + ."\n" + .'- **INDEX**: index optimization'."\n" + ."\n" + .'- **TIERING**: hot/cold data optimization', 'type' => 'string', 'required' => false, 'example' => 'INDEX', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'account1', - ], + 'schema' => ['description' => 'The keyword for the query. Fuzzy match by table name is supported.', 'type' => 'string', 'required' => false, 'example' => 'you_table_name', 'title' => ''], ], [ - 'name' => 'AccountPrivileges', + 'name' => 'SchemaTableName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The permissions that you want to grant to the database account.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrivilegeObject' => [ - 'description' => 'The objects on which you want to grant permissions, including databases, tables, and columns.'."\n", - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'description' => 'The databases on which you want to grant permissions. This parameter must be specified when the PrivilegeType parameter is set to Database, Table, or Column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tsdb1', - ], - 'Table' => [ - 'description' => 'The tables on which you want to grant permissions. This parameter must be specified when the PrivilegeType parameter is set to Table or Column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table1', - ], - 'Column' => [ - 'description' => 'The columns on which you want to grant permissions. This parameter must be specified when the PrivilegeType parameter is set to Column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - ], - ], - 'required' => false, - ], - 'Privileges' => [ - 'description' => 'The permissions that you want to grant to the database account.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The permission that you want to grant to the database account. You can call the `DescribeEnabledPrivileges` operation to query the permissions that can be granted to the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'select', - ], - 'required' => false, - ], - 'PrivilegeType' => [ - 'description' => 'The permission level that you want to assign to the database account. You can call the `DescribeEnabledPrivileges` operation to query the permission level that can be assigned to the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Global', - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'schema' => ['description' => 'The name of the database and table. Format: **database.table**.', 'type' => 'string', 'required' => false, 'example' => 'tpch.lineitem', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order by which to sort the query results. The value is a JSON string. Example: `[{"Field":"SchemaName","Type":"Asc"}]`. Fields:'."\n" + ."\n" + .'- `Field`: The field by which to sort the results. Valid values:'."\n" + ."\n" + .' - `SchemaName`: the database name'."\n" + ."\n" + .' - `TableName`: the table name'."\n" + ."\n" + .' - `JobStatus`: the status of the build job for the table'."\n" + ."\n" + .' - `SubmitTime`: the time when the advice was submitted'."\n" + ."\n" + .' - `Benefit`: the estimated benefit'."\n" + ."\n" + .'- `Type`: The sort order. Valid values:'."\n" + ."\n" + .' - `Asc`: ascending'."\n" + ."\n" + .' - `Desc`: descending'."\n" + ."\n" + .'> If you do not set this parameter, the query results are sorted by advice submission time in descending order.', 'type' => 'string', 'required' => false, 'example' => '[{\\"Field\\":\\"AdviceType\\",\\"Type\\":\\"Desc\\"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9DD88DE7-824F-1082-AA57-575AFC6517A8', + 'Items' => [ + 'title' => '', + 'description' => 'Details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of advice.', + 'type' => 'object', + 'properties' => [ + 'AdviceId' => ['title' => '', 'description' => 'The advice ID.', 'type' => 'string', 'example' => '7417db9c-914d-43f3-a123-4d0e448f****'], + 'SubmitTime' => ['title' => '', 'description' => 'The time when the advice was submitted. The time is in the `yyMMddHHmm` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2208131600'], + 'SubmitStatus' => ['title' => '', 'description' => 'The submission status of the advice. Valid values:'."\n" + ."\n" + .'- **SUCCEED**: The advice is submitted.'."\n" + ."\n" + .'- **FAILED**: The advice fails to be submitted.', 'type' => 'string', 'example' => 'SUCCEED'], + 'SQL' => ['title' => '', 'description' => 'The SQL statement that is used to apply the advice.', 'type' => 'string', 'example' => 'alter table `schema1`.`table1` drop key col1_1_idx'], + 'RollbackSQL' => ['title' => '', 'description' => 'The SQL statement that is used to roll back the advice.', 'type' => 'string', 'example' => 'alter table `schema1`.`table1` add key col1_1_idx(col1)'], + 'JobStatus' => ['title' => '', 'description' => 'The status of the task that is used to apply the advice. Valid values:'."\n" + ."\n" + .'- **SUCCEED**: The task is successful.'."\n" + ."\n" + .'- **FAILED**: The task has failed.', 'type' => 'string', 'example' => 'SUCCEED'], + 'Benefit' => ['title' => '', 'description' => 'The benefit of the advice.', 'type' => 'string', 'example' => '节省0.4 GB的存储空间'], + 'BuildSQL' => ['title' => '', 'description' => 'The SQL statement of the build task.', 'type' => 'string', 'example' => 'build table `schema1`.`table1`'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned. The value must be an integer that is greater than or equal to 0. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30** (Default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'PageNumber' => ['title' => '', 'description' => 'The page number of the returned page. The value must be an integer that is greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'IndexFields' => ['description' => 'The index fields.', 'type' => 'string', 'example' => 'message', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number of the returned page. The value must be an integer that is greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30** (Default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '84489769-3065-5A28-A4CB-977CD426F1C3', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned. The value must be an integer that is greater than or equal to 0. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SchemaTableNames' => [ + 'description' => 'The concatenated strings of database and table names.', + 'type' => 'array', + 'items' => ['description' => 'The concatenated string of a database name and a table name.', 'type' => 'string', 'example' => '['."\n" + .' "tpch.lineitem",'."\n" + .' "tpch.partsupp",'."\n" + .' "tpch.orders"'."\n" + .']', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - '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.', + '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\\": \\"message\\"\\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' => 'DescribeAppliedAdvices', + 'changeSet' => [ + ['createdAt' => '2025-07-09T06:38:11.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppliedAdvices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAppliedAdvices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DD88DE7-824F-1082-AA57-575AFC6517A8\\"\\n}","type":"json"}]', - 'title' => 'ModifyAccountPrivileges', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'translator' => 'machine', ], - 'DescribeAccountPrivileges' => [ - 'summary' => 'Queries the permissions of a database account on a specified permission level.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeApsActionLogs' => [ + 'summary' => 'Queries the logs of a real-time data ingestion job for an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '159083', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '154388', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1r053byu48p****', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1k5p066e1a****', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'account1', - ], + 'schema' => ['description' => 'The start time of the logs to be queried. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mmZ** format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-02-11T08:30Z', 'title' => ''], ], [ - 'name' => 'PrivilegeType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The permission level that you want to query. You can call the `DescribeEnabledPrivileges` operation to query the permission level of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Global', - 'default' => 'Database', - ], + 'schema' => ['description' => 'The end time of the logs to be queried. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mmZ** format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time. The maximum time range that can be specified is 30 days.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-02-11T09:30Z', 'title' => ''], ], [ - 'name' => 'DatabasePrivilegeObject', + 'name' => 'WorkloadId', 'in' => 'query', - 'schema' => [ - 'description' => 'The databases that you want to query. You can use this parameter to query the permissions of the database account on specific databases. This parameter is available only if the PrivilegeType parameter is set to Database, Table, or Column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'db1', - ], + 'schema' => ['description' => 'The ID of the real-time data ingestion job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-hz109vpvt4fg8528d****', 'title' => ''], ], [ - 'name' => 'TablePrivilegeObject', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The tables that you want to query. You can use this parameter to query the permissions of the database account on specific tables. This parameter can be used together with the DatabasePrivilegeObject parameter. This parameter is available only if the PrivilegeType parameter is set to Table or Column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table1', - ], + 'schema' => ['description' => 'The keyword that you want to use for fuzzy match in the query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'table_test', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Stage', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The phase during which the logs to be queried were generated. Valid values:'."\n" + ."\n" + .'* **StructureMigrate**: schema migration.'."\n" + .'* **FullDataSync**: full data synchronization.'."\n" + .'* **IncrementalSync**: incremental data synchronization.'."\n" + ."\n" + .'> If you do not specify this parameter, logs of all the phases are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FullDataSync', 'title' => ''], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => ['description' => 'The types of the logs. Separate multiple log types with commas (,). Valid values:'."\n" + ."\n" + .'* **INFO**'."\n" + .'* **WARN**'."\n" + .'* **ERROR**'."\n" + ."\n" + .'> If you do not specify this parameter, logs of all types are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INFO,WARN,ERROR', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '30', 'default' => '10', 'title' => ''], ], [ - 'name' => 'ColumnPrivilegeObject', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The columns that you want to query. You can use this parameter to query the permissions of the database account on specific columns. This parameter is available only if the PrivilegeType parameter is set to Column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'col1', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DA32480A-E3E5-1BE7-BA98-724551DC04C8', - ], - 'Data' => [ - 'description' => 'Details of the permissions.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5EDBA27-AF3E-5966-9503-FD1557E19167', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp1r053byu48p****', 'title' => ''], + 'WorkloadId' => ['description' => 'The ID of the real-time data ingestion job.'."\n", 'type' => 'string', 'example' => 'aps-hz109vpvt4fg8528d****', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '3', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'ActionLogs' => [ + 'description' => 'The queried logs.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'PrivilegeType' => [ - 'description' => 'The permission level of the permission. Valid values: `Global`, `Database`, `Table`, and `Column`. You can call the `DescribeEnabledPrivileges` parameter to query the permission level of a specific permission.'."\n", - 'type' => 'string', - 'example' => 'Column', - ], - 'PrivilegeObject' => [ - 'description' => 'The objects on which the permission takes effect, including databases, tables, columns, and additional descriptions.'."\n", - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'db1', - ], - 'Table' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'tabl1', - ], - 'Column' => [ - 'description' => 'The name of the column.'."\n", - 'type' => 'string', - 'example' => 'column1', - ], - 'Description' => [ - 'description' => 'The description of the permission object.'."\n", - 'type' => 'string', - 'example' => 'a test column', - ], - ], - ], - 'Privileges' => [ - 'description' => 'The name of the permission. You can call the `DescribeEnabledPrivileges` operation to query the name of the permission.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'insert,select', - ], - ], + 'Time' => ['description' => 'The time when the log was generated. The time follows the ISO 8601 standard in the **yyyy-MM-ddTHH:mm:ssZ** format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-02-01T05:46:30Z', 'title' => ''], + 'Stage' => ['description' => 'The phase during which the log was generated. Valid values:'."\n" + ."\n" + .'* **StructureMigrate**: schema migration.'."\n" + .'* **FullDataSync**: full data synchronization.'."\n" + .'* **IncrementalSync**: incremental data synchronization.'."\n", 'type' => 'string', 'example' => 'FullDataSync', 'title' => ''], + 'State' => ['description' => 'The type of the log. Multiple log types are separated by commas (,). Valid values:'."\n" + ."\n" + .'* **INFO**'."\n" + .'* **WARN**'."\n" + .'* **ERROR**'."\n", 'type' => 'string', 'example' => 'INFO,WARN,ERROR', 'title' => ''], + 'Context' => ['description' => 'The content of the log.'."\n", 'type' => 'string', 'example' => 'DDL migration job finished', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', + 'AccessDeniedDetail' => [ + 'description' => 'The information about the request denial.'."\n", + '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" + .'}', + 'title' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - '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' => 'DescribeAccountPrivileges', - ], - 'DescribeEnabledPrivileges' => [ - 'summary' => 'Queries the permission level and permissions supported for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'methods' => [ - 'get', + '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' => 'DescribeApsActionLogs', + 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" + .'* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-05-14T08:33:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-24T03:42:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-21T09:28:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-30T02:43:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-01T17:21:16.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsActionLogs'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsActionLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeApsDatasource' => [ + 'summary' => 'Queries the information about an AnalyticDB Pipeline Service (APS) data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '159129', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168878', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD'], ], 'parameters' => [ [ 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp14t95lun0w****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-*******', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n" - ."\n" - .'> You can call the [DescribeAccounts](~~612430~~) operation to query the information about database accounts for a cluster, including the account name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_accout', - ], + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '246F42E0-A475-15FF-96D2-8DC47FC2F289', - ], - 'Data' => [ - 'description' => 'The queried permission level and permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Scope' => [ - 'description' => 'The permission level.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Global', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-**D8-5***-A***-****587'], + 'ApsDatasource' => [ + 'description' => 'The queried APS data source.', + 'type' => 'object', + 'properties' => [ + 'DatasourceName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'kafka-2024***', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the data source was created.'."\n", 'type' => 'string', 'example' => '2024-04-12T15:03:38Z', 'title' => ''], + 'DatasourceType' => ['description' => 'The type of the data source.'."\n", 'type' => 'string', 'example' => 'KAFKA', 'title' => ''], + 'DatasourceDescription' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'SlsInfo' => [ + 'description' => 'The Simple Log Service (SLS) project.'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceRegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Project' => ['description' => 'The name of the SLS project.'."\n", 'type' => 'string', 'example' => '***', 'title' => ''], + 'Store' => ['description' => 'The name of the SLS Logstore.'."\n", 'type' => 'string', 'example' => '***', 'title' => ''], + 'Across' => ['description' => 'Indicates whether the data source is a cross-account resource. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'AcrossUid' => ['description' => 'The cross-account UID.'."\n", 'type' => 'string', 'example' => '123456', 'title' => ''], + 'AcrossRole' => ['description' => 'The name of the cross-account role.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], ], - 'Description' => [ - 'description' => 'The description of the permission level.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', + 'example' => '-', + 'title' => '', + ], + 'KafkaInfo' => [ + 'description' => 'The information about the Kafka instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'KafkaClusterId' => ['description' => 'The ID of the Kafka instance.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'KafkaTopic' => ['description' => 'The topic of the Kafka instance.'."\n", 'type' => 'string', 'example' => '[{\'value\': \'hongxian_test\'}]', 'title' => ''], ], - 'Privileges' => [ - 'description' => 'The queried permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the permission.'."\n", - 'type' => 'string', - 'example' => 'select', - ], - 'Description' => [ - 'description' => 'The description of the permission.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'required' => true, + 'example' => '-', + 'title' => '', + ], + 'HiveInfo' => [ + 'description' => 'The information about the Hive data source.'."\n", + 'type' => 'object', + 'properties' => [ + 'MetaStoreUri' => ['description' => 'The URL of the Hive Metastore.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'Vswitch' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-******', 'title' => ''], + 'SecurityGroup' => ['description' => 'The security group ID.'."\n", 'type' => 'string', 'example' => 'sg-******', 'title' => ''], + 'EmrClusterId' => ['description' => 'The ID of the E-MapReduce (EMR) cluster.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], ], + 'example' => '-', + 'title' => '', + ], + 'RdsMysqlInfo' => [ + 'description' => 'The parameter is no longer supported.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserName' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'RegionId' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'InstanceId' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'ConnectUrl' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'SecurityGroup' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + ], + 'example' => '-', + 'title' => '', + ], + 'PolarDBMysqlInfo' => [ + 'description' => 'The parameter is no longer supported.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserName' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'RegionId' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'InstanceId' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'ConnectUrl' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'SecurityGroup' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'Across' => ['description' => 'The parameter is no longer supported.', 'type' => 'boolean', 'example' => '-', 'title' => ''], + 'AcrossUid' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'AcrossRole' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'example' => '-', 'title' => ''], + ], + 'example' => '-', + 'title' => '', + ], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-******', 'title' => ''], + 'DatabricksInfo' => [ + 'description' => 'The information about Databricks.'."\n", + 'type' => 'object', + 'properties' => [ + 'accessToken' => ['description' => 'The token that is used to access Databricks.'."\n", 'type' => 'string', 'example' => '******', 'title' => ''], + 'workspaceURL' => ['description' => 'The URL of the workspace.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + ], + 'example' => '-', + 'title' => '', ], - 'required' => true, ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - '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' => 'DescribeEnabledPrivileges', - ], - 'DescribeAccountAllPrivileges' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeApsDatasource', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsDatasource'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsDatasource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeApsDatasources' => [ + 'summary' => 'Queries a list of AnalyticDB Pipeline Service (APS) data sources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '162785', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD', 'FEATUREadsCORDM7'], ], 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '30', 'title' => ''], + ], [ 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp14t95lun0w****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-******', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'account1', - ], + 'name' => 'DatasourceType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SLS', 'title' => ''], ], [ - 'name' => 'Marker', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the start position marker from which to return results. If you receive a response indicating that the results are truncated, set this parameter to the value of the `Marker` parameter in the response that you received.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'EXAMPLE', - ], + 'name' => 'DatasourceName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-01-01', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-01-30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResponse', - 'description' => 'BaseResponse', + 'title' => '', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3BB185E9-BB54-1727-B876-13243E4C0EB5', - ], - 'Data' => [ - 'description' => 'Details of the permissions.'."\n", - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => 'The permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrivilegeType' => [ - 'description' => 'The permission level of the database account. You can call the `DescribeEnabledPrivileges` operation to query the permission level of the database account.'."\n", - 'type' => 'string', - 'example' => 'Global', - ], - 'PrivilegeObject' => [ - 'description' => 'The objects on which the permission takes effect, including databases, tables, and columns. If Global is returned for the PrivilegeType parameter, an empty string is returned for this parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'tdb1', - ], - 'Table' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'table1', - ], - 'Column' => [ - 'description' => 'The name of the column.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'Description' => [ - 'description' => 'The description of the permission object.'."\n", - 'type' => 'string', - 'example' => 'id of table', - ], - ], - ], - 'Privileges' => [ - 'description' => 'The name of the permission, which is the same as the permission name returned by the `DescribeEnabledPrivileges` operation.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'select', - ], - ], - ], - ], - ], - 'Marker' => [ - 'description' => 'Indicates the position where the results are truncated. When a value of `true` is returned for the `Truncated` parameter, this parameter is present and contains the value to use for the Marker parameter in a subsequent call.'."\n", - 'type' => 'string', - 'example' => '0573e74fd1ccb01739993a691e876074db6e1b6ad79f54115f0e98528432ba6a523cfec5780ade5189299cc3396f6ff7', - ], - 'Truncated' => [ - 'description' => 'Indicates whether the results are truncated. If the results are truncated, a value of `true` is returned. In this case, you must call this operation again to obtain all the results until a value of `false` is returned for this parameter.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-5213-******-B608-******'], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'ApsDatasources' => [ + 'description' => 'The queried APS data sources.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasourceName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the data source was created.'."\n", 'type' => 'string', 'example' => '2024-01-10 14:44:33', 'title' => ''], + 'DatasourceType' => ['description' => 'The type of the data source.'."\n", 'type' => 'string', 'example' => 'SLS', 'title' => ''], + 'DatasourceDescription' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DatasourceId' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'HasJob' => ['description' => 'Indicates whether a job is using the data source.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'example' => '-', + 'description' => 'The queried APS data source.', + 'title' => '', ], + 'example' => '-', + 'title' => '', ], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - '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' => 'DescribeAccountAllPrivileges', - 'summary' => 'Queries the permissions of a database account on all permission levels.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).', - ], - 'DescribeAccountPrivilegeObjects' => [ - 'summary' => 'Queries the databases, tables, and columns on which a database account has permissions.', - 'methods' => [ - 'post', + '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' => 'DescribeApsDatasources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsDatasources'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsDatasources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeApsHiveWorkload' => [ + 'summary' => 'Queries the information about an AnalyticDB Pipeline Service (APS) job from a Hive data source.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '160215', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '170284', + 'abilityTreeNodes' => ['FEATUREadsBIVU9O'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ch-hangzhou', - ], - ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1k3wdmt139****', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'PrivilegeType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The permission level. Valid values: Database, Table, and Column. Global is not supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Column', - 'default' => 'Database', - ], - ], - [ - 'name' => 'DatabasePrivilegeObject', - 'in' => 'query', - 'schema' => [ - 'description' => 'The database name that is used to filter databases.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database1', - ], - ], - [ - 'name' => 'TablePrivilegeObject', - 'in' => 'query', - 'schema' => [ - 'description' => 'The table name that is used to filter tables.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table1', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-*******', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-******', 'title' => ''], ], [ - 'name' => 'ColumnPrivilegeObject', - 'in' => 'query', - 'schema' => [ - 'description' => 'The column name that is used to filter columns.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'col1', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34B2AD29-682F-1C14-B3AA-9EF1A96084B8', - ], - 'Data' => [ - 'description' => 'The permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The permission objects, including the database, table, and column.'."\n", - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'description' => 'The name of the database. This parameter is returned when PrivilegeType is set to Database, Table, or Column.'."\n", - 'type' => 'string', - 'example' => 'tdb1', - ], - 'Table' => [ - 'description' => 'The name of the table. This parameter is returned when PrivilegeType is set to Table or Column.'."\n", - 'type' => 'string', - 'example' => 'table1', - ], - 'Column' => [ - 'description' => 'The name of the column. This parameter is returned when PrivilegeType is set to Column.'."\n", - 'type' => 'string', - 'example' => 'column1', - ], - 'Description' => [ - 'description' => 'The description that is specified when you create a table or column. This parameter is returned only when PrivilegeType is set to Database or Table, indicating the database description or table description.'."\n", - 'type' => 'string', - 'example' => 'a test db', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '86F92D26-B774-5FA1-8E53-******'], + 'ApsWorkload' => [ + 'description' => 'The queried job.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-*******', 'title' => ''], + 'WorkloadId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'aps-******', 'title' => ''], + 'WorkloadName' => ['description' => 'The name of the workload.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ResourceGroup' => ['description' => 'The resource group to which the SQL statement belongs.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'FullComputeUnit' => ['description' => 'The number of AnalyticDB compute units (ACUs) required for migration.'."\n", 'type' => 'string', 'example' => '16', 'title' => ''], + 'SyncAllowExpression' => ['description' => 'The expression that manually matches the source database table whitelist.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'SyncDenyExpression' => ['description' => 'Manually match the blacklist expressions for source database tables.'."\n", 'type' => 'string', 'example' => 'def', 'title' => ''], + 'TargetType' => ['description' => 'The destination type.'."\n", 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'OssLocation' => ['description' => 'The Object Storage Service (OSS) URL of the AnalyticDB for MySQL cluster data.'."\n", 'type' => 'string', 'example' => 'oss://******', 'title' => ''], + 'ConflictStrategy' => ['description' => 'The policy to handle tables with the same name in the destination cluster.'."\n", 'type' => 'string', 'example' => 'Intercept', 'title' => ''], + 'AdvancedConfig' => ['description' => 'The advanced configurations.'."\n", 'type' => 'string', 'example' => 'test.adv.config=value', 'title' => ''], + 'DatasourceId' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + 'DatasourceName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'sls-******', 'title' => ''], + 'Parallelism' => ['description' => 'The number of tasks that are allowed in parallel.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'WorkloadTypeName' => ['description' => 'The name of the workload.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'State' => ['description' => 'The status of the workload.'."\n", 'type' => 'string', 'example' => 'COMPLETED', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the workload was created.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'MetaStoreUri' => ['description' => 'The URL of the Hive Metastore.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'Vswitch' => ['description' => 'The name of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-******', 'title' => ''], + 'EmrClusterId' => ['description' => 'The ID of the E-MapReduce (EMR) cluster.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], ], - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', + 'example' => '-', + 'title' => '', ], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - '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' => 'DescribeAccountPrivilegeObjects', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeOperatorPermission' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeApsHiveWorkload', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsHiveWorkload'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsHiveWorkload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeApsJobDetail' => [ + 'summary' => 'Queries the information about an AnalyticDB Pipeline Service (APS) job.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12688,235 +8837,328 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '214554', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '180625', + 'abilityTreeNodes' => ['FEATUREadsH8FO36'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-uf6wjk5xxxxxxxxxx', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'CreatedTime' => [ - 'description' => 'The time when the permissions take effect.'."\n", - 'type' => 'string', - 'example' => '2024-02-25T03:35:02Z', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Privileges' => [ - 'description' => 'The queried permissions.'."\n", - 'type' => 'string', - 'example' => 'Control,Data', - ], - 'ExpiredTime' => [ - 'description' => 'The time when the permissions expire.'."\n", - 'type' => 'string', - 'example' => '2024-01-10T02:19:00Z', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-uf6wjk5xxxxxxxxxx', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-E606-4A42-BF6D-******'], + 'APSJobDetail' => [ + 'description' => 'The queried job.'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceEndpointRegion' => ['description' => 'The region of the source instance.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'SourceEndpointInstanceID' => ['description' => 'The ID of the source instance.'."\n", 'type' => 'string', 'example' => 'pc-*******', 'title' => ''], + 'DestinationEndpointRegion' => ['description' => 'The region of the destination cluster.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'DestinationEndpointInstanceID' => ['description' => 'The ID of the destination cluster.'."\n", 'type' => 'string', 'example' => 'amv-******', 'title' => ''], + 'PartitionList' => ['description' => 'The partitions.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], + 'DbList' => ['description' => 'The objects that are synchronized.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], + 'TargetTableMode' => ['description' => 'The mode of the destination table.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'Status' => ['description' => 'The status of the job.'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + ], + 'example' => '-', + 'title' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - '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' => 'DescribeOperatorPermission', - 'summary' => 'Queries the service account permissions of an AnalyticDB for MySQL cluster.', - ], - 'RevokeOperatorPermission' => [ - 'summary' => 'Revokes permissions from the service account of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ], + ], + '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' => 'DescribeApsJobDetail', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsJobDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsJobDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeApsJobs' => [ + 'summary' => 'Queries a list of AnalyticDB Pipeline Service (APS) jobs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '214578', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '180030', + 'abilityTreeNodes' => ['FEATUREadsH8FO36'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1mfe9qmsw1dzyg', - ], + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'formData', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-03-23T01:10Z', 'title' => ''], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-04-23T01:10Z', 'title' => ''], + ], + [ + 'name' => 'ApsJobName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the APS job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aps-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-7F9D-5DBD-993E-******'], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'APSJobs' => [ + 'description' => 'The queried APS jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried APS job.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the APS job.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'ApsJobName' => ['description' => 'The name of the APS job.'."\n", 'type' => 'string', 'example' => 'data-sync-******', 'title' => ''], + 'DestinationInstanceID' => ['description' => 'The destination cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-*******', 'title' => ''], + 'SourceInstanceID' => ['description' => 'The ID of the source instance or cluster.'."\n", 'type' => 'string', 'example' => 'pc-******', 'title' => ''], + 'Delay' => ['description' => 'The synchronization latency.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the APS job was created.'."\n", 'type' => 'string', 'example' => '2022-06-28 15:00:04', 'title' => ''], + 'Projress' => ['description' => 'The progress.'."\n", 'type' => 'string', 'example' => '30: progress 30%', 'title' => ''], + 'ApsJobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'aps-******', 'title' => ''], + 'SubStatus' => ['description' => 'The status of the task.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'example' => '-', + 'title' => '', + ], + 'example' => '-', + 'title' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The status code. A value of 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'ok', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RelatedTaskNotFinish', - 'errorMessage' => 'The related task does not finish.', - ], + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', - 'title' => 'RevokeOperatorPermission', - ], - 'GrantOperatorPermission' => [ - 'summary' => 'Grants permissions to the service account of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + '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: progress 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' => 'DescribeApsJobs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsJobs'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeApsJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeApsMigrationWorkloads' => [ + 'summary' => 'Queries the workloads of AnalyticDB Pipeline Service (APS) migration jobs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '214575', - 'abilityTreeNodes' => [ - 'FEATUREadsF4WPVU', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '30', 'title' => ''], + ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1565u55p32****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-*******', 'title' => ''], ], [ - 'name' => 'ExpiredTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The expiration time of the service account permissions. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-11-30T00:00:00Z', - ], + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workload.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Privileges', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the permissions. Valid values:'."\n" - ."\n" - .'* **Control**: the configuration permissions. The service account is granted the permissions to query and modify cluster configurations.'."\n" - .'* **Data**: the data permissions. The service account is granted the permissions to query schemas, indexes, and SQL statements.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'Control' => 'Control', - 'Data' => 'Data', - ], - 'example' => 'Control', - ], + 'name' => 'OssLocation', + 'in' => 'formData', + 'schema' => ['description' => 'The Object Storage Service (OSS) URL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://******', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start of the time range to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-06-20T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-07-20T16:00:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A438072A-E2E7-5509-9A3F-66293512A820', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-57F0-9F06-******', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MigrationWorkloads' => [ + 'description' => 'The queried migration workloads.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => ['description' => 'The time when the migration job was modified.'."\n", 'type' => 'string', 'example' => '2021-06-21T02:15:16Z', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the job was created.'."\n", 'type' => 'string', 'example' => '2021-06-21T02:15:16Z', 'title' => ''], + 'Id' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'State' => ['description' => 'The status.'."\n", 'type' => 'string', 'example' => 'COMPLETED', 'title' => ''], + 'OssLocation' => ['description' => 'The OSS URL.'."\n", 'type' => 'string', 'example' => 'oss://******', 'title' => ''], + 'TargetType' => ['description' => 'The destination type.'."\n", 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'WorkloadSubType' => ['description' => 'The sub-type of the workload.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Name' => ['description' => 'The name of the workload.'."\n", 'type' => 'string', 'example' => 'TEST-001', 'title' => ''], + 'AcuCount' => ['description' => 'The number of AnalyticDB compute units (ACUs).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '-', 'title' => ''], + 'MaxRT' => ['description' => 'The maximum response time.'."\n", 'type' => 'string', 'example' => '1000', 'title' => ''], + 'FailedMsg' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + ], + 'description' => 'The queried migration workloads.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RelatedTaskNotFinish', - 'errorMessage' => 'The related task does not finish.', - ], + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A438072A-E2E7-5509-9A3F-66293512A820\\"\\n}","type":"json"}]', - 'title' => 'GrantOperatorPermission', - ], - 'DescribeBackupPolicy' => [ - 'summary' => '查看集群备份设置', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeApsMigrationWorkloads', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsMigrationWorkloads'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeApsMigrationWorkloads', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeApsProgress' => [ + 'summary' => 'Queries the progress of an AnalyticDB Pipeline Service (APS) job.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12925,26 +9167,27 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsM6VDCK', - ], + 'abilityTreeCode' => '171313', + 'abilityTreeNodes' => ['FEATUREadsH8FO36'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-uf6s7oa710rbu0x3b', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-******', 'title' => ''], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-******', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -12952,241 +9195,218 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PreferredBackupPeriod' => [ - 'description' => 'The cycle based on which backups are performed. If more than one day of the week is specified, the days of the week are separated by commas (,). Valid value:'."\n" - ."\n" - .'* Monday'."\n" - .'* Tuesday'."\n" - .'* Wednesday'."\n" - .'* Thursday'."\n" - .'* Friday'."\n" - .'* Saturday'."\n" - .'* Sunday', - 'type' => 'string', - 'example' => 'Wednesday,Saturday', - ], - 'LogBackupRetentionPeriod' => [ - 'description' => 'The number of days for which the log backup files are retained.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'PreferredBackupTime' => [ - 'description' => 'The data backup time. The time is in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '15:00Z-16:00Z', - ], - 'EnableBackupLog' => [ - 'description' => 'Indicates whether log backup is enabled. Valid values:'."\n" - ."\n" - .'* **Enable**'."\n" - .'* **Disable**'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'BackupRetentionPeriod' => [ - 'description' => 'The number of days for which data backup files are retained.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-******-9F06-******', 'title' => ''], + 'TotalTableCount' => ['description' => 'The total number of tables to be migrated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'SuccessTableCount' => ['description' => 'The total number of migrated tables returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'SuccessPercentage' => ['description' => 'The success rate.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'ApsHiveProgress' => [ + 'description' => 'The migration progress.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DbName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TbName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Progress' => ['description' => 'The migration progress.'."\n", 'type' => 'string', 'example' => '95', 'title' => ''], + 'Speed' => ['description' => 'The migration speed.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'example' => '-', + 'description' => '', + 'title' => '', + ], + 'example' => '-', + 'title' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - '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' => 'DescribeBackupPolicy', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).', - ], - 'ModifyBackupPolicy' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeApsProgress', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsProgress'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsProgress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeApsResourceGroups' => [ + 'summary' => 'Retrieves details about the resource groups used for data synchronization.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '155194', - 'abilityTreeNodes' => [ - 'FEATUREadsM6VDCK', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146751', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-bp1xxxxxxxx47', - ], - ], - [ - 'name' => 'PreferredBackupTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time to perform a full backup. Specify the time in the HH:mmZ-HH:mmZ format. The time must be in UTC.'."\n" - ."\n" - .'> The time range must be 1 hour.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '18:00Z-19:00Z', - ], - ], - [ - 'name' => 'PreferredBackupPeriod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The days of the week on which to perform a full backup. Separate multiple values with commas (,). Valid values:'."\n" - ."\n" - .'* **Monday**'."\n" - .'* **Tuesday**'."\n" - .'* **Wednesday**'."\n" - .'* **Thursday**'."\n" - .'* **Friday**'."\n" - .'* **Saturday**'."\n" - .'* **Sunday**'."\n" - ."\n" - .'> To ensure data security, we recommend that you specify at least two values.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Monday,Wednesday,Friday,Sunday', - ], - ], - [ - 'name' => 'BackupRetentionPeriod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of days for which to retain full backup files. Valid values: 7 to 730.'."\n" - ."\n" - .'> If you do not specify this parameter, the default value 7 is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7', - 'default' => '7', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> Call the [DescribeRegions](~~454314~~) operation to view the region ID of a cluster.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EnableBackupLog', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable log backup. Valid values:'."\n" - ."\n" - .'* **Enable**'."\n" - .'* **Disable**'."\n" - ."\n" - .'> If you do not specify this parameter, the default value Enable is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> Call the [DescribeDBClusters](~~612397~~) operation to view the cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp1t6rym21****', 'title' => ''], ], [ - 'name' => 'LogBackupRetentionPeriod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of days for which to retain log backup files. Valid values: 7 to 730.'."\n" - ."\n" - .'> If you do not specify this parameter, the default value 7 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '730', - 'minimum' => '7', - 'example' => '7', - 'default' => '7', - ], + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data synchronization task.', 'type' => 'string', 'required' => false, 'example' => 'aps-hz1686v37sx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6FC370D7-1D4C-5A8E-805E-F73366382C66', 'title' => ''], + 'Message' => ['description' => 'Additional information about the call. Valid values:'."\n" + ."\n" + .'- Success is returned if the request is successful.'."\n" + ."\n" + .'- An error code is returned if the request fails.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The information about the resource groups.', + 'type' => 'object', + 'properties' => [ + 'Step' => ['description' => 'The step size of the resource group, in ACU.'."\n" + ."\n" + .'- If GroupType is **Interactive**, the step size is 16 ACU.'."\n" + ."\n" + .'- If GroupType is **Job**, the step size is 8 ACU.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + 'ResourceGroups' => [ + 'description' => 'The resource groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource groups.', + 'type' => 'object', + 'properties' => [ + 'CuOptions' => [ + 'description' => 'The resource gradient values.', + 'type' => 'array', + 'items' => ['description' => 'The resource gradient value.', 'type' => 'integer', 'format' => 'int64', 'example' => '无', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MaxComputeResource' => ['description' => 'The maximum reserved computing resources, in ACU.'."\n" + ."\n" + .'- If GroupType is **Interactive**, the maximum reserved computing resources are the current unallocated resources of the cluster, and the step size is 16 ACU.'."\n" + ."\n" + .'- If GroupType is **Job**, the maximum reserved computing resources are the current unallocated resources of the cluster, and the step size is 8 ACU.', 'type' => 'integer', 'format' => 'int32', 'example' => '512', 'title' => ''], + 'LeftComputeResource' => ['description' => 'The remaining computing resources, in ACU.', 'type' => 'integer', 'format' => 'int32', 'example' => '512', 'title' => ''], + 'MinComputeResource' => ['description' => 'The minimum reserved computing resources, in ACU.'."\n" + ."\n" + .'- If GroupType is **Interactive**, the minimum reserved computing resources are 16 ACU.'."\n" + ."\n" + .'- If GroupType is **Job**, the minimum reserved computing resources are 0 ACU.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'GroupName' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GroupType' => ['description' => 'The type of the resource group. Valid values:'."\n" + ."\n" + .'- **Interactive**'."\n" + ."\n" + .'- **Job**'."\n" + ."\n" + .'> For more information about resource groups in Data Lakehouse Edition, see [Resource groups](~~428610~~).', 'type' => 'string', 'example' => 'Job', 'title' => ''], + 'Available' => ['description' => 'Indicates whether the resource group is available. Valid values:'."\n" + ."\n" + .'- **True**'."\n" + ."\n" + .'- **False**', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **True**'."\n" + ."\n" + .'- **False**', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - '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.', - ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeApsResourceGroups', + 'description' => '- Public endpoint for a region: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'- VPC endpoint for a region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.', + 'changeSet' => [ + ['createdAt' => '2024-04-10T07:29:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-09T09:42:58.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-08T07:26:35.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsResourceGroups'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsResourceGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', - 'title' => 'ModifyBackupPolicy', - 'summary' => 'Modifies the backup policy of an AnalyticDB for MySQL cluster.', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'translator' => 'machine', ], - 'DescribeBackups' => [ - 'summary' => '查询实例备份集', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAuditLogRecords' => [ + 'summary' => 'Query SQL audit logs for the cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13195,412 +9415,603 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '155193', - 'abilityTreeNodes' => [ - 'FEATUREadsM6VDCK', - ], + 'abilityTreeCode' => '132363', + 'abilityTreeNodes' => ['FEATUREadsGAMOR7'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-bp18934i73vb5****', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all clusters in a region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-t4nj8619bz2w3****', 'title' => ''], ], [ - 'name' => 'BackupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The backup set ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1679758862', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2011-06-01T16:00Z', - ], + 'schema' => ['description' => 'The start of the time range to query. The time must be in UTC and in the `yyyy-MM-ddTHH:mmZ` format.'."\n" + ."\n" + .'> You can query SQL audit logs only when this feature is enabled. Logs are available for the last 30 days. If you disable and then re-enable SQL audit, only logs generated after the feature was re-enabled are returned.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-12T04:17Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-02-20T02:30Z', - ], + 'schema' => ['description' => 'The end of the time range to query. The time must be in UTC and in the `yyyy-MM-ddTHH:mmZ` format.'."\n" + ."\n" + .'> - The end time must be later than the start time.'."\n" + .'>'."\n" + .'> - The time range cannot exceed 24 hours.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-12T17:08Z', 'title' => ''], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database on which the SQL statement was executed.', 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => ['description' => 'A keyword used to perform a fuzzy search on the returned results.', 'type' => 'string', 'required' => false, 'example' => 'adb', 'title' => ''], + ], + [ + 'name' => 'SqlType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the SQL statement. Valid values:'."\n" + ."\n" + .'- **DELETE**'."\n" + ."\n" + .'- **SELECT**'."\n" + ."\n" + .'- **UPDATE**'."\n" + ."\n" + .'- **INSERT INTO SELECT**'."\n" + ."\n" + .'- **ALTER**'."\n" + ."\n" + .'- **DROP**'."\n" + ."\n" + .'- **CREATE**'."\n" + ."\n" + .'> You can specify only one type per request. If this parameter is not specified, all types are queried by default.', 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], + ], + [ + 'name' => 'Succeed', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether the SQL statement was successfully executed. Valid values:'."\n" + ."\n" + .'- **true**: The SQL statement succeeded.'."\n" + ."\n" + .'- **false**: The SQL statement failed.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'HostAddress', + 'in' => 'query', + 'schema' => ['description' => 'The client IP address and port number.', 'type' => 'string', 'required' => false, 'example' => '100.104.XX.XX:43908', 'title' => ''], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => ['description' => 'The sort order for the results based on execution time. Valid values:'."\n" + ."\n" + .'- **asc**: ascending order.'."\n" + ."\n" + .'- **desc**: descending order.', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => 'The username that executed the SQL statement.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the fields for sorting the results. The value is a JSON string that is an array of objects. The order of objects in the array defines the sort priority. Each object contains the`Field` and`Type` parameters. Example: `[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]`.'."\n" + ."\n" + .'- `Field`: the field by which to sort the results. Valid values:'."\n" + ."\n" + .' - **HostAddress**: the client IP address.'."\n" + ."\n" + .' - **UserName**: the username.'."\n" + ."\n" + .' - **ExecutionStartTime**: the execution start time of the SQL statement.'."\n" + ."\n" + .' - **QueryTime**: the execution duration.'."\n" + ."\n" + .' - **PeakMemoryUsage**: the peak memory usage of the SQL statement.'."\n" + ."\n" + .' - **ScanRows**: the number of rows scanned by a task that involves a data source.'."\n" + ."\n" + .' - **ScanSize**: the amount of data scanned.'."\n" + ."\n" + .' - **ScanTime**: the time taken for the data scan.'."\n" + ."\n" + .' - **PlanningTime**: the time taken to generate the execution plan.'."\n" + ."\n" + .' - **WallTime**: the total CPU time of all operators on all nodes.'."\n" + ."\n" + .' - **ProcessID**: the process ID.'."\n" + ."\n" + .'- `Type`: the sort order. Valid values:'."\n" + ."\n" + .' - **Desc**: descending order.'."\n" + ."\n" + .' - **Asc**: ascending order.', 'type' => 'string', 'required' => false, 'example' => '[{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* 30'."\n" - .'* 50'."\n" - .'* 100'."\n" - ."\n" - .'Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => 'The page size. Valid values:'."\n" + ."\n" + .'- **10** (default)'."\n" + ."\n" + .'- **30**'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Remote', + 'name' => 'ProxyUser', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['description' => 'A reserved parameter.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '300', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CE17270B-F8F8-5A31-9DB4-DADDFDAD7940', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'FreeBackupSize' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'TotalBackupSize' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '6974', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8A564B7F-8C00-43C0-8EC5-919FBB70573', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'example' => 'amv-t4nj8619bz2w3****', 'title' => ''], 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Backup' => [ - 'description' => 'The queried backup sets.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'am-bp11q28kvl688****', - ], - 'BackupType' => [ - 'description' => 'The backup type. Valid values:'."\n" - ."\n" - .'* **FullBackup**'."\n" - .'* **IncrementalBackup**'."\n", - 'type' => 'string', - 'example' => 'FullBackup', - ], - 'BackupStartTime' => [ - 'description' => 'The start time of the backup.'."\n", - 'type' => 'string', - 'example' => '2022-06-01T16:00Z', - ], - 'BackupSize' => [ - 'description' => 'The size of the backup set. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2167808', - ], - 'BackupEndTime' => [ - 'description' => 'The end time of the backup.'."\n", - 'type' => 'string', - 'example' => '2022-06-02T16:00Z', - ], - 'BackupExpiredTime' => [ - 'type' => 'string', - ], - 'BackupId' => [ - 'description' => 'The backup set ID.'."\n", - 'type' => 'string', - 'example' => '32732****', - ], - 'BackupMethod' => [ - 'description' => 'The backup method. Snapshot is returned.'."\n", - 'type' => 'string', - 'example' => 'Snapshot', - ], - 'BackupRegion' => [ - 'type' => 'string', - ], - 'ParentBackupId' => [ - 'type' => 'string', - ], - 'BackupStatus' => [ - 'type' => 'string', - ], - ], - 'description' => '', + 'description' => 'A list of audit log records.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an audit log record.', + 'type' => 'object', + 'properties' => [ + 'HostAddress' => ['description' => 'The IP address and port of the client that ran the SQL statement.', 'type' => 'string', 'example' => '100.104.XX.XX:43908', 'title' => ''], + 'Succeed' => ['description' => 'Indicates whether the SQL statement succeeded. Valid values:'."\n" + ."\n" + .'- **true**: The SQL statement succeeded.'."\n" + ."\n" + .'- **false**: The SQL statement failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'SQLText' => ['description' => 'The SQL statement.', 'type' => 'string', 'example' => 'SELECT * FROM adb_hdfs_import_source', 'title' => ''], + 'TotalTime' => ['description' => 'The execution duration of the SQL statement in milliseconds (ms).', 'type' => 'string', 'example' => '216', 'title' => ''], + 'ConnId' => ['description' => 'The connection ID.', 'type' => 'string', 'example' => '14356****', 'title' => ''], + 'DBName' => ['description' => 'The name of the database on which the SQL statement ran.', 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'SQLType' => ['description' => 'The SQL type.', 'type' => 'string', 'example' => 'SELECT', 'title' => ''], + 'ExecuteTime' => ['description' => 'The execution start time of the SQL statement. The time is in the `yyyy-MM-dd HH:mm:ss` format and in the local time zone.', 'type' => 'string', 'example' => '2022-08-12 10:10:00', 'title' => ''], + 'ExecuteTimestamp' => ['description' => 'The execution start time of the SQL statement, as a millisecond timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774600396584', 'title' => ''], + 'ProcessID' => ['description' => 'The process ID.', 'type' => 'string', 'example' => '202106081752021720161662490345362390', 'title' => ''], + 'User' => ['description' => 'The username of the account that ran the SQL statement.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'HasDiagnosticInfo' => [ + 'description' => 'Specifies whether the response contains diagnostic information.', + 'enumValueTitles' => ['true' => 'Diagnostic information is included.', 'false' => 'Diagnostic information is not included.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","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\\": 1774600396584,\\n \\"ProcessID\\": \\"202106081752021720161662490345362390\\",\\n \\"User\\": \\"test\\",\\n \\"HasDiagnosticInfo\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeAuditLogRecords', + 'description' => '- You can query SQL audit logs only if SQL audit is enabled. Log data is retained for up to 30 days. If you disable and re-enable SQL audit, you can only query logs generated after it is re-enabled. SQL audit logs do not record **INSERT INTO VALUES**, **REPLACE INTO VALUES**, or **UPSERT INTO VALUES** operations.'."\n" + ."\n" + .'- For a list of endpoints, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-10-27T07:49:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-08T02:33:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T04:03:32.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'DescribeBackups', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'CreateBackup' => [ - 'summary' => 'Creates a data backup for an AnalyticDB for MySQL instance.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAuditLogRecords'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAuditLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'machine', + ], + 'DescribeAutoRenewalAttribute' => [ + 'summary' => 'Queries the auto-renewal status of a subscription cluster.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '246050', - 'abilityTreeNodes' => [ - 'FEATUREadsM6VDCK', - ], - 'tenantRelevance' => 'tenant', + 'chargeType' => 'free', + 'abilityTreeCode' => '10788', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz9or2xawpnc****', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', + 'description' => 'The cluster IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'am-bp1u8c0mgfg58****', 'title' => ''], 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries returned on each page. Valid values:'."\n" + ."\n" + .'* **30**(Default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. A positive integer greater than 0 and not exceeding the maximum value of the Integer data type. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', 'title' => ''], + ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '421794A3-72A5-5D27-9E8B-A75A4C50****', + 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BA0F6761-7A8C-59F8-9624-FB56788C0EDF', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoRenewalAttribute' => [ + 'description' => 'The list of auto-renewal details.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-uf6485635fz8****', 'title' => ''], + 'AutoRenewalPeriodUnit' => ['description' => 'The unit of auto-renewal duration. Valid values:'."\n" + ."\n" + .'* **Year**'."\n" + .'* **Month**'."\n", 'type' => 'string', 'example' => 'Year', 'title' => ''], + 'AutoRenewalPeriod' => ['description' => 'The auto-renewal duration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AutoRenewalStatus' => ['description' => 'The renewal method. Valid values:'."\n" + ."\n" + .'* **AutoRenewal**: The cluster is automatically renewed.'."\n" + .'* **Normal**: The cluster is manually renewed. Before the cluster expires, the system sends you a reminder by SMS message.'."\n" + .'* **NotRenewal**: The cluster is not renewed. Reminders are only sent three days before cluster expiration.'."\n", 'type' => 'string', 'example' => 'AutoRenewal', 'title' => ''], + 'AutoRenewalEnabled' => ['description' => 'Indicates whether auto-renewal is enabled for the cluster. Valid values:'."\n" + ."\n" + .'* **true**: Enables.'."\n" + .'* **false**: Disables.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => '[{"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' => 'DescribeAutoRenewalAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAutoRenewalAttribute'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAutoRenewalAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C50****\\"\\n}","type":"json"}]', - 'title' => 'CreateBackup', - 'description' => '**Before you call this operation, make sure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/ads/detail/ads_pre) of AnalyticDB for MySQL.** Temporary backups are the same as regular backups in terms of price and retention period of backup sets.'."\n", ], - 'DeleteBackups' => [ - 'summary' => 'Manually deletes backup sets.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeAvailableAdvices' => [ + 'summary' => 'Use DescribeAvailableAdvices to list available optimization recommendations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeCode' => '246050', - 'abilityTreeNodes' => [ - 'FEATUREadsM6VDCK', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193677', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-uf6g8w25jacm7****', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-bp198m028ih55****', 'title' => ''], ], [ - 'name' => 'BackupIds', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the backup set that you want to delete. Separate multiple backup set IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '763,764', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'AdviceDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The date when the advice was generated, in the `yyyyMMdd` format.'."\n" + ."\n" + .'> Advice is generated daily. To query for advice, specify a date at least one day before the current date. For example, if you query on June 27, 2024, set this parameter to `20240626` or an earlier date.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '20221124'], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The display language for the advice. Valid values:'."\n" + ."\n" + .'- **zh**: Simplified Chinese (default).'."\n" + ."\n" + .'- **en**: English.'."\n" + ."\n" + .'- **ja**: Japanese.'."\n" + ."\n" + .'- **zh-tw**: Traditional Chinese.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'zh', 'example' => 'zh'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'- **30** (default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'default' => '100', 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number. The value must be an integer that is greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'default' => '1', 'example' => '1'], + ], + [ + 'name' => 'AdviceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of advice. Valid values:'."\n" + ."\n" + .'- **INDEX**: index optimization.'."\n" + ."\n" + .'- **TIERING**: hot and cold data tiering.', 'type' => 'string', 'required' => false, 'example' => 'INDEX', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword for a fuzzy search on table names.', 'type' => 'string', 'required' => false, 'example' => 'you_table_name', 'title' => ''], + ], + [ + 'name' => 'SchemaTableName', + 'in' => 'query', + 'schema' => ['description' => 'A concatenation of the database name and the table name.', 'type' => 'string', 'required' => false, 'example' => 'tpch.lineitem', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the sort order for the results. The value is a JSON string. Example: `[{"Field":"SchemaName","Type":"Asc"}]`. The JSON string contains the following key-value pairs:'."\n" + ."\n" + .'- `Field`: the field to sort by. Valid values:'."\n" + ."\n" + .' - `SchemaName`: the database name.'."\n" + ."\n" + .' - `TableName`: the table name.'."\n" + ."\n" + .' - `Benefit`: the expected benefit.'."\n" + ."\n" + .'- `Type`: the sort order. Valid values:'."\n" + ."\n" + .' - `Asc`: ascending order.'."\n" + ."\n" + .' - `Desc`: descending order.'."\n" + ."\n" + .'> By default, results are sorted by expected benefit in descending order.', 'type' => 'string', 'required' => false, 'example' => '[{\\"Field\\":\\"AdviceType\\",\\"Type\\":\\"Desc\\"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '771C5FAA-530F-52F7-B84D-EBAD4561D590', + 'Items' => [ + 'title' => '', + 'description' => 'The optimization advice items.', + 'type' => 'array', + 'items' => [ + 'description' => 'An optimization advice item.', + 'type' => 'object', + 'properties' => [ + 'AdviceId' => ['title' => '', 'description' => 'The advice ID.', 'type' => 'string', 'example' => 'dcd04135-0925-4aed-a5a7-e7d92cb1****'], + 'AdviceDate' => ['title' => '', 'description' => 'The date when the advice was generated. The date is displayed in the yyyyMMdd format.', 'type' => 'string', 'example' => '20221124'], + 'AdviceType' => ['title' => '', 'description' => 'The type of the advice. Valid values:'."\n" + ."\n" + .'- **INDEX**: index optimization.'."\n" + ."\n" + .'- **TIERING**: hot and cold data optimization.', 'type' => 'string', 'example' => 'INDEX'], + 'SQL' => ['title' => '', 'description' => 'The SQL statement that is used to apply the advice.', 'type' => 'string', 'example' => 'alter table `schema1`.`table1` drop key col1_1_idx'], + 'Reason' => ['title' => '', 'description' => 'The reason why the optimization advice is generated.', 'type' => 'string', 'example' => '15天未使用，历史使用统计概率小于1%'], + 'Benefit' => ['title' => '', 'description' => 'The benefits of the advice.', 'type' => 'string', 'example' => '节省0.4 GB的存储空间。'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned. The value is greater than or equal to 0 and less than or equal to the maximum value of the integer data type. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '10192'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30** (default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'PageNumber' => ['title' => '', 'description' => 'The page number. The value is greater than 0 and less than or equal to the maximum value of the integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'test_table', 'title' => ''], + 'IndexFields' => ['description' => 'The index fields.', 'type' => 'string', 'example' => 'message', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'PageNumber' => ['title' => '', 'description' => 'The page number. The value is greater than 0 and less than or equal to the maximum value of the integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30** (default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '96A55627-28E9-5E47-B8F6-D786BE551349', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned. The value is greater than or equal to 0 and less than or equal to the maximum value of the integer data type. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '10192', 'title' => ''], + 'SchemaTableNames' => [ + 'description' => 'The names of databases and tables.', + 'type' => 'array', + 'items' => ['description' => 'The name of a database and a table.', 'type' => 'string', 'example' => '['."\n" + .' "tpch.lineitem",'."\n" + .' "tpch.partsupp",'."\n" + .' "tpch.orders"'."\n" + .']', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'MissingParameter.PageSize', 'errorMessage' => 'The PageSize parameter is required.', 'description' => 'The PageSize parameter is not specified.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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\\": \\"message\\"\\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' => 'DescribeAvailableAdvices', + 'changeSet' => [ + ['createdAt' => '2025-07-09T06:38:11.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771C5FAA-530F-52F7-B84D-EBAD4561D590\\"\\n}","type":"json"}]', - 'title' => 'DeleteBackups', - 'description' => '* You can delete up to 100 backup sets at a time. If you want to delete more than 100 backup sets, call this operation twice.'."\n" - .'* To ensure data security, the system forcibly retains one valid backup set. If you want to delete the last backup set, the system prohibits your operation.'."\n", - ], - 'DescribeHistoryTasks' => [ - 'summary' => 'Retrieve historical task records.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableAdvices'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAvailableAdvices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeBackupPolicy' => [ + 'summary' => 'Queries the backup settings of a cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13612,165 +10023,149 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '254755', - 'abilityTreeNodes' => [ - 'FEATUREads12ZDDA', - ], + 'abilityTreeNodes' => ['FEATUREadsM6VDCK'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'allowEmptyValue' => false, + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> Call the [DescribeDBClusters](~~129857~~) operation to view the details of all AnalyticDB for MySQL clusters in the destination region, including the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-uf6s7oa710rbu0x3b', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-beijing', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => ['description' => 'The data backup cycle. Separate multiple values with commas (,). Valid values:'."\n" + ."\n" + .'- Monday'."\n" + ."\n" + .'- Tuesday'."\n" + ."\n" + .'- Wednesday'."\n" + ."\n" + .'- Thursday'."\n" + ."\n" + .'- Friday'."\n" + ."\n" + .'- Saturday'."\n" + ."\n" + .'- Sunday', 'type' => 'string', 'example' => 'Wednesday,Saturday', 'title' => ''], + 'LogBackupRetentionPeriod' => ['description' => 'The number of days to retain log backups.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'PreferredBackupTime' => ['description' => 'The data backup time. The time is in the HH:mmZ-HH:mmZ format.', 'type' => 'string', 'example' => '15:00Z-16:00Z', 'title' => ''], + 'EnableBackupLog' => ['description' => 'Indicates whether real-time log backup is enabled. Valid values:'."\n" + ."\n" + .'- **Enable**: enabled.'."\n" + ."\n" + .'- **Disable**: disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'BackupRetentionPeriod' => ['description' => 'The number of days to retain data backups.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 10 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Valid range: positive integers. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - [ - 'name' => 'InstanceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance type. The value is fixed to Instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Instance', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeBackupPolicy', + 'description' => 'For more information about endpoints, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2022-11-16T06:02:18.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], ], + ], + 'ramActions' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the task. Valid values:'."\n" - ."\n" - .'* **Scheduled**'."\n" - .'* **Running**'."\n" - .'* **Succeed**'."\n" - .'* **Failed**: The task failed.'."\n" - .'* **Cancelling**'."\n" - .'* **Canceled**'."\n" - .'* **Waiting**'."\n" - ."\n" - .'If querying multiple statuses, separate them with English commas. Default is empty, meaning select all.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Scheduled', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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"}]', + 'translator' => 'machine', + ], + 'DescribeBackups' => [ + 'summary' => 'Queries the backup sets for an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID. Separate multiple cluster IDs with commas (,). Maximum 30 cluster IDs. If not filled, defaults to querying historical tasks of all clusters in that region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-********', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155193', + 'abilityTreeNodes' => ['FEATUREadsM6VDCK'], + ], + 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The job IDs. Separate multiple task IDs with commas (,). Maximum 30 task IDs. If not filled, defaults to querying historical tasks of all clusters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 't-83br18hloy3faf****', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> Call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all clusters in a specific region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-bp18934i73vb5****', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Task type, used to query specific type task situations. If multiple, separate with English commas (,), maximum 30 supported. Default is empty, meaning no restriction.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'autotest_dispatch_cases', - ], + 'schema' => ['description' => 'The backup set ID.', 'type' => 'string', 'required' => false, 'example' => '1679758862', 'title' => ''], ], [ - 'name' => 'FromStartTime', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Start time of task start time, indicating querying tasks whose start time is after this time. Expressed according to ISO8601 standard, and must use UTC +0 time, format: yyyy-MM-ddTHH:mm:ssZ. Earliest supports 30 days ago, automatically converts to 30 days ago if more than 30 days from current time.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-01-02T11:31:03Z', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the \\`yyyy-MM-ddTHH:mmZ\\` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2011-06-01T16:00Z', 'title' => ''], ], [ - 'name' => 'ToStartTime', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'End time of task start time, indicating querying tasks whose start time is before this time. Expressed according to ISO8601 standard, and must use UTC +0 time, format: yyyy-MM-ddTHH:mm:ssZ.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-03-02T11:31:03Z', - ], + 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the \\`yyyy-MM-ddTHH:mmZ\\` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-02-20T02:30Z', 'title' => ''], ], [ - 'name' => 'FromExecTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Minimum task execution time. Used to filter tasks with execution time greater than this value, in seconds. Default 0, meaning no limit.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- 30'."\n" + ."\n" + .'- 50'."\n" + ."\n" + .'- 100'."\n" + ."\n" + .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '30', 'title' => ''], ], [ - 'name' => 'ToExecTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Maximum task execution time. Used to filter tasks with execution time not less than this value, in seconds. Default 0, meaning no limit.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Remote', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-ae****', - ], + 'schema' => ['description' => 'Specifies whether to query only cross-region backups. Set the value to true to query only cross-region backups. Set the value to false to query only local backups.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -13778,525 +10173,392 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => 'E51713A3-BB45-5616-AB15-170B704F8F01', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'Total record count.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '300', 'title' => ''], + 'PageSize' => ['description' => 'The number of backup sets on the current page.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CE17270B-F8F8-5A31-9DB4-DADDFDAD7940', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'FreeBackupSize' => ['description' => 'The free backup space. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'TotalBackupSize' => ['description' => 'The total size of the backup sets. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '64953700', 'title' => ''], 'Items' => [ - 'description' => 'The task list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task object.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Task status. Valid values:'."\n" - ."\n" - .'* **Scheduled**'."\n" - .'* **Running**'."\n" - .'* **Succeed**'."\n" - .'* **Failed**: The task failed.'."\n" - .'* **Cancelling**'."\n" - .'* **Canceled**'."\n" - .'* **Waiting**'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'TaskId' => [ - 'description' => 'Task ID.'."\n", - 'type' => 'string', - 'example' => 't-83br18hloy3faf****', - ], - 'CurrentStepName' => [ - 'description' => 'Current executing step name. If empty, represents task has not started.'."\n", - 'type' => 'string', - 'example' => 'exec_task', - ], - 'StartTime' => [ - 'description' => 'Task start time.'."\n", - 'type' => 'string', - 'example' => '2022-02-03T11:31:03Z', - ], - 'EndTime' => [ - 'description' => 'Task end time.'."\n", - 'type' => 'string', - 'example' => '2022-02-03T12:06:17Z', - ], - 'TaskType' => [ - 'description' => 'Task type.'."\n", - 'type' => 'string', - 'example' => 'autotest_dispatch_cases', - ], - 'RemainTime' => [ - 'description' => 'Estimated remaining execution time, in seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'Progress' => [ - 'description' => 'Indicates the task progress.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '79.0', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'InstanceType' => [ - 'description' => 'Instance type.'."\n", - 'type' => 'string', - 'example' => 'Instance', - ], - 'InstanceId' => [ - 'description' => 'Cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-********', - ], - 'InstanceName' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DbType' => [ - 'description' => 'The database engine type.'."\n", - 'type' => 'string', - 'example' => 'analyticdb', - ], - 'Product' => [ - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'example' => 'ads', - 'default' => 'ADB', - ], - 'TaskDetail' => [ - 'description' => 'The task details.'."\n", - 'type' => 'string', - 'example' => '{\\"callerUid\\":\\"test\\"}', - ], - 'ActionInfo' => [ - 'description' => 'Allowed operation information. When used specifically, matches operation Action based on currentStepName+status in this information. If no Action is matched, represents task current status does not support operations.'."\n", - 'type' => 'string', - 'example' => '{\\"steps\\":[{\\"action_info\\":{\\"Waiting\\":[\\"modifySwitchTime\\"]},\\"step_name\\":\\"exec_task\\"}]}', - ], - 'Uid' => [ - 'description' => 'null'."\n", - 'type' => 'string', - 'example' => '141345906006****', - ], - 'CallerSource' => [ - 'description' => 'null'."\n", - 'type' => 'string', - 'example' => '141345906006****', - ], - 'CallerUid' => [ - 'description' => 'null'."\n" - ."\n" - .'* **null**'."\n" - .'* **null**'."\n", - 'type' => 'string', - 'example' => 'User', - ], - 'ReasonCode' => [ - 'description' => 'The reason why the current task was initiated.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => 'The HTTP status code that is returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. null'."\n" - ."\n" - .'* null****'."\n" - .'* null'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'AccessDeniedDetail' => [ - 'description' => 'null'."\n", 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'AuthAction' => [ - 'description' => 'null'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AuthPrincipalDisplayName' => [ - 'description' => 'null'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AuthPrincipalOwnerId' => [ - 'description' => 'null'."\n", - 'type' => 'string', - 'example' => '141345906006****', - ], - 'AuthPrincipalType' => [ - 'description' => 'null'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'EncodedDiagnosticMessage' => [ - 'description' => 'null'."\n", - 'type' => 'string', - 'example' => 'AQFmy+hZZsvoWTQ2NTJFQUFBLUIyNjktMzk5NS05MEZCLUMxMzgwNDUwMDA2Ng==', - ], - 'NoPermissionType' => [ - 'description' => 'null'."\n" - ."\n" - .'* **null**'."\n" - .'* **null**'."\n", - 'type' => 'string', - 'example' => 'ImplicitDeny', - ], - 'PolicyType' => [ - 'description' => 'null'."\n" - ."\n" - .'* **null**'."\n" - .'* **null**'."\n" - .'* **null**'."\n" - .'* **null**'."\n" - .'* **null**'."\n", - 'type' => 'string', - 'example' => 'ControlPolicy', + 'Backup' => [ + 'description' => 'The list of backup sets.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'example' => 'am-bp11q28kvl688****', 'title' => ''], + 'BackupType' => ['description' => 'The backup type. Valid values:'."\n" + ."\n" + .'- **FullBackup**: A full backup.'."\n" + ."\n" + .'- **IncrementalBackup**: An incremental backup.', 'type' => 'string', 'example' => 'FullBackup', 'title' => ''], + 'BackupStartTime' => ['description' => 'The start time of the backup.', 'type' => 'string', 'example' => '2022-06-01T16:00Z', 'title' => ''], + 'BackupSize' => ['description' => 'The size of the backup file. Unit: bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2167808', 'title' => ''], + 'BackupEndTime' => ['description' => 'The end time of the backup.', 'type' => 'string', 'example' => '2022-06-02T16:00Z', 'title' => ''], + 'BackupExpiredTime' => ['description' => 'The expiration time of the backup set.', 'type' => 'string', 'example' => '2022-07-02T16:00Z'."\n", 'title' => ''], + 'BackupId' => ['description' => 'The backup set ID.', 'type' => 'string', 'example' => '32732****', 'title' => ''], + 'BackupMethod' => ['description' => 'The backup method. Only snapshot backup is supported.', 'type' => 'string', 'example' => 'Snapshot', 'title' => ''], + 'BackupRegion' => ['description' => 'The region where the cross-region backup is stored.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ParentBackupId' => ['description' => 'The ID of the local backup set that is associated with the cross-region backup.', 'type' => 'string', 'example' => '32733****', 'title' => ''], + 'BackupStatus' => ['description' => 'The backup status. Valid values:'."\n" + ."\n" + .'- Running: The backup is in progress.'."\n" + ."\n" + .'- Finished: The backup is complete.', 'type' => 'string', 'example' => 'Finished', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], ], - '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' => 'DescribeHistoryTasks', - 'description' => 'Only supports viewing tasks within the last 30 days.'."\n", - ], - 'DescribeHistoryTasksStat' => [ - 'summary' => 'Queries task statistics.', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DescribeBackups', + 'description' => 'For information about the endpoints for this service, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-09-11T07:17:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-05-26T01:44:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-10-12T14:49:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-16T06:02:18.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackups'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'schemes' => [ - 'https', + '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"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'machine', + ], + 'DescribeBadSqlDetection' => [ + 'summary' => 'Queries the bad SQL statements that affect cluster stability within a time range.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['Perth'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '254776', - 'abilityTreeNodes' => [ - 'FEATUREadsCORDM7', - ], + 'abilityTreeCode' => '194347', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the region where the instance resides.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-xxx', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the task. Valid values:'."\n" - ."\n" - .'* **Scheduled**'."\n" - .'* **Running**'."\n" - .'* **Succeed**'."\n" - .'* **Failed**: The task failed.'."\n" - .'* **Cancelling**'."\n" - .'* **Canceled**'."\n" - .'* **Waiting**'."\n" - ."\n" - .'Separate multiple states with commas (,). This parameter is empty by default, which indicates that tasks in all states are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Scheduled', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-********', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-01-23T02:18Z', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Task ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1564657730', - ], + 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2024-11-17T02:16Z', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'Task type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'all', - ], + 'schema' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'* **zh**: simplified Chinese.'."\n" + .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], - [ - 'name' => 'FromStartTime', - 'in' => 'query', - 'allowEmptyValue' => false, + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Query start time.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-05-08T07:04:17Z', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '50', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '584CFCAE-E3C8-5BBB-B46C-724E77A830A7', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-xxxx', 'title' => ''], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried detection item and detection result.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the detection item.'."\n", 'type' => 'string', 'example' => 'Cost', 'title' => ''], + 'Results' => [ + 'description' => 'The detection result items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The detection result item.', + 'type' => 'object', + 'properties' => [ + 'Cost' => ['description' => 'The total execution duration. Unit: milliseconds.'."\n" + ."\n" + .'> This value is the cumulative value of the `QueuedTime`, `TotalPlanningTime`, and `ExecutionTime` parameters.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '709', 'title' => ''], + 'PeakMemory' => ['description' => 'The peak memory. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '234', 'title' => ''], + 'OperatorCost' => ['description' => 'The total CPU time consumed by all operators in the stage, which is equivalent to the total CPU time of the stage. You can use this parameter to determine which parts of the stage consume a large amount of computing resources. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2345', 'title' => ''], + 'ScanSize' => ['description' => 'The amount of scanned data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2342', 'title' => ''], + 'OutputDataSize' => ['description' => 'The amount of returned data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '235433', 'title' => ''], + 'ProcessId' => ['description' => 'The query ID.'."\n", 'type' => 'string', 'example' => '202410161002191720161451770345363xxxx', 'title' => ''], + 'TotalStages' => ['description' => 'The total number of stages generated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'DiagnosisResults' => [ + 'description' => 'The diagnostic result items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The diagnostic result item.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The diagnostic code.'."\n", 'type' => 'string', 'example' => 'Large amounts of data are returned to the client.', 'title' => ''], + 'Detail' => ['description' => 'The information about the diagnostic result.', 'type' => 'string', 'example' => 'Large amounts of data are returned to the client. Import the data to OSS.', 'title' => ''], + 'StageId' => ['description' => 'The stage ID.'."\n", 'type' => 'string', 'example' => 'Stage[67]', 'title' => ''], + 'OperatorId' => ['description' => 'The operator ID.'."\n", 'type' => 'string', 'example' => 'TableScan[234]', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SQL' => ['description' => 'The SQL statement.'."\n" + ."\n" + .'> For performance considerations, an SQL statement cannot exceed 5,120 characters in length. Otherwise, the SQL statement is truncated. You can call the [DownloadDiagnosisRecords](~~308212~~) operation to download the information about SQL statements that meet a query condition for an AnalyticDB for MySQL cluster, including the complete SQL statements.'."\n", 'type' => 'string', 'example' => 'SELECT * FROM device WHERE product_key = \'h66zXfxet2X\' AND name = \'device@zntbtfptv5_9237117\'', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-09-06T02:11:00Z', 'title' => ''], + 'PatternId' => ['description' => 'The SQL pattern ID.'."\n", 'type' => 'string', 'example' => '3467484070025860498', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Status' => ['description' => 'The severity level of the detection result. Valid values:'."\n" + ."\n" + .'* NORMAL'."\n" + .'* WARNING'."\n" + .'* CRITICAL'."\n", 'type' => 'string', 'example' => 'WARNING', 'title' => ''], + 'Message' => ['description' => 'The information about the detection result.', 'type' => 'string', 'example' => 'SQL statements that result in high peak memory are detected.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AccessDeniedDetail' => ['description' => 'The information about the request denial.'."\n", '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" + .'}', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + '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\\": \\"Large amounts of data are returned to the client.\\",\\n \\"Detail\\": \\"Large amounts of data are returned to the client. Import the data to 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 statements that result in high peak memory are detected.\\"\\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' => 'DescribeBadSqlDetection', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBadSqlDetection'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ToStartTime', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Represents tasks whose start time is before this time.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-02-24T10:01:37Z', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeBadSqlDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + ], + 'DescribeClusterAccessWhiteList' => [ + 'summary' => 'Queries the IP whitelist for a specified cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FromExecTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'Minimum task execution time, used to filter tasks with execution time greater than this value, in seconds. Default 0, meaning no limit'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsG383TB'], + ], + 'parameters' => [ [ - 'name' => 'ToExecTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Maximum task execution time, used to filter tasks with execution time not less than this value, in seconds. Default 0, meaning no limit'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmy*****', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '370D09FD-442A-5225-AAD3-7362CAE39177', 'title' => ''], 'Items' => [ - 'description' => 'The tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Task information list.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the APS job.'."\n" - ."\n" - .'* **Scheduled**'."\n" - .'* **Running**'."\n" - .'* **Succeed**'."\n" - .'* **Failed**: The task failed.'."\n" - .'* **Cancelling**'."\n" - .'* **Canceled**'."\n" - .'* **Waiting**'."\n", - 'type' => 'string', - 'example' => 'Scheduled', - ], - 'TotalCount' => [ - 'description' => 'The total number of tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, an success message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Code' => [ - 'description' => 'API status or POP error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The queried information about the request denial.'."\n", 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'AuthAction' => [ - 'description' => 'Authorized action'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AuthPrincipalDisplayName' => [ - 'description' => 'The display name of the requester.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AuthPrincipalOwnerId' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the authentication principal belongs.'."\n", - 'type' => 'string', - 'example' => '141345906006****', - ], - 'AuthPrincipalType' => [ - 'description' => 'The requester type.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'EncodedDiagnosticMessage' => [ - 'description' => 'The encoded diagnostic message.'."\n", - 'type' => 'string', - 'example' => 'test'."\n", - ], - 'NoPermissionType' => [ - 'description' => 'The type of the policy denial. Valid values:'."\n" - ."\n" - .'* **ImplicitDeny**: The resource holder has not configured a policy for the current user. By default, unauthorized operations are denied.'."\n" - .'* **ExplicitDeny**: The RAM policy configured by the resource holder explicitly denies the current user access to the corresponding resources.'."\n", - 'type' => 'string', - 'example' => 'ImplicitDeny', - ], - 'PolicyType' => [ - 'description' => 'The type of the policy that causes the access denied error.'."\n" - ."\n" - .'* **ControlPolicy**: control policy'."\n" - .'* **SessionPolicy**: an additional policy that is added to the temporary token.'."\n" - .'* **AssumeRolePolicy**: the authorization policy of the RAM role.'."\n" - .'* **AccountLevelIdentityBasedPolicy**: the principal policies of the account authorization scope, including custom policies and system policies.'."\n" - .'* **ResourceGroupLevelIdentityBasedPolicy**: the principal policy of the resource group authorization scope, including custom policies and system policies.'."\n", - 'type' => 'string', - 'example' => 'ControlPolicy', + 'IPArray' => [ + 'description' => 'An array of IP whitelist groups for the cluster.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an IP whitelist group.', + 'type' => 'object', + 'properties' => [ + 'DBClusterIPArrayAttribute' => ['description' => 'The whitelist group attribute.'."\n" + ."\n" + .'> Groups with the **hidden** attribute are not displayed in the console. These groups are typically used to access other Alibaba Cloud services, such as DTS and PolarDB.', 'type' => 'string', 'example' => 'hidden', 'title' => ''], + 'SecurityIPList' => ['description' => 'The IP addresses in the IP whitelist group. You can specify up to 500 IP addresses, separated by commas (,).', 'type' => 'string', 'example' => '127.0.xx.xx', 'title' => ''], + 'DBClusterIPArrayName' => ['description' => 'The name of the IP whitelist group.'."\n" + ."\n" + .'Each cluster supports a maximum of 50 whitelist groups.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => ''], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ], ], - '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' => 'DescribeHistoryTasksStat', - ], - 'DescribeExecutorDetection' => [ - 'summary' => 'Queries the diagnostic results of the compute layer.', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeClusterAccessWhiteList', + 'description' => 'For information about endpoints, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-09-26T08:36:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-31T07:03:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:52.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterAccessWhiteList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeClusterAccessWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeClusterNetInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14305,77 +10567,34 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '194344', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '133667', + 'abilityTreeNodes' => ['FEATUREads4DZDZG'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-xxx', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2024-10-31T02:06Z', - ], + 'schema' => ['description' => 'The ID of an Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the details of clusters in a specific region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-wz9dqvn0o7****', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Engine', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-05-27T16:00Z', - ], + 'schema' => ['description' => 'The database engine. Valid values:'."\n" + ."\n" + .'- **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" + ."\n" + .'- **ClickHouse**: the wide table engine.', 'type' => 'string', 'required' => false, 'example' => 'Clickhouse', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'ResourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese.'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -14383,220 +10602,138 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '566', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9DFF5F54-162B-5860-80A5-411FF550B347', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'am-xxx', - ], - 'DetectionItems' => [ - 'description' => 'The queried detection items and detection results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection item and detection result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the detection item.'."\n", - 'type' => 'string', - 'example' => 'Metric detection', - ], - 'Results' => [ - 'description' => 'The detection result items.'."\n", + 'ClusterNetworkType' => ['description' => 'The network type of the cluster. The value is always **VPC**, as this is the only supported network type.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '69A29B65-CD0C-52B1-BE42-8B454569747F', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Address' => [ + 'description' => 'The network connection details.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details for a single network connection.', 'type' => 'object', 'properties' => [ - 'OperatorDetails' => [ - 'description' => 'The detection result items of abnormal operators.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The name of the detection metric.'."\n", - 'type' => 'string', - 'example' => 'PeakMemory', - ], - 'SearchResults' => [ - 'description' => 'The detection result items of abnormal operators.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProcessId' => [ - 'description' => 'The query ID.'."\n", - 'type' => 'string', - 'example' => '2024080110010002102500023803151627972', - ], - 'StageId' => [ - 'description' => 'The stage ID.'."\n", - 'type' => 'string', - 'example' => 'Stage[3]', - ], - 'OperatorName' => [ - 'description' => 'The name of the operator.'."\n", - 'type' => 'string', - 'example' => 'Join', - ], - 'PeakMemory' => [ - 'description' => 'The peak memory. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234', - ], - 'OperatorCost' => [ - 'description' => 'The total CPU time consumed by all operators in the stage, which is equivalent to the total CPU time of the stage. You can use this parameter to determine which parts of the stage consume a large amount of computing resources. Unit: milliseconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '123', - ], - 'InputRows' => [ - 'description' => 'The number of rows input by the operator.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OutputRows' => [ - 'description' => 'The number of rows output by the operator.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2345', - ], - 'InputSize' => [ - 'description' => 'The amount of data input by the operator. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '345', - ], - 'OutputSize' => [ - 'description' => 'The amount of data output by the operator. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234', - ], - 'OperatorInfo' => [ - 'description' => 'The property information about the operator.'."\n", - 'type' => 'string', - 'example' => 'GROUP BY field: uid', - ], - ], - 'description' => 'The detection result items of abnormal operators.', - ], - ], - ], - 'description' => 'The detection result items of abnormal operators.'."\n", - ], - ], - 'OperatorAgg' => [ - 'description' => 'The detection result items of operator metric aggregation.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The name of the detection metric.'."\n", - 'type' => 'string', - 'example' => 'OperatorCost', - ], - 'SearchResults' => [ - 'description' => 'The detection result items of operator metric aggregation.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OperatorName' => [ - 'description' => 'The name of the operator.'."\n", - 'type' => 'string', - 'example' => 'Window', - ], - 'MaxValue' => [ - 'description' => 'The maximum value of the operator metric.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2345', - ], - 'TotalValue' => [ - 'description' => 'The cumulative value of the operator metric.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '345', - ], - 'AvgValue' => [ - 'description' => 'The average value of the operator metric.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '234', - ], - 'OperatorCount' => [ - 'description' => 'The number of occurrences of the operator.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - ], - 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'VSwitchId' => ['description' => 'The vSwitch ID.'."\n" + ."\n" + .'> If the value of `NetType` is `Public`, this parameter is empty.', 'type' => 'string', 'example' => 'vsw-bp1syh8vvw8yec****', 'title' => ''], + 'ConnectionString' => ['description' => 'The connection string of the cluster.'."\n" + ."\n" + .'- If the network type is VPC, `ConnectionString` is the VPC connection string.'."\n" + ."\n" + .'- If the network type is Public, `ConnectionString` is the public network connection string.', 'type' => 'string', 'example' => 'amv-wz9dqvn0o7****.ads.aliyuncs.com', 'title' => ''], + 'NetType' => ['description' => 'The network type. Valid values:'."\n" + ."\n" + .'- **Public**: the public network.'."\n" + ."\n" + .'- **VPC**: the VPC network.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'Port' => ['description' => 'The port number. The value is always **3306**.', 'type' => 'string', 'example' => '3306', 'title' => ''], + 'VPCId' => ['description' => 'The VPC ID.'."\n" + ."\n" + .'> If the value of `NetType` is `Public`, this parameter is empty.', 'type' => 'string', 'example' => 'vpc-8vbhucmd5b****', 'title' => ''], + 'IPAddress' => ['description' => 'The IP address.'."\n" + ."\n" + .'- If the network type is VPC, `IPAddress` is the private IP address.'."\n" + ."\n" + .'- If the network type is Public, `IPAddress` is the public IP address for connecting to the database.', 'type' => 'string', 'example' => '192.168.xx.xx', 'title' => ''], + 'ConnectionStringPrefix' => ['description' => 'The prefix of the connection string.'."\n" + ."\n" + .'- If the network type is VPC, `ConnectionStringPrefix` is the prefix of the VPC connection string.'."\n" + ."\n" + .'- If the network type is Public, `ConnectionStringPrefix` is the prefix of the public network connection string.', 'type' => 'string', 'example' => 'amv-wz9dqvn0o7****', 'title' => ''], + 'Ports' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ports' => [ + 'description' => 'A list of ports.', + 'type' => 'array', + 'items' => [ + 'description' => 'The port details.', + 'type' => 'object', + 'properties' => [ + 'Port' => ['description' => 'The service port.', 'type' => 'string', 'example' => '3306', 'title' => ''], + 'Protocol' => ['description' => 'The protocol. Valid values:'."\n" + ."\n" + .'- **tcp**: Transmission Control Protocol (TCP).'."\n" + ."\n" + .'- **http**: Hypertext Transfer Protocol.'."\n" + ."\n" + .'- **https**: Hypertext Transfer Protocol Secure.'."\n" + ."\n" + .'- **mysql**: MySQL protocol.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'description' => 'The detection result items of operator metric aggregation.'."\n", ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The information about the detection result.'."\n", - 'type' => 'string', - 'example' => 'Large amounts of memory resources are used by the Aggregation operator.', - ], - 'Status' => [ - 'description' => 'The severity level of the detection result. Valid values:'."\n" - ."\n" - .'* NORMAL'."\n" - .'* WARNING'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'WARNING', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => 'The response parameters.', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'DescribeClusterNetInfo', + 'summary' => 'Queries the network information of a specified cluster.', + 'description' => 'For service endpoints, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-06-13T13:53:51.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-11T16:51:52.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'DescribeExecutorDetection', - ], - 'DescribeWorkerDetection' => [ - 'summary' => 'Queries the diagnostic results of the storage layer.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterNetInfo'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeClusterNetInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeClusterResourceDetail' => [ + 'summary' => 'Queries the information about resource usage of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14604,465 +10741,212 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '194345', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-bp1jj9xqft1po****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-xxxxx', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The queried resource usage.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-adbxxxxx', 'title' => ''], + 'ComputeResource' => ['description' => 'The amount of reserved computing resources. Unit: AnalyticDB compute units (ACUs). Valid values: 0 to 4096. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.'."\n", 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'FreeComputeResource' => ['description' => 'The amount of idle reserved computing resources. Unit: ACUs. Valid values: 0 to 4096. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.'."\n", 'type' => 'string', 'example' => '0ACU', 'title' => ''], + 'StorageResource' => ['description' => 'The amount of reserved storage resources. Unit: ACUs. Valid values: 0 to 2064. The value must be in increments of 24 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.'."\n", 'type' => 'string', 'example' => '24ACU', 'title' => ''], + 'ResourceGroupList' => [ + 'description' => 'The resource groups.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PoolId' => ['description' => 'The resource group ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '17', 'title' => ''], + 'PoolName' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'example' => 'testadb', 'title' => ''], + 'PoolType' => ['description' => 'The type of the resource group.'."\n", 'type' => 'string', 'example' => 'interactive', 'title' => ''], + 'MinComputeResource' => ['description' => 'The minimum amount of reserved computing resources.', 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'MaxComputeResource' => ['description' => 'The maximum amount of reserved computing resources.', 'type' => 'string', 'example' => '128ACU', 'title' => ''], + 'PoolUsers' => ['description' => 'The user of the resource group.'."\n", 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'Status' => ['description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* **running**'."\n" + .'* **deleting**'."\n" + .'* **scaling**'."\n", 'type' => 'string', 'example' => 'running', 'title' => ''], + 'ClusterSizeResource' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'MinClusterCount' => ['description' => 'A reserved parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MaxClusterCount' => ['description' => 'A reserved parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'RunningClusterCount' => ['description' => 'A reserved parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ClusterMode' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => '0', 'default' => 'Disable', 'title' => ''], + 'EnableSpot' => ['description' => 'Indicates whether the preemptible instance feature is enabled for the resource group. After the preemptible instance feature is enabled, you are charged for resources at a lower unit price but the resources are probably released. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'The True value is returned only for job resource groups.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'title' => 'DescribeClusterResourceDetail', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2024-01-26T02:37:32.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterResourceDetail'], + ], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~612293~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeClusterResourceDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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"}]', + ], + 'DescribeClusterResourceUsage' => [ + 'summary' => 'Queries the resource usage of an AnalyticDB for MySQL cluster.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2021-11-18T00:00Z', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2024-04-25T02:04Z', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-11-29T10:20Z', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* **zh** (default): simplified Chinese.'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-08-22T01:06:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E5B37B61-E6C9-5FE0-9374-45BAA548AEF6', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'am-xxxxx', - ], - 'DetectionItems' => [ - 'description' => 'The queried detection items and detection results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection item and detection result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the detection item.'."\n", - 'type' => 'string', - 'example' => 'Metric detection', - ], - 'Results' => [ - 'description' => 'The detection result items.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The queried resource usage.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-uf6dj23rt5zo9s9d', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-03-14T03:42:15Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-03-23T02:31Z', 'title' => ''], + 'AcuInfo' => [ + 'description' => 'The AnalyticDB compute unit (ACU) usage of the cluster.'."\n", + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'SkewedTables' => [ - 'description' => 'The detection result items of skewed tables.'."\n", + 'Name' => ['description' => 'The resource usage metric. Valid values:'."\n" + ."\n" + .'* `TotalAcuNumber`: the total number of ACUs.'."\n" + .'* `ReservedAcuNumber`: the number of ACUs for the reserved resources.'."\n" + .'* `ReservedAcuUsageNumber`: the number of ACUs for the reserved resources that are used.'."\n", 'type' => 'string', 'example' => 'TotalAcuNumber', 'title' => ''], + 'Values' => [ + 'description' => 'The values of the metric at specific points in time.'."\n", 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'platfunc', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'sls_log_cheat_action', - ], - 'DDL' => [ - 'description' => 'The SQL statement that is used to create the table.'."\n", - 'type' => 'string', - 'example' => 'create table test(id varchar)', - ], - 'PartitionCount' => [ - 'description' => 'The number of partitions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalDataSize' => [ - 'description' => 'The total data size of the table. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2345', - ], - 'TotalRowCount' => [ - 'description' => 'The number of rows in the table.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34', - ], - 'TotalPkSize' => [ - 'description' => 'The data size of the primary key. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234', - ], - 'TotalRemoteDataSize' => [ - 'description' => 'The size of cold data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234', - ], - 'TotalLocalDataSize' => [ - 'description' => 'The size of hot data. Unit: bytes.', - 'type' => 'string', - 'example' => '2345', - ], - 'ShardSkewedRows' => [ - 'description' => 'The number of skewed rows in the table.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - ], - 'description' => 'The detection result items of skewed table.', - ], - ], - 'PartitionedTables' => [ - 'description' => 'The detection result items of improper partitioned tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detection result items of the improper partitioned table.'."\n", - 'type' => 'object', - 'properties' => [ - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'nxg', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'zhw_place_order', - ], - 'DDL' => [ - 'description' => 'The SQL statement that is used to create the table.'."\n", - 'type' => 'string', - 'example' => 'create table test(id varchar)', - ], - 'PartitionCount' => [ - 'description' => 'The number of partitions.'."\n", - 'type' => 'string', - 'example' => '234', - ], - 'PartitionIds' => [ - 'description' => 'The ID of the improper partition.'."\n", - 'type' => 'string', - 'example' => '[2024,2025]', - ], - 'TotalDataSize' => [ - 'description' => 'The total data size of the table.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - 'TopAccessTables' => [ - 'description' => 'The detection result items of table access.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detection result items of table access.'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The name of the detection metric.'."\n", - 'type' => 'string', - 'example' => 'Peak memory detection', - ], - 'SearchResults' => [ - 'description' => 'The detection result items of table access.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detection result items of table access.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'tiberias_2copt_origin_order_goods_info', - ], - 'MaxScanCost' => [ - 'description' => 'The maximum amount of time for scanning. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '345', - ], - 'AvgScanCost' => [ - 'description' => 'The average amount of time for scanning. Unit: milliseconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '234', - ], - 'MaxScanSize' => [ - 'description' => 'The maximum data size for scanning. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2345', - ], - 'AvgScanSize' => [ - 'description' => 'The average data size for scanning. Unit: bytes.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '234', - ], - 'AccessCount' => [ - 'description' => 'The number of accesses to the table.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1111', - ], - ], - ], - ], - ], - ], - ], - 'OperatorDetails' => [ - 'description' => 'The detection result items of abnormal operators.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detection result items of abnormal operators.'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The name of the detection metric.'."\n", - 'type' => 'string', - 'example' => 'PeakMemory', - ], - 'SearchResults' => [ - 'description' => 'The detection result items of abnormal operators.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detection result items of the abnormal operator.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProcessId' => [ - 'description' => 'The query ID that can be used for diagnostics.'."\n", - 'type' => 'string', - 'example' => '2024041909301402103302422803151411141', - ], - 'StageId' => [ - 'description' => 'The stage ID.'."\n", - 'type' => 'string', - 'example' => 'Stage[2]', - ], - 'OperatorName' => [ - 'description' => 'The name of the operator.'."\n", - 'type' => 'string', - 'example' => 'TableScan', - ], - 'PeakMemory' => [ - 'description' => 'The peak memory. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'OperatorCost' => [ - 'description' => 'The total CPU time consumed by all operators in the stage, which is equivalent to the total CPU time of the stage. You can use this parameter to determine which parts of the stage consume a large amount of computing resources. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'InputRows' => [ - 'description' => 'The number of rows input by the operator.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OutputRows' => [ - 'description' => 'The number of rows output by the operator.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'InputSize' => [ - 'description' => 'The amount of data input by the operator. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OutputSize' => [ - 'description' => 'The amount of data output by the operator. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'OperatorInfo' => [ - 'description' => 'The property information about the operator.'."\n", - 'type' => 'string', - 'example' => 'GROUP BY field: id'."\n", - ], - ], - ], - ], - ], - ], - ], - 'OperatorAgg' => [ - 'description' => 'The detection result items of operator metric aggregation.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The detection result items of operator metric aggregation.'."\n", - 'type' => 'string', - 'example' => 'Peak memory', - ], - 'SearchResults' => [ - 'description' => 'The detection result items of operator metric aggregation.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OperatorName' => [ - 'description' => 'The name of the operator.'."\n", - 'type' => 'string', - 'example' => 'Aggregation', - ], - 'MaxValue' => [ - 'description' => 'The maximum value of the operator metric.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '444', - ], - 'TotalValue' => [ - 'description' => 'The cumulative value of the operator metric.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'AvgValue' => [ - 'description' => 'The average value of the operator metric.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2234', - ], - 'OperatorCount' => [ - 'description' => 'The number of occurrences of the operator.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - 'description' => 'The detection result items of operator metric aggregation.'."\n", - ], - ], - ], - 'description' => 'The detection result items of operator metric aggregation.'."\n", - ], + 'items' => ['description' => 'The value of the metric at a specific point in time.'."\n", 'type' => 'string', 'example' => '16.0', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The information about the detection result.'."\n", - 'type' => 'string', - 'example' => 'There are a total of 10 tables with an excessive number of primary keys.', - ], - 'Status' => [ - 'description' => 'The severity level of the detection result. Valid values:'."\n" - ."\n" - .'* NORMAL'."\n" - .'* WARNING'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'WARNING', - ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => 'The response parameters.', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 'title' => 'DescribeClusterResourceUsage', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterResourceUsage'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeClusterResourceUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - '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' => 'DescribeWorkerDetection', + '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"}]', ], - 'DescribeControllerDetection' => [ - 'summary' => 'Queries the diagnostic results of the access layer.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeColumns' => [ + 'summary' => 'Queries a list of columns in a table.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15074,435 +10958,321 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '194343', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-xxxx', - ], - ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-03-10T23:56Z', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1xxxxxxxx47', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mmZ** format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time. The maximum time range that can be specified is 30 days.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2024-06-23T02:21Z', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese.'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.', - 'type' => 'string', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '257FAE29-ED5F-586C-94E4-43BD1392F238', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-xxx', - ], - 'DetectionItems' => [ - 'description' => 'The queried detection items and detection results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection item and detection result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => 'The information about the detection result.', - 'type' => 'string', - 'example' => 'A CPU increase is detected on the access node.', - ], - 'Name' => [ - 'description' => 'The name of the detection item.'."\n", - 'type' => 'string', - 'example' => 'CPU increase detection', - ], - 'Status' => [ - 'description' => 'The severity level of the detection result. Valid values:'."\n" - ."\n" - .'* NORMAL'."\n" - .'* WARNING'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'NORMAL'."\n" - .'WARNING'."\n" - .'CRITICAL', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-XXX442913CEF'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => 'The queried columns.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried column.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The data type of the column.'."\n", 'type' => 'string', 'example' => 'bigint', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the column.'."\n", 'type' => 'string', 'example' => 'id', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AutoIncrementColumn' => ['description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp111m2cfrdl1****', 'title' => ''], + 'PrimaryKey' => ['description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SchemaName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => 'The response parameters.', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - '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' => 'DescribeControllerDetection', - ], - 'DescribeBadSqlDetection' => [ - 'summary' => 'Queries the bad SQL statements that affect cluster stability within a time range.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeColumns', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:07.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-25T03:37:06.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumns'], + ], ], - 'tags' => [ - 'Perth', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:describeAllDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeCompactionServiceSwitch' => [ + 'summary' => 'Queries whether the remote build feature is enabled in the query acceleration configuration of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '194347', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp149vz49b36t****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-xxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D761DA51-12F8-5457-AAA9-F52B9F436D2D', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableCompactionService' => [ + 'description' => 'Indicates whether the remote build feature is enabled.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMaintainTime.Malformed', 'errorMessage' => 'The specified parameter MaintainTime is not valid.', 'description' => 'The MaintainTime parameter is invalid. Check the parameter.'], + ], + ], + 'title' => 'DescribeCompactionServiceSwitch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCompactionServiceSwitch'], + ], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DescribeCompactionServiceSwitch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D761DA51-12F8-5457-AAA9-F52B9F436D2D\\",\\n \\"Data\\": {\\n \\"EnableCompactionService\\": true\\n }\\n}","type":"json"}]', + ], + 'DescribeComputeResourceUsage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-01-23T02:18Z', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-bp1xxxxxxxx47', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'ResourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2024-11-17T02:16Z', - ], + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese.'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2023-02-04T03:45:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2023-02-05T03:45:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '50', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '584CFCAE-E3C8-5BBB-B46C-724E77A830A7', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-xxxx', - ], - 'DetectionItems' => [ - 'description' => 'The queried detection items and detection results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection item and detection result.', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the detection item.'."\n", - 'type' => 'string', - 'example' => 'Cost', - ], - 'Results' => [ - 'description' => 'The detection result items.', - 'type' => 'array', - 'items' => [ - 'description' => 'The detection result item.', - 'type' => 'object', - 'properties' => [ - 'Cost' => [ - 'description' => 'The total execution duration. Unit: milliseconds.'."\n" - ."\n" - .'> This value is the cumulative value of the `QueuedTime`, `TotalPlanningTime`, and `ExecutionTime` parameters.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '709', - ], - 'PeakMemory' => [ - 'description' => 'The peak memory. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234', - ], - 'OperatorCost' => [ - 'description' => 'The total CPU time consumed by all operators in the stage, which is equivalent to the total CPU time of the stage. You can use this parameter to determine which parts of the stage consume a large amount of computing resources. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2345', - ], - 'ScanSize' => [ - 'description' => 'The amount of scanned data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2342', - ], - 'OutputDataSize' => [ - 'description' => 'The amount of returned data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235433', - ], - 'ProcessId' => [ - 'description' => 'The query ID.'."\n", - 'type' => 'string', - 'example' => '202410161002191720161451770345363xxxx', - ], - 'TotalStages' => [ - 'description' => 'The total number of stages generated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'DiagnosisResults' => [ - 'description' => 'The diagnostic result items.', - 'type' => 'array', - 'items' => [ - 'description' => 'The diagnostic result item.', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The diagnostic code.'."\n", - 'type' => 'string', - 'example' => 'Large amounts of data are returned to the client.', - ], - 'Detail' => [ - 'description' => 'The information about the diagnostic result.', - 'type' => 'string', - 'example' => 'Large amounts of data are returned to the client. Import the data to OSS.', - ], - 'StageId' => [ - 'description' => 'The stage ID.'."\n", - 'type' => 'string', - 'example' => 'Stage[67]', - ], - 'OperatorId' => [ - 'description' => 'The operator ID.'."\n", - 'type' => 'string', - 'example' => 'TableScan[234]', - ], - ], - ], - ], - 'SQL' => [ - 'description' => 'The SQL statement.'."\n" - ."\n" - .'> For performance considerations, an SQL statement cannot exceed 5,120 characters in length. Otherwise, the SQL statement is truncated. You can call the [DownloadDiagnosisRecords](~~308212~~) operation to download the information about SQL statements that meet a query condition for an AnalyticDB for MySQL cluster, including the complete SQL statements.'."\n", - 'type' => 'string', - 'example' => 'SELECT * FROM device WHERE product_key = \'h66zXfxet2X\' AND name = \'device@zntbtfptv5_9237117\'', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-09-06T02:11:00Z', - ], - 'PatternId' => [ - 'description' => 'The SQL pattern ID.'."\n", - 'type' => 'string', - 'example' => '3467484070025860498', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The queried resource usage.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-clusterxxx', 'title' => ''], + 'ResourceGroupType' => ['description' => 'The type of the resource group.'."\n", 'type' => 'string', 'example' => 'interative', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-04-24T07:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-06-07T02:37:00Z', 'title' => ''], + 'AcuInfo' => [ + 'description' => 'The AnalyticDB compute unit (ACU) usage of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The resource usage metric. Valid values:'."\n" + ."\n" + .'* `TotalAcuNumber`: the total number of ACUs.'."\n" + .'* `ReservedAcuNumber`: the number of ACUs for the reserved resources.'."\n" + .'* `ReservedAcuUsageNumber`: the number of ACUs for the reserved resources that are used.'."\n", 'type' => 'string', 'example' => 'TotalAcuNumber', 'title' => ''], + 'Values' => [ + 'description' => 'The values of the metric at specific points in time.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The value of the metric at a specific point in time.'."\n", 'type' => 'string', 'example' => '16.0', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Status' => [ - 'description' => 'The severity level of the detection result. Valid values:'."\n" - ."\n" - .'* NORMAL'."\n" - .'* WARNING'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'WARNING', - ], - 'Message' => [ - 'description' => 'The information about the detection result.', - 'type' => 'string', - 'example' => 'SQL statements that result in high peak memory are detected.', - ], + 'title' => '', + 'example' => '', ], ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The information about the request denial.'."\n", - '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" - .'}', + 'title' => '', + 'example' => '', ], ], - 'description' => 'The response parameters.', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 'title' => 'DescribeComputeResourceUsage', + 'summary' => 'Queries the computing resource usage of a resource group in an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComputeResourceUsage'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeComputeResourceUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - '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' => 'DescribeBadSqlDetection', + '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"}]', ], - 'DescribeAbnormalPatternDetection' => [ - 'summary' => 'Queries abnormal SQL patterns within a time range.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeControllerDetection' => [ + 'summary' => 'Queries the diagnostic results of the access layer.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15514,10 +11284,8 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '194346', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '194343', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -15525,59 +11293,38 @@ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-xxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-xxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-zhangjiakou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2021-09-30T00:10Z', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-03-10T23:56Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2024-11-17T02:16Z', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mmZ** format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time. The maximum time range that can be specified is 30 days.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2024-06-23T02:21Z', 'title' => ''], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* **zh** (default): simplified Chinese.'."\n" - .'* **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'* **zh**: simplified Chinese.'."\n" + .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -15585,21 +11332,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.', - 'type' => 'string', - 'example' => '15', - ], - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '19B824E0-690D-5A78-9992-5398C2F43694', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.', - 'type' => 'string', - 'example' => 'amv-xxxx', - ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '257FAE29-ED5F-586C-94E4-43BD1392F238', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-xxx', 'title' => ''], 'DetectionItems' => [ 'description' => 'The queried detection items and detection results.'."\n", 'type' => 'array', @@ -15607,105 +11342,61 @@ 'description' => 'The queried detection item and detection result.'."\n", 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the detection item.', - 'type' => 'string', - 'example' => 'Cost', - ], - 'Results' => [ - 'description' => 'The detection result items.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detection result item.'."\n", - 'type' => 'object', - 'properties' => [ - 'PatternId' => [ - 'description' => 'The SQL pattern ID.'."\n", - 'type' => 'string', - 'example' => '2803084667741875187', - ], - 'SQLPattern' => [ - 'description' => 'The SQL statement that represents the SQL pattern.', - 'type' => 'string', - 'example' => 'SELECT `tsid`nFROM `prod_ods_marketing_engine_material`nWHERE `tsid` = ?nLIMIT ?', - ], - 'Detail' => [ - 'description' => 'The description of the detection result.', - 'type' => 'string', - 'example' => 'Two SQL patterns that have abnormal totalTime metric values are detected. This may result in increased CPU utilization, query slowdown, and degraded system stability. Go to the monitoring page to diagnose the issue and then perform optimization.', - ], - 'RelatedMetrics' => [ - 'description' => 'The metrics related to the SQL pattern.'."\n", - 'type' => 'string', - 'example' => 'Maximum query duration: 1.43s'."\n" - .'Maximum peak memory: 20.73 MB'."\n" - .'Maximum read table data: 10.12 MB', - ], - 'User' => [ - 'description' => 'The name of the database account that is used to submit the query.', - 'type' => 'string', - 'example' => 'test', - ], - 'AccessIp' => [ - 'description' => 'The IP address of the SQL client that submits the SQL pattern.', - 'type' => 'string', - 'example' => '172.16.133.168', - ], - 'Tables' => [ - 'description' => 'The names of tables.', - 'type' => 'string', - 'example' => 'dw_student_exam.ods_school_queanal', - ], - 'QueryCount' => [ - 'description' => 'The number of queries.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72', - ], - 'FailedCount' => [ - 'description' => 'The number of failed SQL patterns within the time range.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - ], - ], - ], - ], + 'Message' => ['description' => 'The information about the detection result.', 'type' => 'string', 'example' => 'A CPU increase is detected on the access node.', 'title' => ''], + 'Name' => ['description' => 'The name of the detection item.'."\n", 'type' => 'string', 'example' => 'CPU增高检测', 'title' => ''], + 'Status' => ['description' => 'The severity level of the detection result. Valid values:'."\n" + ."\n" + .'* NORMAL'."\n" + .'* WARNING'."\n" + .'* CRITICAL'."\n", 'type' => 'string', 'example' => 'NORMAL'."\n" + .'WARNING'."\n" + .'CRITICAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - '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' => 'DescribeAbnormalPatternDetection', - ], - 'DescribeInclinedNodes' => [ - 'summary' => 'Queries the disk usage of all storage nodes.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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\\": \\"A CPU increase is detected on the access node.\\",\\n \\"Name\\": \\"CPU增高检测\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeControllerDetection', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeControllerDetection'], + ], ], - 'tags' => [ - 'Perth', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeControllerDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeDBClusterAttribute' => [ + 'summary' => 'Returns the details of a specific cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15715,50 +11406,19 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '217356', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130313', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-wz9jd******d1765', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of file titles and error messages. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of an Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to obtain the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], ], ], 'responses' => [ @@ -15766,65 +11426,314 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C0BF6685-0519-543E-90F8-DB8949E4D5F2', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], 'Items' => [ - 'description' => 'The queried storage nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried storage node.'."\n", - 'type' => 'object', - 'properties' => [ - 'Node' => [ - 'description' => 'The number of the storage node.'."\n", - 'type' => 'string', - 'example' => 'Node1', - ], - 'DiskUsageRatio' => [ - 'description' => 'The disk usage of the storage node.'."\n", - 'type' => 'string', - 'example' => '90.5', + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => 'The information about the Enterprise Edition and Basic Edition clusters.'."\n" + .'The information about the Data Lakehouse Edition clusters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the cluster.', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => ['description' => 'The time when the cluster was created. The time is in the `yyyy-MM-ddThh:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2022-07-01T09:50:18Z', 'title' => ''], + 'Expired' => ['description' => 'Indicates whether the subscription cluster has expired. Valid values:'."\n" + ."\n" + .'- **true**: The cluster has expired.'."\n" + ."\n" + .'- **false**: The cluster has not expired.'."\n" + ."\n" + .'> * If a cluster expires, the cluster is locked or even released after a period of time. We recommend that you renew the cluster. For more information, see [Renewal](~~135248~~).'."\n" + ."\n" + .'- This parameter is not returned for pay-as-you-go clusters.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'MaintainTime' => ['description' => 'The maintenance window of the cluster. The time is in the `HH:mmZ-HH:mmZ` format and is displayed in UTC.'."\n" + ."\n" + .'> For more information about maintenance windows, see [Set a maintenance window](~~122569~~).', 'type' => 'string', 'example' => '04:00Z-05:00Z', 'title' => ''], + 'PayType' => ['description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + ."\n" + .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n" + ."\n" + .'> To add tags to the cluster, call the [TagResources](~~179253~~) operation.', 'type' => 'string', 'example' => 'tag1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Mode' => ['description' => 'The mode of the cluster. The default value is **flexible**, which indicates an elastic mode cluster.', 'type' => 'string', 'example' => 'flexible', 'title' => ''], + 'Port' => ['description' => 'The port number of the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', 'title' => ''], + 'LockMode' => ['description' => 'The lock mode of the cluster. Valid values:'."\n" + ."\n" + .'- **Unlock**: The cluster is not locked.'."\n" + ."\n" + .'- **ManualLock**: The cluster is manually locked.'."\n" + ."\n" + .'- **LockByExpiration**: The cluster is automatically locked due to expiration.', 'type' => 'string', 'example' => 'ManualLock', 'title' => ''], + 'EngineVersion' => ['description' => 'The engine version of the cluster.', 'type' => 'string', 'default' => '3.1.7.0', 'example' => '3.1.16', 'title' => ''], + 'StorageResource' => ['description' => 'The amount of reserved storage resources. These resources are used for data reads and writes. Increasing them can improve the cluster\'s read and write performance.', 'type' => 'string', 'example' => '24ACU', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'example' => 'amv-wz9509beptiz****', 'title' => ''], + 'ConnectionString' => ['description' => 'The VPC endpoint of the cluster.', 'type' => 'string', 'example' => 'amv-wz9509beptiz****.ads.aliyuncs.com', 'title' => ''], + 'DBClusterType' => ['description' => 'The type of the cluster. The default value is **Common**, which indicates a regular cluster.', 'type' => 'string', 'example' => 'Common', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code of the cluster, which is the same as the code of the cluster on the Billing Management page. Valid values:'."\n" + ."\n" + .'- **ads**: A pay-as-you-go cluster.'."\n" + ."\n" + .'- **ads\\_pre**: A subscription cluster.', 'type' => 'string', 'example' => 'ads_pre', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the cluster.'."\n" + ."\n" + .'- If the cluster is a subscription cluster, the expiration time is returned.'."\n" + ."\n" + .'- If the cluster is a pay-as-you-go cluster, an empty string is returned.', 'type' => 'string', 'example' => '2022-10-01T09:50:18Z', 'title' => ''], + 'LockReason' => ['description' => 'The reason why the cluster is locked.'."\n" + ."\n" + .'> This parameter is returned only when the cluster is locked. The value is always **instance\\_expire**.', 'type' => 'string', 'example' => 'instance_expire', 'title' => ''], + 'VPCId' => ['description' => 'The Virtual Private Cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-bp13h7uzhulpu****', 'title' => ''], + 'ComputeResource' => ['description' => 'The amount of reserved computing resources. One AnalyticDB Compute Unit (ACU) is equivalent to approximately 1 core and 4 GB of memory. Computing resources are used for data computation. Increasing these resources can accelerate queries. You can scale the resources on demand based on the actual performance of the cluster.', 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the cluster.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf629gydd54ld****', 'title' => ''], + 'DBVersion' => ['description' => 'The version of the AnalyticDB for MySQL cluster. Currently, only version **5.0** is supported.', 'type' => 'string', 'example' => '5.0', 'title' => ''], + 'DBClusterStatus' => ['description' => 'The status of the cluster. Valid values:'."\n" + ."\n" + .'- **Preparing**: The cluster is being prepared.'."\n" + ."\n" + .'- **Creating**: The cluster is being created.'."\n" + ."\n" + .'- **Running**: The cluster is running.'."\n" + ."\n" + .'- **Deleting**: The cluster is being deleted.'."\n" + ."\n" + .'- **Restoring**: The cluster is being restored from a backup.'."\n" + ."\n" + .'- **ClassChanging**: The cluster specifications are being changed.'."\n" + ."\n" + .'- **NetAddressCreating**: A network connection is being created.'."\n" + ."\n" + .'- **NetAddressDeleting**: A network connection is being deleted.'."\n" + ."\n" + .'- **NetAddressModifying**: A network connection is being modified.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], + 'DBClusterNetworkType' => ['description' => 'The network type of the cluster. Only **VPC** (Virtual Private Cloud) is supported.', 'type' => 'string', 'default' => 'VPC', 'example' => 'VPC', 'title' => ''], + 'DBClusterDescription' => ['description' => 'The description of the cluster.', 'type' => 'string', 'example' => 'adb_test', 'title' => ''], + 'UserENIStatus' => ['description' => 'Indicates whether an elastic network interface (ENI) is enabled. Valid values:'."\n" + ."\n" + .'- **true**: An ENI is enabled.'."\n" + ."\n" + .'- **false**: An ENI is not enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID of the cluster.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'Engine' => ['description' => 'The database engine of the cluster. The value is always **AnalyticDB**.', 'type' => 'string', 'example' => 'AnalyticDB', 'title' => ''], + 'ReservedACU' => ['description' => 'The amount of available reserved computing resources in the cluster.', 'type' => 'string', 'example' => '24ACU', 'title' => ''], + 'ComputeResourceTotal' => ['description' => 'The total amount of computing resources in the cluster.', 'type' => 'string', 'example' => '48ACU', 'title' => ''], + 'StorageResourceTotal' => ['description' => 'The total amount of storage resources in the cluster.', 'type' => 'string', 'example' => '24ACU', 'title' => ''], + 'SupportedFeatures' => [ + 'description' => 'This parameter is reserved for future use.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'This parameter is reserved for future use.', 'type' => 'string', 'example' => '预留参数，不涉及。', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ProductForm' => [ + 'description' => 'This parameter is reserved for future use.', + 'type' => 'string', + 'example' => 'Reserved parameter. Not applicable.', + 'enum' => ['IntegrationForm', 'LegacyForm'], + 'title' => '', + ], + 'ReservedNodeSize' => ['description' => 'This parameter is reserved for future use.', 'type' => 'string', 'example' => 'Reserved parameter. Not applicable.', 'title' => ''], + 'ReservedNodeCount' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'example' => 'Reserved parameter. Not applicable.', 'format' => 'int32', 'title' => ''], + 'ClickhouseEngineEnabled' => [ + 'description' => 'Indicates whether the ClickHouse wide table engine is enabled.'."\n" + ."\n" + .'- **true**: The ClickHouse wide table engine is enabled.'."\n" + ."\n" + .'- **false**: The ClickHouse wide table engine is not enabled.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'AINodeNumber' => ['description' => 'The number of AI nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ProductVersion' => ['description' => 'The product version of the cluster. Valid values:'."\n" + ."\n" + .'- **BasicVersion**: Basic Edition.'."\n" + ."\n" + .'- **EnterpriseVersion**: Enterprise Edition.', 'type' => 'string', 'example' => 'BasicVersion', 'title' => ''], + 'KmsId' => ['description' => 'The key ID used for disk encryption.'."\n" + ."\n" + .'> This parameter is returned only when disk encryption is enabled for the AnalyticDB for MySQL cluster.', 'type' => 'string', 'example' => 'e1935511-cf88-1123-a0f8-1be8d251****', 'title' => ''], + 'TaskInfo' => [ + 'description' => 'The task information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'ScaleUpDBCluster', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'- NOT\\_RUN: The task is waiting to run.'."\n" + ."\n" + .'- RUNNING: The task is running.'."\n" + ."\n" + .'- SUCCEED: The task is complete.', + 'type' => 'string', + 'enum' => ['RUNNING', 'SUCCEED', 'NOT_RUN'], + 'example' => 'RUNNING', + 'title' => '', + ], + 'Progress' => ['description' => 'The progress of the task, in percentage.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'StepList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StepList' => [ + 'description' => 'The steps of the task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a step.', + 'type' => 'object', + 'properties' => [ + 'StepName' => ['description' => 'The name of the step.', 'type' => 'string', 'example' => 'PrepareResources', 'title' => ''], + 'StepDesc' => ['description' => 'The description of the step.', 'type' => 'string', 'example' => 'Prepare resources', 'title' => ''], + 'StepStatus' => [ + 'description' => 'The status of the step. Valid values:'."\n" + ."\n" + .'- NOT\\_RUN: The step is waiting to run.'."\n" + ."\n" + .'- RUNNING: The step is running.'."\n" + ."\n" + .'- SUCCEED: The step is complete.', + 'type' => 'string', + 'enum' => ['RUNNING', 'SUCCEED', 'NOT_RUN'], + 'example' => 'RUNNING', + 'title' => '', + ], + 'StepProgress' => ['description' => 'The progress of the step, in percentage.', 'type' => 'string', 'example' => '50', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the step. The time is in the `yyyy-MM-ddThh:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2024-03-10T09:28:34Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the step. The time is in the `yyyy-MM-ddThh:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2024-03-10T10:28:34Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'UserENIVpcId' => ['description' => 'The VPC information of the ENI.', 'type' => 'string', 'example' => 'vpc-rj9hnedlfm645uj******', 'title' => ''], + 'UserENIVSwitchOptions' => ['description' => 'The vSwitch IDs for the ENI. Multiple IDs are separated by commas (,).', 'type' => 'string', 'example' => 'vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******', 'title' => ''], + 'UserENIZoneOptions' => ['description' => 'The zone IDs for the ENI. Multiple IDs are separated by commas (,).', 'type' => 'string', 'example' => 'cn-hangzhou-k,cn-hangzhou-h', 'title' => ''], + 'SecondaryZoneId' => ['description' => 'The ID of the secondary zone.', 'type' => 'string', 'example' => 'cn-hangzhou-k', 'title' => ''], + 'SecondaryVSwitchId' => ['description' => 'The ID of the secondary vSwitch.', 'type' => 'string', 'example' => 'vsw-8vbl7kfaxxxxx', 'title' => ''], + 'DiskEncryption' => ['description' => 'Indicates whether disk encryption is enabled. Valid values:'."\n" + ."\n" + .'- true: Disk encryption is enabled.'."\n" + ."\n" + .'- false: Disk encryption is not enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ClickhouseEngineCacheSize' => ['description' => 'The cache size of the ClickHouse wide table engine, in GB. A value of -1 indicates that the wide table engine is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'AINodeSpec' => ['description' => 'The specifications of the AI nodes.', 'type' => 'string', 'example' => 'ADB.MLGrand.5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - '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' => 'DescribeInclinedNodes', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeDBClusterHealthStatus' => [ - 'summary' => 'Queries the health status of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","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\\": \\"Reserved parameter. Not applicable.\\",\\n \\"ReservedNodeSize\\": \\"Reserved parameter. Not applicable.\\",\\n \\"ReservedNodeCount\\": 0,\\n \\"ClickhouseEngineEnabled\\": true,\\n \\"AINodeNumber\\": 3,\\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\\": \\"cn-hangzhou-k\\",\\n \\"SecondaryVSwitchId\\": \\"vsw-8vbl7kfaxxxxx\\",\\n \\"DiskEncryption\\": false,\\n \\"ClickhouseEngineCacheSize\\": 100,\\n \\"AINodeSpec\\": \\"ADB.MLGrand.5\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDBClusterAttribute', + 'description' => 'To find the endpoints for this service, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-06-25T11:59:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-04T16:10:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-25T18:09:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-25T02:08:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-13T13:53:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-28T03:05:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-23T06:30:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-09T02:08:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-26T07:36:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-27T11:22:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-03T03:01:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-27T12:01:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-11T16:52:03.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterAttribute'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'translator' => 'manual', + ], + 'DescribeDBClusterHealthStatus' => [ + 'summary' => 'View a cluster\'s health status.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15837,36 +11746,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '151720', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-uf6o6m8p6x7v****', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of clusters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-uf6o6m8p6x7v****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -15875,168 +11771,116 @@ 'type' => 'object', 'properties' => [ 'CS' => [ - 'description' => 'The access nodes of the queried cluster.'."\n", + 'description' => 'The health status of the instance access nodes.', 'type' => 'object', 'properties' => [ - 'ActiveCount' => [ - 'description' => 'The number of healthy access nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'UnavailableCount' => [ - 'description' => 'The number of unavailable access nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RiskCount' => [ - 'description' => 'The number of risky nodes.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ExpectedCount' => [ - 'description' => 'The total number of access nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Status' => [ - 'description' => 'The health state of access nodes. Valid values:'."\n" - ."\n" - .'* **RISK**'."\n" - .'* **NORMAL**'."\n" - .'* **UNAVAILABLE**'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], + 'ActiveCount' => ['description' => 'The number of healthy instance access nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'UnavailableCount' => ['description' => 'The number of unavailable instance access nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RiskCount' => ['description' => 'The number of instance access nodes at risk.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ExpectedCount' => ['description' => 'The total number of instance access nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The health status of the instance access nodes. Valid values:'."\n" + ."\n" + .'- **RISK**: The instance access nodes are at risk.'."\n" + ."\n" + .'- **NORMAL**: The instance access nodes are healthy.'."\n" + ."\n" + .'- **UNAVAILABLE**: The instance access nodes are unavailable.', 'type' => 'string', 'example' => 'UNAVAILABLE', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'Executor' => [ - 'description' => 'The compute node groups of the queried cluster.'."\n", + 'description' => 'The health status of the executor groups.', 'type' => 'object', 'properties' => [ - 'ActiveCount' => [ - 'description' => 'The number of healthy access nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'UnavailableCount' => [ - 'description' => 'The number of unavailable access nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RiskCount' => [ - 'description' => 'The number of risky nodes.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ExpectedCount' => [ - 'description' => 'The total number of compute nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Status' => [ - 'description' => 'The health state of compute node groups. Valid values:'."\n" - ."\n" - .'* **RISK**'."\n" - .'* **NORMAL**'."\n" - .'* **UNAVAILABLE**'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], + 'ActiveCount' => ['description' => 'The number of healthy executor nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'UnavailableCount' => ['description' => 'The number of unavailable executor nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RiskCount' => ['description' => 'The number of executor nodes at risk.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ExpectedCount' => ['description' => 'The total number of executor nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The health status of the executor groups. Valid values:'."\n" + ."\n" + .'- **RISK**: The executor groups are at risk.'."\n" + ."\n" + .'- **NORMAL**: The executor groups are healthy.'."\n" + ."\n" + .'- **UNAVAILABLE**: The executor groups are unavailable.', 'type' => 'string', 'example' => 'UNAVAILABLE', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'Worker' => [ - 'description' => 'The storage node groups of the queried cluster.'."\n", + 'description' => 'The health status of the worker node groups.', 'type' => 'object', 'properties' => [ - 'ActiveCount' => [ - 'description' => 'The number of healthy storage node groups.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'UnavailableCount' => [ - 'description' => 'The number of unavailable storage node groups.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RiskCount' => [ - 'description' => 'The number of risky storage node groups.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ExpectedCount' => [ - 'description' => 'The total number of storage node groups.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Status' => [ - 'description' => 'The health state of storage node groups. Valid values:'."\n" - ."\n" - .'* **RISK**'."\n" - .'* **NORMAL**'."\n" - .'* **UNAVAILABLE**'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], + 'ActiveCount' => ['description' => 'The number of healthy worker node groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'UnavailableCount' => ['description' => 'The number of unavailable worker node groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RiskCount' => ['description' => 'The number of worker node groups at risk.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ExpectedCount' => ['description' => 'The total number of worker node groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The health status of the worker node groups. Valid values:'."\n" + ."\n" + .'- **RISK**: The worker node groups are at risk.'."\n" + ."\n" + .'- **NORMAL**: The worker node groups are healthy.'."\n" + ."\n" + .'- **UNAVAILABLE**: The worker node groups are unavailable.', 'type' => 'string', 'example' => 'UNAVAILABLE', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'InstanceStatus' => [ - 'description' => 'The health state of the cluster. Valid values:'."\n" - ."\n" - .'* **RISK**'."\n" - .'* **NORMAL**'."\n" - .'* **UNAVAILABLE**'."\n" - ."\n" - .'> When the states of the access nodes, compute node groups, and storage node groups of a cluster are all **NORMAL** and a connection to the cluster is established, the state of the cluster is **NORMAL**. When the state of the access nodes, compute node groups, or storage node groups of the cluster is **RISK**, the state of the cluster is **RISK**. When the state of the access nodes, compute node groups, or storage node groups of the cluster is **UNAVAILABLE**, the state of the cluster is **UNAVAILABLE**.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEA', - ], - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], + 'InstanceStatus' => ['description' => 'The health status of the cluster. Valid values:'."\n" + ."\n" + .'- **RISK**: The cluster is at risk.'."\n" + ."\n" + .'- **NORMAL**: The cluster is healthy.'."\n" + ."\n" + .'- **UNAVAILABLE**: The cluster is unavailable.'."\n" + ."\n" + .'> The cluster health status is considered **NORMAL** only if the instance access nodes, executor groups, and worker node groups are all **NORMAL**, and the instance is responsive. If any of these components has a **RISK** status, the cluster status is **RISK**. If any component has an **UNAVAILABLE** status, the cluster status is **UNAVAILABLE**.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CAV', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'Details of the authentication failure.', 'type' => 'string', 'example' => 'Authentication failed.', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - '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"}]', + '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\\": \\"Authentication failed.\\"\\n}","type":"json"}]', 'title' => 'DescribeDBClusterHealthStatus', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeDBClusterPerformance' => [ - 'summary' => 'Queries the performance data of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'get', - 'post', + 'description' => 'For the service access address, see [service endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-05-14T08:33:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-01T03:15:34.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterHealthStatus'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterHealthStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => 'View target cluster performance data.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16049,82 +11893,46 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '131503', - 'abilityTreeNodes' => [ - 'FEATUREadsCVPI8C', - ], + 'abilityTreeNodes' => ['FEATUREadsCVPI8C'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~~612397~~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1hx5n1o8f61****', - ], + 'schema' => ['description' => 'The ID of an enterprise edition, basic edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of a Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~~612397~~~) operation to query the IDs of all clusters in a specific region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1hx5n1o8f61****', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The key of the performance metric that you want to query. Separate multiple keys with commas (,). For more information about the performance metrics, see [Metric overview](~~2863211~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'AnalyticDB_CPU_Usage_Percentage', - 'default' => 'AnalyticDB_CPU_Usage_Percentage', - ], + 'schema' => ['description' => 'The key of the performance metric. Separate multiple keys with commas (,). For a list of supported metrics, see [metric overview](~~2863211~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'AnalyticDB_CPU_Usage_Percentage', 'example' => 'AnalyticDB_CPU_Usage_Percentage', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-03-10T23:56Z', - ], + 'schema' => ['description' => 'The start of the time range. The time is in UTC and must be in the *yyyy-MM-ddTHH:mmZ* format.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-03-10T23:56Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time. The maximum time range that can be specified is two days.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-03-11T15:01Z', - ], + 'schema' => ['description' => 'The end of the time range. The time is in UTC and must be in the *yyyy-MM-ddTHH:mmZ* format.'."\n" + ."\n" + .'> The end time must be later than the start time. The time range cannot exceed two days.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-03-11T15:01Z', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~612393~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~612393~~) operation to query the regions and availability zones supported by AnalyticDB for MySQL, including the region IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourcePools', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user_default', - ], + 'schema' => ['description' => 'The name of the resource pool.', 'type' => 'string', 'required' => false, 'example' => 'user_default', 'title' => ''], ], ], 'responses' => [ @@ -16132,247 +11940,321 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-03-11T15:01Z', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BD8C3096-8BC6-51DF-A4AB-BACD9DC10435', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-03-10T23:56Z', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1hx5n1o8f61****', - ], + 'EndTime' => ['description' => 'The end time of the query. The time is in UTC and uses the *yyyy-MM-ddTHH:mmZ* format.', 'type' => 'string', 'example' => '2022-03-11T15:01Z', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BD8C3096-8BC6-51DF-A4AB-BACD9DC10435', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. The time is in UTC and uses the *yyyy-MM-ddTHH:mmZ* format.', 'type' => 'string', 'example' => '2022-03-10T23:56Z', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> Call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all clusters in a specific region.', 'type' => 'string', 'example' => 'amv-bp1hx5n1o8f61****', 'title' => ''], 'Performances' => [ - 'description' => 'The queried performance metrics.'."\n", + 'description' => 'The cluster performance metrics.', 'type' => 'array', 'items' => [ - 'description' => 'The queried performance metric.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The name of the performance metric.'."\n", - 'type' => 'string', - 'example' => 'AnalyticDB_CPU_Usage_Percentage', - ], - 'Unit' => [ - 'description' => 'The unit of the performance metric.'."\n", - 'type' => 'string', - 'example' => '%', - ], + 'Key' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'AnalyticDB_CPU_Usage_Percentage', 'title' => ''], + 'Unit' => ['description' => 'The unit of the monitoring metric.', 'type' => 'string', 'example' => '%', 'title' => ''], 'Series' => [ - 'description' => 'The queried performance metric data.'."\n", + 'description' => 'The time series data for the metric.', 'type' => 'array', 'items' => [ - 'description' => 'The queried performance metric data.'."\n", + 'description' => 'The details of a time series.', 'type' => 'object', 'properties' => [ 'Values' => [ - 'description' => 'The values of the performance metric at different points in time.'."\n", + 'description' => 'An array of data points for the time series.', 'type' => 'array', - 'items' => [ - 'description' => 'The value of the performance metric at a specific point in time.'."\n", - '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' => 'The name of the performance metric value. For more information about the performance metrics, see [Metric overview](~~2863211~~).'."\n", - 'type' => 'string', - 'example' => 'AnalyticDB_Storage_CPU_Avg_Usage_Percentage', - ], - 'Tags' => [ - 'description' => 'The tags that are added to the cluster.'."\n", - 'type' => 'string', - 'example' => "\n" - .'{instance_name: "am-***"}', - ], - 'TranslateKey' => [ - 'type' => 'string', + 'items' => ['description' => 'A data point, which is an array that contains a timestamp string and a value string.', '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" + .']', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Name' => ['description' => 'The name of the performance metric. This parameter is the Value Name of the monitoring metric. For more information, see [Overview of Monitoring Items](~~2863211~~).', 'type' => 'string', 'example' => 'AnalyticDB_Storage_CPU_Avg_Usage_Percentage', 'title' => ''], + 'Tags' => ['description' => 'A JSON string that contains the tags for the metric series.', 'type' => 'string', 'example' => "\n" + .'{instance_name: "am-***"}', 'title' => ''], + 'TranslateKey' => ['description' => 'A key for internal internationalization (i18n). You can safely ignore this parameter.', 'type' => 'string', 'example' => 'AnalyticDB_RP_WaitTime', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['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.', 'description' => ''], ], ], - '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":""}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","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\\": \\"AnalyticDB_RP_WaitTime\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeDBClusterPerformance', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeClusterResourceUsage' => [ - 'summary' => 'Queries the resource usage of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'get', + 'description' => 'For the service endpoint address, see [service endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-12-16T07:27:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-13T12:07:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-01T08:50:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-03-22T08:51:02.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterPerformance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'translator' => 'manual', + ], + 'DescribeDBClusterSSL' => [ + 'summary' => 'Queries the SSL configurations of a cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '220651', + 'abilityTreeNodes' => ['FEATUREadsG383TB'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~612393~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-************', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => '348303D8-6F42-5141-9B00-A6EECA1E37B6', 'title' => ''], + 'ExpireTime' => ['description' => 'The validity period of the SSL certificate. Format: yyyy-MM-ddTHH:mm:ssZ(UTC time).'."\n", 'type' => 'string', 'example' => '2022-10-11T08:16:43Z', 'title' => ''], + 'ConnectionString' => ['description' => 'The endpoint that is protected by SSL encryption.'."\n", 'type' => 'string', 'example' => 'amv-*********.ads.aliyuncs.com', 'title' => ''], + 'SSLEnabled' => ['description' => 'Indicates whether SSL encryption is enabled. Default value: true. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + 'title' => 'DescribeDBClusterSSL', + 'description' => '>目前该功能处于内测阶段，控制台界面展示及API调用接口尚未稳定，可能持续变化。>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterSSL'], + ], + ], + 'ramActions' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-11-29T10:20Z', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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"}]', + ], + 'DescribeDBClusterSpaceSummary' => [ + 'summary' => 'Queries the storage overview information of an AnalyticDB for MySQL cluster, such as the total data size, hot data size, cold data size, and data growth.', + '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' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-wz9v5sa7mm79z4l2', 'title' => ''], + ], [ - 'name' => 'EndTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-08-22T01:06:00Z', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PlainResponse', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], 'Data' => [ - 'description' => 'The queried resource usage.'."\n", + 'description' => 'The queried storage overview information.'."\n", 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-uf6dj23rt5zo9s9d', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-03-14T03:42:15Z', + 'TotalSize' => ['description' => 'The total data size. Unit: bytes.'."\n" + ."\n" + .'> Formula: Total data size = Hot data size+ Cold data size.'."\n", 'type' => 'string', 'example' => '8388608', 'title' => ''], + 'HotData' => [ + 'description' => 'The hot data.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => ['description' => 'The hot data size. Unit: bytes.'."\n" + ."\n" + .'> Formula: Hot data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4194304', 'title' => ''], + 'DataSize' => ['description' => 'The data size of table records. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + 'IndexSize' => ['description' => 'The data size of regular indexes. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + 'PrimaryKeyIndexSize' => ['description' => 'The data size of primary key indexes. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + 'OtherSize' => ['description' => 'The data size of other data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'EndTime' => [ - 'description' => 'The end time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-03-23T02:31Z', + 'ColdData' => [ + 'description' => 'The cold data.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => ['description' => 'The cold data size. Unit: bytes.'."\n" + ."\n" + .'> Formula: Cold data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4194304', 'title' => ''], + 'DataSize' => ['description' => 'The data size of table records. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + 'IndexSize' => ['description' => 'The data size of regular indexes. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + 'PrimaryKeyIndexSize' => ['description' => 'The data size of primary key indexes. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + 'OtherSize' => ['description' => 'The data size of other data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'AcuInfo' => [ - 'description' => 'The AnalyticDB compute unit (ACU) usage of the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The resource usage metric. Valid values:'."\n" - ."\n" - .'* `TotalAcuNumber`: the total number of ACUs.'."\n" - .'* `ReservedAcuNumber`: the number of ACUs for the reserved resources.'."\n" - .'* `ReservedAcuUsageNumber`: the number of ACUs for the reserved resources that are used.'."\n", - 'type' => 'string', - 'example' => 'TotalAcuNumber', - ], - 'Values' => [ - 'description' => 'The values of the metric at specific points in time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the metric at a specific point in time.'."\n", - 'type' => 'string', - 'example' => '16.0', - ], - ], - ], + 'DataGrowth' => [ + 'description' => 'The data growth.'."\n", + 'type' => 'object', + 'properties' => [ + 'DayGrowth' => ['description' => 'The data growth within the last day. Unit: bytes.'."\n" + ."\n" + .'> Formula: Data growth within the last day = Current data size - Data size one day ago.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + 'WeekGrowth' => ['description' => 'The daily data growth within the last seven days. Unit: bytes.'."\n" + ."\n" + .'> Formula: Daily data growth within the last seven days = (Current data size - Data size seven days ago)/7.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeClusterResourceUsage', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + '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' => 'DescribeDBClusterSpaceSummary', 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeClusterResourceDetail' => [ - 'summary' => 'Queries the information about resource usage of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterSpaceSummary'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterSpaceSummary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeDBClusterStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16382,175 +12264,78 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'abilityTreeCode' => '133754', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1jj9xqft1po****', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'>You can call the [DescribeRegions](~~143074~~) operation to query available region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PlainResponse', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The queried resource usage.'."\n", - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-adbxxxxx', - ], - 'ComputeResource' => [ - 'description' => 'The amount of reserved computing resources. Unit: AnalyticDB compute units (ACUs). Valid values: 0 to 4096. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.'."\n", - 'type' => 'string', - 'example' => '16ACU', - ], - 'FreeComputeResource' => [ - 'description' => 'The amount of idle reserved computing resources. Unit: ACUs. Valid values: 0 to 4096. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.'."\n", - 'type' => 'string', - 'example' => '0ACU', - ], - 'StorageResource' => [ - 'description' => 'The amount of reserved storage resources. Unit: ACUs. Valid values: 0 to 2064. The value must be in increments of 24 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.'."\n", - 'type' => 'string', - 'example' => '24ACU', - ], - 'ResourceGroupList' => [ - 'description' => 'The resource groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PoolId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17', - ], - 'PoolName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'testadb', - ], - 'PoolType' => [ - 'description' => 'The type of the resource group.'."\n", - 'type' => 'string', - 'example' => 'interactive', - ], - 'MinComputeResource' => [ - 'description' => 'The minimum amount of reserved computing resources.', - 'type' => 'string', - 'example' => '16ACU', - ], - 'MaxComputeResource' => [ - 'description' => 'The maximum amount of reserved computing resources.', - 'type' => 'string', - 'example' => '128ACU', - ], - 'PoolUsers' => [ - 'description' => 'The user of the resource group.'."\n", - 'type' => 'string', - 'example' => 'user1', - ], - 'Status' => [ - 'description' => 'The status of the resource group. Valid values:'."\n" - ."\n" - .'* **running**'."\n" - .'* **deleting**'."\n" - .'* **scaling**'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'ClusterSizeResource' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'MinClusterCount' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxClusterCount' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RunningClusterCount' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ClusterMode' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0', - 'default' => 'Disable', - ], - 'EnableSpot' => [ - 'description' => 'Indicates whether the preemptible instance feature is enabled for the resource group. After the preemptible instance feature is enabled, you are charged for resources at a lower unit price but the resources are probably released. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n" - ."\n" - .'The True value is returned only for job resource groups.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], + 'Status' => [ + 'description' => 'The cluster status list.', + 'type' => 'array', + 'items' => ['description' => 'The cluster status. Valid values:'."\n" + .'- **Preparing**: The cluster is being prepared.'."\n" + ."\n" + .'- **Creating**: The cluster is being created.'."\n" + ."\n" + .'- **Restoring**: The cluster is being restored from a backup.'."\n" + ."\n" + .'- **Running**: The cluster is running.'."\n" + ."\n" + .'- **Deleting**: The cluster is being deleted.'."\n" + ."\n" + .'- **ClassChanging**: The cluster specifications are being changed.'."\n" + ."\n" + .'- **NetAddressCreating**: A network connection is being created.'."\n" + ."\n" + .'- **NetAddressDeleting**: A network connection is being released.'."\n" + ."\n" + .'- **NetAddressModifying**: The network address is being modified.'."\n" + ."\n" + .'- **EngineVersionUpgrading**: The engine version is being upgraded.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAU', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeClusterResourceDetail', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeStorageResourceUsage' => [ - 'summary' => 'Queries the storage resource usage of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Query the status list of a cluster', + 'summary' => 'Queries the status list of a cluster.', + 'description' => 'For the service registration information of this service, see [Endpoint](~~612373~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterStatus'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": [\\n \\"Running\\"\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAU\\"\\n}","type":"json"}]', + ], + 'DescribeDBClusters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16559,610 +12344,858 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130697', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp10yt0gva71ei7d', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the IDs of available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-08-22T01:06:00Z'."\n", - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'If you omit this parameter, the operation returns information about all clusters in the specified region.', 'type' => 'string', 'required' => false, 'example' => 'amv-bp1r053byu48p****', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-08-23T01:06:00Z'."\n", - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'PlainResponse', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The queried resource usage.'."\n", - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1bg858bo8c****', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-08-22T01:06:00Z'."\n", - ], - 'EndTime' => [ - 'description' => 'The end time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-08-23T01:06:00Z'."\n", - ], - 'AcuInfo' => [ - 'description' => 'The AnalyticDB compute unit (ACU) usage of the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The resource usage metric. Valid values:'."\n" - ."\n" - .'* `TotalAcuNumber`: the total number of ACUs.'."\n" - .'* `ReservedAcuNumber`: the number of ACUs for the reserved resources.'."\n", - 'type' => 'string', - 'example' => 'TotalAcuNumber', - ], - 'Values' => [ - 'description' => 'The values of the metric at specific points in time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the metric at a specific point in time.'."\n", - 'type' => 'string', - 'example' => '16ACU', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'schema' => ['description' => 'The cluster description.'."\n" + ."\n" + .'- Cannot start with `http://` or `https://`.'."\n" + ."\n" + .'- The description must be 2 to 256 characters long.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], - ], - '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' => 'DescribeStorageResourceUsage', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeJobResourceUsage' => [ - 'summary' => 'Retrieves resource usage statistics for a job.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => ['description' => 'The cluster status. Valid values:'."\n" + ."\n" + .'- **Preparing**: The cluster is preparing.'."\n" + ."\n" + .'- **Creating**: The cluster is being created.'."\n" + ."\n" + .'- **Running**: The cluster is running.'."\n" + ."\n" + .'- **Deleting**: The cluster is being deleted.'."\n" + ."\n" + .'- **Restoring**: The cluster is being restored from a backup.'."\n" + ."\n" + .'- **ClassChanging**: The cluster specifications are changing.'."\n" + ."\n" + .'- **NetAddressCreating**: A network connection is being created for the cluster.'."\n" + ."\n" + .'- **NetAddressDeleting**: The network connection of the cluster is being deleted.'."\n" + ."\n" + .'- **NetAddressModifying**: The network connection of the cluster is being modified.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '173228', - 'abilityTreeNodes' => [ - 'FEATUREadsCQJTKP', + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30** (default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-uf6g8w25jacm7****', - ], + 'schema' => ['description' => 'The page number. The value must be a positive integer. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-02-04T03:45:00Z', - ], + 'schema' => ['description' => 'The ID of the resource group. If you omit this parameter, the operation returns information about clusters in all resource groups.', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-03-17T16:00:00Z', + 'description' => 'The tags to filter clusters by.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a cluster tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'ProductVersion', 'in' => 'query', 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The product version. Valid values:'."\n" + ."\n" + .'- **EnterpriseVersion**: Enterprise edition.'."\n" + ."\n" + .'- **BasicVersion**: Basic edition.'."\n" + ."\n" + .'> If you omit this parameter, the operation returns clusters of all product versions.', + 'type' => 'string', + 'enum' => ['EnterpriseVersion', 'BasicVersion'], + 'required' => false, + 'example' => 'BasicVersion', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'DBClusterVersion', 'in' => 'query', 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The cluster version. Valid values:'."\n" + ."\n" + .'- **3.0**: Data Warehouse edition.'."\n" + ."\n" + .'- **5.0** (default): Includes the Lakehouse, Enterprise, and Basic editions.'."\n" + ."\n" + .'- **All**: All editions, including the Data Warehouse, Lakehouse, Enterprise, and Basic editions.', + 'type' => 'string', + 'default' => '5.0', + 'enum' => ['All', '3.0', '5.0'], + 'required' => false, + 'example' => '5.0', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PlainResponse', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The queried resource usage.'."\n", + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5EDBA27-AF3E-5966-9503-FD1557E19167', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-clusterxxx', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-05-22T16:00:00Z', - ], - 'EndTime' => [ - 'description' => 'The end time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-05-23T16:00:00Z'."\n", - ], - 'JobAcuUsage' => [ - 'description' => 'The AnalyticDB compute unit (ACU) usage of the job resource group.'."\n", + 'DBCluster' => [ + 'description' => 'The details of the clusters.', 'type' => 'array', 'items' => [ + 'description' => 'The details of the cluster.', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '1592', - ], - 'ResourceGroupName' => [ - 'description' => 'The name of the job resource group.'."\n", - 'type' => 'string', - 'example' => 'job_default', - ], - 'JobStartTime' => [ - 'description' => 'The start time of the job. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-05-22T16:00:00Z'."\n", - ], - 'JobEndTime' => [ - 'description' => 'The end time of the job. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-05-23T16:00:00Z', - ], - 'AcuUsageDetail' => [ - 'description' => 'The ACU usage.'."\n", + 'Expired' => ['description' => 'Indicates whether the subscription cluster has expired. Valid values:'."\n" + ."\n" + .'- **true**: The cluster has expired.'."\n" + ."\n" + .'- **false**: The cluster has not expired.'."\n" + ."\n" + .'> * If a subscription cluster expires, it is locked and may be released after a period of time. We recommend that you renew the cluster. For more information, see [Renewal](~~135246~~).'."\n" + ."\n" + .'- This parameter is not returned for pay-as-you-go clusters.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the cluster. The time is in UTC and formatted as *yyyy-MM-ddTHH:mm:ssZ*.', 'type' => 'string', 'example' => '2022-04-01T09:50:18Z', 'title' => ''], + 'PayType' => ['description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + ."\n" + .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], + 'Mode' => ['description' => 'The mode of the cluster. A value of **flexible** indicates that the cluster is in elastic mode.', 'type' => 'string', 'example' => 'flexible', 'title' => ''], + 'Port' => ['description' => 'The port number of the cluster.', 'type' => 'string', 'example' => '3306', 'title' => ''], + 'LockMode' => ['description' => 'The lock state of the cluster. Valid values:'."\n" + ."\n" + .'- **Unlock**: The cluster is not locked.'."\n" + ."\n" + .'- **ManualLock**: The cluster is manually locked.'."\n" + ."\n" + .'- **LockByExpiration**: The cluster is automatically locked upon expiration.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'StorageResource' => ['description' => 'The amount of reserved storage resources. An AnalyticDB Compute Unit (ACU) is equivalent to 1 vCPU and 4 GB of memory. Storage resources are used for data read and write operations. Increasing storage resources can improve the read and write performance of the cluster.', 'type' => 'string', 'example' => '24ACU', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'example' => 'amv-bp163885f8q21****', 'title' => ''], + 'ConnectionString' => ['description' => 'The public endpoint of the cluster.', 'type' => 'string', 'example' => 'amv-bp163885f8q21****.ads.aliyuncs.com', 'title' => ''], + 'DBClusterType' => ['description' => 'The type of the cluster. A value of **Common** indicates a regular cluster.', 'type' => 'string', 'example' => 'Common', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code of the cluster. Valid values:'."\n" + ."\n" + .'- **ads**: a pay-as-you-go cluster.'."\n" + ."\n" + .'- **ads\\_pre**: a subscription cluster.', 'type' => 'string', 'example' => 'ads_pre', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the cluster. The time is in UTC and formatted as *yyyy-MM-ddTHH:mm:ssZ*.'."\n" + ."\n" + .'> - If the cluster has a subscription billing method, the actual expiration time is returned.'."\n" + ."\n" + .'- If the cluster has a pay-as-you-go billing method, no value is returned.', 'type' => 'string', 'example' => '2022-07-01T09:50:18Z', 'title' => ''], + 'LockReason' => ['description' => 'The reason that the cluster is locked.'."\n" + ."\n" + .'> This parameter is returned only when the cluster is locked. The value is fixed as **instance\\_expired**.', 'type' => 'string', 'example' => 'instance_expired', 'title' => ''], + 'VPCId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-bp13h7uzhulpuxvnp****', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the cluster resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ComputeResource' => ['description' => 'The amount of reserved computing resources. An AnalyticDB Compute Unit (ACU) is equivalent to 1 vCPU and 4 GB of memory. Computing resources are used for data computation. You can increase computing resources to accelerate queries and elastically scale them based on the cluster performance.', 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1syh8vvw8yech7n****', 'title' => ''], + 'DBVersion' => ['description' => 'The database engine version. The only supported version is **5.0**.', 'type' => 'string', 'example' => '5.0', 'title' => ''], + 'DBClusterStatus' => ['description' => 'The status of the cluster. Valid values:'."\n" + ."\n" + .'- **Preparing**: The cluster is being prepared.'."\n" + ."\n" + .'- **Creating**: The cluster is being created.'."\n" + ."\n" + .'- **Running**: The cluster is running.'."\n" + ."\n" + .'- **Deleting**: The cluster is being deleted.'."\n" + ."\n" + .'- **Restoring**: The cluster is being restored from a backup.'."\n" + ."\n" + .'- **ClassChanging**: The cluster specifications are being changed.'."\n" + ."\n" + .'- **NetAddressCreating**: A network connection is being created.'."\n" + ."\n" + .'- **NetAddressDeleting**: A network connection is being deleted.'."\n" + ."\n" + .'- **NetAddressModifying**: A network connection is being modified.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], + 'DBClusterNetworkType' => ['description' => 'The network type of the cluster. The only supported network type is **VPC**.', 'type' => 'string', 'default' => 'VPC', 'example' => 'VPC', 'title' => ''], + 'DBClusterDescription' => ['description' => 'The description of the cluster.', 'type' => 'string', 'example' => 'adb_test', 'title' => ''], + 'ZoneId' => ['description' => 'The ID of the zone where the cluster resides.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'Engine' => ['description' => 'The database engine of the cluster. The value is fixed as **AnalyticDB**.', 'type' => 'string', 'example' => 'AnalyticDB', 'title' => ''], + 'ReservedACU' => ['description' => 'The amount of remaining reserved computing resources. An ACU is equivalent to 1 vCPU and 4 GB of memory.', 'type' => 'string', 'example' => '32ACU', 'title' => ''], + 'Tags' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'TotalAcuNumber' => [ - 'description' => 'The total number of ACUs.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '32ACU', - ], - 'ReservedAcuNumber' => [ - 'description' => 'The number of ACUs for the reserved resources.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '16ACU', - ], - 'ElasticAcuNumber' => [ - 'description' => 'The number of ACUs for the elastic resources.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '16ACU', + 'Tag' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n" + ."\n" + .'> You can call the [TagResources](~~179253~~) operation to add tags to the cluster.', 'type' => 'string', 'example' => 'tag1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'SpotAcuNumber' => [ - 'description' => 'The number of spot ACUs.', - 'type' => 'number', - 'format' => 'float', - 'example' => '16ACU', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Category' => ['description' => 'The edition of the cluster. This parameter is returned only for clusters in Data Warehouse Edition. Valid values:'."\n" + ."\n" + .'- **BASIC**: Basic Edition in reserved mode.'."\n" + ."\n" + .'- **CLUSTER**: Cluster Edition in reserved mode.'."\n" + ."\n" + .'- **MIXED\\_STORAGE**: Elastic Mode Cluster Edition (New).'."\n" + ."\n" + .'> For more information about cluster editions, see [Product editions](~~205001~~).', 'type' => 'string', 'example' => 'MIXED_STORAGE', 'title' => ''], + 'InnerPort' => ['description' => 'The internal port of the cluster.', 'type' => 'string', 'example' => '3306', 'title' => ''], + 'VPCCloudInstanceId' => ['description' => 'The internal endpoint.', 'type' => 'string', 'example' => 'am-bp163885f8q21****-controller', 'title' => ''], + 'InnerIp' => ['description' => 'The internal IP address of the cluster.', 'type' => 'string', 'example' => '10.1.xx.xx', 'title' => ''], + 'DtsJobId' => ['description' => 'The ID of the Data Transmission Service (DTS) synchronization task. This parameter is returned only for MySQL analysis instances. For more information, see [Overview of MySQL analysis instances](~~154779~~).', 'type' => 'string', 'example' => 'dtsb1578j90XXXX', 'title' => ''], + 'ElasticIOResource' => ['description' => 'The number of Elastic IO Units (EIUs). For more information, see [EIU details](~~189505~~).'."\n" + ."\n" + .'> This parameter is returned only for clusters in elastic mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RdsInstanceId' => ['description' => 'The ID of the source ApsaraDB RDS instance. This parameter is returned only for MySQL analysis instances. For more information, see [Overview of MySQL analysis instances](~~154779~~).', 'type' => 'string', 'example' => 'rm-bp11q28kvl688****', 'title' => ''], + 'ExecutorCount' => ['description' => 'The number of compute nodes in an elastic mode cluster.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'DBNodeClass' => ['description' => 'The node specification. This parameter is returned only for clusters in Data Warehouse Edition.', 'type' => 'string', 'example' => 'E8', 'title' => ''], + 'DiskType' => ['description' => 'The disk type of the cluster. Valid values:'."\n" + ."\n" + .'- **local\\_ssd**: local SSD.'."\n" + ."\n" + .'- **cloud**: standard cloud disk.'."\n" + ."\n" + .'- **cloud\\_ssd**: SSD cloud disk.'."\n" + ."\n" + .'- **cloud\\_efficiency**: ultra disk.'."\n" + ."\n" + .'- **cloud\\_essd**: PL1 ESSD.'."\n" + ."\n" + .'- **cloud\\_essd2**: PL2 ESSD.'."\n" + ."\n" + .'- **cloud\\_essd3**: PL3 ESSD.'."\n" + ."\n" + .'> For more information about ESSDs, see [ESSD specifications](~~122389~~).', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''], + 'DBNodeStorage' => ['description' => 'The storage capacity of the cluster. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''], + 'DBNodeCount' => ['description' => 'The number of node groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'TaskInfo' => [ + 'description' => 'Information about the task.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'analyticDBFlexibleScaleOut', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'- **NOT\\_RUN**: The task is pending.'."\n" + ."\n" + .'- **RUNNING**: The task is running.'."\n" + ."\n" + .'- **SUCCEED**: The task is complete.', + 'type' => 'string', + 'enum' => ['RUNNING', 'SUCCEED', 'NOT_RUN'], + 'example' => 'RUNNING', + 'title' => '', ], - 'SpotAcuPercentage' => [ - 'description' => 'The percent of spot ACUs.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.9', + 'Progress' => ['description' => 'The task progress, specified as a percentage.', 'type' => 'string', 'example' => '10%', 'title' => ''], + 'StepList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StepList' => [ + 'description' => 'The steps of the task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The steps of the task.', + 'type' => 'object', + 'properties' => [ + 'StepName' => ['description' => 'The name of the step.', 'type' => 'string', 'example' => 'ApplyResource', 'title' => ''], + 'StepDesc' => ['description' => 'The description of the step.', 'type' => 'string', 'example' => 'Apply resource', 'title' => ''], + 'StepStatus' => [ + 'description' => 'The status of the step. Valid values:'."\n" + ."\n" + .'- **NOT\\_RUN**: The step is pending.'."\n" + ."\n" + .'- **RUNNING**: The step is running.'."\n" + ."\n" + .'- **SUCCEED**: The step is complete.', + 'type' => 'string', + 'enum' => ['RUNNING', 'SUCCEED', 'NOT_RUN'], + 'example' => 'SUCCEED', + 'title' => '', + ], + 'StepProgress' => ['description' => 'The progress of the step, specified as a percentage.', 'type' => 'string', 'example' => '50%', 'title' => ''], + 'StartTime' => ['description' => 'The time when the step started. The time is formatted as YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'example' => '2024-03-10T09:28:34Z', 'title' => ''], + 'EndTime' => ['description' => 'The time when the step ended. The time is formatted as YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'example' => '2024-03-10T10:28:34Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'UseCachePool' => [ - 'type' => 'boolean', + 'ProductForm' => [ + 'description' => 'The product form. Valid values:'."\n" + ."\n" + .'- **LegacyForm**: The legacy form.'."\n" + ."\n" + .'- **IntegrationForm**: The integrated form.', + 'type' => 'string', + 'enum' => ['IntegrationForm', 'LegacyForm'], + 'example' => 'IntegrationForm', + 'title' => '', ], + 'ProductVersion' => ['description' => 'The product version. Valid values:'."\n" + ."\n" + .'- **BasicVersion**: Basic Edition.'."\n" + ."\n" + .'- **EnterpriseVersion**: Enterprise Edition.', 'type' => 'string', 'example' => 'EnterpriseVersion', 'title' => ''], + 'ReservedNodeSize' => ['description' => 'The resource specification of a single reserved node.', 'type' => 'string', 'example' => '8ACU', 'title' => ''], + 'ReservedNodeCount' => ['description' => 'The number of reserved resource nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AINodeSpec' => ['description' => 'The AI node specification.', 'type' => 'string', 'example' => 'ADB.MLGrand.5', 'title' => ''], + 'AINodeNumber' => ['description' => 'The number of AI nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'PageNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'TotalCount' => [ - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeJobResourceUsage', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribePerformanceViews' => [ - 'summary' => 'Queries a list of monitoring views.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An internal error occurred. Please try again later.'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'The system is unavailable. Please try again later.'], + ], + ], + 'title' => 'DescribeDBClusters', + 'summary' => 'View the Data Lakehouse Edition clusters in the destination region.', + 'description' => 'For a current list of service endpoints, see [Service Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-09-08T10:17:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-28T03:05:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-09T03:29:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-07-27T11:22:29.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-11-03T03:01:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-11T16:51:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusters'], + ], ], - 'tags' => [ - 'Perth', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"ADB.MLGrand.5\\",\\n \\"AINodeNumber\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeDBResourceGroup' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '220841', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '136430', + 'abilityTreeNodes' => ['FEATUREadsYXZ2UA'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1ub9grke1****', - ], + 'schema' => ['description' => 'The cluster ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The cluster ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The resource group name.'."\n" + .'> If this parameter is not specified, information about all resource groups in the specified cluster is returned by default.', 'type' => 'string', 'required' => false, 'example' => 'test_group', 'title' => ''], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => ['description' => 'The resource group type. Valid values:'."\n" + .'- **Interactive**'."\n" + .'- **Job**'."\n" + .'> For more information about resource groups in Data Lakehouse Edition, see [Resource group overview](~~428610~~).', 'type' => 'string', 'required' => false, 'example' => 'Job', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~612393~~) operation to query the region ID of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8', - ], - 'Views' => [ - 'description' => 'the list of view.', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD3'], + 'GroupsInfo' => [ + 'description' => 'The list of resource group information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The list of resource group information.', 'type' => 'object', 'properties' => [ - 'ViewName' => [ - 'description' => 'The name of the view.'."\n", - 'type' => 'string', - 'example' => 'Basic', + 'GroupType' => ['description' => 'The resource group type. Valid values:'."\n" + .'- **Interactive**'."\n" + .'- **Job**'."\n" + .'> For more information about resource groups in Data Lakehouse Edition, see [Resource group overview (Data Lakehouse Edition)](~~428610~~).', 'type' => 'string', 'example' => 'Job', 'title' => ''], + 'GroupName' => ['description' => 'The resource group name.', 'type' => 'string', 'example' => 'test1', 'title' => ''], + 'MinComputeResource' => ['description' => 'The minimum reserved computing resources. Unit: ACUs.', 'type' => 'string', 'example' => '0ACU', 'title' => ''], + 'MaxComputeResource' => ['description' => 'The maximum reserved computing resources. Unit: ACUs.', 'type' => 'string', 'example' => '512ACU', 'title' => ''], + 'ClusterSizeResource' => ['description' => 'A reserved parameter. Not applicable.', 'type' => 'string', 'example' => 'Reserved parameter', 'title' => ''], + 'MinClusterCount' => ['description' => 'A reserved parameter. Not applicable.', 'type' => 'integer', 'format' => 'int32', 'example' => 'Reserved parameter', 'title' => ''], + 'MaxClusterCount' => ['description' => 'A reserved parameter. Not applicable.', 'type' => 'integer', 'format' => 'int32', 'example' => 'Reserved parameter', 'title' => ''], + 'RunningClusterCount' => ['description' => 'A reserved parameter. Not applicable.', 'type' => 'integer', 'format' => 'int32', 'example' => 'Reserved parameter', 'title' => ''], + 'ClusterMode' => ['description' => 'A reserved parameter. Not applicable.', 'type' => 'string', 'example' => 'Reserved parameter', 'title' => ''], + 'ElasticMinComputeResource' => ['description' => 'The minimum elastic computing resources. Unit: ACUs.', 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'EnableSpot' => ['description' => 'Indicates whether the spot instance feature is enabled for the resource group. When the spot instance feature is enabled, the unit price of resources is reduced, but the resources may be released. Valid values:'."\n" + .'- **True**: The spot instance feature is enabled.'."\n" + .'- **False**: The spot instance feature is disabled.'."\n" + ."\n" + .'Only Job-type resource groups can be set to True.', 'type' => 'string', 'example' => 'True', 'title' => ''], + 'GroupUsers' => ['description' => 'The Resource Access Management (RAM) users attached to the resource group.', 'type' => 'string', 'example' => 'testb,testc', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the resource group was created. The time is in UTC and in the format of yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-08-29T03:34:30Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the resource group was last updated. The time is in UTC and in the format of yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-08-31T03:34:30Z', 'title' => ''], + 'Status' => ['description' => 'The status of the resource group. Valid values:'."\n" + .'- **creating**: being created'."\n" + .'- **ok**: created'."\n" + .'- **pendingdelete**: pending deletion', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'Rules' => [ + 'description' => 'The job routing rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of rule information.', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The resource group name.', 'type' => 'string', 'example' => 'user_default', 'title' => ''], + 'QueryTime' => ['description' => 'The query execution time threshold. Unit: milliseconds (ms).', 'type' => 'string', 'example' => '180000', 'title' => ''], + 'TargetGroupName' => ['description' => 'The name of the target resource group.', 'type' => 'string', 'example' => 'job', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'description' => 'The time when created.', - 'type' => 'string', - 'example' => '2024-06-18T07:06:53.000+00:00', + 'Engine' => ['description' => 'The engine type.', 'type' => 'string', 'example' => 'AnalyticDB', 'title' => ''], + 'Message' => ['description' => 'The job routing rule message.', 'type' => 'string', 'required' => true, 'example' => 'SUCCESS', 'title' => ''], + 'AutoStopInterval' => ['description' => 'The automatic stop interval, in the format of a number followed by m (minutes). The value ranges from 0m or 5m to 10080m. A value of 0m indicates that automatic stop is disabled.', 'type' => 'string', 'example' => '0m', 'title' => ''], + 'SpecName' => ['description' => 'The specification name.', 'type' => 'string', 'example' => 'ADB.MLLarge.2', 'title' => ''], + 'TargetResourceGroupName' => ['description' => 'The name of the target resource group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'MinGpuQuantity' => ['description' => 'The minimum number of GPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'MaxGpuQuantity' => ['description' => 'The maximum number of GPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RayConfig' => [ + 'description' => 'The Ray configuration information.', + 'type' => 'object', + 'properties' => [ + 'EnableUserEni' => ['description' => 'Indicates whether ENI is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'HeadSpecType' => ['description' => 'The resource type of the head node.', 'type' => 'string', 'example' => 'cpu', 'title' => ''], + 'HeadSpec' => ['description' => 'The node specifications of the head node.', 'type' => 'string', 'example' => 'ADB.MLLarge.2', 'title' => ''], + 'HeadAllocateUnit' => ['description' => 'The allocation unit of the head node.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'HeadDiskCapacity' => ['description' => 'The disk size of the head node.', 'type' => 'string', 'example' => '100Gi', 'title' => ''], + 'Category' => [ + 'description' => 'The Ray cluster type. Valid values:'."\n" + ."\n" + .'- BASIC: basic type, non-high-availability'."\n" + ."\n" + .'- HIGH_AVAILABILITY: high-availability type', + 'type' => 'string', + 'enum' => ['Basic', 'HighAvailability'], + 'example' => 'BASIC', + 'title' => '', + ], + 'WorkerGroups' => [ + 'title' => '', + 'description' => 'The list of Ray worker groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of Ray worker groups.', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['title' => '', 'description' => 'The name of the Ray worker group.', 'type' => 'string', 'example' => 'g01'], + 'AllocateUnit' => ['title' => '', 'description' => 'The allocation unit.', 'type' => 'string', 'example' => '1'], + 'MaxWorkerQuantity' => ['title' => '', 'description' => 'The maximum number of workers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'MinWorkerQuantity' => ['title' => '', 'description' => 'The minimum number of workers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'WorkerDiskCapacity' => ['title' => '', 'description' => 'The disk size per worker.', 'type' => 'string', 'example' => '100G'], + 'WorkerSpecName' => ['title' => '', 'description' => 'The worker specification name.', 'type' => 'string', 'example' => 'large'], + 'WorkerSpecType' => [ + 'title' => '', + 'description' => 'The Ray worker resource type.', + 'type' => 'string', + 'example' => 'CPU', + 'enum' => ['CPU', 'GPU'], + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'RayClusterAddress' => ['title' => '', 'description' => 'The Ray cluster address.', 'type' => 'string', 'example' => 'http://ray-cluster-address.example.com'], + 'RayDashboardAddress' => ['title' => '', 'description' => 'The Ray Dashboard address.', 'type' => 'string', 'example' => 'http://ray-dashboard-address.example.com'], + 'RayGrafanaAddress' => ['title' => '', 'description' => 'The Ray Grafana address.', 'type' => 'string', 'example' => 'http://ray-grafana-address.example.com'], + 'RayServePublicAddress' => ['type' => 'string', 'example' => '1.2.3.4:8100', 'description' => '', 'title' => ''], + 'AppConfig' => [ + 'title' => '', + 'description' => 'The Ray application configuration.', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['title' => '', 'description' => 'The Ray application name.', 'type' => 'string', 'example' => 'app01'], + 'AppType' => ['title' => '', 'description' => 'The Ray application type.', 'type' => 'string', 'example' => 'IsaacLab'], + 'ImageSelector' => [ + 'title' => '', + 'description' => 'The image configuration.', + 'type' => 'object', + 'properties' => [ + 'Image' => ['title' => '', 'description' => 'The image.', 'type' => 'string', 'example' => 'lab2.10.0-ray2.43.0'], + 'InferenceEngine' => ['title' => '', 'description' => 'The inference engine.', 'type' => 'string', 'example' => 'vLLM'], + 'LlmModel' => ['title' => '', 'description' => 'The LLM model.', 'type' => 'string', 'example' => 'Deepseek-R1'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'StorageMounts' => [ + 'title' => '', + 'description' => 'The list of storage mounts.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The storage mount.', + 'type' => 'object', + 'properties' => [ + 'StorageId' => ['title' => '', 'description' => 'The storage ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MountPath' => ['title' => '', 'description' => 'The mount path.', 'type' => 'string', 'example' => '/mnt/data01'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'UserDefinedRequirements' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'GpuElasticPlan' => [ + 'description' => 'The GPU time-sharing elastic plan.', + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['description' => 'Indicates whether the plan is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Rules' => [ + 'description' => 'The list of rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule.', + 'type' => 'object', + 'properties' => [ + 'StartCronExpression' => ['description' => 'The start time, specified as a cron expression. The interval must be at least 1 hour.', 'type' => 'string', 'example' => '0 0 2 * * ?', 'title' => ''], + 'EndCronExpression' => ['description' => 'The end time, specified as a cron expression. The interval must be at least 1 hour.', 'type' => 'string', 'example' => '0 0 3 * * ?', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'UpdateTime' => [ - 'description' => 'The time when updated.', + 'ScalePolicy' => [ + 'description' => 'The scale-out policy of the resource group. Valid values:'."\n" + ."\n" + .'- AutoScaling: enables the AutoScaling automatic scaling policy.'."\n" + .'- Disable: disables automatic scaling.'."\n" + .'- MultiCluster: enables the MultiCluster automatic scaling policy.', 'type' => 'string', - 'example' => '2024-06-18T07:07:32.000+00:00', + 'enum' => ['AutoScaling', 'Disable', 'MultiCluster'], + 'example' => 'AutoScaling', + 'title' => '', + ], + 'Classification' => ['description' => 'The classification of the resource group. Valid values:'."\n" + ."\n" + .'- SQL'."\n" + .'- SparkSQL'."\n" + .'- MultiCluster'."\n" + .'- AI', 'type' => 'string', 'example' => 'SQL', 'title' => ''], + 'EngineParams' => [ + 'title' => '', + 'description' => 'The engine parameters.', + 'type' => 'object', + 'additionalProperties' => ['title' => '', 'description' => 'The engine parameters.', 'type' => 'any', 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}'], + 'example' => '', + ], + 'AtmConfig' => [ + 'type' => 'object', + 'properties' => [ + 'InsertNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'description' => '', 'title' => ''], + 'InsertNodeNum' => ['type' => 'string', 'example' => '1', 'description' => '', 'title' => ''], + 'SelectNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'description' => '', 'title' => ''], + 'SelectNodeNum' => ['type' => 'string', 'example' => '1', 'description' => '', 'title' => ''], + 'SelectNodeCacheSize' => ['type' => 'string', 'example' => '10', 'description' => '', 'title' => ''], + 'StorageNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'description' => '', 'title' => ''], + 'StorageNodeNum' => ['type' => 'string', 'example' => '2', 'description' => '', 'title' => ''], + 'StorageNodeDiskSize' => ['type' => 'string', 'example' => '100', 'description' => '', 'title' => ''], + 'StorageNodeDiskType' => [ + 'type' => 'string', + 'example' => 'essd_pl1', + 'enum' => ['essd_pl1', 'essd_pl2'], + 'description' => '', + 'title' => '', + ], + 'AuthNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'description' => '', 'title' => ''], + 'AuthNodeNum' => ['type' => 'string', 'example' => '2', 'description' => '', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n" - ."\n" - .'> This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", - '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" - .'}', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'InvalidPoolName.Malformed', 'errorMessage' => 'The specified parameter PoolName is not valid.', 'description' => 'The PoolName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolUser.Malformed', 'errorMessage' => 'The specified parameter PoolUser is not valid.', 'description' => 'The PoolUser parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolType.Malformed', 'errorMessage' => 'The specified parameter PoolType is not valid.', 'description' => 'The PoolType parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMinComputeResource.Malformed', 'errorMessage' => 'The specified parameter MinComputeResource is not valid.', 'description' => 'The MinComputeResource parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMaxComputeResource.Malformed', 'errorMessage' => 'The specified parameter MaxComputeResource is not valid.', 'description' => 'The MaxComputeResource parameter is invalid. Check the parameter.'], + ], + 408 => [ + ['errorCode' => 'AcsServerTimeOut', 'errorMessage' => 'The request has failed due to Adb Cloud Service time out.', 'description' => 'The backend service timed out. Please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Query resource groups', + 'summary' => 'Queries the resource group information of a cluster.', + 'description' => 'For information about the service registration of the current service, see [Endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-12-02T15:07:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-17T13:49:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-08-20T12:54:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-31T12:12:58.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-15T17:29:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-29T13:33:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-13T16:32:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-25T02:12:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-01T08:17:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-26T02:37:32.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-25T10:08:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-31T07:03:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:36.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'DescribePerformanceViews', - ], - 'CreatePerformanceView' => [ - 'summary' => 'Creates a custom monitoring view.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBResourceGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'tags' => [ - 'Perth', + 'responseDemo' => '[{"errorExample":"","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\\": \\"Reserved parameter\\",\\n \\"MinClusterCount\\": 0,\\n \\"MaxClusterCount\\": 0,\\n \\"RunningClusterCount\\": 0,\\n \\"ClusterMode\\": \\"Reserved parameter\\",\\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\\": \\"AnalyticDB\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"AutoStopInterval\\": \\"0m\\",\\n \\"SpecName\\": \\"ADB.MLLarge.2\\",\\n \\"TargetResourceGroupName\\": \\"test\\",\\n \\"MinGpuQuantity\\": 1,\\n \\"MaxGpuQuantity\\": 2,\\n \\"RayConfig\\": {\\n \\"EnableUserEni\\": false,\\n \\"HeadSpecType\\": \\"cpu\\",\\n \\"HeadSpec\\": \\"ADB.MLLarge.2\\",\\n \\"HeadAllocateUnit\\": \\"1\\",\\n \\"HeadDiskCapacity\\": \\"100Gi\\",\\n \\"Category\\": \\"BASIC\\",\\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 \\"RayServePublicAddress\\": \\"1.2.3.4:8100\\",\\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 \\"UserDefinedRequirements\\": \\"\\"\\n },\\n \\"GpuElasticPlan\\": {\\n \\"Enabled\\": false,\\n \\"Rules\\": [\\n {\\n \\"StartCronExpression\\": \\"0 0 2 * * ?\\",\\n \\"EndCronExpression\\": \\"0 0 3 * * ?\\"\\n }\\n ]\\n },\\n \\"ScalePolicy\\": \\"AutoScaling\\",\\n \\"Classification\\": \\"SQL\\",\\n \\"EngineParams\\": {\\n \\"key\\": \\"{\\\\\\\\\\\\\\"spark.adb.version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"3.5\\\\\\\\\\\\\\"}\\"\\n },\\n \\"AtmConfig\\": {\\n \\"InsertNodeSpec\\": \\"8ACU\\",\\n \\"InsertNodeNum\\": \\"1\\",\\n \\"SelectNodeSpec\\": \\"8ACU\\",\\n \\"SelectNodeNum\\": \\"1\\",\\n \\"SelectNodeCacheSize\\": \\"10\\",\\n \\"StorageNodeSpec\\": \\"8ACU\\",\\n \\"StorageNodeNum\\": \\"2\\",\\n \\"StorageNodeDiskSize\\": \\"100\\",\\n \\"StorageNodeDiskType\\": \\"essd_pl1\\",\\n \\"AuthNodeSpec\\": \\"8ACU\\",\\n \\"AuthNodeNum\\": \\"2\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'machine', + ], + 'DescribeDiagnosisDimensions' => [ + 'summary' => 'Queries the deduplicated statistics of resource groups, databases, usernames, and source IP addresses about SQL statements that meet a query condition for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '221254', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, + 'abilityTreeCode' => '132346', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1ub9grke1****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bt6u59zcmd945****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> You can query data only within the last 14 days.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1625220210000', 'title' => ''], ], [ - 'name' => 'ViewDetail', + 'name' => 'EndTime', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the monitoring view.'."\n", - 'type' => 'object', - 'properties' => [ - 'ChartsPerLine' => [ - 'description' => 'The number of charts to display in each row.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'ChartLinked' => [ - 'description' => 'Specifies whether to enable the filter interaction feature. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Categories' => [ - 'description' => 'The metric categories.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metric category.'."\n", - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'description' => 'The name of the metric category. Valid values:'."\n" - ."\n" - .'* **Node**'."\n" - .'* **DiskData**'."\n" - .'* **WorkLoad**'."\n" - .'* **ResourceGroup**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Node', - ], - 'Keys' => [ - 'description' => 'The metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metric.'."\n", - 'type' => 'object', - 'properties' => [ - 'KeyName' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AnalyticDB_CPU', - ], - 'Selected' => [ - 'description' => 'Specifies whether to select the metric. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The end of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The end time must be later than the start time.'."\n" + ."\n" + .'* The maximum time range that can be specified is 24 hours.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1625220213000', 'title' => ''], ], [ - 'name' => 'ViewName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the view.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'viewname', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CreateFromViewType', + 'name' => 'QueryCondition', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view.', - 'type' => 'string', - 'required' => false, - 'example' => 'Basic', - ], + 'schema' => ['description' => 'The query condition for SQL statements, which can contain the `Type`, `Value`, `Min`, and `Max` fields. Specify the condition in the JSON format. `Type` specifies the query dimension. Valid values for Type: `maxCost`, `status`, and `cost`. `Value`, `Min`, or `Max` specifies the query range for the dimension. Valid values:'."\n" + ."\n" + .'* `{"Type":"maxCost","Value":"100"}`: queries the top 100 most time-consuming SQL statements. Set `Value` to 100.'."\n" + .'* `{"Type":"status","Value":"finished"}`: queries the executed SQL statements. You can set `Value` to `running` to query the SQL statements that are being executed. You can also set Value to `failed` to query the SQL statements that failed to be executed.'."\n" + .'* `{"Type":"cost","Min":"10","Max":"200"}`: queries the SQL statements whose execution duration is in the range of 10 to 200 milliseconds. You can also specify custom values for the Min and Max fields.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Type":"maxCost","Value":"100"}', 'title' => ''], ], [ - 'name' => 'FillOriginViewKeys', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to populate the names of the metrics in the original monitoring view when you view the monitoring view. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'* **zh-CN** (default): simplified Chinese.'."\n" + .'* **en-US**: English.'."\n" + .'* **ja**: Japanese.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], ], ], 'responses' => [ @@ -17170,81 +13203,93 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', + 'ClientIps' => [ + 'description' => 'The queried source IP addresses.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried source IP address.'."\n", 'type' => 'string', 'example' => '106.11.xx.xx', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'CreateStatus' => [ - 'description' => 'The creation result. Valid values:'."\n" - ."\n" - .'* **SUCCESS**'."\n" - .'* **FAILED**'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', + 'ResourceGroups' => [ + 'description' => 'The queried resource group names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried resource group name.'."\n", 'type' => 'string', 'example' => 'user_defaul', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n" - ."\n" - .'> This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", - '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" - .'}', + 'UserNames' => [ + 'description' => 'The queried usernames.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried username.'."\n", 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Databases' => [ + 'description' => 'The queried database names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried database name.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DEA97C6B-D7A4-5E69-9EFC-D7F88737CED5', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'DescribeDiagnosisDimensions', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-09-13T12:07:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T04:03:32.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'CreatePerformanceView', - ], - 'ModifyPerformanceView' => [ - 'summary' => 'Modifies the information about a custom monitoring view.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisDimensions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDiagnosisDimensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'tags' => [ - 'Perth', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + ], + 'DescribeDiagnosisRecords' => [ + 'summary' => 'Queries the summary of SQL statements that meet specified conditions in an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '220840', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '131519', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -17252,181 +13297,304 @@ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1ub9grke1****', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> Call the [DescribeDBClusters](~~612397~~) operation to view the details of all clusters in your account, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1scs48yc125****', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query. Specify the time in the UNIX timestamp format. The time must be in milliseconds.'."\n" + ."\n" + .'> Only data from the last 14 days can be queried.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1632931200000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the UNIX timestamp format. The time must be in milliseconds.'."\n" + ."\n" + .'> - The end time must be later than the start time.'."\n" + .'>'."\n" + .'> - The interval between the start time and the end time cannot exceed 24 hours.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1633017540000', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> Call the [DescribeRegions](~~143074~~) operation to view the regions and zones supported by AnalyticDB for MySQL, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ViewName', + 'name' => 'QueryCondition', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the monitoring view.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Basic', - ], + 'schema' => ['description' => 'The conditions for the SQL query. This parameter is a JSON string that contains fields such as Type, `Value`, `Min`, and `Max`. The `Type` field indicates the query dimension. Valid values for `Type`: `maxCost`, `status`, and `cost`. The `Value`, `Min`, and `Max` fields specify the query range for the dimension. Valid values:'."\n" + ."\n" + .'- `{"Type":"maxCost","Value":"100"}`: queries the details of the top 100 SQL statements that have the longest execution durations. The `Value` field can only be set to 100.'."\n" + ."\n" + .'- `{"Type":"status","Value":"finished"}`: queries the details of completed SQL statements. You can also set `Value` to `running` or `failed` to query SQL statements that are running or have failed.'."\n" + ."\n" + .'- `{"Type":"cost","Min":"10","Max":"200"}`: queries the details of SQL statements whose execution durations are between 10 ms and 200 ms. You can customize the minimum and maximum execution durations. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"Type":"status","Value":"finished"}', 'title' => ''], ], [ - 'name' => 'ViewDetail', + 'name' => 'Keyword', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'Filters the queries by the keywords contained in the SQL statements.', 'type' => 'string', 'required' => false, 'example' => 'select', 'title' => ''], + ], + [ + 'name' => 'MinPeakMemory', + 'in' => 'query', + 'schema' => ['description' => 'The minimum peak memory of the SQL statement. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'MaxPeakMemory', + 'in' => 'query', + 'schema' => ['description' => 'The maximum peak memory of the SQL statement. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '89000000', 'title' => ''], + ], + [ + 'name' => 'MinScanSize', + 'in' => 'query', + 'schema' => ['description' => 'The minimum scan size of the SQL statement. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'MaxScanSize', + 'in' => 'query', + 'schema' => ['description' => 'The maximum scan size of the target SQL statement. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024000000', 'title' => ''], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'query', + 'schema' => ['description' => 'The resource group to which the SQL statement belongs.'."\n" + ."\n" + .'> Call the [DescribeDiagnosisDimensions](~~308210~~) operation to view the resource groups, database names, usernames, and source IP addresses for the SQL statements that meet the specified query conditions.', 'type' => 'string', 'required' => false, 'example' => 'user_default', 'title' => ''], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['description' => 'The username used to execute the SQL statement.'."\n" + .'Call the [DescribeDiagnosisDimensions](~~308210~~) operation to view the resource groups, database names, usernames, and source IP addresses for the SQL statements that meet the specified query conditions.', 'type' => 'string', 'required' => false, 'example' => 'test_user', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The database where the SQL statement is executed.'."\n" + ."\n" + .'> Call the [DescribeDiagnosisDimensions](~~308210~~) operation to view the resource groups, database names, usernames, and source IP addresses for the SQL statements that meet the specified query conditions.', 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => ['description' => 'The source IP address.'."\n" + ."\n" + .'> Call the [DescribeDiagnosisDimensions](~~308210~~) operation to view the resource groups, database names, usernames, and source IP addresses for the SQL statements that meet the specified query conditions.', 'type' => 'string', 'required' => false, 'example' => '59.82.XX.XX', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sorting order of the SQL statements. This parameter is a JSON array that is ordered by the sequence of the input array. It contains the `Field` and `Type` fields. Example: `[{"Field":"StartTime", "Type": "desc" }]`. The fields are described as follows:'."\n" + ."\n" + .'- `Field` specifies the field by which to sort the SQL statements. Valid values:'."\n" + ."\n" + .' - `StartTime`: the start time of the execution.'."\n" + ."\n" + .' - `Status`: the execution state.'."\n" + ."\n" + .' - `UserName`: the username.'."\n" + ."\n" + .' - `Cost`: the execution duration.'."\n" + ."\n" + .' - `PeakMemory`: the peak memory.'."\n" + ."\n" + .' - `ScanSize`: the amount of scanned data.'."\n" + ."\n" + .' - `Database`: the database name.'."\n" + ."\n" + .' - `ClientIp`: the source IP address.'."\n" + ."\n" + .' - `ResourceGroup`: the resource group.'."\n" + ."\n" + .' - `QueueTime`: the amount of time that the query waited in a queue.'."\n" + ."\n" + .' - `OutputRows`: the number of output rows.'."\n" + ."\n" + .' - `OutputDataSize`: the amount of output data.'."\n" + ."\n" + .' - `ResourceCostRank`: the ranking of the execution duration of an operator in the SQL statement. This field is returned only when `QueryCondition` is set to `{"Type":"status","Value":"running"}`.'."\n" + ."\n" + .'- `Type` specifies the sorting type. Valid values (case-insensitive):'."\n" + ."\n" + .' - `Desc`: descending order.'."\n" + ."\n" + .' - `Asc`: ascending order.', 'type' => 'string', 'required' => false, 'example' => '[{"Field":"StartTime", "Type": "desc" }]', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'- **30** (default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the file title and some error messages in the downloaded file. Valid values:'."\n" + ."\n" + .'- **zh**: Simplified Chinese (default).'."\n" + ."\n" + .'- **en**: English.'."\n" + ."\n" + .'- **ja**: Japanese.'."\n" + ."\n" + .'- **zh-tw**: Traditional Chinese.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'PatternId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the SQL pattern.', 'type' => 'string', 'required' => false, 'example' => '5575924945138******', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The new information about the monitoring view.'."\n", 'type' => 'object', 'properties' => [ - 'ChartsPerLine' => [ - 'description' => 'The number of charts to display in each row.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'ChartLinked' => [ - 'description' => 'Specifies whether to enable the filter interaction feature. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Categories' => [ - 'description' => 'The metric categories.'."\n", + 'PageNumber' => ['description' => 'The page number. The value is an integer that is greater than 0. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'- **30** (default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Querys' => [ + 'description' => 'The list of SQL statement details.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A list of queries.', 'type' => 'object', 'properties' => [ - 'Category' => [ - 'description' => 'The name of the metric category. Valid values:'."\n" + 'SQL' => ['description' => 'The details of the SQL statement.'."\n" + ."\n" + .'> For performance, an SQL statement can be up to 5,120 characters long. Longer statements are truncated. Call the [DownloadDiagnosisRecords](~~308212~~) operation to download the summary information of SQL statements that meet the specified conditions, including the complete SQL statements.', 'type' => 'string', 'example' => 'SELECT count(*)\\nFROM nation', 'title' => ''], + 'SQLTruncatedThreshold' => ['description' => 'The truncation threshold for the SQL statement. The value is fixed at 5,120 characters. SQL statements that exceed this limit are truncated.', 'type' => 'integer', 'format' => 'int64', 'example' => '5120', 'title' => ''], + 'Status' => ['description' => 'The state of the SQL statement. Valid values:'."\n" + ."\n" + .'- **running**: The statement is running.'."\n" + ."\n" + .'- **finished**: The statement is complete.'."\n" + ."\n" + .'- **failed**: The statement failed to be executed.', 'type' => 'string', 'example' => 'finished', 'title' => ''], + 'OutputDataSize' => ['description' => 'The amount of returned data. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'Cost' => ['description' => 'The total execution duration of the query. Unit: milliseconds.'."\n" + ."\n" + .'> This duration is the sum of `QueuedTime`, `TotalPlanningTime`, and `ExecutionTime`.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'OutputRows' => ['description' => 'The number of returned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RcHost' => ['description' => 'The IP address and port number of the AnalyticDB for MySQL frontend node that is used to execute the SQL statement.', 'type' => 'string', 'example' => '10.0.XX.XX:3004', 'title' => ''], + 'ScanSize' => ['description' => 'The amount of scanned data. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'ProcessId' => ['description' => 'The query ID.', 'type' => 'string', 'example' => '2021093000414401000000023503151******', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the SQL execution. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1632933704000', 'title' => ''], + 'SQLTruncated' => ['description' => 'Indicates whether the length of the query result exceeds the threshold. If the length exceeds the threshold, the query result is truncated. Valid values:'."\n" + ."\n" + .'- **true**: The length of the query result exceeds the threshold.'."\n" + ."\n" + .'- **false**: The length of the query result does not exceed the threshold.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Database' => ['description' => 'The name of the database where the SQL statement is executed.', 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'ScanRows' => ['description' => 'The number of scanned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ResourceCostRank' => ['description' => 'The ranking of the execution duration of an operator in the SQL statement.'."\n" + ."\n" + .'> This parameter is returned only for SQL statements that are in the `running` state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ClientIp' => ['description' => 'The source IP address.', 'type' => 'string', 'example' => '59.82.XX.XX', 'title' => ''], + 'PeakMemory' => ['description' => 'The peak memory. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '16648', 'title' => ''], + 'QueueTime' => ['description' => 'The amount of time that the query waited in a queue before execution. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'ResourceGroup' => ['description' => 'The resource pool to which the SQL statement belongs.', 'type' => 'string', 'example' => 'user_default', 'title' => ''], + 'UserName' => ['description' => 'The username used to execute the SQL statement.', 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'ExecutionTime' => ['description' => 'The execution duration of the query. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'TotalPlanningTime' => ['description' => 'The amount of time that was required to generate the execution plan. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'EtlWriteRows' => ['description' => 'The number of rows written to a table in an ETL task.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'TotalStages' => ['description' => 'The total number of stages generated for the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'QueryProperties' => [ + 'description' => 'The list of properties that are in effect for the current query.'."\n" ."\n" - .'* **Node**'."\n" - .'* **DiskData**'."\n" - .'* **WorkLoad**'."\n" - .'* **ResourceGroup**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Node', - ], - 'Keys' => [ - 'description' => 'The metrics.'."\n", + .'> For a list of common properties, see [Config and Hint configuration parameters](~~408955~~).', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The description of the property key-value pair.', 'type' => 'object', 'properties' => [ - 'KeyName' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AnalyticDB_CPU', - ], - 'Selected' => [ - 'description' => 'Specifies whether to select the metric. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'max_select_items_count', 'title' => ''], + 'Value' => ['description' => 'The property value.', 'type' => 'string', 'example' => '1024', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], + 'PatternId' => ['description' => 'The ID of the SQL pattern.'."\n" + ."\n" + .'> Call the [DescribePatternPerformance](~~612503~~) operation to view the detailed execution metrics of the SQL pattern within a specified time range.', 'type' => 'string', 'example' => '-5575924945138******', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7F88BEFA-CF0B-5C95-8BB1-92EC9F09E40D', 'title' => ''], ], - 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', - ], - 'ModifyStatus' => [ - 'description' => 'The modification result. Valid values:'."\n" - ."\n" - .'* **SUCCESS**'."\n" - .'* **FAILED**'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", - '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" - .'}', - ], - ], - 'description' => '', - ], + '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' => 'DescribeDiagnosisRecords', + 'description' => 'For information about service endpoints, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-10-21T12:16:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-30T11:11:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-13T12:07:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-03-22T08:51:02.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisRecords'], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'ModifyPerformanceView', + 'translator' => 'machine', ], - 'DescribePerformanceViewAttribute' => [ - 'summary' => 'Queries the information about a monitoring view.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'Perth', - ], + 'DescribeDiagnosisSQLInfo' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -17435,52 +13603,60 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '220839', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '132343', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of AnalyticDB for MySQL clusters in a specific region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1r053by****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the region IDs supported by AnalyticDB for MySQL.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ViewName', + 'name' => 'ProcessId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the view.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Basic', - ], + 'schema' => ['description' => 'The query ID.'."\n" + .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the SQL summary information of a specific AnalyticDB for MySQL cluster, including the query ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => '2023091317073501108614302703151362858', 'example' => '20210702164322172016168****', 'title' => ''], + ], + [ + 'name' => 'ProcessStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the SQL statement execution. Specify the value as a UNIX timestamp in milliseconds.'."\n" + .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the SQL summary information of a specific AnalyticDB for MySQL cluster, including the start time of the SQL statement execution.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'default' => '-1', 'example' => '1625215402000', 'title' => ''], + ], + [ + 'name' => 'ProcessState', + 'in' => 'query', + 'schema' => ['description' => 'The status of the SQL statement. Valid values:'."\n" + .'- **running**: The SQL statement is being executed.'."\n" + .'- **finished**: The SQL statement has been executed.'."\n" + .'- **failed**: The SQL statement failed to be executed.'."\n" + .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the SQL summary information of a specific AnalyticDB for MySQL cluster, including the status of the SQL statement.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'running', 'example' => 'running', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the file title and error messages in the downloaded file. Valid values:'."\n" + .'- **zh**: simplified Chinese.'."\n" + .'- **en**: English.'."\n" + .'- **ja**: Japanese.'."\n" + .'- **zh-tw**: traditional Chinese.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'ProcessRcHost', + 'in' => 'query', + 'schema' => ['description' => 'The IP address and port number of the AnalyticDB for MySQL frontend node that executes the SQL statement.'."\n" + .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the SQL summary information of a specific AnalyticDB for MySQL cluster, including the IP address and port number of the frontend node.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '192.45.***.***:3145', 'title' => ''], ], ], 'responses' => [ @@ -17488,237 +13664,121 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', - ], - 'ViewName' => [ - 'description' => 'The name of the view.'."\n", - 'type' => 'string', - 'example' => 'Basic', - ], - 'CreateFromViewType' => [ - 'description' => 'The type of the view.', - 'type' => 'string', - 'example' => 'Basic', - ], - 'ViewDetail' => [ - 'description' => 'The information about the monitoring view.'."\n", - 'type' => 'object', - 'properties' => [ - 'ChartsPerLine' => [ - 'description' => 'The number of charts to display in each row.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ChartLinked' => [ - 'description' => 'Specifies whether to enable the filter interaction feature. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Categories' => [ - 'description' => 'The metric category.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metric category.'."\n", - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'description' => 'The name of the metric category. Valid values:'."\n" - ."\n" - .'* **Node**'."\n" - .'* **DiskData**'."\n" - .'* **WorkLoad**'."\n" - .'* **ResourceGroup**'."\n", - 'type' => 'string', - 'example' => 'Node', - ], - 'Keys' => [ - 'description' => 'The metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metrics.'."\n", - 'type' => 'object', - 'properties' => [ - 'KeyName' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'example' => 'AnalyticDB_CPU', - ], - 'Selected' => [ - 'description' => 'Specifies whether to select the metric. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'GroupType' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The type of the resource group.', - 'example' => 'Interactive', - ], - 'description' => 'The type of the resource group. Valid values:'."\n" - ."\n" - .'* **Interactive**'."\n" - .'* **Job**'."\n" - ."\n" - .'> For more information about resource groups, see [Resource group overview](~~428610~~).'."\n", - ], - 'Engine' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The database engine of the cluster.', - 'example' => 'AnalyticDB', - ], - 'description' => 'The database engine of the cluster. Valid values:'."\n" - ."\n" - .'* AnalyticDB', - ], - 'EnableAutoMc' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the multi-cluster feature is enabled. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], + 'DiagnosisSQLInfo' => ['description' => 'The execution details of the SQL statement, including the detailed SQL statement, statistics information, execution plan, and operator information.', '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 } }', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'StageInfos' => [ + 'description' => 'The stage-level execution information of the query.', + 'type' => 'array', + 'items' => [ + 'description' => 'The stage-level execution information of the query.', + 'type' => 'object', + 'properties' => [ + 'InputRows' => ['description' => 'The total number of input rows in the stage.', 'type' => 'integer', 'format' => 'int64', 'example' => '2341', 'title' => ''], + 'InputDataSize' => ['description' => 'The total input data size of the stage, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2341', 'title' => ''], + 'OutputRows' => ['description' => 'The total number of output rows in the stage.', 'type' => 'integer', 'format' => 'int64', 'example' => '2341', 'title' => ''], + 'OutputDataSize' => ['description' => 'The total output data size of the stage, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2341', 'title' => ''], + 'PeakMemory' => ['description' => 'The total peak memory of the stage, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2341', 'title' => ''], + 'OperatorCost' => ['description' => 'The cumulative operator duration of the stage, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2341', 'title' => ''], + 'StageId' => ['description' => 'StageID。', 'type' => 'string', 'example' => 'Stage[26]', 'title' => ''], + 'State' => ['description' => 'The status of the stage.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'Progress' => ['description' => 'The execution progress of the stage.', 'type' => 'number', 'format' => 'double', 'example' => '0.3', 'title' => ''], + 'ExecutionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n" - ."\n" - .'> This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", - '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' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'example' => 'amv-bp198m028ih55xxxx', - ], - 'FillOriginViewKeys' => [ - 'description' => 'Specifies whether to populate the names of the metrics in the original monitoring view when you view the monitoring view. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'PerformanceViewNotFound', - 'errorMessage' => 'Performance view not found.', - ], - ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - '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' => 'DescribePerformanceViewAttribute', - ], - 'DeletePerformanceView' => [ - 'summary' => 'Deletes a monitoring view.', - 'methods' => [ - 'post', - 'get', + 'title' => 'View SQL execution details', + 'summary' => 'Queries the execution details of a specific SQL statement, including the execution plan, runtime information, resource usage, and self-diagnostics results.', + 'description' => 'For the service registration addresses of this service, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-04-18T08:59:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-05T06:00:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-03T03:56:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-15T11:35:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-26T03:55:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-26T03:51:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T04:03:32.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisSQLInfo'], + ], ], - 'tags' => [ - 'Perth', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDiagnosisSQLInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeDownloadRecords' => [ + 'summary' => 'Queries the five most recent download tasks for SQL query results in a specified AnalyticDB for MySQL Lakehouse Edition (3.0) cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '221469', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '132356', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-uf6wjk5xxxxxxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the details of all AnalyticDB for MySQL Lakehouse Edition (3.0) clusters in a specific region, including the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-8vb6ha79k6e****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ViewName', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the view.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'view_dwd_plan_double_term', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- **zh**: Simplified Chinese (default).'."\n" + ."\n" + .'- **en**: English.'."\n" + ."\n" + .'- **ja**: Japanese.'."\n" + ."\n" + .'- **zh-tw**: Traditional Chinese.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -17726,621 +13786,578 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'DeleteStatus' => [ - 'description' => 'The delete status.', - 'type' => 'boolean', - 'example' => 'SUCCESS', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n" - ."\n" - .'> This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", - '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" - .'}', + 'Records' => [ + 'description' => 'A list of download tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a download task.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- **running**: The task is in progress.'."\n" + ."\n" + .'- **finished**: The task is complete.'."\n" + ."\n" + .'- **failed**: The task failed.', 'type' => 'string', 'example' => 'finished', 'title' => ''], + 'DownloadId' => ['description' => 'The ID of the download task.', 'type' => 'integer', 'format' => 'int64', 'example' => '636890', 'title' => ''], + 'ExceptionMsg' => ['description' => 'The exception message returned if the download task fails.', 'type' => 'string', 'example' => 'The query result is empty.', 'title' => ''], + 'Url' => ['description' => 'The download URL of the result file.', 'type' => 'string', 'example' => 'https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/amv-*********/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******"', 'title' => ''], + 'FileName' => ['description' => 'The name of the downloaded file.', 'type' => 'string', 'example' => '20210806094635-20210806095135', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D761DA51-12F8-5457-AAA9-F52B9F436D2D', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The authentication failure message.', 'type' => 'string', 'example' => 'Authentication failed.', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'PerformanceViewNotFound', - 'errorMessage' => 'Performance view not found.', - ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"Authentication failed.\\"\\n}","type":"json"}]', + 'title' => 'DescribeDownloadRecords', + 'description' => 'For a list of service endpoints, see [Service Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-12-19T09:33:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-14T08:33:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-22T04:03:32.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDownloadRecords'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDownloadRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - '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' => 'DeletePerformanceView', + 'translator' => 'manual', ], - 'ExistRunningSQLEngine' => [ - 'summary' => 'Queries whether a running SQL engine exists.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeElasticPlanAttribute' => [ + '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', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1cit7z8j****', - ], + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the scaling plan.'."\n" + ."\n" + .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'> You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the name of the resource group for a cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'spark_test', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FA675D68-14A4-5D9C-8820-92537D9F447E', - ], - 'Data' => [ - 'description' => 'Indicates whether a running SQL engine exists in the resource group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **True**'."\n" - .'* **False**'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'True' => 'True', - 'False' => 'False', + 'ElasticPlan' => [ + 'description' => 'The queried scaling plan.'."\n", + 'type' => 'object', + 'properties' => [ + 'ElasticPlanName' => ['description' => 'The name of the scaling plan.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'The type of the scaling plan.'."\n", 'type' => 'string', 'example' => 'EXECUTOR', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the scaling plan is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the resource group used by the scaling plan.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TargetSize' => ['description' => 'The amount of elastic resources after scaling.'."\n", 'type' => 'string', 'example' => '32ACU', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the scaling plan.'."\n" + ."\n" + .'> The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-01-01T12:01:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the scaling plan.'."\n" + ."\n" + .'> The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2025-01-01T12:01:00Z', 'title' => ''], + 'CronExpression' => ['description' => 'A CORN expression that indicates the scaling cycle and time for the scaling plan.'."\n", 'type' => 'string', 'example' => '0 20 14 * * ?', 'title' => ''], + 'AutoScale' => ['description' => 'Indicates whether **Default Proportional Scaling for EIUs** is enabled. Valid values: true: Default Proportional Scaling for EIUs is enabled. If you set this parameter to true, storage resources are scaled along with computing resources. false: Default Proportional Scaling for EIUs is not enabled.'."\n" + ."\n" + .'> You can enable Default Proportional Scaling for EIUs for only a single scaling plan of a cluster. After you enable a scaling plan of the Default Proportional Scaling for EIUs type, you cannot enable scaling plans of other types.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'example' => 'True', + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], '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', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'ACS.ElasticPlan.NotFound', 'errorMessage' => 'The elastic plan is not found.', 'description' => 'The elastic plan is not found'], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'DescribeElasticPlanAttribute', + 'summary' => 'Queries the information about a scaling plan for an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-12-12T10:09:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-23T02:55:53.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-04-13T11:20:16.000Z', 'description' => 'Error codes changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA675D68-14A4-5D9C-8820-92537D9F447E\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'ExistRunningSQLEngine', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'ExecuteSparkWarehouseBatchSQL' => [ - 'summary' => 'Executes Spark SQL statements in batches.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticPlanAttribute'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeElasticPlanAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'tags' => [], + '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":""}]', + ], + 'DescribeElasticPlanJobs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '235566', - 'abilityTreeNodes' => [ - 'FEATUREadsCQJTKP', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'Agency', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DataWorks', - 'default' => 'POPSDK', - ], - ], - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the scaling plan.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you do not specify this parameter, all scaling plans of the cluster are queried.'."\n" + ."\n" + .'* You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ResourceGroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you do not specify this parameter, the scaling plans of all resource groups are queried, including the interactive resource group and elastic I/O unit (EIU) types.'."\n" + ."\n" + .'* You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the resource group name for a cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Query', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The SQL statements that you want to execute in batches. Separate multiple SQL statements with semicolons (;). The execution engine executes the SQL statements in sequence in the same session.', - 'type' => 'string', - 'required' => true, - 'example' => 'CREATE TABLE user(id INT, name STRING);'."\n" - .'INSERT INTO t VALUE(1, \'Bob\');'."\n" - .'SELECT * FROM t;', - ], + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The state of the scaling plan job. Valid values:'."\n" + ."\n" + .'* RUNNING'."\n" + .'* SUCCESSFUL'."\n" + .'* FAILED'."\n" + ."\n" + .'> If you do not specify this parameter, the scaling plans in all states are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SUCCESSFUL', 'title' => ''], ], [ - 'name' => 'Schema', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-01-01T12:01:00Z', 'title' => ''], ], [ - 'name' => 'ExecuteResultLimit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum amount of execution result data that can be written to Object Storage Service (OSS). Unit: MB. Default value: 4096. The size of compressed objects is difficult to estimate. The data that is actually written to OSS is smaller than the specified value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '4096', - 'default' => '1000', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ExecuteTimeLimitInSeconds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum execution duration. Unit: seconds. If a set of SQL statements fail to be executed for the specified period of time after submission, they are marked as a timeout error. The default value is 360000 seconds, which is equivalent to 100 hours.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600000', - 'default' => '604800', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RuntimeConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The additional runtime parameter. Specify the parameter in the JSON format.', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "OSSURL": "oss://testBucketname/"'."\n" - .'}', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CBE843D8-964D-5EA3-9D31-822125611B6E', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'example' => 'true', - '$ref' => '#/components/schemas/SparkBatchSQL', + 'TotalCount' => ['description' => 'The total number of scaling plan jobs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Jobs' => [ + 'description' => 'The queried scaling plan jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ElasticPlanName' => ['description' => 'The name of the scaling plan.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Status' => ['description' => 'The state of the scaling plan job. Valid values:'."\n" + ."\n" + .'* RUNNING'."\n" + .'* SUCCESSFUL'."\n" + .'* FAILED'."\n", 'type' => 'string', 'example' => 'SUCCESSFUL', 'title' => ''], + 'Type' => ['description' => 'The type of the scaling plan job. Valid values:'."\n" + ."\n" + .'* EXECUTOR: the interactive resource group type, which indicates the computing resource type.'."\n" + .'* WORKER: the EIU type.'."\n", 'type' => 'string', 'example' => 'EXECUTOR', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the scaling plan job.'."\n" + ."\n" + .'> The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-01-01T11:01:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the scaling plan job.'."\n" + ."\n" + .'> The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-01-01T12:01:00Z', 'title' => ''], + 'TargetSize' => ['description' => 'The desired specifications of elastic resources after scaling.'."\n", 'type' => 'string', 'example' => '32ACU', 'title' => ''], + 'TotalAcu' => ['description' => 'The total amount of resources.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If Type is set to EXECUTOR, TotalAcu indicates the total amount of computing resources in the current resource group.'."\n" + ."\n" + .'* If Type is set to WORKER, TotalAcu indicates the total amount of storage resources in the cluster.'."\n", 'type' => 'string', 'example' => '32ACU', 'title' => ''], + 'ReserveAcu' => ['description' => 'The amount of reserved resources.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If Type is set to EXECUTOR, ReserveAcu indicates the amount of reserved resources in the current resource group.'."\n" + ."\n" + .'* If Type is set to WORKER, ReserveAcu indicates the total amount of reserved storage resources in the current cluster.'."\n", 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'ElasticAcu' => ['description' => 'The amount of elastic resources.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If Type is set to EXECUTOR, ElasticAcu indicates the amount of elastic resources in the current resource group.'."\n" + ."\n" + .'* If Type is set to WORKER, ElasticAcu indicates the total amount of elastic storage resources in the current cluster.'."\n", 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'InstanceSize' => ['description' => 'The number of compute nodes or storage replica sets.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If Type is set to EXECUTOR, InstanceSize indicates the number of compute nodes in the cluster.'."\n" + ."\n" + .'* If Type is set to EXECUTOR, InstanceSize indicates the number of storage replica sets in the cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], ], + 'example' => '', ], ], ], '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', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'DescribeElasticPlanJobs', + 'summary' => 'Queries a list of scaling plan jobs for an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see Endpoints.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-12-12T10:09:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-13T11:20:16.000Z', 'description' => 'Error codes changed'], ], - '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' => 'ExecuteSparkWarehouseBatchSQL', - ], - 'CancelSparkWarehouseBatchSQL' => [ - 'summary' => 'Cancels the execution of a Spark SQL statement.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticPlanJobs'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeElasticPlanJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeElasticPlanSpecifications' => [ + 'summary' => 'Queries the resource specifications that are supported by different types of scaling plans of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235570', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'QueryId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The query ID of the Spark SQL statement.', - 'type' => 'string', - 'required' => true, - 'example' => 'sq202501011001s****', - ], + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The type of the scaling plan. Valid values:'."\n" + ."\n" + .'* EXECUTOR: the interactive resource group type, which specifies the computing resource type.'."\n" + .'* WORKER: the elastic I/O unit (EIU) type.'."\n", 'type' => 'string', 'required' => true, 'example' => 'EXECUTOR', 'title' => ''], ], [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'amv-uf6485635f***', - ], + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter must be specified only when you query the resource specifications that are supported by an interactive resource group.'."\n" + ."\n" + .'* You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the name of a resource group within a cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Agency', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the client, which can be up to 16 characters in length. Specify a descriptive name that makes it easy to identify.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DMS', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '771C5FAA-530F-52F7-B84D-EBAD45***', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'example' => '123', - '$ref' => '#/components/schemas/SparkBatchSQL', + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Specifications' => [ + 'description' => 'The queried resource specifications.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried resource specification.'."\n", 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], ], + 'example' => '', ], ], ], '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', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'DescribeElasticPlanSpecifications', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-12-12T10:09:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-13T11:20:15.000Z', 'description' => 'Error codes changed'], ], - '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' => 'CancelSparkWarehouseBatchSQL', - ], - 'ListSparkWarehouseBatchSQL' => [ - 'summary' => 'Queries a list of Spark SQL statements.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticPlanSpecifications'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeElasticPlanSpecifications', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeElasticPlans' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236211', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1ub9grke1****', - ], + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the scaling plan.'."\n" + ."\n" + .'> If you do not specify this parameter, all scaling plans are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ResourceGroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the interactive resource group for which the Spark engine is enabled.', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'> * If you do not specify this parameter, the scaling plans of all resource groups are queried, covering the interactive resource group type and the elastic I/O unit (EIU) type.'."\n" + .'>* You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the name of a resource group within a cluster.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query the scaling plans that are immediately enabled after the plans are created. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - 'default' => '10', - ], + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The type of the scaling plan. Valid values:'."\n" + ."\n" + .'* **EXECUTOR**: the interactive resource group type, which specifies the computing resource type.'."\n" + .'* **WORKER**: the EIU type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'EXECUTOR', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'PaginationResponse\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Queries' => [ - 'description' => 'The queried Spark SQL statements.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried Spark SQL statement.'."\n", - 'example' => '[{\\"doc_id\\":[\\"1293619227704606720\\"]}]', - '$ref' => '#/components/schemas/SparkBatchSQL', - ], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'ElasticPlans' => [ + 'description' => 'The queried scaling plans.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried scaling plan.'."\n", + 'type' => 'object', + 'properties' => [ + 'ElasticPlanName' => ['description' => 'The name of the scaling plan.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'The type of the scaling plan. Valid values:'."\n" + ."\n" + .'* **EXECUTOR**: the interactive resource group type, which specifies the computing resource type.'."\n" + .'* **WORKER**: the EIU type.'."\n", 'type' => 'string', 'example' => 'EXECUTOR', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the scaling plan is immediately enabled after the plan is created. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the name of a resource group within a cluster.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TargetSize' => ['description' => 'The amount of elastic resources after scaling.'."\n", 'type' => 'string', 'example' => '32ACU', 'title' => ''], + 'NextScheduleTime' => ['description' => 'The time when the next scheduling is performed.'."\n" + ."\n" + .'> The time is in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", 'type' => 'string', 'example' => '2022-01-01T12:01:00Z', 'title' => ''], + 'AutoScale' => ['description' => 'Indicates whether **Proportional Default Scaling for EIUs** is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], ], + 'example' => '', ], ], ], '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' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + 'title' => 'DescribeElasticPlans', + 'summary' => 'Queries scaling plans of an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-06-02T01:37:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-04-13T11:20:16.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticPlans'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'Spark.ObjectNotFound', - 'errorMessage' => 'The object is not found. More information: %s', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeElasticPlans', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'ListSparkWarehouseBatchSQL', + '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":""}]', ], - 'GetSparkWarehouseBatchSQL' => [ - 'summary' => 'Queries the execution result of a Spark SQL statement.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeEnabledPrivileges' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18349,152 +14366,133 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235568', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '159129', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ - 'name' => 'QueryId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The query ID of the Spark SQL statement.', - 'type' => 'string', - 'required' => true, - 'example' => 'sq2024123*****', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-uf6485635f***', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster..', 'type' => 'string', 'required' => true, 'example' => 'amv-bp14t95lun0w****', 'title' => ''], ], [ - 'name' => 'Agency', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the client, which can be up to 16 characters in length. Specify a descriptive name that makes it easy to identify.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DMS', - 'default' => 'POPSDK', - ], + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database account.'."\n" + .'> You can call the [DescribeAccounts](~~612430~~) operation to query the database account information of a specified cluster, including the account name.', 'type' => 'string', 'required' => false, 'example' => 'test_accout', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3D44EDA0-A9DC-580D-9B5A-019370C075F4', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '246F42E0-A475-15FF-96D2-8DC47FC2F289', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'example' => '{\'DBClusterId\': \'amv-uf6485635fz852mn\', \'Statements\': [{\'Code\': \'show databases\', \'State\': \'FINISHED\', \'StatementId\': \'sq202501141001sh8e12e080006846-0000\', \'Result\': \'+--------------------+n', - '$ref' => '#/components/schemas/SparkBatchSQL', + 'description' => 'The supported permission levels and the list of permissions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The permission level and the permissions supported at that level.', + 'type' => 'object', + 'properties' => [ + 'Scope' => ['description' => 'The permission level.', 'type' => 'string', 'required' => true, 'example' => 'Global', 'title' => ''], + 'Description' => ['description' => 'The description of the permission level.', 'type' => 'string', 'required' => true, 'example' => '全局权限', 'title' => ''], + 'Privileges' => [ + 'description' => 'The list of supported permissions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The permission details, including the permission name and description.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The permission name.', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'Description' => ['description' => 'The permission description.', 'type' => 'string', 'example' => '查询数据', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + 'title' => 'Query supported permission levels and permissions', + 'summary' => 'Retrieves the supported permission levels and the list of permissions.', + 'description' => '- Central public endpoint: `adb.aliyuncs.com`.'."\n" + .'- Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- Regional VPC endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.', + 'changeSet' => [ + ['createdAt' => '2023-12-18T14:04:04.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-12-06T02:33:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-20T14:39:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-24T06:25:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnabledPrivileges'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'Spark.ObjectNotFound', - 'errorMessage' => 'The object is not found. More information: %s', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeEnabledPrivileges', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'GetSparkWarehouseBatchSQL', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', ], - 'StartSparkReplSession' => [ - 'summary' => 'Starts a Spark session.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeEssdCacheConfig' => [ + 'summary' => 'Queries the disk cache size in the query acceleration configuration of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1mfe9qm****', - ], - ], - [ - 'name' => 'ResourceGroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the job resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'Config', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The configuration parameters that are used to start the Spark session, which are in the JSON format. For more information, see [Spark application configuration parameters](~~471203~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{ "spark.shuffle.timeout": ":0s" }', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-uf685u1o987hj6rn', 'title' => ''], ], ], 'responses' => [ @@ -18502,204 +14500,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C1797FEA-B7D6-5ED6-A24B-2C8C5F4D7361', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', 'title' => ''], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'SessionId' => [ - 'description' => 'The ID of the session that executes the code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AttemptId' => [ - 'description' => 'The attempt ID of the Spark application.'."\n", - 'type' => 'string', - 'example' => 's202301061000h****', - ], - 'Error' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'session time out', - ], - 'WebUiAddress' => [ - 'description' => 'The URL of the web UI for the Spark application.'."\n", - 'type' => 'string', - 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', - ], - 'State' => [ - 'description' => 'The status of the session. Valid values:'."\n" + 'EnableEssdCache' => [ + 'description' => 'Specifies whether to enable the disk cache feature.'."\n" ."\n" - .'* IDLE'."\n" - .'* BUSY'."\n" - .'* DEAD'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'IDLE', - ], - 'AliyunUid' => [ - 'description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", - 'type' => 'string', - 'example' => '178157466******', + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', + 'title' => '', ], + 'EssdCacheSize' => ['description' => 'The disk cache size. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], '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' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMaintainTime.Malformed', 'errorMessage' => 'The specified parameter MaintainTime is not valid.', 'description' => 'The MaintainTime parameter is invalid. Check the parameter.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + 'title' => 'DescribeEssdCacheConfig', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEssdCacheConfig'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DescribeEssdCacheConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'StartSparkReplSession', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"Data\\": {\\n \\"EnableEssdCache\\": true,\\n \\"EssdCacheSize\\": 500\\n }\\n}","type":"json"}]', ], - 'GetSparkReplStatement' => [ - 'summary' => 'Queries the execution result of a code block.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeExcessivePrimaryKeys' => [ + 'summary' => 'Queries the information about tables that have excessive primary key fields in an AnalyticDB for MySQL Data Lakehouse Edition (V5.0) cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18708,46 +14570,85 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '217360', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark App的名称', - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 's202411071444hzdvk486d9d200****', - 'default' => 'ADB-Spark-Application', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-bp1xxxxxxxx47', 'title' => ''], ], [ - 'name' => 'StatementId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique ID of the code block in the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SessionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the session that executes the code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2019-06-01T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2019-06-01T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '30', 'default' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of file titles and error messages. Valid values:'."\n" + ."\n" + .'* **zh (default)**: simplified Chinese.'."\n" + .'* **en**: English.'."\n" + .'* **ja**: Japanese.'."\n" + .'* **zh-tw**: traditional Chinese.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order in which table fields are sorted. Specify the value in the JSON format.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .' ['."\n" + ."\n" + .' {'."\n" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\n" + .' }'."\n" + ."\n" + .' ]'."\n" + ."\n" + .'In the preceding code, Field specifies the field that is used to sort the table data. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.'."\n" + ."\n" + .'Field and Type are case-insensitive.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"Field":"TableName", "Type": "Desc" }]', 'title' => ''], ], ], 'responses' => [ @@ -18755,249 +14656,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'StatementId' => [ - 'description' => 'The unique ID of the code block in the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Code' => [ - 'description' => 'The code that is executed.'."\n", - 'type' => 'string', - 'example' => 'print(1+1)', - ], - 'CodeType' => [ - 'description' => 'The code type. Valid values:'."\n" - ."\n" - .'* PYTHON'."\n" - .'* SCALA'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'PYTHON', - ], - 'CodeState' => [ - 'description' => 'The code execution status. Valid values:'."\n" - ."\n" - .'* CANCELLED'."\n" - .'* RUNNING'."\n" - .'* SUCCEEDED'."\n" - .'* ERROR'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'RUNNING', - ], - 'AliyunUid' => [ - 'description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '144740799645****', - ], - 'OutputType' => [ - 'description' => 'The execution result type.'."\n" + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '300', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'example' => '30', 'default' => '10', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '863D51B7-5321-41D8-A0B6-A088B0******', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'am-bp1ub9grke1****', 'title' => ''], + 'Tables' => [ + 'description' => 'The queried tables that have excessive primary key fields.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'SchemaName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'ColumnCount' => ['description' => 'The total number of columns.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '21', 'title' => ''], + 'PrimaryKeyCount' => ['description' => 'The number of primary key fields.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PrimaryKeyColumns' => ['description' => 'The queried primary key fields.'."\n", 'type' => 'string', 'example' => 'id,date'."\n", 'title' => ''], + 'SpaceRatio' => ['description' => 'The percentage of the table size. Unit: %.'."\n" ."\n" - .'Valid values:'."\n" + .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '23', 'title' => ''], + 'TotalSize' => ['description' => 'The cold data size. Unit: bytes.'."\n" ."\n" - .'* TABLE'."\n" - .'* TEXT'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'TABLE' => '', - 'TEXT' => '', - ], - 'example' => 'TEXT', - ], - 'Output' => [ - 'description' => 'The code execution result, which is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{"text/plain": 2}', - ], - 'Columns' => [ - 'description' => 'The column names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The column name.'."\n", - 'type' => 'string', - 'example' => 'col1', - ], - ], - 'Error' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'stackoverflow error', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730968194000', - ], - 'EndTime' => [ - 'description' => 'The end time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730968194000', + .'> Formula: Cold data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'PrimaryKeyIndexSize' => ['description' => 'The data size of primary key indexes. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '222', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried detection item and detection result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the detection item.'."\n", 'type' => 'string', 'example' => 'Excessive primary keys detection', 'title' => ''], + 'Message' => ['description' => 'The detection result.'."\n", 'type' => 'string', 'example' => 'Multiple tables are detected with excessive primary keys.', 'title' => ''], + 'Status' => ['description' => 'The severity level of the detection result.'."\n", 'type' => 'string', 'example' => 'NORMAL'."\n" + .'WARNNING'."\n" + .'CRITICAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'AccessDeniedDetail' => ['description' => 'The queried information about the request denial.'."\n", '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" + .' }', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + '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\\": \\"Excessive primary keys detection\\",\\n \\"Message\\": \\"Multiple tables are detected with excessive primary keys.\\",\\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' => 'DescribeExcessivePrimaryKeys', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExcessivePrimaryKeys'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeExcessivePrimaryKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'GetSparkReplStatement', ], - 'ExecuteSparkReplStatement' => [ - 'summary' => 'Executes part of the code in a Spark job.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeExecutorDetection' => [ + 'summary' => 'Queries the diagnostic results of the compute layer.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19006,59 +14766,46 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '194344', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark App的名称', - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 's202411071444hzdvk486d9d2001****', - 'default' => 'ADB-Spark-Application', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-xxx', 'title' => ''], ], [ - 'name' => 'Code', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The code that you want to execute.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'print(1+1)', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen', 'title' => ''], ], [ - 'name' => 'CodeType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The language type of the code. Valid values:'."\n" - ."\n" - .'* SCALA'."\n" - .'* PYTHON'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'PYTHON', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2024-10-31T02:06Z', 'title' => ''], ], [ - 'name' => 'SessionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the session that you want to use to execute the code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-05-27T16:00Z', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'* **zh**: simplified Chinese.'."\n" + .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -19066,247 +14813,150 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'StatementId' => [ - 'description' => 'The unique ID of the code block in the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Code' => [ - 'description' => 'The code that is executed.'."\n", - 'type' => 'string', - 'example' => 'print(1+1)', - ], - 'CodeType' => [ - 'description' => 'The code type. Valid values:'."\n" - ."\n" - .'* SCALA'."\n" - .'* PYTHON'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'PYTHON', - ], - 'CodeState' => [ - 'description' => 'The code execution status. Valid values:'."\n" - ."\n" - .'* CANCELLED'."\n" - .'* RUNNING'."\n" - .'* SUCCEEDED'."\n" - .'* ERROR'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'RUNNING', - ], - 'AliyunUid' => [ - 'description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17108278707****', - ], - 'OutputType' => [ - 'description' => 'The execution result type, which is in the JSON format. Valid values:'."\n" - ."\n" - .'* TEXT: the text content that conforms to Apache Livy.'."\n" - .'* TABLE: the table content that conforms to Apache Livy.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'TABLE' => '', - 'TEXT' => '', - ], - 'example' => 'TEXT', - ], - 'Output' => [ - 'description' => 'The code execution result, which is a JSON string that conforms to Apache Livy.'."\n", - 'type' => 'string', - 'example' => '{"text/plain": 2}', - ], - 'Columns' => [ - 'description' => 'The column names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The column name.'."\n", - 'type' => 'string', - 'example' => 'col1', + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '566', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9DFF5F54-162B-5860-80A5-411FF550B347', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'am-xxx', 'title' => ''], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried detection item and detection result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the detection item.'."\n", 'type' => 'string', 'example' => 'Metric detection', 'title' => ''], + 'Results' => [ + 'description' => 'The detection result items.'."\n", + 'type' => 'object', + 'properties' => [ + 'OperatorDetails' => [ + 'description' => 'The detection result items of abnormal operators.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The name of the detection metric.'."\n", 'type' => 'string', 'example' => 'PeakMemory', 'title' => ''], + 'SearchResults' => [ + 'description' => 'The detection result items of abnormal operators.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProcessId' => ['description' => 'The query ID.'."\n", 'type' => 'string', 'example' => '2024080110010002102500023803151627972', 'title' => ''], + 'StageId' => ['description' => 'The stage ID.'."\n", 'type' => 'string', 'example' => 'Stage[3]', 'title' => ''], + 'OperatorName' => ['description' => 'The name of the operator.'."\n", 'type' => 'string', 'example' => 'Join', 'title' => ''], + 'PeakMemory' => ['description' => 'The peak memory. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '234', 'title' => ''], + 'OperatorCost' => ['description' => 'The total CPU time consumed by all operators in the stage, which is equivalent to the total CPU time of the stage. You can use this parameter to determine which parts of the stage consume a large amount of computing resources. Unit: milliseconds.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '123', 'title' => ''], + 'InputRows' => ['description' => 'The number of rows input by the operator.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'OutputRows' => ['description' => 'The number of rows output by the operator.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2345', 'title' => ''], + 'InputSize' => ['description' => 'The amount of data input by the operator. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '345', 'title' => ''], + 'OutputSize' => ['description' => 'The amount of data output by the operator. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '234', 'title' => ''], + 'OperatorInfo' => ['description' => 'The property information about the operator.'."\n", 'type' => 'string', 'example' => 'Group By字段：uid', 'title' => ''], + ], + 'description' => 'The detection result items of abnormal operators.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The detection result items of abnormal operators.'."\n", + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OperatorAgg' => [ + 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The name of the detection metric.'."\n", 'type' => 'string', 'example' => 'OperatorCost', 'title' => ''], + 'SearchResults' => [ + 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperatorName' => ['description' => 'The name of the operator.'."\n", 'type' => 'string', 'example' => 'Window', 'title' => ''], + 'MaxValue' => ['description' => 'The maximum value of the operator metric.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2345', 'title' => ''], + 'TotalValue' => ['description' => 'The cumulative value of the operator metric.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '345', 'title' => ''], + 'AvgValue' => ['description' => 'The average value of the operator metric.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '234', 'title' => ''], + 'OperatorCount' => ['description' => 'The number of occurrences of the operator.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + ], + 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The information about the detection result.'."\n", 'type' => 'string', 'example' => '检测到Aggregation算子消耗内存资源较多'."\n", 'title' => ''], + 'Status' => ['description' => 'The severity level of the detection result. Valid values:'."\n" + ."\n" + .'* NORMAL'."\n" + .'* WARNING'."\n" + .'* CRITICAL'."\n", 'type' => 'string', 'example' => 'WARNING', 'title' => ''], ], - 'Error' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'StackOverflow Exception', - ], - 'StartTime' => [ - 'description' => 'The start time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730968125000', - ], - 'EndTime' => [ - 'description' => 'The end time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730968125000', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + '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\\": \\"Metric detection\\",\\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' => 'DescribeExecutorDetection', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExecutorDetection'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeExecutorDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'ExecuteSparkReplStatement', ], - 'CancelSparkReplStatement' => [ - 'summary' => 'Terminates part of the code in a Spark job.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHistoryTasks' => [ + 'summary' => 'Retrieve historical task records.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -19315,46 +14965,88 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '254755', + 'abilityTreeNodes' => ['FEATUREads12ZDDA'], ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark App的名称', - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 's202411071444hzdvk486d9d2001****', - 'default' => 'ADB-Spark-Application', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region ID'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'StatementId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique ID of the code block in the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values: 10 to 100. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10', 'title' => ''], ], [ - 'name' => 'SessionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '456', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Valid range: positive integers. Default value: 1'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => ['description' => 'The instance type. The value is fixed to Instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instance', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The state of the task. Valid values:'."\n" + ."\n" + .'* **Scheduled**'."\n" + .'* **Running**'."\n" + .'* **Succeed**'."\n" + .'* **Failed**: The task failed.'."\n" + .'* **Cancelling**'."\n" + .'* **Canceled**'."\n" + .'* **Waiting**'."\n" + ."\n" + .'If querying multiple statuses, separate them with English commas. Default is empty, meaning select all.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID. Separate multiple cluster IDs with commas (,). Maximum 30 cluster IDs. If not filled, defaults to querying historical tasks of all clusters in that region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-********', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The job IDs. Separate multiple task IDs with commas (,). Maximum 30 task IDs. If not filled, defaults to querying historical tasks of all clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-83br18hloy3faf****', 'title' => ''], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['description' => 'Task type, used to query specific type task situations. If multiple, separate with English commas (,), maximum 30 supported. Default is empty, meaning no restriction.'."\n", 'type' => 'string', 'required' => false, 'example' => 'autotest_dispatch_cases', 'title' => ''], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => ['description' => 'Start time of task start time, indicating querying tasks whose start time is after this time. Expressed according to ISO8601 standard, and must use UTC +0 time, format: yyyy-MM-ddTHH:mm:ssZ. Earliest supports 30 days ago, automatically converts to 30 days ago if more than 30 days from current time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-01-02T11:31:03Z', 'title' => ''], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => ['description' => 'End time of task start time, indicating querying tasks whose start time is before this time. Expressed according to ISO8601 standard, and must use UTC +0 time, format: yyyy-MM-ddTHH:mm:ssZ.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-03-02T11:31:03Z', 'title' => ''], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => ['description' => 'Minimum task execution time. Used to filter tasks with execution time greater than this value, in seconds. Default 0, meaning no limit.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => ['description' => 'Maximum task execution time. Used to filter tasks with execution time not less than this value, in seconds. Default 0, meaning no limit.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'Resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-ae****', 'title' => ''], ], ], 'responses' => [ @@ -19362,496 +15054,302 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'StatementId' => [ - 'description' => 'The unique ID of the code block in the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Code' => [ - 'description' => 'The code that is executed.'."\n", - 'type' => 'string', - 'example' => 'print(1+1)', - ], - 'CodeType' => [ - 'description' => 'The code type. Valid values:'."\n" - ."\n" - .'* SCALA'."\n" - .'* PYTHON'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'PYTHON', - ], - 'CodeState' => [ - 'description' => 'The code execution status. Valid values:'."\n" + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'E51713A3-BB45-5616-AB15-170B704F8F01', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'Total record count.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Items' => [ + 'description' => 'The task list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The task object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Task status. Valid values:'."\n" ."\n" - .'* CANCELLED'."\n" - .'* RUNNING'."\n" - .'* SUCCEEDED'."\n" - .'* ERROR'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'RUNNING', - ], - 'AliyunUid' => [ - 'description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190063530332****', - ], - 'OutputType' => [ - 'description' => 'The execution result type, which is in the JSON format. Valid values:'."\n" + .'* **Scheduled**'."\n" + .'* **Running**'."\n" + .'* **Succeed**'."\n" + .'* **Failed**: The task failed.'."\n" + .'* **Cancelling**'."\n" + .'* **Canceled**'."\n" + .'* **Waiting**'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'TaskId' => ['description' => 'Task ID.'."\n", 'type' => 'string', 'example' => 't-83br18hloy3faf****', 'title' => ''], + 'CurrentStepName' => ['description' => 'Current executing step name. If empty, represents task has not started.'."\n", 'type' => 'string', 'example' => 'exec_task', 'title' => ''], + 'StartTime' => ['description' => 'Task start time.'."\n", 'type' => 'string', 'example' => '2022-02-03T11:31:03Z', 'title' => ''], + 'EndTime' => ['description' => 'Task end time.'."\n", 'type' => 'string', 'example' => '2022-02-03T12:06:17Z', 'title' => ''], + 'TaskType' => ['description' => 'Task type.'."\n", 'type' => 'string', 'example' => 'autotest_dispatch_cases', 'title' => ''], + 'RemainTime' => ['description' => 'Estimated remaining execution time, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Progress' => ['description' => 'Indicates the task progress.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '79.0', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'InstanceType' => ['description' => 'Instance type.'."\n", 'type' => 'string', 'example' => 'Instance', 'title' => ''], + 'InstanceId' => ['description' => 'Cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-********', 'title' => ''], + 'InstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DbType' => ['description' => 'The database engine type.'."\n", 'type' => 'string', 'example' => 'analyticdb', 'title' => ''], + 'Product' => ['description' => 'The service name.'."\n", 'type' => 'string', 'example' => 'ads', 'default' => 'ADB', 'title' => ''], + 'TaskDetail' => ['description' => 'The task details.'."\n", 'type' => 'string', 'example' => '{\\"callerUid\\":\\"test\\"}', 'title' => ''], + 'ActionInfo' => ['description' => 'Allowed operation information. When used specifically, matches operation Action based on currentStepName+status in this information. If no Action is matched, represents task current status does not support operations.'."\n", 'type' => 'string', 'example' => '{\\"steps\\":[{\\"action_info\\":{\\"Waiting\\":[\\"modifySwitchTime\\"]},\\"step_name\\":\\"exec_task\\"}]}', 'title' => ''], + 'Uid' => ['description' => 'null'."\n", 'type' => 'string', 'example' => '141345906006****', 'title' => ''], + 'CallerSource' => ['description' => 'null'."\n", 'type' => 'string', 'example' => '141345906006****', 'title' => ''], + 'CallerUid' => ['description' => 'null'."\n" ."\n" - .'* TEXT: the text content that conforms to Apache Livy.'."\n" - .'* TABLE: the table content that conforms to Apache Livy.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'TEXT', - ], - 'Output' => [ - 'description' => 'The code execution result, which is a JSON string that conforms to Apache Livy.'."\n", - 'type' => 'string', - 'example' => '{"text/plain": "2"}', - ], - 'Columns' => [ - 'description' => 'The column names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The column name.'."\n", - 'type' => 'string', - 'example' => 'col1', - ], - ], - 'Error' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'StackOverflow Exception:', - ], - 'StartTime' => [ - 'description' => 'The start time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730968056000', - ], - 'EndTime' => [ - 'description' => 'The end time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730968056000', + .'* **null**'."\n" + .'* **null**'."\n", 'type' => 'string', 'example' => 'User', 'title' => ''], + 'ReasonCode' => ['description' => 'The reason why the current task was initiated.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code that is returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. null'."\n" + ."\n" + .'* null****'."\n" + .'* null'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'AccessDeniedDetail' => [ + 'description' => 'null'."\n", + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['description' => 'null'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'null'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'null'."\n", 'type' => 'string', 'example' => '141345906006****', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'null'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'null'."\n", 'type' => 'string', 'example' => 'AQFmy+hZZsvoWTQ2NTJFQUFBLUIyNjktMzk5NS05MEZCLUMxMzgwNDUwMDA2Ng==', 'title' => ''], + 'NoPermissionType' => ['description' => 'null'."\n" + ."\n" + .'* **null**'."\n" + .'* **null**'."\n", 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'null'."\n" + ."\n" + .'* **null**'."\n" + .'* **null**'."\n" + .'* **null**'."\n" + .'* **null**'."\n" + .'* **null**'."\n", 'type' => 'string', 'example' => 'ControlPolicy', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeHistoryTasks', + 'description' => 'Only supports viewing tasks within the last 30 days.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasks'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeHistoryTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'CancelSparkReplStatement', + '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"}]', ], - 'GetSparkReplSession' => [ - 'summary' => 'Queries the status of a Spark session.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHistoryTasksStat' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '254776', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark App的名称', - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query all application IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 's202411071444hzdvk486d9d200****', - 'default' => 'ADB-Spark-Application', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The ID of the region where the instance resides.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'SessionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the session that executes the code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The state of the task. Valid values:'."\n" + ."\n" + .'* **Scheduled**'."\n" + .'* **Running**'."\n" + .'* **Succeed**'."\n" + .'* **Failed**: The task failed.'."\n" + .'* **Cancelling**'."\n" + .'* **Canceled**'."\n" + .'* **Waiting**'."\n" + ."\n" + .'Separate multiple states with commas (,). This parameter is empty by default, which indicates that tasks in all states are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-********', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'Task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1564657730', 'title' => ''], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['description' => 'Task type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'Query start time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-05-08T07:04:17Z', 'title' => ''], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'Represents tasks whose start time is before this time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-02-24T10:01:37Z', 'title' => ''], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => ['description' => 'Minimum task execution time, used to filter tasks with execution time greater than this value, in seconds. Default 0, meaning no limit'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => ['description' => 'Maximum task execution time, used to filter tasks with execution time not less than this value, in seconds. Default 0, meaning no limit'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'Resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4CE6DF97-AEA4-484F-906F-C407EE3770EB', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Items' => [ + 'description' => 'The tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Task information list.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the APS job.'."\n" + ."\n" + .'* **Scheduled**'."\n" + .'* **Running**'."\n" + .'* **Succeed**'."\n" + .'* **Failed**: The task failed.'."\n" + .'* **Cancelling**'."\n" + .'* **Canceled**'."\n" + .'* **Waiting**'."\n", 'type' => 'string', 'example' => 'Scheduled', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Data' => [ - 'description' => 'The returned data.'."\n", + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, an success message is returned.'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Code' => ['description' => 'API status or POP error code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'AccessDeniedDetail' => [ + 'description' => 'The queried information about the request denial.'."\n", 'type' => 'object', 'properties' => [ - 'SessionId' => [ - 'description' => 'The ID of the session that executes the code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'State' => [ - 'description' => 'The status of the session. Valid values:'."\n" - ."\n" - .'* IDLE'."\n" - .'* BUSY'."\n" - .'* DEAD'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'IDEL', - ], - 'AttemptId' => [ - 'description' => 'The attempt ID of the Spark application.'."\n", - 'type' => 'string', - 'example' => 's202301061000hz57d797b00002****', - ], - 'Error' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Session timed out', - ], - 'WebUiAddress' => [ - 'description' => 'The URL of the web UI for the Spark application.'."\n", - 'type' => 'string', - 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', - ], - 'AliyunUid' => [ - 'description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", - 'type' => 'string', - 'example' => '178157466101****', - ], - 'Active' => [ - 'description' => 'Indicates whether the session is active. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'true', - ], + 'AuthAction' => ['description' => 'Authorized action'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The display name of the requester.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the Alibaba Cloud account to which the authentication principal belongs.'."\n", 'type' => 'string', 'example' => '141345906006****', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The requester type.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded diagnostic message.'."\n", 'type' => 'string', 'example' => 'test'."\n", 'title' => ''], + 'NoPermissionType' => ['description' => 'The type of the policy denial. Valid values:'."\n" + ."\n" + .'* **ImplicitDeny**: The resource holder has not configured a policy for the current user. By default, unauthorized operations are denied.'."\n" + .'* **ExplicitDeny**: The RAM policy configured by the resource holder explicitly denies the current user access to the corresponding resources.'."\n", 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], + 'PolicyType' => ['description' => 'The type of the policy that causes the access denied error.'."\n" + ."\n" + .'* **ControlPolicy**: control policy'."\n" + .'* **SessionPolicy**: an additional policy that is added to the temporary token.'."\n" + .'* **AssumeRolePolicy**: the authorization policy of the RAM role.'."\n" + .'* **AccountLevelIdentityBasedPolicy**: the principal policies of the account authorization scope, including custom policies and system policies.'."\n" + .'* **ResourceGroupLevelIdentityBasedPolicy**: the principal policy of the resource group authorization scope, including custom policies and system policies.'."\n", 'type' => 'string', 'example' => 'ControlPolicy', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeHistoryTasksStat', + 'summary' => 'Queries task statistics.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasksStat'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DescribeHistoryTasksStat', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 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' => 'GetSparkReplSession', + '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"}]', ], - 'DescribeSparkAppType' => [ - 'summary' => 'Queries the type of a Spark application.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeInclinedNodes' => [ + 'summary' => 'Queries the disk usage of all storage nodes.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['Perth'], 'security' => [ [ 'AK' => [], @@ -19861,51 +15359,31 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '189112', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '217356', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-wz9w49b12933****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-wz9jd******d1765', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~612475~~) operation to query the Spark application IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202407161205sza4c07c1000****', - ], + 'schema' => ['description' => 'The language of file titles and error messages. Valid values:'."\n" + ."\n" + .'* **zh**: simplified Chinese.'."\n" + .'* **en**: English.'."\n" + .'* **ja**: Japanese.'."\n" + .'* **zh-tw**: traditional Chinese.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -19913,65 +15391,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '596AF63B-8798-501E-BA06-CD2184D48A35', - ], - 'Type' => [ - 'description' => 'The type of the Spark application. Valid values:'."\n" - ."\n" - .'* BATCH'."\n" - .'* SQLENGINE'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SQLENGINE' => '', - 'BATCH' => '', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C0BF6685-0519-543E-90F8-DB8949E4D5F2', 'title' => ''], + 'Items' => [ + 'description' => 'The queried storage nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried storage node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Node' => ['description' => 'The number of the storage node.'."\n", 'type' => 'string', 'example' => 'Node1', 'title' => ''], + 'DiskUsageRatio' => ['description' => 'The disk usage of the storage node.'."\n", 'type' => 'string', 'example' => '90.5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'Batch', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The detailed reason why the access was denied.'."\n", - '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" - .'}', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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' => 'DescribeSparkAppType', - ], - 'PreloadSparkAppMetrics' => [ - 'summary' => 'Preloads metrics for a Spark application.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeInclinedNodes', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInclinedNodes'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeInclinedNodes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + ], + 'DescribeInclinedTables' => [ + 'summary' => 'Queries the information about skewed tables for an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19980,225 +15463,192 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '169119', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186716', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'spark app的id', - 'description' => 'The Spark application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202204221525hzca7d8140000003', - 'maxLength' => 64, - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-k2jofo4pi5zhd****', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'TableType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp1mfe9qmsw1dzyg', - ], + 'schema' => ['description' => 'The type of the table. Valid values:'."\n" + ."\n" + .'* **FactTable**: the partitioned table.'."\n" + .'* **DimensionTable**: the dimension table.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FactTable', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order by which to sort query results. Specify the parameter value in the JSON format.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .' ['."\n" + ."\n" + .' {'."\n" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\n" + .' }'."\n" + ."\n" + .' ]'."\n" + ."\n" + .'Field specifies the field by which to sort the query results. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.'."\n" + ."\n" + .'Field and Type are case-insensitive.'."\n", 'type' => 'string', 'required' => false, 'example' => '[ { "Field":"Name", "Type":"Asc" } ]', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '30', 'default' => '30', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'* **zh (default)**: simplified Chinese.'."\n" + .'* **en**: English.'."\n" + .'* **ja**: Japanese.'."\n" + .'* **zh-tw**: traditional Chinese.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '84489769-3065-5A28-A4CB-977CD426F1C3', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], + 'PageSize' => ['description' => 'The total number of pages.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The queried tables.'."\n", 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => 'The ID of the Spark application.'."\n", - 'type' => 'string', - 'example' => 's202212181815shaccb8be0000253', - ], - 'AttemptId' => [ - 'description' => 'The retry ID of the Spark application.'."\n", - 'type' => 'string', - 'example' => 's202301061000hz57d797b0000201-0001', - ], - 'Finished' => [ - 'description' => 'Indicates whether parsing is complete. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'EventLogPath' => [ - 'description' => 'The event log path.'."\n", - 'type' => 'string', - 'example' => 'oss://path/to/eventLog', - ], - 'ScanMetrics' => [ - 'description' => 'The metrics.'."\n", - 'type' => 'object', - 'properties' => [ - 'OutputRowsCount' => [ - 'description' => 'The number of rows scanned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'TotalReadFileSizeInByte' => [ - 'description' => 'The size of the scanned data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', + 'Table' => [ + 'description' => 'The queried table.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the table.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The detection type of the table.'."\n", 'type' => 'string', 'example' => 'Fact', 'title' => ''], + 'Schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'spark_test', 'title' => ''], + 'Size' => ['description' => 'The number of rows in the table.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Name' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'admin_daily_own_statistic_record', 'title' => ''], + 'IsIncline' => ['description' => 'Indicates whether data is skewed in the table.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'TotalSize' => ['description' => 'The total data size of the table. Unit: bytes.'."\n" + ."\n" + .'> The following formulas can be used to calculate the total data size:'."\n" + ."\n" + .'* Formula 1: Total data size = Hot data size + Cold data size.'."\n" + .'* Formula 2: Total data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '53687091200', 'title' => ''], + 'SpaceRatio' => ['description' => 'The percentage of the table size. Unit: %.'."\n" + ."\n" + .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.4', 'title' => ''], + 'RowCount' => ['description' => 'The number of rows in the table.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detection result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the detection item.'."\n", 'type' => 'string', 'example' => 'Table skew', 'title' => ''], + 'Message' => ['description' => 'The message of the detection result.'."\n", 'type' => 'string', 'example' => 'A shard skew is detected in a table.', 'title' => ''], + 'Status' => ['description' => 'The severity level of the detection result.'."\n", 'type' => 'string', 'example' => 'NORMAL'."\n" + .'WARNNING'."\n" + .'CRITICAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", '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" + .'}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', - ], + '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\\": \\"Table skew\\",\\n \\"Message\\": \\"A shard skew is detected in a table.\\",\\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' => 'DescribeInclinedTables', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInclinedTables'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeInclinedTables', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'PreloadSparkAppMetrics', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", ], - 'GetSparkAppMetrics' => [ - 'summary' => 'Queries the metrics of a Spark application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeJobResourceUsage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20208,312 +15658,144 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '169120', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173228', + 'abilityTreeNodes' => ['FEATUREadsCQJTKP'], ], 'parameters' => [ - [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'spark app的id', - 'description' => 'The ID of the Spark application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202204221525hzca7d8140000003', - 'maxLength' => 64, - ], - ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp1ggnu61d77****', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'am-uf6g8w25jacm7****', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the query. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'required' => true, 'example' => '2023-02-04T03:45:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the query. The end time must be later than the start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'required' => true, 'example' => '2023-03-17T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'SparkAppName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value must be a positive integer. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'- 30'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'PlainResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Code' => ['description' => 'The API status or POP error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => 'The ID of the Spark application.'."\n", - 'type' => 'string', - 'example' => 's202302051515shfa865f80003691', - ], - 'AttemptId' => [ - 'description' => 'The attempt ID of the Spark application.'."\n", - 'type' => 'string', - 'example' => 's202301061000hz57d797b0000201-0001', - ], - 'Finished' => [ - 'description' => 'Indicates whether parsing is complete. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'EventLogPath' => [ - 'description' => 'The path of the event log.'."\n", - 'type' => 'string', - 'example' => 'oss://path/to/eventLog', - ], - 'ScanMetrics' => [ - 'description' => 'The metrics.'."\n", - 'type' => 'object', - 'properties' => [ - 'OutputRowsCount' => [ - 'description' => 'The number of scanned rows.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'TotalReadFileSizeInByte' => [ - 'description' => 'The number of scanned bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', + 'DBClusterId' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'example' => 'amv-clusterxxx', 'title' => ''], + 'StartTime' => ['description' => 'The start time. Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'example' => '2023-05-22T16:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time. Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'example' => '2023-05-23T16:00:00Z'."\n", 'title' => ''], + 'JobAcuUsage' => [ + 'description' => 'The ACU usage of the job resource group.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '1592', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the job resource group.', 'type' => 'string', 'example' => 'job_default', 'title' => ''], + 'JobStartTime' => ['description' => 'The start time of the job. Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'example' => '2023-05-22T16:00:00Z'."\n", 'title' => ''], + 'JobEndTime' => ['description' => 'The end time of the job. Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'example' => '2023-05-23T16:00:00Z', 'title' => ''], + 'AcuUsageDetail' => [ + 'description' => 'The ACU resource usage details.', + 'type' => 'object', + 'properties' => [ + 'TotalAcuNumber' => ['description' => 'The total number of ACU resources.', 'type' => 'number', 'format' => 'float', 'example' => '32ACU', 'title' => ''], + 'ReservedAcuNumber' => ['description' => 'The number of reserved ACU resources.', 'type' => 'number', 'format' => 'float', 'example' => '16ACU', 'title' => ''], + 'ElasticAcuNumber' => ['description' => 'The number of elastic ACU resources.', 'type' => 'number', 'format' => 'float', 'example' => '16ACU', 'title' => ''], + 'SpotAcuNumber' => ['description' => 'The number of spot instance ACU resources.', 'type' => 'number', 'format' => 'float', 'example' => '16ACU', 'title' => ''], + 'SpotAcuPercentage' => ['description' => 'The percentage of spot instance resources in the total elastic resources.', 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'UseCachePool' => ['description' => 'Indicates whether the hot pool is used.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SparkAppName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', - ], + 'title' => 'Query job resource usage', + 'summary' => 'Retrieves resource usage statistics for jobs.', + 'description' => 'For the service registration information of this service, see [Service registration](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-09-25T10:17:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-08T10:17:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-06-30T06:27:54.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeJobResourceUsage'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeJobResourceUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'GetSparkAppMetrics', - 'description' => '* Before you call this operation, you must call the [PreloadSparkAppMetrics](~~612447~~) operation to preload the metrics of a Spark application.'."\n" - .'* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + '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\\": false,\\n \\"SparkAppName\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 100\\n }\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'ListSparkLogAnalyzeTasks' => [ - 'summary' => 'Queries a list of Spark log analysis tasks.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeKernelVersion' => [ + 'summary' => 'Queries the information about the minor version of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20525,337 +15807,321 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '254101', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群ID', - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-9scxs****', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '页码号', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-2ze918p6qf6h9****', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '每页数量', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskList' => [ - 'title' => '分析任务列表', - 'description' => 'The queried Spark log analysis tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried Spark log analysis task.'."\n", - '$ref' => '#/components/schemas/SparkAnalyzeLogTask', - ], - ], - 'PageNumber' => [ - 'title' => '页码号', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页数量', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TotalCount' => [ - 'title' => 'Task总数', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'KernelVersion' => ['description' => 'The minor version of the cluster. Example: **3.1.8**.'."\n", 'type' => 'string', 'example' => '3.1.8', 'title' => ''], + 'ExpireDate' => ['description' => 'The maintenance expiration time of the version. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. After the time arrives, the system no longer maintains the version. If any issues occur, update the minor version of the cluster to a later version.'."\n", 'type' => 'string', 'example' => '2025-01-12T16:00:00Z', 'title' => ''], + 'AvailableKernelVersions' => [ + 'description' => 'The minor versions to which you can update the current minor version of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The minor versions to which you can update the current minor version of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'KernelVersion' => ['description' => 'The minor version. Example: **3.1.9**.'."\n", 'type' => 'string', 'example' => '3.1.9', 'title' => ''], + 'ReleaseDate' => ['description' => 'The time when the minor version was released. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-07-17T16:00:00Z'."\n", 'title' => ''], + 'ExpireDate' => ['description' => 'The maintenance expiration time of the version. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. After the time arrives, the system no longer maintains the version. If any issues occur, update the minor version of the cluster to a later version.'."\n", 'type' => 'string', 'example' => '2025-07-17T16:00:00Z', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + 'title' => 'DescribeKernelVersion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeKernelVersion'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeKernelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'ListSparkLogAnalyzeTasks', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + '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"}]', ], - 'SubmitSparkLogAnalyzeTask' => [ - 'summary' => 'Submits a Spark log analysis task and queries the analysis results.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeLakeCacheSize' => [ + 'summary' => 'Queries the lake cache size of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', + 'abilityTreeCode' => '214834', + 'abilityTreeNodes' => ['FEATUREadsCQJTKP'], ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark App ID'."\n", - 'description' => 'The ID of the Spark application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202301121553hzd9c6f7xxxx', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp10b6646l07akdt', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Code' => ['description' => 'The status code. The value 200 indicates that the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The information about the Spark log analysis task.'."\n", - '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-bp10b6646l07akdt'."\n", 'title' => ''], + 'EnableLakeCache' => ['description' => 'Indicates whether the lake cache feature is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Instances' => [ + 'description' => 'The clusters that share the lake cache space.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-bp10b6646l07akdt'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Capacity' => ['description' => 'The size of the lake cache space. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'DataSize' => ['description' => 'The size of the data that occupies the lake cache space. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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.', - ], + 'title' => 'DescribeLakeCacheSize', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLakeCacheSize'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeLakeCacheSize', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'SubmitSparkLogAnalyzeTask', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + '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"}]', ], - 'KillSparkLogAnalyzeTask' => [ - 'summary' => 'Terminates a Spark log analysis task and queries the information about the analysis task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeMVRecommendResults' => [ + 'summary' => 'Queries the results of a materialized view recommendation task.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', + 'operationType' => 'get', + 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'TaskId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark日志分析任务ID'."\n", - 'description' => 'The ID of the Spark log analysis task. You can call the ListSparkLogAnalyzeTasks operation to query the IDs and states of all analysis tasks in the current cluster.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'example' => '15', - ], + 'name' => 'SubtaskId', + 'in' => 'query', + 'schema' => ['description' => 'The subtask ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the recommendation task.', 'type' => 'string', 'required' => false, 'example' => 'task_n1', 'title' => ''], + ], + [ + 'name' => 'SubQueryId', + 'in' => 'query', + 'schema' => ['description' => 'The subquery ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'am-bp1ub9grke1****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => ['description' => 'A static value. This parameter cannot be modified.', 'type' => 'string', 'example' => 'Modification is not supported.', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'ActionInner', + 'in' => 'query', + 'schema' => ['description' => 'A static value. This parameter cannot be modified.', 'type' => 'string', 'example' => 'Modification is not supported.', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'The sorting field.', 'type' => 'string', 'required' => false, 'example' => '{"Type": "Desc","Field": "AcceleratedQueriesCount"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'Data' => [ - 'description' => 'The information about the Spark log analysis task.'."\n", - '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. The default value is **1**.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'- **30** (Default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'MvRecommendResultModels' => [ + 'description' => 'A list of materialized view recommendation results.', + 'type' => 'array', + 'items' => ['description' => 'The details of a recommendation result.', '$ref' => '#/components/schemas/open_struct_MVRecommendResultModel', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], ], 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], ], 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' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - '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' => 'KillSparkLogAnalyzeTask', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'GetSparkLogAnalyzeTask' => [ - 'summary' => 'Queries the results of a Spark log analysis task.', - 'methods' => [ - 'post', + '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\\": \\"test\\",\\n \\"DataVolumn\\": \\"321233\\",\\n \\"EnableBinlog\\": true,\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ],\\n \\"AcceleratedQueriesCount\\": 32,\\n \\"SupportIncrementalRefresh\\": true,\\n \\"SubqueryId\\": 1,\\n \\"SavedScanbytes\\": 321321223,\\n \\"Subquery\\": \\"SELECT * FROM demo.tbl\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeMVRecommendResults', + 'description' => 'For information about the endpoints of this service, see [Endpoints](~~612373~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMVRecommendResults'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeMVRecommendResults', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeMvRecommendSubTasks' => [ + 'summary' => 'View subtasks of a materialized view', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20867,282 +16133,273 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'TaskId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark日志分析任务ID'."\n", - 'description' => 'The ID of the Spark log analysis task. You can call the ListSparkLogAnalyzeTasks operation to query the IDs of all Spark log analysis tasks that are submitted in the current cluster.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'example' => '12', - ], + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the materialized view recommendation task.', 'type' => 'string', 'required' => false, 'example' => 'my_task_1', 'title' => ''], + ], + [ + 'name' => 'SubtaskId', + 'in' => 'query', + 'schema' => ['description' => 'The subtask ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'The sorting criteria.'."\n" + .'Valid values for \\`Type\\`:'."\n" + ."\n" + .'- Asc'."\n" + ."\n" + .'- Desc'."\n" + ."\n" + .'Valid values for \\`Field\\`:'."\n" + ."\n" + .'- StartTime'."\n" + ."\n" + .'- EndTime', 'type' => 'string', 'required' => false, 'example' => '{\\"Type\\": \\"ASC\\", \\"Field\\": \\"StartTime\\"}', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'am-bp1ub9grke1****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => ['description' => 'A static value. This parameter cannot be modified.', 'type' => 'string', 'example' => 'Modification is not supported.', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'ActionInner', + 'in' => 'query', + 'schema' => ['description' => 'A static value. This parameter cannot be modified.', 'type' => 'string', 'example' => 'Modification is not supported.', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'Data' => [ - 'description' => 'The information about the Spark log analysis task.'."\n", - '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'MvRecommendSubTaskModels' => [ + 'description' => 'The list of materialized view recommendation task executions.', + 'type' => 'array', + 'items' => ['description' => 'The details of a materialized view recommendation task execution.', '$ref' => '#/components/schemas/open_struct_MvRecommendSubTaskModel', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], ], 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], ], 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' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - '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' => 'GetSparkLogAnalyzeTask', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'SetSparkAppLogRootPath' => [ - 'summary' => 'Modifies the Spark log configuration.', - 'methods' => [ - 'post', + '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\\": 70,\\n \\"Status\\": \\"RUNNING\\",\\n \\"EndTime\\": \\"2025-10-16 16:56\\\\n\\",\\n \\"StartTime\\": \\"2025-10-16 16:55\\\\n\\",\\n \\"SubtaskId\\": 123,\\n \\"ScanQueriesCount\\": 55,\\n \\"MinRewriteQueryCount\\": 3,\\n \\"MinRewriteQueryPattern\\": 5,\\n \\"SlowQueryThreshold\\": 2\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeMvRecommendSubTasks', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMvRecommendSubTasks'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeMvRecommendSubTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeMvRecommendTasks' => [ + 'summary' => 'Views recommendation tasks for materialized views.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '156583', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the materialized view recommendation task.', 'type' => 'string', 'required' => false, 'example' => 'my_task_1', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库的id', - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-dbclusterid', - 'maxLength' => 64, - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'OssLogPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of Object Storage Service (OSS) logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://path/to/log', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'UseDefaultOss', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to use the default OSS log path.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'From', + 'in' => 'query', + 'schema' => ['description' => 'A static field. This parameter cannot be modified.', 'type' => 'string', 'example' => 'Modification is not supported.', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'ActionInner', + 'in' => 'query', + 'schema' => ['description' => 'A static field. This parameter cannot be modified.', 'type' => 'string', 'example' => 'Modification is not supported.', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'IsLogPathExists' => [ - 'title' => '是否存在日志地址', - 'description' => 'Indicates whether a log path exists.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RecordedLogPath' => [ - 'title' => '记录的地址名称', - 'description' => 'The recorded log path.'."\n", - 'type' => 'string', - 'example' => 'oss://path/to/log', - ], - 'ModifiedUid' => [ - 'title' => '修改者ID', - 'description' => 'The modifier ID.'."\n", - 'type' => 'string', - 'example' => '1111111', - ], - 'ModifiedTimestamp' => [ - 'title' => '上一次修改时间', - 'description' => 'The last modification time.'."\n", - 'type' => 'string', - 'example' => '1675236908', - ], - 'DefaultLogPath' => [ - 'title' => '推荐的默认地址', - 'description' => 'The default log path.'."\n", - 'type' => 'string', - 'example' => 'oss://path/to/log', + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'MvRecommendTaskModels' => [ + 'description' => 'The list of materialized view recommendation tasks.', + 'type' => 'array', + 'items' => ['description' => 'The details of the materialized view recommendation task.', '$ref' => '#/components/schemas/open_struct_MvRecommendTaskModel', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], ], - 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.', - ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], ], 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' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - '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' => 'SetSparkAppLogRootPath', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'GetSparkConfigLogPath' => [ - 'summary' => 'Queries the Spark log configuration of an AnalyticDB for MySQL cluster, including the default Spark log path.', - 'methods' => [ - 'post', + '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\\": \\"task desc\\\\n\\",\\n \\"CreatedTime\\": \\"2024-12-12 23:59\\",\\n \\"LastRunAt\\": \\"2024-12-13 00:10\\",\\n \\"TaskName\\": \\"mv_task1\\",\\n \\"ScanQueriesRange\\": 3,\\n \\"SchedulingSettings\\": \\"The 12:30 every day\\",\\n \\"MinRewriteQueryCount\\": 3,\\n \\"MinRewriteQueryPattern\\": 5,\\n \\"SlowQueryThreshold\\": 2\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeMvRecommendTasks', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMvRecommendTasks'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeMvRecommendTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeOperatorPermission' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21154,23 +16411,16 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '156541', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], + 'abilityTreeCode' => '214554', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库的id', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-adsdxxxx', - 'maxLength' => 64, - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-uf6wjk5xxxxxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -21178,793 +16428,641 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1919-xxx-ssdfsdff', - ], - 'Data' => [ - 'description' => 'The queried Spark log configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'IsLogPathExists' => [ - 'title' => '是否存在日志地址', - 'description' => 'Indicates whether a log path exists.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RecordedLogPath' => [ - 'title' => '记录的地址名称', - 'description' => 'The recorded log path.'."\n", - 'type' => 'string', - 'example' => 'oss://test/spark-logs/', - ], - 'ModifiedUid' => [ - 'title' => '修改者ID', - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '10130223128xxx', - ], - 'ModifiedTimestamp' => [ - 'title' => '上一次修改时间', - 'description' => 'The last modification time.'."\n", - 'type' => 'string', - 'example' => '1675654361000', - ], - 'DefaultLogPath' => [ - 'title' => '推荐的默认地址', - 'description' => 'The default log path.'."\n", - 'type' => 'string', - 'example' => 'oss://aliyun-oa-adb-spark-1111-oss-cn-hanghzou/spark-logs', - ], - ], - ], + 'CreatedTime' => ['description' => 'The time when the permissions take effect.', 'type' => 'string', 'example' => '2024-02-25T03:35:02Z', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Privileges' => ['description' => 'The queried permissions.', 'type' => 'string', 'example' => 'Control,Data', 'title' => ''], + 'ExpiredTime' => ['description' => 'The time when the permissions expire.', 'type' => 'string', 'example' => '2024-01-10T02:19:00Z', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'amv-uf6wjk5xxxxxxxxxx', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', - ], + 'title' => 'DescribeOperatorPermission', + 'summary' => 'Queries the service account permissions of an AnalyticDB for MySQL cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOperatorPermission'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeOperatorPermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], ], - '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' => 'GetSparkConfigLogPath', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + '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"}]', + 'translator' => 'manual', ], - 'StartSparkSQLEngine' => [ - 'summary' => 'Starts the Spark SQL engine.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeOversizeNonPartitionTableInfos' => [ + 'summary' => 'Queries the information about oversized non-partitioned tables in an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '152577', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '217358', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-abcd****', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'spark-rg-name', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MinExecutor', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The minimum number of executors that are required to execute SQL statements. Valid values: 0 to 2000. A value of 0 indicates that no executors are permanent if no SQL statements are executed. If this value exceeds the total number of executors that are supported by the resource group, the Spark SQL engine fails to be started. The value must be less than the value of MaxExecutor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2024-05-11T05:44Z', 'title' => ''], ], [ - 'name' => 'MaxExecutor', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum number of executors that are required to execute SQL statements. Valid values: 1 to 2000. If this value exceeds the total number of executes that are supported by the resource group, the Spark SQL engine fails to be started.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time. The specified time range must be less than seven days.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2024-05-11T05:44Z', 'title' => ''], ], [ - 'name' => 'Jars', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Object Storage Service (OSS) paths of third-party JAR packages that are required to start the Spark SQL engine. Separate multiple OSS paths with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://testBuckname/test.jar,oss://testBuckname/test2.jar', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* 30'."\n" + .'* 50'."\n" + .'* 100'."\n" + ."\n" + .'Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', 'title' => ''], ], [ - 'name' => 'SlotNum', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum number of slots that are required to maintain Spark sessions for executing SQL statements. Valid values: 1 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - 'default' => '50', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Config', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The configuration that is required to start the Spark SQL engine. Specify this value in the JSON format. For more information, see [Conf configuration parameters](~~471203~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "spark.shuffle.timeout": ":0s" }', - ], + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of file titles and error messages. Valid values:'."\n" + ."\n" + .'* **zh (default)**: simplified Chinese.'."\n" + .'* **en**: English'."\n" + .'* **ja**: Japanese.'."\n" + .'* **zh-tw**: traditional Chinese.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order by which to sort query results. Specify the parameter value in the JSON format.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .' ['."\n" + ."\n" + .' {'."\n" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\n" + .' }'."\n" + ."\n" + .' ]'."\n" + ."\n" + .'Field specifies the field by which to sort the query results. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.'."\n" + ."\n" + .'Field and Type are case-insensitive.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"Field":"SchemaName","Type":"Asc"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => 'The ID of the Spark job.'."\n", - 'type' => 'string', - 'example' => 's202301xxxx', - ], - 'State' => [ - 'description' => 'The state of the Spark SQL engine. Valid values:'."\n" + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'am-bp16t5ci7r74s****', 'title' => ''], + 'Tables' => [ + 'description' => 'The queried oversized non-partitioned tables.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'RowCount' => ['description' => 'The number of rows in the table.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1222', 'title' => ''], + 'IndexSize' => ['description' => 'The data size of regular indexes. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''], + 'DataSize' => ['description' => 'The data size of the table. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2921132457984', 'title' => ''], + 'LocalDataSize' => ['description' => 'The size of hot data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1223', 'title' => ''], + 'PrimaryKeySize' => ['description' => 'The data size of the primary key index. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'RemoteDataSize' => ['description' => 'The size of cold data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '122', 'title' => ''], + 'SpaceRatio' => ['description' => 'The percentage of the table size. Unit: %.'."\n" ."\n" - .'* SUBMITTED'."\n" - .'* STARTING'."\n" - .'* RUNNING'."\n" - .'* FAILED'."\n", - 'type' => 'string', - 'example' => 'SUBMITTED', - ], - 'AppName' => [ - 'description' => 'The name of the Spark application.'."\n", - 'type' => 'string', - 'example' => 'SQLEngine1', + .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.3', 'title' => ''], ], + 'description' => 'The queried oversized non-partitioned table.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried detection item and detection result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the detection item.'."\n", 'type' => 'string', 'example' => 'Oversized non-partitioned table', 'title' => ''], + 'Message' => ['description' => 'The information about the detection result.'."\n", 'type' => 'string', 'example' => 'Multiple oversized non-partitioned tables are detected.', 'title' => ''], + 'Status' => ['description' => 'The severity level of the detection result.'."\n", 'type' => 'string', 'example' => 'NORMAL'."\n" + .'WARNING'."\n" + .'CRITICAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response parameter.', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + '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\\": \\"Oversized non-partitioned table\\",\\n \\"Message\\": \\"Multiple oversized non-partitioned tables are detected.\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeOversizeNonPartitionTableInfos', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOversizeNonPartitionTableInfos'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeOversizeNonPartitionTableInfos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'StartSparkSQLEngine', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", ], - 'KillSparkSQLEngine' => [ - 'summary' => 'Shuts down a Spark SQL engine.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribePatternPerformance' => [ + 'summary' => 'View metric details (such as query time and average memory consumption) for SQL patterns over a specified time range in a cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '152585', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '132321', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-8vbn8pq537k8w****', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the details of all clusters in a region, including their cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-uf6li1r3do8m****', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'spark_test', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in UTC in the *yyyy-MM-ddTHH:mm:ssZ* format.'."\n" + ."\n" + .'> - You can query data from the last 14 days. If you specify a start time earlier than this period, an empty value is returned. For example, if the current date is August 22, 2022 (China Standard Time), the earliest valid start time is 2022-08-08T16:00:00Z.'."\n" + ."\n" + .'- The interval between the start time and the end time cannot exceed 24 hours.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-21T02:15:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in UTC in the *yyyy-MM-ddTHH:mm:ssZ* format.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-22T01:06:00Z', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PatternId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the SQL pattern.'."\n" + ."\n" + .'> You can call the [DescribeSQLPatterns](~~321868~~) operation to query information about all SQL patterns in a cluster within a specified time range, including the ID of each SQL pattern.', 'type' => 'string', 'required' => false, 'default' => '-1', 'example' => '3847585356974******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', - ], - 'Data' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'EndTime' => ['description' => 'The end of the query time range. The time is in UTC and is formatted as *yyyy-MM-ddTHH:mmZ*.', 'type' => 'string', 'example' => '2022-08-22T01:06:00Z', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F21AF487-B8C9-57E0-8E3A-A92BC3611FB6', 'title' => ''], + 'StartTime' => ['description' => 'The start of the query time range. The time is in UTC and is formatted as *yyyy-MM-ddTHH:mmZ*.', 'type' => 'string', 'example' => '2022-08-21T02:15:00Z', 'title' => ''], + 'Performances' => [ + 'description' => 'The performance metrics.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a performance metric.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The performance metric. Valid values:'."\n" + ."\n" + .'- **AnalyticDB\\_PatternQueryCount**: The total number of queries that match the sql pattern.'."\n" + ."\n" + .'- **AnalyticDB\\_PatternQueryTime**: The total time for queries that match the sql pattern.'."\n" + ."\n" + .'- **AnalyticDB\\_PatternExecutionTime**: The total execution time of queries that match the sql pattern.'."\n" + ."\n" + .'- **AnalyticDB\\_PatternPeakMemory**: The peak memory usage of queries that match the sql pattern.'."\n" + ."\n" + .'- **AnalyticDB\\_PatternScanSize**: The total data scan size of queries that match the sql pattern.', 'type' => 'string', 'example' => 'AnalyticDB_PatternExecutionTime', 'title' => ''], + 'Unit' => ['description' => 'The unit of the performance metric. The returned unit varies based on the value of `Key`:'."\n" + ."\n" + .'- If `Key` is `AnalyticDB_PatternQueryTime` or `AnalyticDB_PatternExecutionTime`, the unit is **ms**.'."\n" + ."\n" + .'- If `Key` is `AnalyticDB_PatternPeakMemory`, the unit is **MB**.'."\n" + ."\n" + .'- If `Key` is `AnalyticDB_PatternScanSize`, the unit is **MB**.'."\n" + ."\n" + .'- If `Key` is `AnalyticDB_PatternQueryCount`, this parameter is empty.', 'type' => 'string', 'example' => 'ms', 'title' => ''], + 'Series' => [ + 'description' => 'The time series data for the performance metric.', + 'type' => 'array', + 'items' => [ + 'description' => 'A time series for a specific performance value.', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => 'The list of performance values.', + 'type' => 'array', + 'items' => ['description' => 'A data point, which is an array containing a timestamp and its corresponding performance value.', 'type' => 'string', 'example' => '[ "2021-11-18 13:38:00", "224" ]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The name of the performance value. The value of this parameter varies based on the value of `Key`:'."\n" + ."\n" + .'- If `Key` is `AnalyticDB_PatternQueryCount`, this parameter returns `pattern_query_count`, which indicates the query count for the sql pattern.'."\n" + ."\n" + .'- If `Key` is `AnalyticDB_PatternQueryTime`, this parameter can be one of the following values:'."\n" + ."\n" + .' - `average_query_time`: the average total time of queries that match the sql pattern.'."\n" + ."\n" + .' - `max_query_time`: the maximum total time of queries that match the sql pattern.'."\n" + ."\n" + .'- If `Key` is `AnalyticDB_PatternExecutionTime`, this parameter can be one of the following values:'."\n" + ."\n" + .' - `average_execution_time`: the average execution time of queries that match the sql pattern.'."\n" + ."\n" + .' - `max_execution_time`: the maximum execution time of queries that match the sql pattern.'."\n" + ."\n" + .'- If `Key` is `AnalyticDB_PatternPeakMemory`, this parameter can be one of the following values:'."\n" + ."\n" + .' - `average_peak_memory`: the average peak memory usage of queries that match the sql pattern.'."\n" + ."\n" + .' - `max_peak_memory`: the maximum peak memory usage of queries that match the sql pattern.'."\n" + ."\n" + .'- If `Key` is `AnalyticDB_PatternScanSize`, this parameter can be one of the following values:'."\n" + ."\n" + .' - `average_scan_size`: the average data scan size of queries that match the sql pattern.'."\n" + ."\n" + .' - `max_scan_size`: the maximum data scan size of queries that match the sql pattern.', 'type' => 'string', 'example' => 'max_query_time', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'User' => ['description' => 'The database account that executes the SQL statements.', 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'AccessIp' => ['description' => 'The client IP address that submitted the queries that match the sql pattern.', 'type' => 'string', 'example' => '172.16.14.*', 'title' => ''], + 'SQLPattern' => ['description' => 'The SQL statement for the sql pattern.', 'type' => 'string', 'example' => 'SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?', 'title' => ''], + 'Tables' => ['description' => 'The tables queried by the sql pattern.', 'type' => 'string', 'example' => 'tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation', 'title' => ''], + 'FailedCount' => ['description' => 'The number of failed executions for the sql pattern within the query time range.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'QueryCount' => ['description' => 'The number of executions for the sql pattern within the query time range.', 'type' => 'integer', 'format' => 'int64', 'example' => '1202', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', - ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"test_user\\",\\n \\"AccessIp\\": \\"172.16.14.*\\",\\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 \\"FailedCount\\": 1,\\n \\"QueryCount\\": 1202\\n}","type":"json"}]', + 'title' => 'DescribePatternPerformance', + 'description' => 'For the endpoint of this service, see [endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-10-21T12:16:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-08T02:33:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-08T03:15:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T04:03:34.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePatternPerformance'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribePatternPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - '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' => 'KillSparkSQLEngine', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'translator' => 'machine', ], - 'GetSparkSQLEngineState' => [ - 'summary' => 'Queries the state information about the Spark SQL engine.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribePerformanceViewAttribute' => [ + 'summary' => 'Queries the information about a monitoring view.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['Perth'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '152586', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], + 'abilityTreeCode' => '220839', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the job resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_instance', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the view.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Custom-All metrics-2 columns-Linked', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'xxxx-xxx-xx', - ], - 'Data' => [ - 'description' => 'The state information about the Spark SQL engine.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', 'title' => ''], + 'ViewName' => ['description' => 'The name of the view.'."\n", 'type' => 'string', 'example' => 'Custom-All metrics-2 columns-Linked', 'title' => ''], + 'CreateFromViewType' => ['description' => 'The type of the view.', 'type' => 'string', 'example' => 'Basic', 'title' => ''], + 'ViewDetail' => [ + 'description' => 'The information about the monitoring view.'."\n", 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => 'The ID of the Spark application.'."\n", - 'type' => 'string', - 'example' => 's202207151211hz0c****', - ], - 'MinExecutor' => [ - 'description' => 'The minimum number of started Spark executors.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'MaxExecutor' => [ - 'description' => 'The maximum number of started Spark executors.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Jars' => [ - 'description' => 'The third-party JAR package.'."\n", - 'type' => 'string', - 'example' => 'oss://test-bucket/test.jar', - ], - 'SlotNum' => [ - 'description' => 'The slot number of the Spark application.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Config' => [ - 'description' => 'The configuration of the Spark application.'."\n", - 'type' => 'string', - 'example' => '{"key1": "value1", "key2": "value2"}', - ], - 'State' => [ - 'description' => 'The execution state of the application. Valid values:'."\n" - ."\n" - .'* SUBMITTED'."\n" - .'* STARTING'."\n" - .'* RUNNING'."\n" - .'* FAILING'."\n" - .'* FAILED'."\n" - .'* KILLING'."\n" - .'* KILLED'."\n" - .'* SUCCEEDING'."\n" - .'* COMPLETED'."\n" - .'* FATAL'."\n" - .'* UNKNOWN'."\n", - 'type' => 'string', - 'example' => 'COMPLETED', - ], - 'SubmittedTimeInMillis' => [ - 'description' => 'The timestamp when the Spark SQL application was submitted. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1651213645000', + 'ChartsPerLine' => ['description' => 'The number of charts to display in each row.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ChartLinked' => ['description' => 'Specifies whether to enable the filter interaction feature. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Categories' => [ + 'description' => 'The metric category.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metric category.'."\n", + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => 'The name of the metric category. Valid values:'."\n" + ."\n" + .'* **Node**'."\n" + .'* **DiskData**'."\n" + .'* **WorkLoad**'."\n" + .'* **ResourceGroup**'."\n", 'type' => 'string', 'example' => 'Node', 'title' => ''], + 'Keys' => [ + 'description' => 'The metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metrics.'."\n", + 'type' => 'object', + 'properties' => [ + 'KeyName' => ['description' => 'The name of the metric.'."\n", 'type' => 'string', 'example' => 'AnalyticDB_CPU', 'title' => ''], + 'Selected' => ['description' => 'Specifies whether to select the metric. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GroupType' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'The type of the resource group.', 'example' => 'Interactive', 'title' => ''], + 'description' => 'The type of the resource group. Valid values:'."\n" + ."\n" + .'* **Interactive**'."\n" + .'* **Job**'."\n" + ."\n" + .'> For more information about resource groups, see [Resource group overview](~~428610~~).'."\n", + 'title' => '', + 'example' => '', + ], + 'Engine' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'The database engine of the cluster.', 'example' => 'AnalyticDB', 'title' => ''], + 'description' => 'The database engine of the cluster. Valid values:'."\n" + ."\n" + .'* AnalyticDB', + 'title' => '', + 'example' => '', + ], + 'EnableAutoMc' => ['type' => 'boolean', 'description' => 'Indicates whether the multi-cluster feature is enabled. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n" + ."\n" + .'> This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", '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" + .'}', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'example' => 'amv-bp198m028ih55xxxx', 'title' => ''], + 'FillOriginViewKeys' => ['description' => 'Specifies whether to populate the names of the metrics in the original monitoring view when you view the monitoring view. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'PerformanceViewNotFound', 'errorMessage' => 'Performance view not found.', 'description' => 'Specified monitoring view name not found'], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"ViewName\\": \\"Custom-All metrics-2 columns-Linked\\",\\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 \\"Interactive\\"\\n ],\\n \\"Engine\\": [\\n \\"AnalyticDB\\"\\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' => 'DescribePerformanceViewAttribute', + 'changeSet' => [ + ['createdAt' => '2024-10-16T02:07:34.000Z', 'description' => 'Response parameters changed'], ], - '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' => 'GetSparkSQLEngineState', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'DescribeSparkCodeOutput' => [ - 'summary' => 'Queries the execution result of Spark code.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePerformanceViewAttribute'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribePerformanceViewAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribePerformanceViews' => [ + 'summary' => 'Queries a list of monitoring views.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['Perth'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220841', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1ub9grke1****', 'title' => ''], ], [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-uf6210mmev07****', - ], - ], - [ - 'name' => 'JobId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '620', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -21972,97 +17070,144 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request was successful, **Success** is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Output' => [ - 'description' => 'The execution result, which is in the format of JSON objects.'."\n", - '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}"', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8', 'title' => ''], + 'Views' => [ + 'description' => 'the list of view.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ViewName' => ['description' => 'The name of the view.'."\n", 'type' => 'string', 'example' => 'Custom-1', 'title' => ''], + 'CreateTime' => ['description' => 'The time when created.', 'type' => 'string', 'example' => '2024-06-18T07:06:53.000+00:00', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when updated.', 'type' => 'string', 'example' => '2024-06-18T07:07:32.000+00:00', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n" + ."\n" + .'> This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", '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" + .'}', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeSparkCodeOutput', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeSparkCodeLog' => [ - 'summary' => 'Queries the execution logs of Spark code.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8\\",\\n \\"Views\\": [\\n {\\n \\"ViewName\\": \\"Custom-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' => 'DescribePerformanceViews', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePerformanceViews'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribePerformanceViews', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeProcessList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads4DZDZG'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The cluster ID of the AnalyticDB for MySQL Data Lakehouse Edition.'."\n" + ."\n" + .'> Call the [DescribeDBClusters](~~129857~~) operation to view details of all AnalyticDB for MySQL Data Lakehouse Edition clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'ShowFull', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-uf6o6m8p6x7v****', - ], + 'schema' => ['description' => 'Specifies whether to display the full SQL statement. Values:'."\n" + ."\n" + .'- **True**: Displays the full SQL statement.'."\n" + ."\n" + .'- **False**: Displays only the first 100 characters of the SQL statement.'."\n" + ."\n" + .'> Default value: False.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'RunningTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1248', - ], + 'schema' => ['description' => 'Filter by running time. Displays queries that have run longer than the specified time. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => 'The database account.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'Filter keyword. Currently, only **SELECT** is supported.', 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'Sort by the specified field in JSON format, `[{"Field":"Time","Type":"Desc" },{ "Field":"User", "Type":"Asc" }]`. Values:'."\n" + ."\n" + .'- **Field**: The name of the field to sort by. Supports Time, User, Host, and DB fields.'."\n" + ."\n" + .'- **Type**: Sort type. **Desc** for descending order, **Asc** for ascending order.', 'type' => 'string', 'required' => false, 'example' => '[ { "Field":"Time","Type":"Desc" }, { "Field":"User", "Type":"Asc" }]', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of records per page. Values:'."\n" + ."\n" + .'- **30** (Default value)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'Page number. Must be a positive integer. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -22070,149 +17215,214 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request was successful, **Success** is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CD65640-9963-5D60-929C-118F2C84070E', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Log' => [ - 'description' => 'The content of the log.'."\n", - 'type' => 'string', - 'example' => '>>>>>>>> stdout:n++++++++++++++++++executing sql: MSCK REPAIR TABLE `footprint_ethereum`.`dwd_eth_eth_txr_v2_di` n++n', + 'TotalCount' => ['description' => 'Total records.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'PageSize' => ['description' => 'The number of pages.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'PageNumber' => ['description' => 'Page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Process' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'Task start time. UTC time. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2020-11-19T02:48:15Z', 'title' => ''], + 'Time' => ['description' => 'Query task running time. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'ProcessId' => ['description' => 'Unique identifier of the task. Used when killing a process.', 'type' => 'string', 'example' => '202011191048151921681492420315100****', 'title' => ''], + 'Host' => ['description' => 'The IP address that initiated the query.', 'type' => 'string', 'example' => '192.168.XX.XX:12308', 'title' => ''], + 'DB' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + 'Command' => ['description' => 'Command type. Only SELECT is supported.', 'type' => 'string', 'example' => 'SELECT', 'title' => ''], + 'User' => ['description' => 'The database account.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'Id' => ['description' => 'The worker thread ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '49104', 'title' => ''], + 'Info' => ['description' => 'Running SQL statement. Returns the first 100 characters by default. If the ShowFull parameter is set to True, the full text is displayed.', 'type' => 'string', 'example' => 'select * from sbtest1,sbtest2,sbtest3,sbtest4', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'List of running queries.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeSparkCodeLog', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeSparkCodeWebUi' => [ - 'summary' => 'Queries the URL of the web UI for a Spark application.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectModuleVersion', 'errorMessage' => 'The specified module version does not support this operation.', 'description' => 'The specified module version does not support this operation.'], + ['errorCode' => 'AnalyticDBKernelError', 'errorMessage' => 'Calling AnalyticDB Kernel error', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + 'title' => 'DescribeProcessList', + 'summary' => 'Call the DescribeProcessList operation to view the running queries of an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeProcessList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"10\\",\\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\\": 40,\\n \\"ProcessId\\": \\"202011191048151921681492420315100****\\",\\n \\"Host\\": \\"192.168.XX.XX:12308\\",\\n \\"DB\\": \\"adb_demo\\",\\n \\"Command\\": \\"SELECT\\",\\n \\"User\\": \\"admin\\",\\n \\"Id\\": 49104,\\n \\"Info\\": \\"select * from sbtest1,sbtest2,sbtest3,sbtest4\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeRegions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '154593', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBClusterId', + 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", + 'description' => 'The language used for the names of regions and zones (the LocalName values in the response). Valid values:'."\n" + .'- **zh-CN**: simplified Chinese (default).'."\n" + .'- **en-US**: English.'."\n" + .'- **ja**: Japanese.', 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1v6usq6m65****', + 'required' => false, + 'enum' => ['zh-CN', 'en-US', 'ja'], + 'example' => 'en-US', + 'title' => '', ], ], [ - 'name' => 'JobId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1248', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request was successful, **SUCCESS** is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '774DDC37-1908-58F6-B9CA-99E3E45965A6', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Url' => [ - 'description' => 'The URL of the web UI for the Spark application.'."\n", - 'type' => 'string', - 'example' => 'https://adb-subuser-cn-hangzhou-1358535755648527-100000648.oss-cn-hangzhou.aliyuncs.com/%3Facl?Expires=1681295967&OSSAccessKeyId=LTAI5tB7NAkm25oiGASu****&Signature=hKAZ1vgvhJ%2FD8hNHTuX%2FOOBWht****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', 'title' => ''], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The list of regions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The region information.', + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'adb.aliyuncs.com', 'title' => ''], + 'LocalName' => ['description' => 'The region name.', 'type' => 'string', 'example' => 'China (Hangzhou)', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => 'The list of zones.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of zones.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'VpcEnabled' => ['description' => 'Indicates whether the zone supports virtual private clouds (VPCs). Valid values:'."\n" + .'- **true**: Supported.'."\n" + .'- **false**: Not supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'LocalName' => ['description' => 'The zone name.', 'type' => 'string', 'example' => 'Hangzhou Zone H', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeSparkCodeWebUi', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'ListSparkTemplateFileIds' => [ - 'summary' => 'Queries a list of Spark template file IDs for AnalyticDB for MySQL clusters.', - 'methods' => [ - 'get', - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'title' => 'Query regions and zones', + 'summary' => 'Queries the regions and zones supported by AnalyticDB for MySQL Data Lakehouse Edition.', + 'description' => 'For the service registration of this service, see [Endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-07-24T07:15:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-15T06:33:47.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeResourceGroupSpec' => [ + 'summary' => 'Queries the information about resource group specifications.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22224,88 +17434,115 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '235394', + 'abilityTreeNodes' => ['FEATUREadsYXZ2UA'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp11q28kvl688****', - ], + 'in' => 'query', + 'schema' => ['description' => 'The Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-8vbo40tl1dxxxxxx', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ai', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'title' => '文件ID列表', - 'description' => 'The IDs of Spark template files.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10226189-4391-5B10-97AF-5CA5XXXXXXX'], + 'Specs' => [ + 'description' => 'The queried specifications.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The ID of the Spark template file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'description' => 'The specifications.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the specification.'."\n", 'type' => 'string', 'example' => 'xlarge', 'title' => ''], + 'AllocateUnits' => [ + 'description' => 'The allocation units supported by this specification.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The allocation units.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MaxQuantity' => ['description' => 'The maximum number of resource groups that can be used with this specification.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'Type' => [ + 'description' => 'The resource type.'."\n", + 'type' => 'string', + 'example' => 'GPU', + 'default' => 'GPU', + 'enum' => ['CPU', 'GPU'], + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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' => 'InvalidPoolName.Malformed', 'errorMessage' => 'The specified parameter PoolName is not valid.', 'description' => 'The PoolName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolUser.Malformed', 'errorMessage' => 'The specified parameter PoolUser is not valid.', 'description' => 'The PoolUser parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolType.Malformed', 'errorMessage' => 'The specified parameter PoolType is not valid.', 'description' => 'The PoolType parameter is invalid. Check the parameter.'], ], - 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', - ], + 408 => [ + ['errorCode' => 'AcsServerTimeOut', 'errorMessage' => 'The request has failed due to Adb Cloud Service time out.', 'description' => 'The backend service timed out. Please try again later.'], ], ], - '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' => 'ListSparkTemplateFileIds', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeResourceGroupSpec', + 'description' => '### [](#)'."\n" ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'GetSparkAppWebUiAddress' => [ - 'summary' => 'Queries the URL of the web UI for a Spark application.', - 'methods' => [ - 'post', - 'get', + .'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResourceGroupSpec'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeResourceGroupSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + ], + 'DescribeResultExportConfig' => [ + 'summary' => 'Queries the user-configured result set export settings.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22315,180 +17552,116 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '119937', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254784', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'spark app的id', - 'description' => 'The Spark application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202205201533hz1209892000****', - 'maxLength' => 64, - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-uf6g8w25jacm7****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-8vbf80pjcz*****', 'title' => ''], + ], + [ + 'name' => 'ExportType', + 'in' => 'query', + 'schema' => ['description' => 'The export type. Valid values:'."\n" + ."\n" + .'* SLS: Indicates that the export destination is SLS.'."\n" + .'* OSS: Indicates that the export destination is OSS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SLS', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'ResultData\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', - ], + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: Valid values:'."\n" + ."\n" + .'* **True: Succeeded.**'."\n" + .'* **False: Failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP response status code. A value of 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* The request succeeded, and the server returns **OK**.'."\n" + .'* The request failed, and the server returns an error message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'API status or POP error code.'."\n", 'type' => 'string', 'example' => 'InvalidInput', 'title' => ''], 'Data' => [ - 'title' => '', - 'description' => 'The returned data.'."\n", + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'title' => 'spark app的id', - 'description' => 'The Spark application ID.'."\n", - 'type' => 'string', - 'example' => 's202205201533hz1209892000****', - ], - 'ExpirationTimeInMillis' => [ - 'title' => 'spark app的WEB UI的可访问截止时间, 毫秒级时间戳.', - 'description' => 'The expiration time. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655801973000', - ], - 'WebUiAddress' => [ - 'title' => 'Spark App的WEB UI的临时访问地址, 有过期时间, 过期后需要再次生成.', - 'description' => 'The URL of the web UI for the Spark application.'."\n", - 'type' => 'string', - 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', + 'ExportType' => ['description' => 'The export type. Valid values:'."\n" + ."\n" + .'* SLS: Indicates that the export destination is SLS.'."\n" + .'* OSS: Indicates that the export destination is OSS.'."\n", 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'SlsInfo' => [ + 'description' => 'The configured SLS export settings, returned when the export destination is SLS.'."\n", + 'type' => 'object', + 'properties' => [ + 'SlsProject' => ['description' => 'The name of the SLS project.'."\n", 'type' => 'string', 'example' => 'test-project', 'title' => ''], + 'ResourceGroup' => ['description' => 'The name of the resource group that runs the export SQL.'."\n", 'type' => 'string', 'example' => 'aps', 'title' => ''], + 'LogstoreTtl' => ['description' => 'The expiration period (in days) for the temporary Logstore automatically created during result set export. The Logstore is automatically deleted after expiration. The returned value is between 1 and 30 days (inclusive).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'DBClusterId' => [ - 'title' => '数据库ID'."\n", - 'description' => 'The database ID.'."\n", - 'type' => 'string', - 'example' => 'amv-clusterxxx', - 'default' => 'DB_CLUSTER_ID', + 'OssInfo' => [ + 'description' => 'The configured OSS export settings, returned when the export destination is OSS.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExportBasePath' => ['description' => 'The path of the OSS bucket to which the result sets are exported.'."\n", 'type' => 'string', 'example' => 'oss://testBucketName/data_result'."\n", 'title' => ''], + 'ResourceGroup' => ['description' => 'The name of the resource group that runs the export SQL.'."\n", 'type' => 'string', 'example' => 'aps', 'title' => ''], + 'ResultFileTtl' => ['description' => 'The expiration period (in days) for the OSS file. The returned value is between 1 and 30 days (inclusive).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - '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.', - ], + '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' => 'DescribeResultExportConfig', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResultExportConfig'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeResultExportConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'GetSparkAppWebUiAddress', - 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" - .'* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", ], - 'ListSparkAppAttempts' => [ - 'summary' => 'Queries the information about retry attempts of a Spark application.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSQLPatterns' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22498,332 +17671,283 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132328', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => 'spark app的id', - 'description' => 'The ID of the Spark application.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query all application IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202204132018hzprec1ac****', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL (Data Lakehouse Edition) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) API to find the cluster IDs of all AnalyticDB for MySQL (Data Lakehouse Edition) clusters in a specific region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-8vb8de93v9b****', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query. The time must be in UTC and formatted as *yyyy-MM-ddTHH:mm:ssZ*.'."\n" + ."\n" + .'> - Data is available for the last 14 days only.'."\n" + ."\n" + .'- The time range cannot exceed 24 hours.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-09-06T03:06:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The time must be in UTC and formatted as *yyyy-MM-ddTHH:mm:ssZ*.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-09-07T03:06:00Z', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword for filtering the query results.', 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order for the results. Specify this parameter as a JSON string, for example, `[{"Field":"AverageQueryTime","Type":"Asc"}]`. The string consists of the following fields:'."\n" + ."\n" + .'- `Field`: the sort field. Valid values:'."\n" + ."\n" + .' - `PatternCreationTime`: The earliest submission time of the pattern.'."\n" + ."\n" + .' - `AverageQueryTime`: The average query time of the pattern.'."\n" + ."\n" + .' - `MaxQueryTime`: The maximum query time of the pattern.'."\n" + ."\n" + .' - `AverageExecutionTime`: The average execution time of the pattern.'."\n" + ."\n" + .' - `MaxExecutionTime`: The maximum execution time of the pattern.'."\n" + ."\n" + .' - `AveragePeakMemory`: The average peak memory of the pattern.'."\n" + ."\n" + .' - `MaxPeakMemory`: The maximum peak memory of the pattern.'."\n" + ."\n" + .' - `AverageScanSize`: The average scanned data size of the pattern.'."\n" + ."\n" + .' - `MaxScanSize`: The maximum scanned data size of the pattern.'."\n" + ."\n" + .' - `QueryCount`: The query count of the pattern.'."\n" + ."\n" + .' - `FailedCount`: The failure count of the pattern.'."\n" + ."\n" + .'- `Type`: the sort order. Valid values (case-insensitive):'."\n" + ."\n" + .' - `Asc`: ascending order.'."\n" + ."\n" + .' - `Desc`: descending order.', 'type' => 'string', 'required' => false, 'default' => '[{"Type":"desc","Field":"AveragePeakMemory"}]', 'example' => '[{"Field":"AverageQueryTime","Type":"Asc"}]', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '页码号', - 'description' => 'The page number. The value must be an integer that is greater than 0. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Must be an integer greater than 0. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页显示数量', - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **10** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'- **10** (default)'."\n" + ."\n" + .'- **30**'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-uf6o6m8p6x***', - ], + 'schema' => ['description' => 'The response language. Valid values:'."\n" + ."\n" + .'- **zh**: Simplified Chinese (default)'."\n" + ."\n" + .'- **en**: English'."\n" + ."\n" + .'- **ja**: Japanese'."\n" + ."\n" + .'- **zh-tw**: Traditional Chinese', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The username of the database account used to execute the SQL statements.', 'type' => 'string', 'required' => false, 'example' => 'test_user', 'title' => ''], + ], + [ + 'name' => 'SqlPatternHash', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The details of the SQL patterns.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'AttemptInfoList' => [ - 'description' => 'The queried attempts. Fields in the response parameter:'."\n" - ."\n" - .'* **AttemptId**: the attempt ID.'."\n" - ."\n" - .'* **State**: the state of the Spark application. Valid values:'."\n" - ."\n" - .' * **SUBMITTED**'."\n" - .' * **STARTING**'."\n" - .' * **RUNNING**'."\n" - .' * **FAILING**'."\n" - .' * **FAILED**'."\n" - .' * **KILLING**'."\n" - .' * **KILLED**'."\n" - .' * **SUCCEEDING**'."\n" - .' * **COMPLETED**'."\n" - .' * **FATAL**'."\n" - .' * **UNKNOWN**'."\n" - ."\n" - .'* **Message**: the alert message that is returned. If no alert is generated, null is returned.'."\n" - ."\n" - .'* **Data** the data of the Spark application template.'."\n" - ."\n" - .'* **EstimateExecutionCpuTimeInSeconds**: the amount of time that is required to consume CPU resources for running the Spark application. Unit: milliseconds.'."\n" - ."\n" - .'* **LogRootPath**: the storage path of log files.'."\n" - ."\n" - .'* **LastAttemptId**: the ID of the last attempt.'."\n" - ."\n" - .'* **WebUiAddress**: the web UI URL.'."\n" - ."\n" - .'* **SubmittedTimeInMillis**: the time when the Spark application was submitted. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'* **StartedTimeInMillis**: the time when the Spark application was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'* **LastUpdatedTimeInMillis**: the time when the Spark application was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'* **TerminatedTimeInMillis**: the time when the Spark application task was terminated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'PatternDetails' => [ + 'description' => 'A list of SQL patterns.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the SQL pattern.', + 'type' => 'object', + 'properties' => [ + 'SQLPattern' => ['description' => 'The SQL pattern.', 'type' => 'string', 'example' => 'SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)', 'title' => ''], + 'PatternId' => ['description' => 'The ID of the SQL pattern.', 'type' => 'string', 'example' => '5575924945138******', 'title' => ''], + 'User' => ['description' => 'The name of the database user who submitted the matching SQL statements.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AccessIp' => ['description' => 'The client IP address used to submit the queries.', 'type' => 'string', 'example' => '192.168.xx.xx', 'title' => ''], + 'Tables' => ['description' => 'The tables scanned by the SQL pattern.', 'type' => 'string', 'example' => 'tpch.orders', 'title' => ''], + 'PatternCreationTime' => ['description' => 'The submission time of the first query that matches this pattern within the specified time range.', 'type' => 'string', 'example' => '2022-09-06 05:06:00', 'title' => ''], + 'AverageQueryTime' => ['description' => 'The average duration of queries matching this pattern. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '4', 'title' => ''], + 'MaxQueryTime' => ['description' => 'The maximum duration of a query matching this pattern. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2341', 'title' => ''], + 'AverageExecutionTime' => ['description' => 'The average execution time of queries matching this pattern. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '234.78', 'title' => ''], + 'MaxExecutionTime' => ['description' => 'The maximum execution time of a query matching this pattern. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2142', 'title' => ''], + 'AveragePeakMemory' => ['description' => 'The average peak memory usage of queries matching this pattern. Unit: bytes.', 'type' => 'number', 'format' => 'double', 'example' => '234.22', 'title' => ''], + 'MaxPeakMemory' => ['description' => 'The maximum peak memory usage of a query matching this pattern. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '234149', 'title' => ''], + 'AverageScanSize' => ['description' => 'The average amount of data scanned by queries matching this pattern. Unit: bytes.', 'type' => 'number', 'format' => 'double', 'example' => '234149.23', 'title' => ''], + 'MaxScanSize' => ['description' => 'The maximum amount of data scanned by a query matching this pattern. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '32212254', 'title' => ''], + 'QueryCount' => ['description' => 'The number of executed queries that match this pattern.', 'type' => 'integer', 'format' => 'int64', 'example' => '345', 'title' => ''], + 'FailedCount' => ['description' => 'The number of failed queries that match this pattern.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''], + 'Blockable' => ['description' => 'Indicates whether queries that match this pattern can be blocked. Valid values:'."\n" ."\n" - .'* **DBClusterId**: the ID of the cluster on which the Spark application runs.'."\n" + .'- **true**: The queries can be blocked.'."\n" ."\n" - .'* **ResourceGroupName**: the name of the job resource group.'."\n" + .'- **false**: The queries cannot be blocked.'."\n" ."\n" - .'* **DurationInMillis**: the amount of time that is required to run the Spark application. Unit: milliseconds.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried attempt. Fields in the response parameter:'."\n" - ."\n" - .'* **AttemptId**: the attempt ID.'."\n" - ."\n" - .'* **State**: the state of the Spark application. Valid values:'."\n" - ."\n" - .' * **SUBMITTED**'."\n" - .' * **STARTING**'."\n" - .' * **RUNNING**'."\n" - .' * **FAILING**'."\n" - .' * **FAILED**'."\n" - .' * **KILLING**'."\n" - .' * **KILLED**'."\n" - .' * **SUCCEEDING**'."\n" - .' * **COMPLETED**'."\n" - .' * **FATAL**'."\n" - .' * **UNKNOWN**'."\n" - ."\n" - .'* **Message**: the alert message that is returned. If no alert is generated, null is returned.'."\n" - ."\n" - .'* **Data** the data of the Spark application template.'."\n" - ."\n" - .'* **EstimateExecutionCpuTimeInSeconds**: the amount of time that is required to consume CPU resources for running the Spark application. Unit: milliseconds.'."\n" - ."\n" - .'* **LogRootPath**: the storage path of log files.'."\n" - ."\n" - .'* **LastAttemptId**: the ID of the last attempt.'."\n" - ."\n" - .'* **WebUiAddress**: the web UI URL.'."\n" - ."\n" - .'* **SubmittedTimeInMillis**: the time when the Spark application was submitted. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'* **StartedTimeInMillis**: the time when the Spark application was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'* **LastUpdatedTimeInMillis**: the time when the Spark application was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'* **TerminatedTimeInMillis**: the time when the Spark application task was terminated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'* **DBClusterId**: the ID of the cluster on which the Spark application runs.'."\n" - ."\n" - .'* **ResourceGroupName**: the name of the job resource group.'."\n" - ."\n" - .'* **DurationInMillis**: the amount of time that is required to run the Spark application. Unit: milliseconds.'."\n", - '$ref' => '#/components/schemas/SparkAttemptInfo', - ], - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], + .'> Currently, AnalyticDB for MySQL allows you to block only SELECT and INSERT statements.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'QueryTimeSum' => ['description' => 'The total query duration for all queries that match this pattern. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + 'QueryTimePercentage' => ['description' => 'The total query time of queries matching this pattern as a percentage of the total query time for all queries. Unit: %.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'PeakMemorySum' => ['description' => 'The sum of the peak memory usage for all queries that match this pattern. Unit: bytes.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + 'PeakMemoryPercentage' => ['description' => 'The total peak memory usage of queries matching this pattern as a percentage of the total peak memory usage for all queries. Unit: %.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'ScanSizeSum' => ['description' => 'The total amount of data scanned by all queries that match this pattern. Unit: bytes.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + 'ScanSizePercentage' => ['description' => 'The total amount of data scanned by queries matching this pattern as a percentage of the total data scanned by all queries. Unit: %.', 'type' => 'number', 'format' => 'double', 'example' => '80', 'title' => ''], + 'AverageOperatorCost' => ['description' => 'The average CPU cost for queries that match this pattern. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + 'MaxOperatorCost' => ['description' => 'The maximum CPU cost for a query that matches this pattern. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + 'OperatorCostSum' => ['description' => 'The total CPU cost for all queries that match this pattern. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + 'OperatorCostPercentage' => ['description' => 'The total CPU cost of queries matching this pattern as a percentage of the total CPU cost for all queries. Unit: %.', 'type' => 'number', 'format' => 'double', 'example' => '20', 'title' => ''], + 'AverageScanCost' => ['description' => 'The average scan time for queries that match this pattern. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + 'MaxScanCost' => ['description' => 'The maximum scan time for a query that matches this pattern. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + 'ScanCostSum' => ['description' => 'The total scan cost for all queries that match this pattern. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + 'ScanCostPercentage' => ['description' => 'The total scan cost of queries matching this pattern as a percentage of the total scan cost for all queries. Unit: %.', 'type' => 'number', 'format' => 'double', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F3174013-5B7A-5A47-9FE0-6B5D397BD86A', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'Details about the access denial. This parameter is returned only if RAM authentication fails.', '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" + .'}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - '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', - ], + 'title' => 'DescribeSQLPatterns', + 'summary' => 'View the list of SQL patterns for an AnalyticDB for MySQL Data Lakehouse Edition cluster for a specified date range.', + 'description' => '- Global public endpoint: `adb.aliyuncs.com`.'."\n" + ."\n" + .'- Regional public endpoint: `adb..aliyuncs.com` (e.g., `adb.cn-hangzhou.aliyuncs.com`).'."\n" + ."\n" + .'- Regional VPC endpoint: `adb-vpc..aliyuncs.com` (e.g., `adb-vpc.cn-hangzhou.aliyuncs.com`).', + 'changeSet' => [ + ['createdAt' => '2025-06-28T01:09:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-06T08:01:23.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-14T08:33:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-08T02:33:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-08T06:16:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T04:03:34.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLPatterns'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSQLPatterns', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'ListSparkAppAttempts', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'responseDemo' => '[{"errorExample":"","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\\": 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\\": \\"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}","type":"json"}]', + 'translator' => 'machine', ], - 'CreateSparkTemplate' => [ - 'summary' => 'Creates a Spark application template.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSQLWebSocketDomain' => [ + 'summary' => 'Queries the registered WebSocket domain.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '132061', - 'abilityTreeNodes' => [ - 'FEATUREadsCQJTKP', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '180261', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板文件所在数据库ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'ParentId', - 'in' => 'formData', - 'schema' => [ - 'title' => '父文件夹ID', - 'description' => 'The ID of the directory to which the application template belongs.'."\n" - ."\n" - .'> You can call the [GetSparkTemplateFolderTree](~~456218~~) operation to query the directory ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'example' => '10', - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板文件名称', - 'description' => 'The name of the application template. The name can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'batchfile', - 'maxLength' => 64, - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n" + ."\n" + .'> Call the [DescribeRegions](~~143074~~) API to query the region IDs supported by AnalyticDB for MySQL.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板文件类型, 可以为FOLDER或者FILE', - 'description' => 'The type of the application template. Valid values:'."\n" - ."\n" - .'* **folder**: directory.'."\n" - .'* **file**: application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'file', - 'enum' => [], - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> Call the [DescribeDBClusters](~~98094~~) API to query the details of all clusters in your account, including cluster IDs.', 'type' => 'string', 'required' => false, 'example' => 'amv-bp1lw6g669zpi660', 'title' => ''], ], [ - 'name' => 'AppType', - 'in' => 'formData', + 'name' => 'Module', + 'in' => 'query', + 'allowEmptyValue' => false, 'schema' => [ - 'title' => '模板文件内容的类型, 可选值有 BATCH, STREAMING, SQL, 默认为UNDEFINED', - 'description' => 'The application type. Valid values:'."\n" + 'description' => 'The application module name.'."\n" ."\n" - .'* **SQL**'."\n" - .'* **STREAMING**'."\n" - .'* **BATCH**'."\n" + .'- `SQLWebSocket`: The module for SQL development.'."\n" ."\n" - .'> You do not need to specify this parameter when Type is set to folder.'."\n", + .'- `Assistant`: The module for the intelligent assistant.', + 'enumValueTitles' => ['SQLWebSocket' => 'SQLWebSocket', 'Assistant' => 'Assistant'], 'type' => 'string', 'required' => false, - 'example' => 'SQL', - 'default' => 'UNDEFINED', + 'example' => 'Assistant', + 'title' => '', ], ], ], @@ -22832,300 +17956,169 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'description' => 'The creation result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Succeeded' => [ - 'title' => '是否创建成功', - 'description' => 'Indicates whether the application template is created. Valid values:'."\n" - ."\n" - .'* **True**'."\n" - .'* **False**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request succeeded.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.'."\n" + ."\n" + .'- Returns **Success** if the request succeeds.'."\n" + ."\n" + .'- Returns a specific error code if the request fails.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => 'E03F0806-A67B-5B24-8562-9589F20DEEB5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + ."\n" + .'- **true**: The call succeeded.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'adb-ws-beijing.console.aliyun.com/query', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + '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' => 'DescribeSQLWebSocketDomain', + 'changeSet' => [ + ['createdAt' => '2025-09-16T01:29:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-12T03:57:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLWebSocketDomain'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeSQLWebSocketDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'CreateSparkTemplate', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'translator' => 'manual', ], - 'DeleteSparkTemplate' => [ - 'summary' => 'Deletes Spark template files.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSchemas' => [ + 'summary' => 'Queries a list of databases in an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '132062', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190445', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '待删除模板文件的ID', - 'description' => 'The directory ID or application ID of the template files that you want to delete.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can call the [GetSparkTemplateFullTree](~~612467~~) operation to query the directory ID or application ID.'."\n" - ."\n" - .'* When you specify a directory ID, the directory and all template files that are included in the directory are deleted.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '725204', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板文件所在数据库的ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - 'maxLength' => 64, - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1xxxxxxxx47', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'description' => 'The returned result.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', 'title' => ''], + 'Items' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Succeeded' => [ - 'title' => '是否删除成功', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **True**'."\n" - .'* **False**'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'Schema' => [ + 'description' => 'The queried databases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried database.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp11q28kvl688****', 'title' => ''], + 'SchemaName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], ], 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.', - ], + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], ], 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', - ], + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - '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' => 'DeleteSparkTemplate', + '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' => 'DescribeSchemas', 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'GetSparkTemplateFolderTree' => [ - 'summary' => 'Queries the directory structure of Spark applications.', - 'methods' => [ - 'post', - 'get', + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:07.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSchemas'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:describeAllDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeSparkAppDiagnosisInfo' => [ + 'summary' => 'Queries the diagnostic information about a Spark application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23137,102 +18130,117 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '189113', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库的ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - 'maxLength' => 64, - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-uf663j39b0jd2***', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query all application IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202411061017sh0ad564b000****', 'title' => ''], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => 'The language in which you want to display the results. Valid values:'."\n" + ."\n" + .'* en: English.'."\n" + .'* zh (default): Chinese.'."\n", 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'title' => '模板文件的结构, 仅包含文件夹, 以树形结构展示.', - 'description' => 'The directory structure of Spark applications, which is in the tree format. Fields in the response parameter:'."\n" - ."\n" - .'* **Uid**: the UID of the Alibaba Cloud account.'."\n" - ."\n" - .'* **Type**: the application template type. Valid values: **FOLDER**'."\n" - ."\n" - .'* **Parent**: indicates whether a child directory exists. Valid values:'."\n" - ."\n" - .' * **0**: no.'."\n" - .' * **-1**: yes.'."\n" - ."\n" - .'* **Children**: the child directory.'."\n" - ."\n" - .'* **LastModified**: the time when applications in the directory are last modified. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'* **Name**: the name of the directory.'."\n" - ."\n" - .'* **Id**: the directory ID.'."\n", - '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" }', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FB5AC339-91F6-5000-8E5A-F47065B01B87', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query all application IDs.'."\n", 'type' => 'string', 'example' => 's202404141952sz6a1391200****', 'title' => ''], + 'StartedTime' => ['description' => 'The time when the application started to be executed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1718329831000', 'title' => ''], + 'DurationInMillis' => ['description' => 'The execution duration of the application. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '281063', 'title' => ''], + 'State' => ['description' => 'The status of the asynchronous import or export job. Valid values:'."\n" + ."\n" + .'* **RUNNING**'."\n" + .'* **FINISHED**'."\n" + .'* **FAILED**'."\n", 'type' => 'string', 'example' => 'FINISHED', 'title' => ''], + 'CpuUtilization' => ['description' => 'The CPU utilization. Unit: %.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'PeakMemoryInByte' => ['description' => 'The peak memory usage. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4096000', 'title' => ''], + 'ShuffleWriteInByte' => ['description' => 'The amount of data used for shuffle writes. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4096000', 'title' => ''], + 'ShuffleReadInByte' => ['description' => 'The amount of data used for shuffle reads. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4096000', 'title' => ''], + 'SpillInByte' => ['description' => 'The amount of data spilled to disks when the memory is insufficient. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'JVMGcCostInMillis' => ['description' => 'The amount of time consumed by the Java virtual machine to perform garbage collection operations. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '81055', 'title' => ''], + 'DiagnosisInfoList' => [ + 'description' => 'The queried diagnostic information.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried diagnostic information.'."\n", '$ref' => '#/components/schemas/Adb4MysqlSparkDiagnosisInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'AccessDeniedDetail' => ['description' => 'The information about the request denial.'."\n", '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" + .'}', 'title' => ''], ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], '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' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + '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' => 'DescribeSparkAppDiagnosisInfo', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkAppDiagnosisInfo'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkAppDiagnosisInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'GetSparkTemplateFolderTree', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", ], - 'GetSparkTemplateFullTree' => [ - 'summary' => 'Queries the directory structure of Spark applications.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSparkAppType' => [ + 'summary' => 'Queries the type of a Spark application.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23244,111 +18252,96 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '189112', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库的ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - 'maxLength' => 64, - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-wz9w49b12933****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~612475~~) operation to query the Spark application IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202407161205sza4c07c1000****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'title' => '模板文件的树形结构', - 'description' => 'The directory structure of Spark applications. Fields in the response parameter:'."\n" - ."\n" - .'* **Uid**: the UID of the Alibaba Cloud account.'."\n" - ."\n" - .'* **Type**: the application template type. Valid values:'."\n" - ."\n" - .' * **FOLDER**'."\n" - .' * **FILE**'."\n" - ."\n" - .'* **Parent**: indicates whether a child directory exists. Valid values:'."\n" - ."\n" - .' * **0**: no.'."\n" - .' * **-1**: yes.'."\n" - ."\n" - .'* **Children**: the child directory.'."\n" - ."\n" - .'* **LastModified**: the time when applications are last modified. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'* **AppType**: the application type. Valid values:'."\n" - ."\n" - .' * **SQL**'."\n" - .' * **STREAMING**'."\n" - .' * **BATCH**'."\n" - ."\n" - .'* **Name**: the name of the directory or application.'."\n" + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '596AF63B-8798-501E-BA06-CD2184D48A35', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the Spark application. Valid values:'."\n" ."\n" - .'* **Id**: the directory ID or application ID.'."\n", + .'* BATCH'."\n" + .'* SQLENGINE'."\n", '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" }', + 'enumValueTitles' => ['SQLENGINE' => '', 'BATCH' => ''], + 'example' => 'Batch', + 'title' => '', ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.'."\n", '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" + .'}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + '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' => 'DescribeSparkAppType', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkAppType'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkAppType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'GetSparkTemplateFullTree', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", ], - 'GetSparkTemplateFileContent' => [ - 'summary' => 'Queries the content of a Spark application template.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSparkAuditLogRecords' => [ + 'summary' => 'Queries the SQL audit logs for a Spark Interactive resource group.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23357,309 +18350,270 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235459', + 'abilityTreeNodes' => ['FEATUREadsGAMOR7'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库的id', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-8vbn8pq537k8w****', - 'maxLength' => 64, - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeDBClusters](~~454250~~) operation to query cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1j7******78j8i', 'title' => ''], ], [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板文件的ID', - 'description' => 'The application template ID.'."\n" - ."\n" - .'> You can call the [GetSparkTemplateFullTree](~~456205~~) operation to query the application template ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '725204', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~612293~~) operation to query the available regions and zones, including region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppType' => [ - 'description' => 'The application type. Valid values:'."\n" - ."\n" - .'* **SQL**'."\n" - .'* **STREAMING**'."\n" - .'* **BATCH**'."\n", - 'type' => 'string', - 'example' => 'SQL', - ], - 'Content' => [ - 'description' => 'The content of the application template.'."\n", - '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' => 'The application template ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '725204', - ], - 'Type' => [ - 'description' => 'The file type. Valid values:'."\n" - ."\n" - .'* **folder**'."\n" - .'* **file**'."\n", - 'type' => 'string', - 'example' => 'file', - ], - 'ResourceGroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'description' => '', - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'Query start time. Format: *yyyy-MM-ddTHH:mmZ* (UTC time).'."\n" + ."\n" + .'> We recommend that you set the query start time to any point in time within 30 days.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2025-09-25T00:00Z', 'title' => ''], ], - ], - '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.', - ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'Query end time. The end time must be later than the start time, and the interval between them must be less than 1 day. Format: yyyy-MM-ddTHH:mmZ (UTC time).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2025-09-25T01:00Z', 'title' => ''], ], - 404 => [ - [ - 'errorCode' => 'Spark.TemplateFile.FileNotFound', - 'errorMessage' => 'The template file %s is not found.', - ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => ['description' => 'The username that is used to execute SQL statements.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_user', 'title' => ''], ], - ], - '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' => 'GetSparkTemplateFileContent', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'UpdateSparkTemplateFile' => [ - 'summary' => 'Updates a Spark application template.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'Sort the SQL statements based on specified fields. The format is a JSON array that preserves order, and composite sorting is performed according to the sequence of objects in the array. Each object contains two fields: `Field` and `Type`. For example:`[{"Field":"CreateTime", "Type": "desc" }]`. Where:'."\n" + ."\n" + .'* `Field` specifies the field that is used to sort the SQL statements. Valid values:'."\n" + ."\n" + .' * `ResourceGroupName`: The name of the resource group.'."\n" + .' * `Status` :SQL execution status.'."\n" + .' * `User`: The username that is used to execute the SQL statement.'."\n" + .' * `ExecuteTime`: The start time of SQL execution.'."\n" + .' * `TotalTime`: The amount of time consumed to execute the SQL statement.'."\n" + .' * `ProcessId`: Query ID.'."\n" + .' * `ClientIp`: The source IP address.'."\n" + .' * `StatementSource`: The source from which the query was initiated.'."\n" + ."\n" + .'* `Type` specifies the sorting order. Valid values (case-insensitive):'."\n" + ."\n" + .' * `Desc`: Descending order.'."\n" + .' * `Asc`: Ascending order.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"Field\\":\\"ExecuteTime\\",\\"Type\\":\\"Desc\\"}]', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '123242', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '30', 'default' => '10', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库的ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-pz5vp4585l466****', - 'maxLength' => 64, - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板文件ID', - 'description' => 'The application template ID.'."\n" - ."\n" - .'> You can call the [GetSparkTemplateFullTree](~~456205~~) operation to query the application template ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '718056', - ], + 'name' => 'ProxyUser', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], ], [ - 'name' => 'Content', - 'in' => 'formData', + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The resource group name.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~612410~~) operation to query the resource group ID within a cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_job', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', 'schema' => [ - 'title' => '模板文件内容', - 'description' => 'The template data to be updated.'."\n" + 'description' => 'The execution status of the SQL statement.'."\n" ."\n" - .'> If you do not specify this parameter, the application template is not updated. For information about how to configure a Spark application template, see [Configure a Spark application](~~452402~~).'."\n", + .'Valid values:'."\n" + ."\n" + .'* cancel: The task is canceled .'."\n" + .'* finished: The execution succeeds .'."\n" + .'* error:The execution fails .'."\n" + .'* timeout: The execution timed out .'."\n", '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;', + 'enumValueTitles' => ['cancel' => '', 'finish' => '', 'error' => '', 'timeout' => ''], + 'example' => 'finish', + 'title' => '', ], ], [ - 'name' => 'ResourceGroupName', - 'in' => 'formData', + 'name' => 'StatementId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the statement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'fbd22066-1c03-xxxx-aa16-6ae28288****', 'title' => ''], + ], + [ + 'name' => 'TotalTime', + 'in' => 'query', + 'schema' => ['description' => 'The duration of the SQL statement. Unit: milliseconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '3000', 'title' => ''], + ], + [ + 'name' => 'SQLText', + 'in' => 'query', + 'schema' => ['description' => 'The keyword in the SQL statement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_table_name', 'title' => ''], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => ['description' => 'The query ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '999f2439-6b10-xxxx-a5d3-daf3b35c****', 'title' => ''], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => ['description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', 'title' => ''], + ], + [ + 'name' => 'StatementSource', + 'in' => 'query', 'schema' => [ - 'title' => '资源组的名称', - 'description' => 'The name of the job resource group.'."\n", + 'description' => 'The source from which the query was initiated.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SQL_EDITOR: SQL_EDITOR.'."\n" + .'* JDBC: JDBC.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'adb', + 'enumValueTitles' => ['SQL_EDITOR' => 'SQL_EDITOR', 'JDBC' => 'JDBC'], + 'example' => 'SQL_EDITOR', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C', - ], - 'Data' => [ - 'description' => 'The update result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Succeeded' => [ - 'title' => '是否更新成功', - 'description' => 'Indicates whether the application template is updated.'."\n" - ."\n" - .'* **True**'."\n" - .'* **False**'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'TotalCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries to return per page.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2D5867CF-423F-559F-BBB1-199A289E****', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-bp1j7******78j8i', 'title' => ''], + 'Items' => [ + 'description' => 'The list of SQL audit logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details.'."\n", + 'type' => 'object', + 'properties' => [ + 'SQLText' => ['description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'SELECT * FROM adb_hdfs_import_source', 'title' => ''], + 'TotalTime' => ['description' => 'The duration of the SQL statement. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40000', 'title' => ''], + 'ExecuteTime' => ['description' => 'The start time of the SQL statement. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.'."\n", 'type' => 'string', 'example' => '2022-01-23T16:05:08Z', 'title' => ''], + 'User' => ['description' => 'The username that is used to execute SQL statements.'."\n", 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'StatementId' => ['description' => 'The ID of the statement.'."\n", 'type' => 'string', 'example' => 'fbd22066-1c03-xxxx-aa16-6ae28288****', 'title' => ''], + 'Status' => [ + 'description' => 'The execution status of the SQL statement.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* cancel: The task is canceled .'."\n" + .'* finished: The execution succeeds .'."\n" + .'* error: The execution fails .'."\n" + .'* timeout: The execution of the command timed out.'."\n", + 'type' => 'string', + 'enumValueTitles' => ['cancel' => '', 'finish' => '', 'error' => '', 'timeout' => ''], + 'example' => 'finish', + 'title' => '', + ], + 'ResourceGroupName' => ['description' => 'The resource group name.'."\n", 'type' => 'string', 'example' => 'test_job', 'title' => ''], + 'AppId' => ['description' => 'The Spark application ID.'."\n", 'type' => 'string', 'example' => 's202411061011hzc5d6476000****', 'title' => ''], + 'InnerQueryId' => ['description' => 'The ID of the query executed within the Spark application.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'IsDiagnosable' => ['description' => 'Whether it can be diagnosed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ClientIp' => ['description' => 'The source IP address.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'ProcessId' => ['description' => 'The query ID.'."\n", 'type' => 'string', 'example' => '999f2439-6b10-xxxx-a5d3-daf3b35c****', 'title' => ''], + 'StatementSource' => [ + 'description' => 'The source from which the query was initiated.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SQL_EDITOR: SQL_EDITOR.'."\n" + .'* JDBC: JDBC.'."\n", + 'type' => 'string', + 'enumValueTitles' => ['SQL_EDITOR' => 'SQL_EDITOR', 'JDBC' => 'JDBC'], + 'example' => 'SQL_EDITOR', + 'title' => '', + ], + 'ErrorMsg' => ['description' => 'The SQL execution error message.'."\n", 'type' => 'string', 'example' => 'notFoundIp', 'title' => ''], + 'ErrorTrace' => ['description' => 'The SQL execution error stack trace.'."\n", 'type' => 'string', 'example' => 'notFoundIpException', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", '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" + .'}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeSparkAuditLogRecords', + 'description' => 'SQL audit logs can be queried only when SQL audit is enabled. Only SQL audit logs within the last 30 days can be queried. If SQL auditing is turned off midway, when it is re-enabled, you can only query the SQL audit logs generated after it was turned back on.'."\n" + ."\n" + .'> You can query only SQL audit logs that are executed by using Spark Interactive Resource Group.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkAuditLogRecords'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkAuditLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'UpdateSparkTemplateFile', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'DeleteSparkTemplateFile' => [ - 'summary' => 'Deletes Spark template files.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + ], + 'DescribeSparkCodeLog' => [ + 'summary' => 'Queries the execution logs of Spark code.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23667,41 +18621,24 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '123240', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板文件的ID', - 'description' => 'The ID of the template file to be deleted.'."\n" - ."\n" - .'> You can call the [GetSparkTemplateFullTree](~~456205~~) operation to query all template file IDs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '284', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库的ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1y769u11748****', - 'maxLength' => 64, - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-uf6o6m8p6x7v****', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1248', 'title' => ''], ], ], 'responses' => [ @@ -23709,236 +18646,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C', - ], - 'Data' => [ - 'description' => 'The deletion result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Succeeded' => [ - 'description' => 'Indicates whether the template file is deleted. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + 'Message' => ['description' => 'The returned message.'."\n" + ."\n" + .'* If the request was successful, **Success** is returned.'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CD65640-9963-5D60-929C-118F2C84070E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Log' => ['description' => 'The content of the log.'."\n", 'type' => 'string', 'example' => '>>>>>>>> stdout:n++++++++++++++++++executing sql: MSCK REPAIR TABLE `footprint_ethereum`.`dwd_eth_eth_txr_v2_di` n++n', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', - ], + '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' => 'DescribeSparkCodeLog', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-09-06T02:42:53.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkCodeLog'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkCodeLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'DeleteSparkTemplateFile', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", ], - 'GetSparkAppAttemptLog' => [ - 'summary' => 'Queries the information about the retry log of a Spark application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSparkCodeOutput' => [ + 'summary' => 'Queries the execution result of Spark code.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'AttemptId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'spark重试的id', - 'description' => 'The ID of the log.'."\n" - ."\n" - .'> You can call the [ListSparkAppAttempts](~~455887~~) operation to query the information about the retry attempts of a Spark application, including the retry log IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202207151211hz****-0001', - 'maxLength' => 72, - ], - ], - [ - 'name' => 'LogLength', - 'in' => 'formData', - 'schema' => [ - 'title' => '返回尾部日志的行数', - 'description' => 'The number of log entries to return. Valid values: 1 to 500. Default value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '500', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '20', - 'default' => '300', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PageNumber', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '读取日志的其实偏移量。', - 'description' => 'The log offset.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-uf6210mmev07****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '一页的日志行数', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '500', - 'default' => '100000', - ], + 'schema' => ['description' => 'The ID of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '620', 'title' => ''], ], ], 'responses' => [ @@ -23946,91 +18725,138 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", + 'Message' => ['description' => 'The returned message.'."\n" + ."\n" + .'* If the request was successful, **Success** is returned.'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Output' => [ + 'description' => 'The execution result, which is in the format of JSON objects.'."\n", 'type' => 'string', - 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C', - ], - 'Data' => [ - 'description' => 'The queried log.'."\n", - 'type' => 'object', - 'properties' => [ - 'LogContent' => [ - 'description' => 'The content of the log.'."\n", - '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' => 'The alert message returned for the request, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", - 'type' => 'string', - 'example' => 'WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-clusterxxx', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 's202204132018hzprec1ac61a000****', - ], - 'LogSize' => [ - 'title' => '日志的行数，0代表没有有效日志。', - 'description' => 'The number of log entries. A value of 0 indicates that no valid logs are returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '775946240', - ], - ], + '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}"', + 'title' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', - ], + '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' => 'DescribeSparkCodeOutput', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-09-06T02:42:53.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkCodeOutput'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkCodeOutput', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'GetSparkAppAttemptLog', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", ], - 'ListSparkApps' => [ - 'summary' => 'Queries the Spark applications that run on an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSparkCodeWebUi' => [ + 'summary' => 'Queries the URL of the web UI for a Spark application.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1v6usq6m65****', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1248', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The returned message.'."\n" + ."\n" + .'* If the request was successful, **SUCCESS** is returned.'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '774DDC37-1908-58F6-B9CA-99E3E45965A6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Url' => ['description' => 'The URL of the web UI for the Spark application.'."\n", 'type' => 'string', 'example' => 'https://adb-subuser-cn-hangzhou-1358535755648527-100000648.oss-cn-hangzhou.aliyuncs.com/%3Facl?Expires=1681295967&OSSAccessKeyId=LTAI5tB7NAkm25oiGASu****&Signature=hKAZ1vgvhJ%2FD8hNHTuX%2FOOBWht****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'DescribeSparkCodeWebUi', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-09-06T02:42:53.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkCodeWebUi'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkCodeWebUi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSparkSQLDiagnosisAttribute' => [ + 'summary' => 'Queries the diagnostic information about a Spark SQL query.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24039,226 +18865,133 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], + 'abilityTreeCode' => '197163', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '数据库的ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-2zeq4788qyy7k662', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the job resource group.', - 'type' => 'string', - 'required' => false, - 'example' => 'test_instance', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '页码号', - 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~612475~~) operation to query a list of Spark application IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202411071444hzdvk486d9d2001****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InnerQueryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10. Valid values:'."\n" - ."\n" - .'- **10**'."\n" - .'- **50**'."\n" - .'- **100**', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '30', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the query executed within the Spark application.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '-2', 'exclusiveMinimum' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Filters', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The language in which to return the query results. Valid values:'."\n" + ."\n" + .'* en: English.'."\n" + .'* zh: Chinese.'."\n", 'type' => 'string', 'required' => true, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~612475~~) operation to query a list of Spark application IDs.'."\n", 'type' => 'string', 'example' => 's202411071444hzdvk486d9d2001****', 'title' => ''], + 'InnerQueryId' => ['description' => 'The ID of the query executed within the Spark application.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ElapsedTime' => ['description' => 'The execution duration of the query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'DiagnosisInfos' => [ + 'description' => 'The queried diagnostic information.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried diagnostic information.'."\n", '$ref' => '#/components/schemas/Adb4MysqlSparkDiagnosisInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'Data' => [ - 'description' => 'The data returned.', + 'OperatorListSortedByMetrics' => [ + 'description' => 'The operators sorted by metrics.'."\n", 'type' => 'object', 'properties' => [ - 'AppInfoList' => [ - 'description' => 'Details of the applications. Fields in the response parameter:'."\n" - ."\n" - .'- **Data**: the data of the Spark application template.'."\n" - .'- **EstimateExecutionCpuTimeInSeconds**: the amount of time it takes to consume CPU resources for running the Spark application. Unit: milliseconds.'."\n" - .'- **LogRootPath**: the storage path of log files.'."\n" - .'- **LastAttemptId**: the most recent attempt ID.'."\n" - .'- **WebUiAddress**: the web UI URL.'."\n" - .'- **SubmittedTimeInMillis**: the time when the Spark application was submitted. The time is displayed in the UNIX timestamp format. Unit: milliseconds.'."\n" - .'- **StartedTimeInMillis**: the time when the Spark application was created. The time is displayed in the UNIX timestamp format. Unit: milliseconds.'."\n" - .'- **LastUpdatedTimeInMillis**: the time when the Spark application was last updated. The time is displayed in the UNIX timestamp format. Unit: milliseconds.'."\n" - .'- **TerminatedTimeInMillis**: the time when the Spark application task was terminated. The time is displayed in the UNIX timestamp format. Unit: milliseconds.'."\n" - .'- **DBClusterId**: the ID of the cluster on which the Spark application runs.'."\n" - .'- **ResourceGroupName**: the name of the job resource group.'."\n" - .'- **DurationInMillis**: the amount of time it takes to run the Spark application. Unit: milliseconds.', + 'OperatorListSortedByMaxMemory' => [ + 'description' => 'The operators sorted by the maximum memory used.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'Details of the applications. Fields in the response parameter:'."\n" - ."\n" - .'- **Data**: the data of the Spark application template.'."\n" - .'- **EstimateExecutionCpuTimeInSeconds**: the amount of time it takes to consume CPU resources for running the Spark application. Unit: milliseconds.'."\n" - .'- **LogRootPath**: the storage path of log files.'."\n" - .'- **LastAttemptId**: the most recent attempt ID.'."\n" - .'- **WebUiAddress**: the web UI URL.'."\n" - .'- **SubmittedTimeInMillis**: the time when the Spark application was submitted. The time is displayed in the UNIX timestamp format. Unit: milliseconds.'."\n" - .'- **StartedTimeInMillis**: the time when the Spark application was created. The time is displayed in the UNIX timestamp format. Unit: milliseconds.'."\n" - .'- **LastUpdatedTimeInMillis**: the time when the Spark application was last updated. The time is displayed in the UNIX timestamp format. Unit: milliseconds.'."\n" - .'- **TerminatedTimeInMillis**: the time when the Spark application task was terminated. The time is displayed in the UNIX timestamp format. Unit: milliseconds.'."\n" - .'- **DBClusterId**: the ID of the cluster on which the Spark application runs.'."\n" - .'- **ResourceGroupName**: the name of the job resource group.'."\n" - .'- **DurationInMillis**: the amount of time it takes to run the Spark application. Unit: milliseconds.', - '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', - ], + 'items' => ['description' => 'The information about the Spark operator.'."\n", '$ref' => '#/components/schemas/SparkOperatorInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'OperatorListSortedByExclusiveTime' => [ + 'description' => 'The operators sorted by the execution duration.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The information about the Spark operator.'."\n", '$ref' => '#/components/schemas/SparkOperatorInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'Root' => ['description' => 'The Spark execution plan tree.'."\n", '$ref' => '#/components/schemas/OperatorNode', 'title' => '', 'example' => ''], + 'AccessDeniedDetail' => ['description' => 'The information about the request denial.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + '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' => 'DescribeSparkSQLDiagnosisAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkSQLDiagnosisAttribute'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkSQLDiagnosisAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'ListSparkApps', - ], - 'GetSparkAppInfo' => [ - 'summary' => 'Queries the information about an Spark application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + ], + 'DescribeSparkSQLDiagnosisList' => [ + 'summary' => 'Queries the diagnostic information about Spark SQL queries.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24268,34 +19001,71 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197113', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'spark app的id', - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query the Spark application IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202205201533hz1209892000****', - 'maxLength' => 64, - 'minLength' => 0, - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-2zez35ww415xjwk5', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'am-bp11q28kvl688****', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'StatementId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the code block in the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '20', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order by which to sort query results. Specify the parameter value in the JSON format. Example: `[{"Field":"MaxExclusiveTime","Type":"Asc"}]`.'."\n" + ."\n" + .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" + ."\n" + .' * `MaxExclusiveTime`: the maximum execution duration.'."\n" + .' * `PeakMemory`: the peak memory.'."\n" + .' * `QueryStartTime`: the start time of the query.'."\n" + .' * `QueryWallclockTime`: the execution duration of the query.'."\n" + ."\n" + .'* `Type` specifies the sorting order. Valid values:'."\n" + ."\n" + .' * `Asc`: ascending order.'."\n" + .' * `Desc`: descending order.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you do not specify this parameter, query results are sorted by `MaxExclusiveTime` in ascending order.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"Field\\":\\"QueryStartTime\\",\\"Type\\":\\"Desc\\"}]', 'title' => ''], + ], + [ + 'name' => 'MinStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The earliest start time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-11-28 22:00:00', 'title' => ''], + ], + [ + 'name' => 'MaxStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The latest start time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-11-28 23:00:00', 'title' => ''], ], ], 'responses' => [ @@ -24303,184 +19073,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', - ], - 'Data' => [ - 'description' => 'The queried Spark application. Fields in the response parameter:'."\n" - ."\n" - .'* **Data**: the data of the Spark application template.'."\n" - .'* **EstimateExecutionCpuTimeInSeconds**: the amount of time that is required to consume CPU resources for running the Spark application. Unit: milliseconds.'."\n" - .'* **LogRootPath**: the storage path of log files.'."\n" - .'* **LastAttemptId**: the most recent attempt ID.'."\n" - .'* **WebUiAddress**: the web UI URL.'."\n" - .'* **SubmittedTimeInMillis**: the time when the Spark application was submitted. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - .'* **StartedTimeInMillis**: the time when the Spark application was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - .'* **LastUpdatedTimeInMillis**: the time when the Spark application was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - .'* **TerminatedTimeInMillis**: the time when the Spark application was terminated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - .'* **DBClusterId**: the ID of the cluster on which the Spark application runs.'."\n" - .'* **ResourceGroupName**: the name of the job resource group.'."\n" - .'* **DurationInMillis**: the amount of time that is required to run the Spark application. Unit: milliseconds.', - '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', + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1343', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A91C9D07-7462-5F35-BB47-83629CE6CCAC', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'SQLDiagnosisList' => [ + 'description' => 'The queried diagnostic information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'State' => ['description' => 'The execution status of the query. Valid values:'."\n" + ."\n" + .'* COMPLETED'."\n" + .'* CANCELED'."\n" + .'* ABORTED'."\n" + .'* FAILED'."\n", 'type' => 'string', 'example' => 'COMPLETED', 'title' => ''], + 'SQL' => ['description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'select * from device where name = \'105506012112790031\'', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~612475~~) operation to query a list of Spark application IDs.'."\n", 'type' => 'string', 'example' => 's202404291020bjd448ad40002122', 'title' => ''], + 'StatementId' => ['description' => 'The unique ID of the code block in the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'InnerQueryId' => ['description' => 'The ID of the query executed within the Spark application.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-11-20 09:09:00', 'title' => ''], + 'ElapsedTime' => ['description' => 'The execution duration of the query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'MaxExclusiveTime' => ['description' => 'The maximum operator execution duration. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '90', 'title' => ''], + 'PeakMemory' => ['description' => 'The maximum operator memory used. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], + 'ScanRowCount' => ['description' => 'The number of entries scanned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + ], + 'description' => 'The queried diagnostic information.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'AccessDeniedDetail' => ['description' => 'The information about the request denial.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'Spark.Forbidden', - 'errorMessage' => 'No permissions to access the resources: %s', - ], + ], + 'title' => 'DescribeSparkSQLDiagnosisList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkSQLDiagnosisList'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkSQLDiagnosisList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'GetSparkAppInfo', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + '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"}]', ], - 'GetSparkAppState' => [ - 'summary' => 'Queries the status of a Spark application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSqlPattern' => [ + 'summary' => 'Queries the information about SQL patterns of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster within a time range.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24489,34 +19155,96 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132339', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + ], + 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'spark app的id', - 'description' => 'The Spark application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202204191546hzpread6a896000****', - 'maxLength' => 64, - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd format. The time must be in UTC.'."\n" + ."\n" + .'> Only data within the last 30 days can be queried.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-08-30', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order by which to sort query results. Specify the parameter value in the JSON string format. Example: `[{"Field":"Pattern","Type":"Asc"}]`. Parameters:'."\n" + ."\n" + .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" + ."\n" + .' * `Pattern`: the SQL pattern.'."\n" + .' * `AccessIP`: the IP address of the client.'."\n" + .' * `User`: the username.'."\n" + .' * `QueryCount`: the number of queries performed in association with the SQL pattern within the time range to query.'."\n" + .' * `AvgPeakMemory`: the average peak memory usage of the SQL pattern within the time range to query. Unit: KB.'."\n" + .' * `MaxPeakMemory`: the maximum peak memory usage of the SQL pattern within the time range to query. Unit: KB.'."\n" + .' * `AvgCpuTime`: the average execution duration of the SQL pattern within the time range to query. Unit: milliseconds.'."\n" + .' * `MaxCpuTime`: the maximum execution duration of the SQL pattern within the time range to query. Unit: milliseconds.'."\n" + .' * `AvgStageCount`: the average number of stages.'."\n" + .' * `MaxStageCount`: the maximum number of stages.'."\n" + .' * `AvgTaskCount`: the average number of tasks.'."\n" + .' * `MaxTaskCount`: the maximum number of tasks.'."\n" + .' * `AvgScanSize`: the average amount of data scanned based on the SQL pattern within the time range to query. Unit: KB.'."\n" + .' * `MaxScanSize`: the maximum amount of data scanned based on the SQL pattern within the time range to query. Unit: KB.'."\n" + ."\n" + .'* `Type` specifies the sorting order. Valid values:'."\n" + ."\n" + .' * `Asc`: ascending order.'."\n" + .' * `Desc`: descending order.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you do not specify this parameter, query results are sorted in ascending order of `Pattern`.'."\n" + ."\n" + .'* If you want to sort query results by `AccessIP`, you must set the `Type` parameter to `accessip`. If you want to sort query results by `User`, you must leave the `Type` parameter empty or set it to `user`.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"Field":"Pattern","Type":"Asc"}]', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'SqlPattern', + 'in' => 'query', + 'schema' => ['description' => 'The keyword that is used for the query.'."\n" + ."\n" + .'> If you do not specify this parameter, all SQL patterns of the AnalyticDB for MySQL cluster within the time period specified by `StartTime` are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The dimension by which to aggregate the SQL patterns. Valid values:'."\n" + ."\n" + .'* `user`: aggregates the SQL patterns by user.'."\n" + .'* `accessip`: aggregates the SQL patterns by client IP address.'."\n" + ."\n" + .'> If you do not specify this parameter, the SQL patterns are aggregated by `user`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp1h405854m****', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1ej1nq9n6****', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **10** (default)'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -24524,156 +19252,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => 'The Spark application ID.'."\n", - 'type' => 'string', - 'example' => 's202204191546hzpread6a896000****', - ], - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Message' => [ - 'description' => 'The alert message returned for the operation, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", - 'type' => 'string', - 'example' => 'Insufficient resources.', - ], - 'State' => [ - 'title' => 'spark app的状态', - 'description' => 'The execution state of the application. Valid values:'."\n" + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'Items' => [ + 'description' => 'The queried SQL pattern.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AvgStageCount' => ['description' => 'The average number of scanned rows.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + 'MaxCpuTime' => ['description' => 'The maximum execution duration of the SQL pattern within the query time range. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '17', 'title' => ''], + 'AccessIP' => ['description' => 'The IP address of the client.'."\n" ."\n" - .'* **SUBMITTED**'."\n" - .'* **STARTING**'."\n" - .'* **RUNNING**'."\n" - .'* **FAILING**'."\n" - .'* **FAILED**'."\n" - .'* **KILLING**'."\n" - .'* **KILLED**'."\n" - .'* **SUCCEEDING**'."\n" - .'* **COMPLETED**'."\n" - .'* **FATAL**'."\n" - .'* **UNKNOWN**'."\n", - 'type' => 'string', - 'example' => 'COMPLETED', - ], - 'DBClusterId' => [ - 'title' => '数据库ID', - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-clusterxxx', - 'default' => 'DB_CLUSTER_ID', - ], + .'> This parameter is returned only when **Type** is set to **accessip**.'."\n", 'type' => 'string', 'example' => '100.104.xx.xx', 'title' => ''], + 'AvgScanSize' => ['description' => 'The average amount of data scanned based on the SQL pattern within the query time range. Unit: KB.'."\n", 'type' => 'string', 'example' => '244', 'title' => ''], + 'MaxScanSize' => ['description' => 'The maximum amount of data scanned based on the SQL pattern within the query time range. Unit: KB.'."\n", 'type' => 'string', 'example' => '1024', 'title' => ''], + 'MaxPeakMemory' => ['description' => 'The maximum peak memory usage of the SQL pattern within the query time range. Unit: KB.'."\n", 'type' => 'string', 'example' => '480096', 'title' => ''], + 'AvgCpuTime' => ['description' => 'The average execution duration of the SQL pattern within the query time range. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1.0625', 'title' => ''], + 'User' => ['description' => 'The username.'."\n" + ."\n" + .'> This parameter is returned only when **Type** is left empty or set to **user**.'."\n", 'type' => 'string', 'example' => 'test_acc', 'title' => ''], + 'AvgPeakMemory' => ['description' => 'The average peak memory usage of the SQL pattern within the query time range. Unit: KB.'."\n", 'type' => 'string', 'example' => '240048', 'title' => ''], + 'MaxStageCount' => ['description' => 'The maximum number of stages.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + 'MaxTaskCount' => ['description' => 'The maximum number of tasks.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + 'InstanceName' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp1ej1nq9n6****', 'title' => ''], + 'QueryCount' => ['description' => 'The number of queries performed in association with the SQL pattern within the query time range.'."\n", 'type' => 'string', 'example' => '16', 'title' => ''], + 'ReportDate' => ['description' => 'The start date of the query.'."\n", 'type' => 'string', 'example' => '2022-08-30', 'title' => ''], + 'Pattern' => ['description' => 'The SQL pattern.'."\n", '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', 'title' => ''], + 'AvgTaskCount' => ['description' => 'The average number of tasks.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DB1F6C23-CBCA-5260-9366-BA7BB5EBF6F1', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + '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' => 'DescribeSqlPattern', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-09-13T12:07:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T04:03:32.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlPattern'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSqlPattern', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'GetSparkAppState', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", - ], - 'GetSparkAppLog' => [ - 'summary' => 'Queries the logs of a Spark application.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + ], + 'DescribeStorageResourceUsage' => [ + 'summary' => 'Queries the storage resource usage of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24681,610 +19341,277 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ - [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => '应用Id', - 'description' => 'The Spark application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~612475~~) operation to query the Spark application ID.', - 'type' => 'string', - 'required' => true, - 'example' => 's202206061441hz22a35ab000****', - ], - ], - [ - 'name' => 'LogLength', - 'in' => 'formData', - 'schema' => [ - 'title' => '需要返回的尾部日志行数.', - 'description' => 'The number of log entries to return. Valid values: 1 to 500. Default value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '500', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '20', - 'default' => '300', - ], - ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-2ze6fl8ud7t***', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp10yt0gva71ei7d', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '读取日志的偏移量。', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-08-22T01:06:00Z'."\n", 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '500', - 'default' => '100000', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-08-23T01:06:00Z'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The queried log.'."\n", + 'description' => 'The queried resource usage.'."\n", 'type' => 'object', 'properties' => [ - 'LogContent' => [ - 'title' => 'spark app的日志内容, 如配置了重试则为最后一次重试的尾部日志内容.', - 'description' => 'The content of the log.'."\n", - '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' => 'The alert message returned for the request, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", - 'type' => 'string', - 'example' => 'WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-clusterxxx', - ], - 'LogSize' => [ - 'description' => 'The number of log entries. A value of 0 indicates that no valid logs are returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3517972480', + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-bp1bg858bo8c****', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'example' => '2022-08-22T01:06:00Z'."\n", 'title' => ''], + 'EndTime' => ['description' => 'The end time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-08-23T01:06:00Z'."\n", 'title' => ''], + 'AcuInfo' => [ + 'description' => 'The AnalyticDB compute unit (ACU) usage of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The resource usage metric. Valid values:'."\n" + ."\n" + .'* `TotalAcuNumber`: the total number of ACUs.'."\n" + .'* `ReservedAcuNumber`: the number of ACUs for the reserved resources.'."\n", 'type' => 'string', 'example' => 'TotalAcuNumber', 'title' => ''], + 'Values' => [ + 'description' => 'The values of the metric at specific points in time.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The value of the metric at a specific point in time.'."\n", 'type' => 'string', 'example' => '16ACU', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - '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', - ], + 'title' => 'DescribeStorageResourceUsage', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStorageResourceUsage'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeStorageResourceUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'GetSparkAppLog', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + '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"}]', ], - 'SubmitSparkApp' => [ - 'summary' => 'Submits a Spark application.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeTableAccessCount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '118686', - 'abilityTreeNodes' => [ - 'FEATUREadsCQJTKP', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ - 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark App的名称', - 'description' => 'The name of the application. The value can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestApp', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all clusters in a region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-2ze627uzpkh8a8****', 'title' => ''], ], [ - 'name' => 'AppType', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark App的类型, 不填写默认为BATCH 批处理类型', - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* **SQL**'."\n" - .'* **STREAMING**'."\n" - .'* **BATCH** (default)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SQL', - 'default' => 'BATCH', - 'enum' => [], - ], - ], - [ - 'name' => 'Data', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark App的配置信息, 定义SQL语句或者执行内容', - 'description' => 'The data of the application template.'."\n" - ."\n" - .'> For information about the application template configuration, see [Spark application configuration guide](~~452402~~).'."\n", - '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' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table.'."\n" + .'> If this parameter is left empty, the access frequency data of all tables in the cluster within the specified date range is returned.', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMER', 'title' => ''], ], [ - 'name' => 'AgentSource', - 'in' => 'formData', - 'schema' => [ - 'title' => '客户端类型', - 'description' => 'The type of the client. The value can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CONSOLE', - 'default' => 'SDK', - 'enum' => [], - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query, in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.'."\n" + .'> Only data within the last 30 days can be queried.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-09-25T12:10:00Z', 'title' => ''], ], [ - 'name' => 'AgentVersion', - 'in' => 'formData', - 'schema' => [ - 'title' => '客户端版本', - 'description' => 'The version of the client. The value can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.091', - ], + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'Sorts the query results by a specified field. The value is a JSON string. Example: `[{"Field":"TableSchema","Type":"Asc"}]`.'."\n" + .'- `Field` specifies the field by which to sort. Valid values:'."\n" + .' - `TableSchema`: the name of the database to which the table belongs.'."\n" + .' - `TableName`: the table name.'."\n" + .' - `AccessCount`: the number of times the table is accessed.'."\n" + .'- `Type` specifies the sort order. Valid values:'."\n" + .' - `Asc`: ascending order.'."\n" + .' - `Desc`: descending order.'."\n" + ."\n" + .'> If this parameter is not specified, the results are sorted by the database name of the table in ascending order by default.', 'type' => 'string', 'required' => false, 'example' => '[{"Field":"TableSchema","Type":"Asc"}]', 'title' => ''], ], [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库的id', - 'description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - 'maxLength' => 64, - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => '资源组的名称', - 'description' => 'The name of the job resource group.'."\n" - ."\n" - .'> You can call the [DescribeDBResourceGroup](~~612410~~) operation to query the name of a resource group within a cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adb', - 'maxLength' => 64, - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'- **10** (default)'."\n" + .'- **30**'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'TemplateFileId', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板文件id', - 'description' => 'The ID of the application template.'."\n" - ."\n" - .'> You can call the [GetSparkTemplateFullTree](~~456205~~) operation to query the application template ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '15', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'title' => 'Spark App的id', - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 's202204132018hzprec1ac61a000****', - ], - 'AppName' => [ - 'title' => 'spark app的名称', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'TestApp', - ], - 'Message' => [ - 'title' => '备注信息', - 'description' => 'The alert message returned for the operation, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", - 'type' => 'string', - 'example' => 'Insufficient resources.', - ], - 'State' => [ - 'title' => 'spark app的状态', - 'description' => 'The execution state of the application. Valid values:'."\n" - ."\n" - .'* **SUBMITTED**'."\n" - .'* **STARTING**'."\n" - .'* **RUNNING**'."\n" - .'* **FAILING**'."\n" - .'* **FAILED**'."\n" - .'* **KILLING**'."\n" - .'* **KILLED**'."\n" - .'* **SUCCEEDING**'."\n" - .'* **COMPLETED**'."\n" - .'* **FATAL**'."\n" - .'* **UNKNOWN**'."\n", - 'type' => 'string', - 'example' => 'SUBMITTED', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6B7D627B-DA23-572D-AD71-256F64698B7D', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The table usage details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details.', + 'type' => 'object', + 'properties' => [ + 'ReportDate' => ['description' => 'The date on which the table was used.', 'type' => 'string', 'example' => '2022-09-26', 'title' => ''], + 'TableSchema' => ['description' => 'The database to which the table belongs.', 'type' => 'string', 'example' => 'tpch', 'title' => ''], + 'AccessCount' => ['description' => 'The number of times the table was accessed.', 'type' => 'string', 'example' => '6', 'title' => ''], + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'CUSTOMER', 'title' => ''], + 'InstanceName' => ['description' => 'The cluster ID of the cluster to which the table belongs.', 'type' => 'string', 'example' => 'amv-2ze627uzpkh8a8****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', - ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Query table access count', + 'summary' => 'Queries the number of times a specified table or all tables in a cluster are accessed within a specified date range.', + 'description' => 'For the service registration of this service, see [Endpoint](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2023-09-13T12:07:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T04:03:32.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTableAccessCount'], ], + ], + 'ramActions' => [ [ - [ - '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', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeTableAccessCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'SubmitSparkApp', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'KillSparkApp' => [ - 'summary' => 'Terminates a Spark application.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeTableDetail' => [ + 'summary' => 'Queries the information about data distribution among shards of a table.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194789', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Spark App的ID', - 'description' => 'The ID of the Spark application that you want to terminate.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202204132018hzprec1ac****', - 'maxLength' => 64, - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-bp1xxxxxxxx47', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp1ub9grke1****', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -25292,116 +19619,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '69D0810B-F9F5-5F4C-A57F-DF36133B63C9', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '9', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The queried data distribution.'."\n", 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'title' => 'Spark App的ID', - 'description' => 'The Spark application ID.'."\n", - 'type' => 'string', - 'example' => 's202204132018hzprec1ac****', - ], - 'AppName' => [ - 'title' => 'Spark App的名称', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'LAKEHOUSE-1-1', - ], - 'Message' => [ - 'title' => '特殊注释信息', - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => '[Advisor] Advisor feature is not available for instance: am-2ze292w4fyglwxxxx', - ], - 'State' => [ - 'title' => 'App的状态信息', - 'description' => 'The execution state of the Spark application. Valid values:'."\n" - ."\n" - .'* **SUBMITTED**'."\n" - .'* **STARTING**'."\n" - .'* **RUNNING**'."\n" - .'* **FAILING**'."\n" - .'* **FAILED**'."\n" - .'* **KILLING**'."\n" - .'* **KILLED**'."\n" - .'* **SUCCEEDING**'."\n" - .'* **COMPLETED**'."\n" - .'* **FATAL**'."\n" - .'* **UNKNOWN**'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'DBClusterId' => [ - 'title' => '数据库ID', - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1c3em7b2e****', - 'default' => 'DB_CLUSTER_ID', + 'Shard' => [ + 'description' => 'The queried shards.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried shard.'."\n", + 'type' => 'object', + 'properties' => [ + 'Size' => ['description' => 'The number of rows in the table.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9484858', 'title' => ''], + 'Id' => ['description' => 'The shard ID. Only the numeric part of the shard name is returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'AvgSize' => ['description' => 'The average number of rows in a shard.'."\n", 'type' => 'string', 'example' => '160', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.'."\n", '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" + .'}', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + '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' => 'DescribeTableDetail', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTableDetail'], ], - 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', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeTableDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'KillSparkApp', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" - ."\n" - .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", ], - 'CreateOssSubDirectory' => [ - 'summary' => 'Creates an Object Storage Service (OSS) subdirectory.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeTablePartitionDiagnose' => [ + 'summary' => 'Queries the information about partition diagnostics.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25410,120 +19699,163 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '125729', - 'abilityTreeNodes' => [ - 'FEATUREadsCORDM7', - ], + 'abilityTreeCode' => '186721', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Path', - 'in' => 'formData', - 'schema' => [ - 'title' => '创建的子目录的完整OSS路径'."\n", - 'description' => 'The OSS path where you want to create a subdirectory.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://testBucketName/das_lakehouse', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp171g24yvbxxxxx', 'title' => ''], ], [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp149vz49b36t****', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order by which to sort query results. Specify the parameter value in the JSON string format. Example: `[{"Field":"TotalSize","Type":"Desc"}]`.'."\n" + ."\n" + .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" + ."\n" + .' * `SchemaName`: the name of the database to which the table belongs.'."\n" + .' * `TableName`: the name of the table.'."\n" + .' * `TotalSize`: the total data size of the table.'."\n" + .' * `SpaceRatio`: the storage percentage of the table.'."\n" + ."\n" + .'* `Type` specifies the sorting order. Valid values:'."\n" + ."\n" + .' * `Asc`: ascending order.'."\n" + .' * `Desc`: descending order.'."\n" + ."\n" + .'> If you do not specify this parameter, the query results are sorted by the TotalSize field in descending order.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"Field\\":\\"TotalSize\\",\\"Type\\":\\"Desc\\"}]', 'default' => '[{"Field":"SchemaName", "Type": "desc" }]', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: simplified Chinese.'."\n" + .'* **en**: English.'."\n" + .'* **ja**: Japanese.'."\n" + .'* **zh-tw**: traditional Chinese.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3A0DE2E0-A37B-5EE4-9136-C4C473714802', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request was successful, a **success** message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'ClientCRC' => [ - 'description' => 'The cyclic redundancy check (CRC) value on the client.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ETag' => [ - 'description' => 'The tag of the OSS path.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3A0DE2E0-A37B-5EE4-9136-C4C473714802', - ], - 'ServerCRC' => [ - 'description' => 'The CRC-64 value on the OSS bucket.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '185', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-bp171g24yvbxxxxx', 'title' => ''], + 'SuggestMaxRecordsPerPartition' => ['description' => 'The recommended maximum number of rows in each partition.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '640000000', 'title' => ''], + 'SuggestMinRecordsPerPartition' => ['description' => 'The recommended minimum number of rows in each partition.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '64000000', 'title' => ''], + 'Items' => [ + 'description' => 'The queried partition diagnostic information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried partition diagnostic information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'user', 'title' => ''], + 'PartitionDetail' => ['description' => 'The improper partitions.'."\n", 'type' => 'string', 'example' => '[20210110, 20210113,20210123]', 'title' => ''], + 'SchemaName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test_db', 'title' => ''], + 'PartitionNumber' => ['description' => 'The number of partitions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TotalSize' => ['description' => 'The total data size of the table. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '42949672960', 'title' => ''], + 'SpaceRatio' => ['description' => 'The storage percentage of the table. Unit: %.'."\n" + ."\n" + .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.', 'type' => 'number', 'format' => 'double', 'example' => '66.23', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried detection item and detection result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the detection item.'."\n", 'type' => 'string', 'example' => '表分区合理性检测', 'title' => ''], + 'Message' => ['description' => 'The detection result.'."\n", 'type' => 'string', 'example' => '检测到表存在分区不合理的情况', 'title' => ''], + 'Status' => ['description' => 'The severity level of the detection result. Valid values:'."\n" + ."\n" + .'* NORMAL'."\n" + .'* WARNING'."\n" + .'* CRITICAL'."\n", 'type' => 'string', 'example' => 'WARNING', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'AccessDeniedDetail' => ['description' => 'The information about the request denial.'."\n", '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" + .'}', 'title' => ''], ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'CreateOssSubDirectory', - 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" - .'* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeViewJobs' => [ - 'summary' => 'Retrieves materialized view refresh tasks.', - 'methods' => [ - 'get', - 'post', + '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' => 'DescribeTablePartitionDiagnose', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTablePartitionDiagnose'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeTablePartitionDiagnose', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeTableStatistics' => [ + 'summary' => 'Queries the table statistics of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25535,248 +19867,159 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], + 'abilityTreeCode' => '186727', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'SchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'demo_db', - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The field used for sorting. Valid values for Type:'."\n" - ."\n" - .'* Asc.'."\n" - .'* Desc.'."\n" - ."\n" - .'Valid values for Field:'."\n" - ."\n" - .'* StartTime.'."\n" - .'* EndTime;'."\n" - .'* ScheduledStartTime;'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"Field\\":\\"StartTime\\",\\"Type\\":\\"Desc\\"}', - ], - ], - [ - 'name' => 'FilterViewName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the view.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_mv', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-****************', 'title' => ''], ], [ - 'name' => 'FilterViewType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'\\-VIRTUAL_VIEW'."\n" - ."\n" - .'\\-MATERIALIZED_VIEW'."\n" - ."\n" - .'This parameter is empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MATERIALIZED_VIEW', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', 'title' => ''], ], [ - 'name' => 'FilterOwner', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The owner of the view.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The order by which to sort query results. Specify the parameter value in the JSON format.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .' ['."\n" + ."\n" + .' {'."\n" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\n" + .' }'."\n" + ."\n" + .' ]'."\n" + ."\n" + .'Field specifies the field by which to sort the query results. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.'."\n" + ."\n" + .'Field and Type are case-insensitive.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"Field":"SchemaName","Type":"Desc"}]', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The region ID'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~612393~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'am-bp1ub9grke1****'."\n", - ], + 'schema' => ['description' => 'The keyword that is used to query information by table name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'you_table_name', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2A318054-6815-528A-AA94-8AC921******', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries that are returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '44', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '693', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C4433FF-5D3A-4C3E-A19C-6D93B2******', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'am-****************', 'title' => ''], + 'Items' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries that are returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '44', - ], - 'MvRefreshJobModels' => [ - 'description' => 'The refresh tasks.'."\n", + 'TableStatisticRecords' => [ + 'description' => 'The queried table statistics.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'Refresh task details.'."\n", - '$ref' => '#/components/schemas/open_struct_RefreshJobModel', + 'description' => 'The queried table statistics.'."\n", + 'type' => 'object', + 'properties' => [ + 'SchemaName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test_schema', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'test_table', 'title' => ''], + 'RowCount' => ['description' => 'The number of rows in the table.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'DataSize' => ['description' => 'The data size of the table. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '15592', 'title' => ''], + 'IndexSize' => ['description' => 'The data size of indexes. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3076', 'title' => ''], + 'PrimaryKeyIndexSize' => ['description' => 'The data size of the primary key index. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16340', 'title' => ''], + 'PartitionCount' => ['description' => 'The number of partitions.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ColdDataSize' => ['description' => 'The size of cold data. Unit: bytes.'."\n" + ."\n" + .'> This parameter is supported only for AnalyticDB for MySQL clusters of V3.1.3.4 or later.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4428120064', 'title' => ''], + 'SpaceRatio' => ['description' => 'The percentage of the table size. Unit: %.'."\n" + ."\n" + .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '66.23', 'title' => ''], + 'TotalSize' => ['description' => 'The total data size of the table. Unit: bytes.'."\n" + ."\n" + .'> The following formulas can be used to calculate the total data size:'."\n" + ."\n" + .'* Formula 1: Total data size = Hot data size + Cold data size.'."\n" + .'* Formula 2: Total data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1577', 'title' => ''], + 'HotDataSize' => ['description' => 'The size of hot data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + 'OtherSize' => ['description' => 'The data size of other data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'SchemaNames' => ['description' => 'The names of databases.'."\n", 'type' => 'string', 'example' => '[\'adb_platform\', \'adb_ai\', \'adb_data\']', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + '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' => 'DescribeTableStatistics', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTableStatistics'], ], - 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeTableStatistics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DescribeViewJobs', ], - 'DescribeTableDetail' => [ - 'summary' => 'Queries the information about data distribution among shards of a table.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeTables' => [ + 'summary' => 'Queries a list of tables in a database.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25788,149 +20031,113 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '194789', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-bp1xxxxxxxx47', - ], - ], - [ - 'name' => 'SchemaName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1xxxxxxxx47', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '9', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], 'Items' => [ - 'description' => 'The queried data distribution.'."\n", 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Shard' => [ - 'description' => 'The queried shards.'."\n", - 'type' => 'array', + 'Table' => [ + 'description' => 'The queried tables.'."\n", + 'type' => 'array', 'items' => [ - 'description' => 'The queried shard.'."\n", + 'description' => 'The queried table.'."\n", 'type' => 'object', 'properties' => [ - 'Size' => [ - 'description' => 'The number of rows in the table.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9484858', - ], - 'Id' => [ - 'description' => 'The shard ID. Only the numeric part of the shard name is returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp1xxxxxxxx47', 'title' => ''], + 'SchemaName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'adb_demo', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'AvgSize' => [ - 'description' => 'The average number of rows in a shard.'."\n", - 'type' => 'string', - 'example' => '160', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The detailed reason why the access was denied.'."\n", - '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" - .'}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], + ], ], - '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' => 'DescribeTableDetail', - ], - 'GetCreateTableSQL' => [ - 'summary' => 'Queries the table creation statement for tables.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeTables', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:08.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-25T03:37:06.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTables'], + ], ], - 'tags' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:describeAllDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + ], + ], + 'DescribeUserQuota' => [ + 'summary' => 'Queries available quotas.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25938,109 +20145,79 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '212744', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", + 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'amv-2ze8mbuai974s4y2', + 'example' => 'amv-bp1qjt3o18d8****', + 'enum' => [], + 'title' => '', ], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '109462AF-B5FA-3D5A-9377-B27E5B******', - ], - 'SQL' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'example' => 'create table ('."\n" - .' id varchar(32)'."\n" - .');', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0322C7FB-4584-5D2A-BF7F-F9036E940C35'], + 'ElasticACU' => ['description' => 'The available elastic AnalyticDB compute units (ACUs).'."\n", 'type' => 'string', 'example' => '512 ACU', 'title' => ''], + 'ResourceGroupCount' => ['description' => 'The number of available resource groups.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + 'ReserverdCompteACU' => ['description' => 'The available reserved computing resources.'."\n", 'type' => 'string', 'example' => '48 ACU', 'title' => ''], + 'ReserverdStorageACU' => ['description' => 'The available reserved storage resources.'."\n", 'type' => 'string', 'example' => '24 ACU', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'DescribeUserQuota', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-11-06T09:42:43.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"109462AF-B5FA-3D5A-9377-B27E5B******\\",\\n \\"SQL\\": \\"create table (\\\\n id varchar(32)\\\\n);\\"\\n}","type":"json"}]', - 'title' => 'GetCreateTableSQL', - ], - 'DescribeTableStatistics' => [ - 'summary' => 'Queries the table statistics of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserQuota'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeUserQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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"}]', + ], + 'DescribeViewJobs' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26052,324 +20229,194 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '186727', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-****************', - ], + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'demo_db', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => 'The sort field.'."\n" + ."\n" + .'Valid values for the sort order:'."\n" + .'- Asc'."\n" + .'- Desc'."\n" + ."\n" + .'Valid values for the sort field:'."\n" + .'- StartTime'."\n" + .'- EndTime'."\n" + .'- ScheduledStartTime', 'type' => 'string', 'required' => false, 'example' => '{\\"Field\\":\\"StartTime\\",\\"Type\\":\\"Desc\\"}', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'FilterViewName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The view name.', 'type' => 'string', 'required' => false, 'example' => 'test_mv', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'FilterViewType', 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON format.'."\n" - ."\n" - .'Example:'."\n" - ."\n" - .' ['."\n" - ."\n" - .' {'."\n" - ."\n" - .' "Field":"Name",'."\n" - ."\n" - .' "Type":"Asc"'."\n" - ."\n" - .' }'."\n" - ."\n" - .' ]'."\n" - ."\n" - .'Field specifies the field by which to sort the query results. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.'."\n" - ."\n" - .'Field and Type are case-insensitive.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Field":"SchemaName","Type":"Desc"}]', - ], + 'schema' => ['description' => 'The view type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- VIRTUAL_VIEW'."\n" + .'- MATERIALIZED_VIEW'."\n" + ."\n" + .'Default value: empty.', 'type' => 'string', 'required' => false, 'example' => 'MATERIALIZED_VIEW', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'FilterOwner', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~612393~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The owner.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to query information by table name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'you_table_name', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'SchemaName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'am-bp1ub9grke1****'."\n", 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '693', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C4433FF-5D3A-4C3E-A19C-6D93B2******', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'am-****************', - ], - 'Items' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2A318054-6815-528A-AA94-8AC921******'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '44', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'TableStatisticRecords' => [ - 'description' => 'The queried table statistics.'."\n", + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '44', 'title' => ''], + 'MvRefreshJobModels' => [ + 'description' => 'The list of refresh tasks.', 'type' => 'array', - 'items' => [ - 'description' => 'The queried table statistics.'."\n", - 'type' => 'object', - 'properties' => [ - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'test_schema', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test_table', - ], - 'RowCount' => [ - 'description' => 'The number of rows in the table.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'DataSize' => [ - 'description' => 'The data size of the table. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15592', - ], - 'IndexSize' => [ - 'description' => 'The data size of indexes. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3076', - ], - 'PrimaryKeyIndexSize' => [ - 'description' => 'The data size of the primary key index. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16340', - ], - 'PartitionCount' => [ - 'description' => 'The number of partitions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ColdDataSize' => [ - 'description' => 'The size of cold data. Unit: bytes.'."\n" - ."\n" - .'> This parameter is supported only for AnalyticDB for MySQL clusters of V3.1.3.4 or later.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4428120064', - ], - 'SpaceRatio' => [ - 'description' => 'The percentage of the table size. Unit: %.'."\n" - ."\n" - .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '66.23', - ], - 'TotalSize' => [ - 'description' => 'The total data size of the table. Unit: bytes.'."\n" - ."\n" - .'> The following formulas can be used to calculate the total data size:'."\n" - ."\n" - .'* Formula 1: Total data size = Hot data size + Cold data size.'."\n" - .'* Formula 2: Total data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1577', - ], - 'HotDataSize' => [ - 'description' => 'The size of hot data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - 'OtherSize' => [ - 'description' => 'The data size of other data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - ], - ], + 'items' => ['description' => 'The details of the refresh task.', '$ref' => '#/components/schemas/open_struct_RefreshJobModel', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], - ], - 'SchemaNames' => [ - 'description' => 'The names of databases.'."\n", - 'type' => 'string', - 'example' => '[\'adb_platform\', \'adb_ai\', \'adb_data\']', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], + ], ], - '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' => 'DescribeTableStatistics', - ], - 'DescribeAdbMySqlTableMeta' => [ - 'summary' => 'Queries the information about table metadata.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query materialized view refresh task list', + 'summary' => 'Retrieves view tasks.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeViewJobs'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeViewJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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\\": \\"RUNNING\\",\\n \\"EndTime\\": \\"2025-01-15 10:12:00\\",\\n \\"RefreshModel\\": \\"FAST\\",\\n \\"StartTime\\": \\"2025-01-15 10:11:00\\",\\n \\"RefreshInterval\\": \\"30s\\",\\n \\"Processid\\": \\"2025103010xxxxxxx\\",\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"ResourceGroup\\": \\"user_default\\",\\n \\"Name\\": \\"demo_mv\\",\\n \\"ScheduledStartTime\\": \\"2025-01-15 10:11:00\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeWorkerDetection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + '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' => 'The cluster ID.'."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the details of all AnalyticDB for MySQL clusters in a region, including the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-xxxxx', 'title' => ''], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~612293~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp11q28kvl688****', - ], + 'schema' => ['description' => 'The beginning of the query time range. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2021-11-18T00:00Z', 'title' => ''], ], [ - 'name' => 'Schema', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'adb_demo', - ], + 'schema' => ['description' => 'The end of the query time range. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2024-04-25T02:04Z', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n" - ."\n" - .'> If you leave this parameter empty, the information about all the current tables in the cluster is returned.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The display language of suggestions. Valid values:'."\n" + .'- **zh**: simplified Chinese (default).'."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -26377,196 +20424,248 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TableMeta' => [ - 'description' => 'The queried table metadata.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableSchema' => [ - 'description' => 'The database to which the table belongs.'."\n", - 'type' => 'string', - 'example' => 'tpch', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'****'."\n", - 'type' => 'string', - 'example' => 'external_supplier', - ], - 'TableType' => [ - 'description' => 'The type of the table.'."\n", - 'type' => 'string', - 'example' => 'fact_table', - ], - 'DistributeType' => [ - 'description' => 'The distribution type.'."\n", - 'type' => 'string', - 'example' => 'hash', - ], - 'DistributeColumn' => [ - 'description' => 'The distribution key column.'."\n", - 'type' => 'string', - 'example' => 'customer_id', - ], - 'PartitionType' => [ - 'description' => 'The type of the partition.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - 'PartitionColumn' => [ - 'description' => 'The partition key column.'."\n", - 'type' => 'string', - 'example' => 'DATE_FORMAT(login_time, \'%Y%m%d\')', - ], - 'PrimaryKeyColumn' => [ - 'description' => 'The primary key column.'."\n", - 'type' => 'string', - 'example' => 'login_time,customer_id,phone_num', - ], - 'TableEngine' => [ - 'description' => 'The table engine.'."\n", - 'type' => 'string', - 'example' => 'XUANWU', - ], - 'IsDictEncode' => [ - 'description' => 'Indicates whether dictionary encoding is used.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsHidden' => [ - 'description' => 'Indicates whether pages are hidden.'."\n" + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E5B37B61-E6C9-5FE0-9374-45BAA548AEF6', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'am-xxxxx', 'title' => ''], + 'DetectionItems' => [ + 'description' => 'The list of detection items and detection results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The detection result.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the detection item.', 'type' => 'string', 'example' => '指标检测', 'title' => ''], + 'Results' => [ + 'description' => 'The detection result.', + 'type' => 'object', + 'properties' => [ + 'SkewedTables' => [ + 'description' => 'The table skew detection results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'platfunc', 'title' => ''], + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'sls_log_cheat_action', 'title' => ''], + 'DDL' => ['description' => 'The CREATE TABLE statement.', 'type' => 'string', 'example' => 'create table test(id varchar)', 'title' => ''], + 'PartitionCount' => ['description' => 'The number of partitions.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TotalDataSize' => ['description' => 'The total data size of the table. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2345', 'title' => ''], + 'TotalRowCount' => ['description' => 'The total number of rows in the table.', 'type' => 'integer', 'format' => 'int64', 'example' => '34', 'title' => ''], + 'TotalPkSize' => ['description' => 'The total primary key data size of the table. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '234', 'title' => ''], + 'TotalRemoteDataSize' => ['description' => 'The cold data size. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '234', 'title' => ''], + 'TotalLocalDataSize' => ['description' => 'The local data size. Unit: bytes.', 'type' => 'string', 'example' => '2345', 'title' => ''], + 'ShardSkewedRows' => ['description' => 'The number of skewed rows in the table.', 'type' => 'string', 'example' => '1234', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PartitionedTables' => [ + 'description' => 'The collection of tables with unreasonable partitions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The table with unreasonable partitions.', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'nxg', 'title' => ''], + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'zhw_place_order', 'title' => ''], + 'DDL' => ['description' => 'The CREATE TABLE statement.', 'type' => 'string', 'example' => 'create table test(id varchar)', 'title' => ''], + 'PartitionCount' => ['description' => 'The number of partitions.', 'type' => 'string', 'example' => '234', 'title' => ''], + 'PartitionIds' => ['description' => 'The IDs of unreasonable partitions.', 'type' => 'string', 'example' => '[2024,2025]', 'title' => ''], + 'TotalDataSize' => ['description' => 'The total data size of the table.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TopAccessTables' => [ + 'description' => 'The collection of table access detection results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The table access detection result.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The name of the detection metric.', 'type' => 'string', 'example' => 'Peak memory detection', 'title' => ''], + 'SearchResults' => [ + 'description' => 'The collection of table access search results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The table access search result.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'tiberias_2copt_origin_order_goods_info', 'title' => ''], + 'MaxScanCost' => ['description' => 'The maximum scan duration. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '345', 'title' => ''], + 'AvgScanCost' => ['description' => 'The average scan duration. Unit: ms.', 'type' => 'number', 'format' => 'double', 'example' => '234', 'title' => ''], + 'MaxScanSize' => ['description' => 'The maximum data read size. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2345', 'title' => ''], + 'AvgScanSize' => ['description' => 'The average table read size. Unit: bytes.', 'type' => 'number', 'format' => 'double', 'example' => '234', 'title' => ''], + 'AccessCount' => ['description' => 'The number of times the table was accessed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OperatorDetails' => [ + 'description' => 'The collection of operator detection results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The operator detection result.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'PeakMemory', 'title' => ''], + 'SearchResults' => [ + 'description' => 'The collection of search results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The operator detection result.', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => ['description' => 'The SQL query ID, which can be used for diagnostics.', 'type' => 'string', 'example' => '2024041909301402103302422803151411141', 'title' => ''], + 'StageId' => ['description' => 'The stage ID.', 'type' => 'string', 'example' => 'Stage[2]', 'title' => ''], + 'OperatorName' => ['description' => 'The operator name.', 'type' => 'string', 'example' => 'TableScan', 'title' => ''], + 'PeakMemory' => ['description' => 'The peak memory consumed by the operator. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], + 'OperatorCost' => ['description' => 'The total operator duration within the stage, which is equivalent to the CPU time of the stage. You can use this value to determine which parts of the query consume more compute resources. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], + 'InputRows' => ['description' => 'The number of input rows of the operator.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'OutputRows' => ['description' => 'The number of output rows of the operator.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'InputSize' => ['description' => 'The input data size of the operator. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'OutputSize' => ['description' => 'The output data size of the operator. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'OperatorInfo' => ['description' => 'The operator property information.', 'type' => 'string', 'example' => 'Group By field: id', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OperatorAgg' => [ + 'description' => 'The aggregated operator metric detection results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The name of the aggregated operator metric detection item.', 'type' => 'string', 'example' => '峰值内存', 'title' => ''], + 'SearchResults' => [ + 'description' => 'The collection of aggregated operator metric search results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperatorName' => ['description' => 'The operator name.', 'type' => 'string', 'example' => 'Aggregation', 'title' => ''], + 'MaxValue' => ['description' => 'The maximum value of the operator metric.', 'type' => 'integer', 'format' => 'int64', 'example' => '444', 'title' => ''], + 'TotalValue' => ['description' => 'The cumulative value of the operator metric.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'AvgValue' => ['description' => 'The average value of the operator metric.', 'type' => 'number', 'format' => 'double', 'example' => '2234', 'title' => ''], + 'OperatorCount' => ['description' => 'The number of times the operator appears.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Message' => ['description' => 'The detection result message.', 'type' => 'string', 'example' => 'There are a total of 10 tables with an excessive number of primary keys.', 'title' => ''], + 'Status' => ['description' => 'The detection result status. Valid values:'."\n" ."\n" - .'* **false**'."\n" - .'* **true**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsAllIndex' => [ - 'description' => 'Indicates whether full-column indexes are used.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsFullTextDict' => [ - 'description' => 'Indicates whether full-text indexes are used.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CreateTime' => [ - 'description' => 'The time when the table was created.'."\n", - 'type' => 'string', - 'example' => '2025-03-14 02:18:08.0', - ], - 'UpdateTime' => [ - 'description' => 'The time when the table was updated.'."\n", - 'type' => 'string', - 'example' => '2024-07-25 02:07:23.0', + .'- NORMAL'."\n" + .'- WARNING'."\n" + .'- CRITICAL', 'type' => 'string', 'example' => 'WARNING', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], ], - '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' => 'DescribeAdbMySqlTableMeta', - ], - 'DescribeAdbMySqlIndexes' => [ - 'summary' => 'Queries the information about table indexes.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Reserved node detection', + 'summary' => 'Queries the diagnostics results of the storage layer.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWorkerDetection'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeWorkerDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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\\": \\"Peak memory detection\\",\\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 field: 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\\": \\"There are a total of 10 tables with an excessive number of primary keys.\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DetachUserENI' => [ + 'summary' => 'Detaches an Elastic Network Interface (ENI).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsPOF80W'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~612393~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-uf6wjk5xxxxxxxxxx', - ], - ], - [ - 'name' => 'Schema', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tpch_oss', - 'default' => 'INFORMATION_SCHEMA', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n" - ."\n" - .'> If you leave this parameter empty, the information about all the current tables in the cluster is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'orders', - 'default' => 'COLUMNS', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-bp11q28kvl688****', 'title' => ''], ], ], 'responses' => [ @@ -26574,92 +20673,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Schema' => [ - 'description' => 'The name of the database.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'****\\'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'IndexCount' => [ - 'description' => 'The number of indexes.````'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Indexes' => [ - 'description' => 'The queried indexes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The index type.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Name' => [ - 'description' => 'The name of the index.'."\n", - 'type' => 'string', - 'example' => 'ttl', - ], - 'Column' => [ - 'description' => 'The name of the column.'."\n", - 'type' => 'string', - 'example' => 'preclcu', - ], - ], - 'description' => '', - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], ], - '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' => 'DescribeAdbMySqlIndexes', - ], - 'DescribeMvRecommendSubTasks' => [ - 'summary' => '查看物化视图子任务', - 'methods' => [ - 'get', - 'post', + 'title' => 'DetachUserENI', + 'description' => 'For the service endpoint, see [Endpoints](~~612373~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachUserENI'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DetachUserENI', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DisableAdviceService' => [ + 'summary' => 'Disables the suggestion feature.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26668,242 +20722,136 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the recommendation task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my_task_1', - ], - ], - [ - 'name' => 'SubtaskId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The subtask ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-uf67culrr26q2****', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting field. Valid values for Type:'."\n" - ."\n" - .'* Asc.'."\n" - .'* Desc.'."\n" - ."\n" - .'Valid values for Field:'."\n" - ."\n" - .'* StartTime;'."\n" - .'* EndTime;'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"Type\\": \\"ASC\\", \\"Field\\": \\"StartTime\\"}', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', 'title' => ''], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '57EC6CCA-A582-572C-A33D-F61845CBC03C'], + ], + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"57EC6CCA-A582-572C-A33D-F61845CBC03C\\"\\n}","type":"json"}]', + 'title' => 'DisableAdviceService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableAdviceService'], ], + ], + 'ramActions' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'am-bp1ub9grke1****', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DisableAdviceService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + ], + 'DisableElasticPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'From', + 'name' => 'ElasticPlanName', 'in' => 'query', - 'schema' => [ - 'description' => 'Fixed system value (non-modifiable).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the scaling plan.'."\n" + ."\n" + .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'ActionInner', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Fixed system value (non-modifiable).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'BaseResponse'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'MvRecommendSubTaskModels' => [ - 'description' => 'The list of recommended tasks to be executed.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Execution details of recommended tasks.'."\n", - '$ref' => '#/components/schemas/open_struct_MvRecommendSubTaskModel', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], ], + 'example' => '', ], ], ], '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.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + ], + 'title' => 'DisableElasticPlan', + 'summary' => 'Disables a scaling plan for an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-12-12T10:09:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-13T11:20:15.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableElasticPlan'], ], - 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DisableElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'DescribeMvRecommendSubTasks', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', ], - 'DescribeMVRecommendResults' => [ - 'summary' => 'Retrieves the result of a recommendation task for a materialized view.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DownloadDiagnosisRecords' => [ + 'summary' => 'Downloads the diagnostic information about SQL statements that meet a query condition for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26912,250 +20860,167 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], + 'abilityTreeCode' => '132341', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], ], 'parameters' => [ [ - 'name' => 'SubtaskId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The subtask ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1q8bu9a****', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the recommendation task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'task_n1', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> You can query data only within the last 14 days.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1662364330000', 'title' => ''], ], [ - 'name' => 'SubQueryId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The end of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The end time must be later than the start time.'."\n" + ."\n" + .'* The maximum time range that can be specified is 24 hours.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1662450730000', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'QueryCondition', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The query condition for SQL statements, which can contain the `Type`, `Value`, `Min`, and `Max` fields. Specify the condition in the JSON format. `Type` specifies the query dimension. Valid values for Type: `maxCost`, `status`, and `cost`. `Value`, `Min`, or `Max` specifies the query range for the dimension. Valid values:'."\n" + ."\n" + .'* `{"Type":"maxCost","Value":"100"}`: queries the top 100 most time-consuming SQL statements. Set `Value` to 100.'."\n" + .'* `{"Type":"status","Value":"finished"}`: queries the executed SQL statements. You can set `Value` to `running` to query the SQL statements that are being executed. You can also set Value to `failed` to query the SQL statements that failed to be executed.'."\n" + .'* `{"Type":"cost","Min":"10","Max":"200"}`: queries the SQL statements whose execution duration is in the range of 10 to 200 milliseconds. You can also specify custom values for the Min and Max fields.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"Type":"status","Value":"finished"}', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'am-bp1ub9grke1****', - ], + 'schema' => ['description' => 'The query keyword of the SQL statements.'."\n", 'type' => 'string', 'required' => false, 'example' => 'select', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'MinPeakMemory', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The minimum peak memory of the SQL statements. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '88000000', 'title' => ''], ], [ - 'name' => 'From', + 'name' => 'MaxPeakMemory', 'in' => 'query', - 'schema' => [ - 'description' => 'Fixed system value (non-modifiable).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The maximum peak memory of the SQL statements. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '88000000', 'title' => ''], ], [ - 'name' => 'ActionInner', + 'name' => 'MinScanSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Fixed system value (non-modifiable).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The minimum scan size of the SQL statements. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1073741824', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'MaxScanSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Type": "Desc","Field": "AcceleratedQueriesCount"}', - ], + 'schema' => ['description' => 'The maximum scan size of the SQL statements. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '64424509440', 'title' => ''], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'query', + 'schema' => ['description' => 'The resource group to which the SQL statements belong.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user_default', 'title' => ''], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['description' => 'The username that is used to execute the SQL statements.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisDimensions](~~~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_user', 'title' => ''], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database on which the SQL statements are executed.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => ['description' => 'The source IP address.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", 'type' => 'string', 'required' => false, 'example' => '106.11.XX.XX', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'* **zh**: simplified Chinese.'."\n" + .'* **en**: English.'."\n" + .'* **ja**: Japanese.'."\n" + .'* **zh-tw**: traditional Chinese.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page. Valid values:'."\n" - ."\n" - .'* **30** (default).'."\n" - .'* **50**.'."\n" - .'* **100**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MvRecommendResultModels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/open_struct_MVRecommendResultModel', - ], - ], - ], - ], + 'DownloadId' => ['description' => 'The download ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25494', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '845774AC-5D43-53A2-AAB8-C73828E68508', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - '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.', - ], + ], + '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' => 'DownloadDiagnosisRecords', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-09-13T12:07:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T04:03:32.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DownloadDiagnosisRecords'], ], - 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:DownloadDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - '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' => 'DescribeMVRecommendResults', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", ], - 'DescribeMvRecommendTasks' => [ - 'summary' => '查看物化视图推荐任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DownloadInstanceCACertificate' => [ + 'summary' => 'Retrieves the OSS download path of a CA certificate for connecting to the wide table engine.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -27167,561 +21032,411 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], + 'abilityTreeCode' => '208235', + 'abilityTreeNodes' => ['FEATUREads4DZDZG'], ], 'parameters' => [ - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the recommendation task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my_task_1', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp11q28kvl688****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-wz9842849v6****', 'title' => ''], ], [ - 'name' => 'From', + 'name' => 'Engine', 'in' => 'query', - 'schema' => [ - 'description' => 'Fixed system value (non-modifiable).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The database engine. Valid values:'."\n" + ."\n" + .'- **AnalyticDB** (default): AnalyticDB for MySQL engine.'."\n" + .'- **Clickhouse**: wide table engine.', 'type' => 'string', 'required' => false, 'example' => 'Clickhouse', 'title' => ''], ], [ - 'name' => 'ActionInner', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Fixed system value (non-modifiable).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the supported regions and zones, including region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries that are returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries that are returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'MvRecommendTaskModels' => [ - 'description' => 'The list of recommended tasks for materialized views.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Recommended task details.'."\n", - '$ref' => '#/components/schemas/open_struct_MvRecommendTaskModel', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF'], + 'DownloadUrl' => ['description' => 'The certificate download path.', 'type' => 'string', 'example' => 'https://***/ca.crt', 'title' => ''], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], - 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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' => 'DescribeMvRecommendTasks', - ], - 'CreateMaterializedViewRecommend' => [ - 'summary' => 'Creates a materialized view recommendation task.', - 'methods' => [ - 'post', - 'get', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Retrieve certificate download URL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DownloadInstanceCACertificate'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DownloadInstanceCACertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"DownloadUrl\\": \\"https://***/ca.crt\\"\\n}","type":"json"}]', + ], + 'EnableAdviceService' => [ + 'summary' => 'Enables the suggestion feature.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsTYGUV3', - ], + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-8vbwm***', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1q10xxzq2z4****', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '推荐任务名称', - 'description' => 'The name of the recommendation task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'task_n1', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', 'title' => ''], ], - [ - 'name' => 'SchedulingPolicy', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '推荐的策略，取值"daliy"或"weekly"', - 'description' => 'The scheduling policy of the recommendation task. Valid values:'."\n" - ."\n" - .'daily'."\n" - ."\n" - .'weekly'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'weekly', - 'enum' => [ - 'daily', - 'weekly', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E1745C03-7CCE-55CF-932E-08121AAFA6AF'], ], + 'example' => '', ], ], - [ - 'name' => 'SchedulingDay', - 'in' => 'query', - 'schema' => [ - 'title' => '仅当SchedulingPolicy取值为weekly时有效，取值为：Monday|Tuesday|Wendesday|Thursday|Friday|Saturday|Sunday，多天以逗号分隔符拼接', - 'description' => 'This parameter is valid only when SchedulingPolicy is set to weekly. Valid values:'."\n" - ."\n" - .'* Monday'."\n" - .'* Tuesday'."\n" - .'* Wednesday'."\n" - .'* Thursday'."\n" - .'* Friday'."\n" - .'* Saturday'."\n" - .'* Sunday'."\n" - ."\n" - .'Separate multiple days with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Monday;Wednesday', - ], - ], - [ - 'name' => 'SpecifiedTime', - 'in' => 'query', - 'schema' => [ - 'title' => '任务的执行时间，格式HH:MM:SS', - 'description' => 'The execution time of the recommendation task. Specify the time in the HH:MM:SS format.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10:00:00', - ], - ], - [ - 'name' => 'ScanQueriesRange', - 'in' => 'query', - 'schema' => [ - 'title' => '扫描的时间范围，单位天，默认取值3', - 'description' => 'The time range for scanning data. Unit: days. Default value: 3.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1745C03-7CCE-55CF-932E-08121AAFA6AF\\"\\n}","type":"json"}]', + 'title' => 'EnableAdviceService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableAdviceService'], ], + ], + 'ramActions' => [ [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '推荐任务的描述', - 'description' => 'The description of the recommendation task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'task desc', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:EnableAdviceService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + ], + 'EnableElasticPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SlowQueryThreshold', - 'in' => 'query', - 'schema' => [ - 'title' => '慢查询阈值', - 'description' => '慢查询阈值', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '2', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'MinRewriteQueryPattern', + 'name' => 'ElasticPlanName', 'in' => 'query', - 'schema' => [ - 'title' => '最小可加速的Pattern数量', - 'description' => '最小可加速的Pattern数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '5', - ], + 'schema' => ['description' => 'The name of the scaling plan.'."\n" + ."\n" + .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'MinRewriteQueryCount', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => 'Pattern匹配的最少慢查询个数', - 'description' => 'Pattern匹配的最少慢查询个数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '3', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ACS.ElasticPlan.AutoWorkerPlanExists', 'errorMessage' => 'Failed to enable the elastic plan. The instance already has an active elastic plan.', 'description' => 'Failed to enable the storage scaling plan because the cluster has another storage scaling plan enabled.'], + ['errorCode' => 'ACS.ElasticPlan.WorkerPlanExists', 'errorMessage' => 'Failed to enable the elastic plan. At least one active elastic plan already exists.', 'description' => 'Failed to enable the storage scaling plan because another storage scaling plan has been enabled.'], + ['errorCode' => 'ACS.ElasticPlan.InvalidStartTimeInterval', 'errorMessage' => 'The start time of this elastic plan is too closed to another one.', 'description' => 'The effective time of the scaling plan is close to that of another scaling plan.'], + ['errorCode' => 'ACS.ElasticPlan.InvalidEndTime', 'errorMessage' => 'The end time should be later than current time.', 'description' => 'The end time of scheduled scaling must be later than the 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.', 'description' => 'Failed to enable the elastic plan. The elastic scaling operation cannot be triggered at the configured time today. Make sure that the configured time is later than the earliest available time (current time plus %s minutes for resource preparation).'], + ['errorCode' => 'ACS.ElasticPlan.InvalidTargetSize', 'errorMessage' => 'Invalid target size.', 'description' => 'The target specification is invalid.'], + ['errorCode' => 'ACS.ElasticPlan.InvalidStartTime', 'errorMessage' => 'Invalid start time.', 'description' => 'The start time of the elastic plan is invalid.'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', - 'title' => 'CreateMaterializedViewRecommend', - ], - 'ModifyMaterializedView' => [ - 'summary' => 'Modifies materialized views.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'title' => 'EnableElasticPlan', + 'summary' => 'Enables a scaling plan for an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-06-30T02:18:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-04-13T11:20:17.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableElasticPlan'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:EnableElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + ], + 'ExecuteSparkReplStatement' => [ + 'summary' => 'Executes part of the code in a Spark job.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsTYGUV3', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'title' => 'ADB实例ID', - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-******', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 's202411071444hzdvk486d9d2001****', 'default' => 'ADB-Spark-Application'], ], [ - 'name' => 'ViewName', - 'in' => 'query', - 'schema' => [ - 'title' => '物化视图名称', - 'description' => 'The name of the materialized view.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mv_1', - ], + 'name' => 'Code', + 'in' => 'formData', + 'schema' => ['description' => 'The code that you want to execute.'."\n", 'type' => 'string', 'required' => true, 'example' => 'print(1+1)', 'title' => ''], ], [ - 'name' => 'DbName', - 'in' => 'query', + 'name' => 'CodeType', + 'in' => 'formData', 'schema' => [ - 'title' => '物化视图所在DB名', - 'description' => 'The name of the database where the materialized view resides.'."\n", + 'description' => 'The language type of the code. Valid values:'."\n" + ."\n" + .'* SCALA'."\n" + .'* PYTHON'."\n", 'type' => 'string', 'required' => true, - 'example' => 'myDB', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '物化视图绑定的资源组名称', - 'description' => 'The name of the resource group to which the materialized view is bound.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'res_1', - ], - ], - [ - 'name' => 'QueryWrite', - 'in' => 'query', - 'schema' => [ - 'title' => '启用/禁用重写功能', - 'description' => 'Specifies whether to enable query rewrite. Valid values:'."\n" - ."\n" - .'* true: Enables query rewrite.'."\n" - .'* false: Disables query rewrite.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'EnableFailureAlert', - 'in' => 'query', - 'schema' => [ - 'title' => '开启刷新任务失败告警', - 'description' => 'Specifies whether to send alerts when the refresh task fails. Valid values:'."\n" - ."\n" - .'* true: Send alerts.'."\n" - .'* false: Alerts disabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'EnableDelayAlert', - 'in' => 'query', - 'schema' => [ - 'title' => '开启刷新延迟告警', - 'description' => 'Enable the refresh delay alert. Valid values:'."\n" - ."\n" - .'* true: Enables alert.'."\n" - .'* false: Disables alert.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'enumValueTitles' => [], + 'example' => 'PYTHON', + 'title' => '', ], ], [ - 'name' => 'LatencyTolerance', - 'in' => 'query', - 'schema' => [ - 'title' => '刷新延迟容忍度（分钟）', - 'description' => 'Refresh delay tolerance (in minutes).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the session that you want to use to execute the code.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'CF8BA882-C9D8-5BEF-AAA3-AD03875F3E18', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'StatementId' => ['description' => 'The unique ID of the code block in the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Code' => ['description' => 'The code that is executed.'."\n", 'type' => 'string', 'example' => 'print(1+1)', 'title' => ''], + 'CodeType' => [ + 'description' => 'The code type. Valid values:'."\n" + ."\n" + .'* SCALA'."\n" + .'* PYTHON'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PYTHON', + 'title' => '', + ], + 'CodeState' => [ + 'description' => 'The code execution status. Valid values:'."\n" + ."\n" + .'* CANCELLED'."\n" + .'* RUNNING'."\n" + .'* SUCCEEDED'."\n" + .'* ERROR'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RUNNING', + 'title' => '', + ], + 'AliyunUid' => ['description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '17108278707****', 'title' => ''], + 'OutputType' => [ + 'description' => 'The execution result type, which is in the JSON format. Valid values:'."\n" + ."\n" + .'* TEXT: the text content that conforms to Apache Livy.'."\n" + .'* TABLE: the table content that conforms to Apache Livy.'."\n", + 'type' => 'string', + 'enumValueTitles' => ['TABLE' => '', 'TEXT' => ''], + 'example' => 'TEXT', + 'title' => '', + ], + 'Output' => ['description' => 'The code execution result, which is a JSON string that conforms to Apache Livy.'."\n", 'type' => 'string', 'example' => '{"text/plain": 2}', 'title' => ''], + 'Columns' => [ + 'description' => 'The column names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The column name.'."\n", 'type' => 'string', 'example' => 'col1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Error' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'StackOverflow Exception', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1730968125000', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1730968125000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.App.ExceedQuotaLimitation', 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', 'description' => ''], + ['errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', 'description' => 'The AppType type is illegal, please refer to using the document to specify the AppType suitable for your business.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ResourceNegativeError', 'errorMessage' => 'The requested resource MUST be positive: %s', 'description' => ''], + ['errorCode' => 'Spark.Config.InvalidAppFilePath', 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', 'description' => 'The main driver file address must be a valid OSS address. The current address is %s.'], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidDiskConfig', 'errorMessage' => 'The requested disk mount parameter is invalid: %s', 'description' => 'The disk mount configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidHostAliasConfig', 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', 'description' => 'The domain name mapping configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidLogOssPath', 'errorMessage' => 'The OSS address for log storage is illegal: %s', 'description' => 'The OSS address for storing logs is invalid.'], + ['errorCode' => 'Spark.Config.InvalidRoleArnFormat', 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', 'description' => 'The configured RoleARN format is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidTimeZone', 'errorMessage' => 'Unable to parse time zone configuration %s : %s', 'description' => 'The time zone configuration is incorrect.'], + ['errorCode' => 'Spark.Config.MainAppFileNotExists', 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', 'description' => 'The main driver file is missing. The file or sqls configuration must not be empty.'], + ['errorCode' => 'Spark.Config.OSSPathAccessError', 'errorMessage' => 'The configured OSS address %s cannot be accessed.', 'description' => 'The configured OSS path is inaccessible.'], + ['errorCode' => 'Spark.Config.OSSPathNotExists', 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', 'description' => 'The OSS path does not exist or the current user does not have permission to access it.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Config.SecurityGroupNotFound', 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.'], + ['errorCode' => 'Spark.Config.VswitchNotFound', 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured vSwitch cannot be found, or the current account has insufficient permissions. %s.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.BlankError', 'errorMessage' => 'Input sql can not be blank string.', 'description' => 'The submitted SQL statement cannot be empty.'], + ['errorCode' => 'Spark.SQL.MultipleSQLError', 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', 'description' => 'The submitted Spark SQL contains multiple executable SQL statements.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.App.NotFound', 'errorMessage' => 'The Spark application %s is not found.', 'description' => 'The specified Spark application was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF8BA882-C9D8-5BEF-AAA3-AD03875F3E18\\"\\n}","type":"json"}]', - 'title' => 'ModifyMaterializedView', - ], - 'ModifyMaterializedViewRecommend' => [ - 'summary' => 'Modifies a materialized view recommendation task.', - 'methods' => [ - 'get', - 'post', + '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' => 'ExecuteSparkReplStatement', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteSparkReplStatement'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:ExecuteSparkReplStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}'], + ], + ], + ], ], + ], + 'ExecuteSparkWarehouseBatchSQL' => [ + 'summary' => 'Executes Spark SQL statements in batches.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => [], 'security' => [ [ 'AK' => [], @@ -27730,276 +21445,311 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsTYGUV3', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '235566', + 'abilityTreeNodes' => ['FEATUREadsCQJTKP'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'name' => 'Agency', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the client.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Dataworks。', 'default' => 'POPSDK', 'title' => ''], ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-uf6o*****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'title' => '推荐任务名称', - 'description' => 'The name of the recommendation task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'task_n1', - ], + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'SchedulingPolicy', - 'in' => 'query', - 'schema' => [ - 'title' => '推荐的策略，取值"daliy"或"weekly"', - 'description' => 'The scheduling policy of the recommendation task. Valid values:'."\n" - ."\n" - .'* daily'."\n" - .'* weekly'."\n" - ."\n" - .''."\n" - ."\n" - .'*'."\n" - .'*'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'weekly', - 'enum' => [ - 'daily', - 'weekly', - ], - ], + 'name' => 'Query', + 'in' => 'formData', + 'schema' => ['description' => 'The SQL statements that you want to execute in batches. Separate multiple SQL statements with semicolons (;). The execution engine executes the SQL statements in sequence in the same session.', 'type' => 'string', 'required' => true, 'example' => 'CREATE TABLE user(id INT, name STRING);'."\n" + .'INSERT INTO t VALUE(1, \'Bob\');'."\n" + .'SELECT * FROM t;', 'title' => ''], ], [ - 'name' => 'SchedulingDay', - 'in' => 'query', - 'schema' => [ - 'title' => '仅当SchedulingPolicy取值为weekly时有效，取值为：Monday|Tuesday|Wendesday|Thursday|Friday|Saturday|Sunday，多天以逗号分隔符拼接', - 'description' => 'This parameter is valid only when SchedulingPolicy is set to weekly. Valid values:'."\n" - ."\n" - .'* Monday'."\n" - .'* Tuesday'."\n" - .'* Wednesday'."\n" - .'* Thursday'."\n" - .'* Friday'."\n" - .'* Saturday'."\n" - .'* Sunday'."\n" - ."\n" - .'Separate multiple days with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Monday;Wednesday', - ], + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], ], [ - 'name' => 'SpecifiedTime', - 'in' => 'query', - 'schema' => [ - 'title' => '任务的执行时间，格式HH:MM:SS', - 'description' => 'The execution time of the recommendation task. Specify the time in the HH:MM:SS format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10:00:00', - ], + 'name' => 'ExecuteResultLimit', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum amount of execution result data that can be written to Object Storage Service (OSS). Unit: MB. Default value: 4096. The size of compressed objects is difficult to estimate. The data that is actually written to OSS is smaller than the specified value.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4096', 'default' => '1000', 'title' => ''], ], [ - 'name' => 'ScanQueriesRange', - 'in' => 'query', - 'schema' => [ - 'title' => '扫描的时间范围，单位天，默认取值3', - 'description' => 'The time range for scanning data. Unit: days. Default value: 3.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'name' => 'ExecuteTimeLimitInSeconds', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum execution duration. Unit: seconds. If a set of SQL statements fail to be executed for the specified period of time after submission, they are marked as a timeout error. The default value is 360000 seconds, which is equivalent to 100 hours.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600000', 'default' => '604800', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '推荐任务的描述', - 'description' => 'The description of the recommendation task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'task desc', - ], + 'name' => 'RuntimeConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The additional runtime parameter. Specify the parameter in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "OSSURL": "oss://testBucketname/"'."\n" + .'}', 'title' => ''], ], - [ - 'name' => 'SlowQueryThreshold', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '慢查询阈值', - 'description' => '慢查询阈值', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '2', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CBE843D8-964D-5EA3-9D31-822125611B6E'], + 'Data' => ['description' => 'The returned data.'."\n", 'example' => 'true', '$ref' => '#/components/schemas/SparkBatchSQL', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + 404 => [ + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBE843D8-964D-5EA3-9D31-822125611B6E\\",\\n \\"Data\\": {\\n \\"Uid\\": 0,\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"Query\\": \\"SELECT * FROM db.tb\\",\\n \\"QueryId\\": \\"sq172352176****\\",\\n \\"Schema\\": \\"default\\",\\n \\"QueryEndTime\\": 1723521767000,\\n \\"DBClusterId\\": \\"amv-bp17s73f016****\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"sq1723521767****-0001\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"+---+-----+\\\\n|age| name|\\\\n+---+-----+\\\\n| 14| Tom|\\\\n| 23|Alice|\\\\n+---+-----+\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\",\\n \\"QueryStartTime\\": 1723521767000,\\n \\"ResourceGroupName\\": \\"spark_rg\\"\\n }\\n}","type":"json"}]', + 'title' => 'ExecuteSparkWarehouseBatchSQL', + '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错误，请联系技术支持。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteSparkWarehouseBatchSQL'], + ], + ], + 'ramActions' => [ [ - 'name' => 'MinRewriteQueryPattern', - 'in' => 'query', - 'schema' => [ - 'title' => '最小可加速的Pattern数量', - 'description' => '最小可加速的Pattern数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '5', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:ExecuteSparkWarehouseBatchSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ExistRunningSQLEngine' => [ + 'summary' => 'Queries whether a running SQL engine exists.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MinRewriteQueryCount', - 'in' => 'query', - 'schema' => [ - 'title' => 'Pattern匹配的最少慢查询个数', - 'description' => 'Pattern匹配的最少慢查询个数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '3', - ], + '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' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1cit7z8j****', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the name of the resource group for a cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'spark_test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FA675D68-14A4-5D9C-8820-92537D9F447E', 'title' => ''], + 'Data' => [ + 'description' => 'Indicates whether a running SQL engine exists in the resource group.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **True**'."\n" + .'* **False**'."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['True' => 'True', 'False' => 'False'], + 'example' => 'True', + 'title' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\"\\n}","type":"json"}]', - 'title' => 'ModifyMaterializedViewRecommend', - ], - 'DeleteMaterializedViewRecommend' => [ - 'summary' => 'Deletes a materialized view recommendation task.', - 'methods' => [ - 'post', - 'get', + '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' => 'ExistRunningSQLEngine', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-05-06T03:09:35.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExistRunningSQLEngine'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetActiveSparkSession', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], + ], + ], + ], ], + ], + 'GenerateSqlBySemanticSql' => [ + 'summary' => 'Generates an executable SQL statement from a semantic SQL statement.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsTYGUV3', - ], + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the ADB cluster.', 'type' => 'string', 'required' => true, 'example' => 'am-uf6wjk5xxxxxxxxxx'], ], [ - 'name' => 'DBClusterId', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-uf66*****', - ], + 'schema' => ['title' => '', 'description' => 'The schema name.', 'type' => 'string', 'example' => 'adb_demo', 'required' => false], ], [ - 'name' => 'TaskName', + 'name' => 'Sql', 'in' => 'query', - 'schema' => [ - 'title' => '推荐任务名称', - 'description' => 'The name of the recommendation task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_task_1', - ], + 'schema' => ['title' => '', 'description' => 'The SQL statement that queries the semantic view.', 'type' => 'string', 'required' => true, 'example' => 'select sum(amount) from sv_sales'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '7B081A85-0568-5E54-82EF-6958C4A3D4B4', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => [ + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'GeneratedSql' => ['title' => '', 'description' => 'The generated executable SQL statement.', 'type' => 'string', 'example' => 'select sum(amount) from orders'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the generation request was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['title' => '', 'description' => 'The error message returned when the task fails to be created.', 'type' => 'string', 'example' => 'Failed to rewrite semantic SQL: Ambiguous path from \'lineitem\' to \'nation\'. Multiple paths found'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B081A85-0568-5E54-82EF-6958C4A3D4B4\\"\\n}","type":"json"}]', - 'title' => 'DeleteMaterializedViewRecommend', - ], - 'DescribeInclinedTables' => [ - 'summary' => 'Queries the information about skewed tables for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ['errorCode' => 'MDS.CatalogAlreadyExist', 'errorMessage' => 'The catalog already exists.', 'description' => 'Catalog already exists'], + ['errorCode' => 'MDS.SemanticViewNotExist', 'errorMessage' => 'This semantic view does not exist.', 'description' => 'This semantic view does not exist'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + [ + ['errorCode' => 'MDS.InstanceNotExist', 'errorMessage' => 'ADB instance does not exist.', 'description' => 'ADB instance does not exist'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Generate executable SQL from semantic SQL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"GeneratedSql\\": \\"select sum(amount) from orders\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"Failed to rewrite semantic SQL: Ambiguous path from \'lineitem\' to \'nation\'. Multiple paths found\\"\\n }\\n}","type":"json"}]', + ], + 'GetADBSparkNecessaryRAMPermissions' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28011,475 +21761,383 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '186716', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-k2jofo4pi5zhd****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n" + .'> Call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all clusters in a specific region.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp1r053byu48p****'."\n", 'title' => ''], ], - [ - 'name' => 'TableType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the table. Valid values:'."\n" - ."\n" - .'* **FactTable**: the partitioned table.'."\n" - .'* **DimensionTable**: the dimension table.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'FactTable', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '642F3512-C628-5D0C-8815-F6670C****'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Passed' => ['description' => 'Indicates whether the current user has the basic permissions to use ADB Spark. Valid values:'."\n" + ."\n" + .'- true: The check is passed. The user has the basic permissions.'."\n" + .'- false: The check failed. The user is missing some permissions.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DeniedDetail' => [ + 'description' => 'The diagnostic information returned when the permission check fails.', + 'type' => 'object', + 'properties' => [ + 'ResourceOwnerId' => ['description' => 'The ID of the resource owner.', 'type' => 'string', 'example' => '11685695632****', 'title' => ''], + 'Action' => ['description' => 'The name of the RAM action for which authentication failed.', 'type' => 'string', 'example' => 'ListSparkApps', 'title' => ''], + 'PrincipalType' => ['description' => 'The identity type of the current user. Valid values:'."\n" + .'- SubUser: Resource Access Management (RAM) user.'."\n" + .'- AssumedRoleUser: RAM role.', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], + 'ResourceAuthTargetInfo' => ['description' => 'The information about the authentication target, which can be the Resource Access Management (RAM) users ID of the current user or the role information of the current accessor.', 'type' => 'string', 'example' => '223345695632****'."\n", 'title' => ''], + 'PolicyType' => ['description' => 'The type of the policy that caused the permission denial. Valid values:'."\n" + .'- ControlPolicy: control policy.'."\n" + .'- SessionPolicy: an additional permission policy attached to a temporary token.'."\n" + .'- AssumeRolePolicy: the trust policy of a RAM role.'."\n" + .'- AccountLevelIdentityBasedPolicy: an identity-access policy at the account authorization scope, including custom policies and system policies.'."\n" + .'- ResourceGroupLevelIdentityBasedPolicy: an identity-access policy at the resource group authorization scope, including custom policies and system policies.', 'type' => 'string', 'example' => 'ControlPolicy', 'title' => ''], + 'NoPermissionType' => ['description' => 'The type of access policy denial. Valid values:'."\n" + .'- ImplicitDeny: The resource owner has not configured a relevant access policy for the current user. Unauthorized operations are denied by default.'."\n" + .'- ExplicitDeny: The RAM policy configured by the resource owner explicitly denies the current user authorization to access the corresponding resource.', 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Suggestion' => ['description' => 'The recommended RAM configuration based on the diagnostic information.', 'type' => 'string', 'example' => 'Grant the system RAM policy \'AliyunADBDeveloperAccess\' to current RAM user can quickly solve this issue.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Spark parameter is not valid, please check error info: %s.', 'description' => 'Spark parameter error, error message: %s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'View the basic spark permission diagnostic report for the current user', + 'summary' => 'Queries the basic permission diagnostic report of the current user for Spark.', + 'description' => 'The API diagnostic report contains all the permissions required by the current user for ADB Spark-related features. The scope of the permission check may exceed the minimum requirements of your business. This API is used for quick initialization of the ADB Spark environment. To configure fine-grained permissions, [refer to the ADB Spark fine-grained permission configuration documentation.](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)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetADBSparkNecessaryRAMPermissions'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON format.'."\n" - ."\n" - .'Example:'."\n" - ."\n" - .' ['."\n" - ."\n" - .' {'."\n" - ."\n" - .' "Field":"Name",'."\n" - ."\n" - .' "Type":"Asc"'."\n" - ."\n" - .' }'."\n" - ."\n" - .' ]'."\n" - ."\n" - .'Field specifies the field by which to sort the query results. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.'."\n" - ."\n" - .'Field and Type are case-insensitive.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[ { "Field":"Name", "Type":"Asc" } ]', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetADBSparkNecessaryRAMPermissions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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"}]', + ], + 'GetCreateTableSQL' => [ + 'summary' => 'Queries the table creation statement for tables.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => [], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '30', - 'default' => '30', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212744', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + ], + 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-2ze8mbuai974s4y2', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hongkong', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* **zh (default)**: simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '15', - ], - 'PageSize' => [ - 'description' => 'The total number of pages.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'The queried tables.'."\n", - 'type' => 'object', - 'properties' => [ - 'Table' => [ - 'description' => 'The queried table.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the table.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The detection type of the table.'."\n", - 'type' => 'string', - 'example' => 'Fact', - ], - 'Schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'spark_test', - ], - 'Size' => [ - 'description' => 'The number of rows in the table.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Name' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'admin_daily_own_statistic_record', - ], - 'IsIncline' => [ - 'description' => 'Indicates whether data is skewed in the table.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'TotalSize' => [ - 'description' => 'The total data size of the table. Unit: bytes.'."\n" - ."\n" - .'> The following formulas can be used to calculate the total data size:'."\n" - ."\n" - .'* Formula 1: Total data size = Hot data size + Cold data size.'."\n" - .'* Formula 2: Total data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '53687091200', - ], - 'SpaceRatio' => [ - 'description' => 'The percentage of the table size. Unit: %.'."\n" - ."\n" - .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.4', - ], - 'RowCount' => [ - 'description' => 'The number of rows in the table.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - ], - ], - ], - 'DetectionItems' => [ - 'description' => 'The queried detection items and detection results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detection result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the detection item.'."\n", - 'type' => 'string', - 'example' => 'Table skew', - ], - 'Message' => [ - 'description' => 'The message of the detection result.'."\n", - 'type' => 'string', - 'example' => 'A shard skew is detected in a table.', - ], - 'Status' => [ - 'description' => 'The severity level of the detection result.'."\n", - 'type' => 'string', - 'example' => 'NORMAL'."\n" - .'WARNNING'."\n" - .'CRITICAL', - ], - ], - ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", - '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" - .'}', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '109462AF-B5FA-3D5A-9377-B27E5B******'], + 'SQL' => ['description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'create table ('."\n" + .' id varchar(32)'."\n" + .');', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + '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' => 'GetCreateTableSQL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCreateTableSQL'], + ], ], - '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' => 'DescribeInclinedTables', - ], - 'DescribeAdbMySqlColumns' => [ - 'summary' => 'Queries the information about table columns for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'get', - 'post', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetCreateTableSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + ], + 'GetDatabaseObjects' => [ + 'summary' => 'Queries the information about databases.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The order in which you want to sort the query results. Valid values:'."\n" + ."\n" + .'* Asc'."\n" + .'* Desc'."\n" + ."\n" + .'Valid values for Field: DatabaseName, CreateTime, and UpdateTime. -CreateTime; -UpdateTime;'."\n" + ."\n" + .'Default value: {"Type": "Desc","Field": "DatabaseName"}.'."\n", 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "Type": "Desc",'."\n" + .' "Field": "DatabaseName"'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'FilterSchemaName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* 30'."\n" + .'* 50'."\n" + .'* 100'."\n" + ."\n" + .'Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1r053byu48p****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'am-bp1565u55p32****', 'title' => ''], ], [ - 'name' => 'Schema', + 'name' => 'FilterOwner', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - 'default' => 'INFORMATION_SCHEMA', - ], + 'schema' => ['description' => 'The owner of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'default' => 'COLUMNS', - ], + 'schema' => ['description' => 'The region ID of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned for the operation. Valid values:'."\n" - ."\n" - .'* **Success** is returned if the operation is successful.'."\n" - .'* An error message is returned if the operation fails.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A9F013CD-0222-595E-8157-445969B97F03', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" - ."\n" - .'* **true**: The operation is successful.'."\n" - .'* **false**: The operation fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ColumnCount' => [ - 'description' => 'The total number of columns.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Columns' => [ - 'description' => 'Details of the columns.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The data type of the column.'."\n", - 'type' => 'string', - 'example' => 'bigint', - ], - 'Name' => [ - 'description' => 'The name of the column.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'Comment' => [ - 'description' => 'The comments of the column.'."\n", - 'type' => 'string', - 'example' => 'test', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '863D51B7-5321-41D8-A0B6-A088B0******'], + 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatabaseSummaryModels' => [ + 'description' => 'The queried databases.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried database.'."\n", '$ref' => '#/components/schemas/DatabaseSummaryModel', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* 30'."\n" + .'* 50'."\n" + .'* 100'."\n" + ."\n" + .'Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'DescribeAdbMySqlColumns', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the 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\\": \\"abc\\",\\n \\"SchemaName\\": \\"testSchema\\",\\n \\"Description\\": \\"description\\",\\n \\"CreateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"UpdateTime\\": \\"2023-01-05 13:17:55\\",\\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' => 'GetDatabaseObjects', 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeAdbMySqlTables' => [ - 'summary' => 'Queries a list of tables for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:07.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-10-25T05:36:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-22T02:16:06.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabaseObjects'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getDatabaseObjectsByFilter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'GetFormationCrawler' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'abilityTreeCode' => '138256', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ [ 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the supported regions and zones, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'CrawlerTaskName', + 'in' => 'formData', + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => 'test-crawler-dbname', 'title' => ''], ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1xxxxxxxx47', 'title' => ''], ], [ - 'name' => 'Schema', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - 'default' => 'INFORMATION_SCHEMA', - ], + 'name' => 'CrawlerTaskId', + 'in' => 'formData', + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '247', 'title' => ''], ], ], 'responses' => [ @@ -28487,151 +22145,197 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The message returned for the operation. Valid values:'."\n" - ."\n" - .'* **Success** is returned if the operation is successful.'."\n" - .'* An error message is returned if the operation fails.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7A7D49E3-5585-5DF8-B62C-75C46B4991DC', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" - ."\n" - .'* **true**: The operation is successful.'."\n" - .'* **false**: The operation fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - 'Tables' => [ - 'description' => 'The names of tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '{'."\n" + .' "crawlerInfo":{'."\n" + .' "scheduleState":"NORMAL",'."\n" + .' "configuration":{},'."\n" + .' "gmtCreated":"2026-07-08T09:05:25.000+00:00",'."\n" + .' "dbName":"sales_db",'."\n" + .' "schemaChangePolicy":{'."\n" + .' "deleteRule":"IGNORE",'."\n" + .' "updateRule":"ONLY_ADD_COLUMN"'."\n" + .' },'."\n" + .' "frequency":{'."\n" + .' "cron":"",'."\n" + .' "type":"run_on_demand"'."\n" + .' },'."\n" + .' "uid":"**",'."\n" + .' "sourceInfo":{'."\n" + .' "ossSourceInfo":{'."\n" + .' "sourceMode":"WAREHOUSE",'."\n" + .' "ossLocations":['."\n" + .' "oss://test-bucket/***/***/"'."\n" + .' ],'."\n" + .' "exclusions":[],'."\n" + .' "inclusions":[]'."\n" + .' }'."\n" + .' },'."\n" + .' "failedCount":0,'."\n" + .' "dbClusterId":"am-bp1xxxxxxxx47",'."\n" + .' "sourceType":"OSSWAREHOUSE",'."\n" + .' "classifiers":[],'."\n" + .' "taskName":"[\\"oss://test-bucket/***/***/\\"] -> sales_db",'."\n" + .' "id":36'."\n" + .' },'."\n" + .' "success":true'."\n" + .'}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message. OK is returned if the call was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeAdbMySqlTables', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeAdbMySqlSchemas' => [ - 'summary' => 'Queries a list of databases for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid. ', 'description' => ''], + ['errorCode' => 'NotExists', 'errorMessage' => 'The formation task does not exist. ', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Query metadata discovery task details', + 'summary' => 'Queries the details of a metadata discovery task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{\\\\n \\\\\\"crawlerInfo\\\\\\":{\\\\n \\\\\\"scheduleState\\\\\\":\\\\\\"NORMAL\\\\\\",\\\\n \\\\\\"configuration\\\\\\":{},\\\\n \\\\\\"gmtCreated\\\\\\":\\\\\\"2026-07-08T09:05:25.000+00:00\\\\\\",\\\\n \\\\\\"dbName\\\\\\":\\\\\\"sales_db\\\\\\",\\\\n \\\\\\"schemaChangePolicy\\\\\\":{\\\\n \\\\\\"deleteRule\\\\\\":\\\\\\"IGNORE\\\\\\",\\\\n \\\\\\"updateRule\\\\\\":\\\\\\"ONLY_ADD_COLUMN\\\\\\"\\\\n },\\\\n \\\\\\"frequency\\\\\\":{\\\\n \\\\\\"cron\\\\\\":\\\\\\"\\\\\\",\\\\n \\\\\\"type\\\\\\":\\\\\\"run_on_demand\\\\\\"\\\\n },\\\\n \\\\\\"uid\\\\\\":\\\\\\"**\\\\\\",\\\\n \\\\\\"sourceInfo\\\\\\":{\\\\n \\\\\\"ossSourceInfo\\\\\\":{\\\\n \\\\\\"sourceMode\\\\\\":\\\\\\"WAREHOUSE\\\\\\",\\\\n \\\\\\"ossLocations\\\\\\":[\\\\n \\\\\\"oss://test-bucket/***/***/\\\\\\"\\\\n ],\\\\n \\\\\\"exclusions\\\\\\":[],\\\\n \\\\\\"inclusions\\\\\\":[]\\\\n }\\\\n },\\\\n \\\\\\"failedCount\\\\\\":0,\\\\n \\\\\\"dbClusterId\\\\\\":\\\\\\"am-bp1xxxxxxxx47\\\\\\",\\\\n \\\\\\"sourceType\\\\\\":\\\\\\"OSSWAREHOUSE\\\\\\",\\\\n \\\\\\"classifiers\\\\\\":[],\\\\n \\\\\\"taskName\\\\\\":\\\\\\"[\\\\\\\\\\\\\\"oss://test-bucket/***/***/\\\\\\\\\\\\\\"] -> sales_db\\\\\\",\\\\n \\\\\\"id\\\\\\":36\\\\n },\\\\n \\\\\\"success\\\\\\":true\\\\n}\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'GetLakeStorage' => [ + 'summary' => 'Queries a lake storage.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'abilityTreeCode' => '216924', + 'abilityTreeNodes' => ['FEATUREadsQO9FPM'], ], 'parameters' => [ [ 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'LakeStorageId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The lake storage ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '-'], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1r053byu48p****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-*******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request was successful, a **success** message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Schemas' => [ - 'description' => 'The queried databases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo,adb_test,mysql', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-******-9F06-******'], + 'Data' => [ + 'description' => 'The queried lake storage.'."\n", + 'type' => 'object', + 'properties' => [ + 'LakeStorageId' => ['title' => '', 'description' => 'The unique identifier of the lake storage.'."\n", 'type' => 'string', 'example' => '-'], + 'Description' => ['title' => '', 'description' => 'The description of the lake storage.'."\n", 'type' => 'string', 'example' => 'a test db'], + 'DBClusterId' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", 'type' => 'string', 'example' => 'amv-*******'], + 'FileSize' => ['title' => '', 'description' => 'The total storage size.'."\n", 'type' => 'string', 'example' => '1'], + 'RowCount' => ['title' => '', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '-', 'pattern' => '', 'default' => ''], + 'TableCount' => ['title' => '', 'description' => 'The number of the tables.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '-', 'pattern' => '', 'default' => ''], + 'PartitionCount' => ['description' => 'The number of partitions.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'CreatorUid' => ['title' => '', 'description' => 'The creator UID.'."\n", 'type' => 'string', 'example' => '123456'], + 'OwnerUid' => ['title' => '', 'description' => 'The owner UID.'."\n", 'type' => 'string', 'example' => '123456'], + 'OperatorUid' => ['title' => '', 'description' => 'The operator UID.'."\n", 'type' => 'string', 'example' => '123456'], + 'Permissions' => [ + 'title' => '', + 'description' => 'The permissions on the lake storage.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The permissions.'."\n", + 'type' => 'object', + 'properties' => [ + 'Read' => ['title' => '', 'description' => 'The read permissions.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Write' => ['title' => '', 'description' => 'The write permissions.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Account' => ['title' => '', 'description' => 'The account ID.'."\n", 'type' => 'string', 'example' => 'test', 'pattern' => '^\\d+$', 'default' => ''], + 'Type' => [ + 'title' => '', + 'description' => 'The account type.'."\n", + 'type' => 'string', + 'example' => '-', + 'enum' => ['CUSTOMER', 'SUB', 'STS'], + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + 'CreateTime' => ['title' => '', 'description' => 'The time when the lake storage was created.'."\n", 'type' => 'string', 'example' => '2023-05-15T07:24:58Z'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the lake storage was last updated.'."\n", 'type' => 'string', 'example' => '2024-10-14T02:28:41Z'], + 'RegionId' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], ], + 'example' => '-', + 'title' => '', ], + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - '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' => 'DescribeAdbMySqlSchemas', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeTableAccessCount' => [ - 'summary' => 'Queries the number of accesses to a table or all tables in an AnalyticDB for MySQL cluster on a date.', - 'methods' => [ - 'post', - 'get', + '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' => 'GetLakeStorage', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLakeStorage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetLakeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetSemanticView' => [ + 'summary' => 'Retrieves the details of a semantic view.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28640,111 +22344,26 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-2ze627uzpkh8a8****', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n" - ."\n" - .'> If you leave this parameter empty, the number of accesses to all tables in the cluster on a date is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CUSTOMER', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" - ."\n" - .'> Only data within the last 30 days can be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-09-25T12:10:00Z', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON string format. Example: `[{"Field":"TableSchema","Type":"Asc"}]`. Fields in the request parameter:'."\n" - ."\n" - .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" - ."\n" - .' * `TableSchema`: the name of the database to which the table belongs.'."\n" - .' * `TableName`: the name of the table.'."\n" - .' * `AccessCount`: the number of accesses to the table.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values:'."\n" - ."\n" - .' * `Asc`: ascending order.'."\n" - .' * `Desc`: descending order.'."\n" - ."\n" - .'> If you do not specify this parameter, query results are sorted in ascending order based on the database and the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Field":"TableSchema","Type":"Asc"}]', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp1d8lbdj22rx****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **10** (default)'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The name of the schema.', 'type' => 'string', 'required' => true, 'example' => 'adb_demo', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ViewName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the semantic view.', 'type' => 'string', 'required' => true, 'example' => 'sv_name', 'title' => ''], ], ], 'responses' => [ @@ -28752,87 +22371,51 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6B7D627B-DA23-572D-AD71-256F64698B7D', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'The queried tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReportDate' => [ - 'description' => 'The date when the table was accessed.'."\n", - 'type' => 'string', - 'example' => '2022-09-26', - ], - 'TableSchema' => [ - 'description' => 'The database to which the table belongs.'."\n", - 'type' => 'string', - 'example' => 'tpch', - ], - 'AccessCount' => [ - 'description' => 'The number of accesses to the table.'."\n", - 'type' => 'string', - 'example' => '6', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'CUSTOMER', - ], - 'InstanceName' => [ - 'description' => 'The ID of the cluster to which the table belongs.'."\n", - 'type' => 'string', - 'example' => 'amv-2ze627uzpkh8a8****', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Data' => ['description' => 'The details of the semantic view.', 'example' => '69', '$ref' => '#/components/schemas/SemanticViewModel', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'description' => 'The returned data.', + 'example' => '', ], ], ], - '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' => 'DescribeTableAccessCount', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'GetViewDDL' => [ - 'summary' => 'Queries the statement that is used to create a view.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.CatalogAlreadyExist', 'errorMessage' => 'The catalog already exists.', 'description' => 'Catalog already exists'], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ['errorCode' => 'MDS.SemanticViewNotExist', 'errorMessage' => 'This semantic view does not exist.', 'description' => 'This semantic view does not exist'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + [ + ['errorCode' => 'MDS.InstanceNotExist', 'errorMessage' => 'ADB instance does not exist.', 'description' => 'ADB instance does not exist'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetSemanticView', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"ViewSchema\\": \\"sales_db\\",\\n \\"Definition\\": \\"name: revenue_analysis\\\\ndescription: \\\\\\"Semantic view for analyzing revenue across products and customers\\\\\\"\\\\n\\\\ntables:\\\\n - name: customers\\\\n description: \\\\\\"Customer information\\\\\\"\\\\n base_table:\\\\n schema: sales_db\\\\n table: customers\\\\n dimensions:\\\\n - name: customer_name\\\\n synonyms: [\\\\\\"client name\\\\\\", \\\\\\"customer\\\\\\"]\\\\n description: \\\\\\"Full name of the customer\\\\\\"\\\\n expr: c_name\\\\n data_type: VARCHAR\\\\n - name: customer_segment\\\\n synonyms: [\\\\\\"segment\\\\\\", \\\\\\"market segment\\\\\\"]\\\\n description: \\\\\\"Customer market segment\\\\\\"\\\\n expr: c_mktsegment\\\\n data_type: VARCHAR\\\\n is_enum: true\\\\n\\\\n - name: orders\\\\n description: \\\\\\"Order information\\\\\\"\\\\n base_table:\\\\n schema: sales_db\\\\n table: orders\\\\n dimensions:\\\\n - name: order_date\\\\n description: \\\\\\"Date when order was placed\\\\\\"\\\\n expr: o_orderdate\\\\n data_type: DATE\\\\n - name: order_year\\\\n description: \\\\\\"Year when order was placed\\\\\\"\\\\n expr: YEAR(o_orderdate)\\\\n data_type: NUMBER\\\\n facts:\\\\n - name: order_total\\\\n description: \\\\\\"Total order amount\\\\\\"\\\\n expr: o_totalprice\\\\n data_type: NUMBER\\\\n metrics:\\\\n - name: total_orders\\\\n description: \\\\\\"Total number of orders\\\\\\"\\\\n expr: COUNT(*)\\\\n - name: total_revenue\\\\n description: \\\\\\"Total revenue of orders\\\\\\"\\\\n expr: SUM(o_totalprice)\\\\n - name: average_order_value\\\\n description: \\\\\\"Average order value\\\\\\"\\\\n expr: AVG(o_totalprice)\\\\n\\\\nrelationships:\\\\n - name: orders_to_customers\\\\n left_table: orders\\\\n right_table: customers\\\\n relationship_columns:\\\\n - left_column: o_custkey\\\\n right_column: c_custkey\\\\n\\\\nmetrics:\\\\n - name: revenue_per_customer\\\\n description: \\\\\\"Average revenue per customer\\\\\\"\\\\n expr: orders.total_revenue / customers.customer_count\\\\n\\",\\n \\"ViewName\\": \\"revenue_analysis\\",\\n \\"Comment\\": \\"这是一个定义销售额相关指标的视图\\",\\n \\"Score\\": 0.81\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetSparkAppAttemptLog' => [ + 'summary' => 'Queries the information about the retry log of a Spark application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28840,142 +22423,103 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '157089', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'SchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], + 'name' => 'AttemptId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the log.'."\n" + ."\n" + .'> You can call the [ListSparkAppAttempts](~~455887~~) operation to query the information about the retry attempts of a Spark application, including the retry log IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202207151211hz****-0001', 'maxLength' => 72], ], [ - 'name' => 'ViewName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the view.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v_modbus', - ], + 'name' => 'LogLength', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The number of log entries to return. Valid values: 1 to 500. Default value: 300.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '20', 'default' => '300'], ], [ - 'name' => 'DBClusterId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1ub9grke1****', - ], + 'schema' => ['title' => '', 'description' => 'The log offset.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'RegionId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page.'."\n", 'type' => 'string', 'required' => false, 'example' => '500', 'default' => '100000'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', - ], - 'SQL' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'example' => 'CREATE VIEW `test`.`test_view` AS SELECT'."\n" - .' `id`'."\n" - .', `name`'."\n" - .'FROM'."\n" - .' `test_tbl_adb`', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C'], + 'Data' => [ + 'description' => 'The queried log.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogContent' => ['description' => 'The content of the log.'."\n", '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}', 'title' => ''], + 'Message' => ['description' => 'The alert message returned for the request, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", 'type' => 'string', 'example' => 'WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp1bg858bo8c****', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'example' => 's202204132018hzprec1ac61a000****', 'title' => ''], + 'LogSize' => ['title' => '', 'description' => 'The number of log entries. A value of 0 indicates that no valid logs are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '775946240'], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], ], 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'GetViewDDL', + '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' => 'GetSparkAppAttemptLog', 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'GetViewObjects' => [ - 'summary' => 'Queries the information about views.', - 'methods' => [ - 'post', - 'get', + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-01-18T12:41:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-09-01T08:38:08.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-27T06:45:59.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppAttemptLog'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppAttemptLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], + ], + ], ], + ], + 'GetSparkAppInfo' => [ + 'summary' => 'Queries the information about an Spark application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28983,278 +22527,265 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '157080', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1xxxxxxxx47', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query the Spark application IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202205201533hz1209892000****', 'maxLength' => 64, 'minLength' => 0], ], [ - 'name' => 'SchemaName', + 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'am-bp11q28kvl688****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380'], + 'Data' => ['description' => 'The queried Spark application. Fields in the response parameter:'."\n" + ."\n" + .'* **Data**: the data of the Spark application template.'."\n" + .'* **EstimateExecutionCpuTimeInSeconds**: the amount of time that is required to consume CPU resources for running the Spark application. Unit: milliseconds.'."\n" + .'* **LogRootPath**: the storage path of log files.'."\n" + .'* **LastAttemptId**: the most recent attempt ID.'."\n" + .'* **WebUiAddress**: the web UI URL.'."\n" + .'* **SubmittedTimeInMillis**: the time when the Spark application was submitted. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + .'* **StartedTimeInMillis**: the time when the Spark application was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + .'* **LastUpdatedTimeInMillis**: the time when the Spark application was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + .'* **TerminatedTimeInMillis**: the time when the Spark application was terminated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + .'* **DBClusterId**: the ID of the cluster on which the Spark application runs.'."\n" + .'* **ResourceGroupName**: the name of the job resource group.'."\n" + .'* **DurationInMillis**: the amount of time that is required to run the Spark application. Unit: milliseconds.', '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', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.KillOperationFailed', 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', 'description' => 'Failed to kill the Spark application. Try again later.'], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Log.IllegalPath', 'errorMessage' => 'Invalid job log URI: %s.', 'description' => 'The Spark log path is invalid.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.Oss.InternalError', 'errorMessage' => 'An OSS internal error occurred: %s', 'description' => 'OSS internal error. The request failed.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ['errorCode' => 'Spark.TemplateFile.BadFileType', 'errorMessage' => 'The requested template %s is not a file.', 'description' => 'The specified template file ID is not of the file type.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which you want to sort the query results. Valid values for Type:'."\n" - ."\n" - .'* Asc'."\n" - .'* Desc'."\n" - ."\n" - .'Valid values for Field: -ViewName'."\n" - ."\n" - .'\\-CreateTime'."\n" - ."\n" - .'\\-UpdateTime'."\n" - ."\n" - .'Default value: {"Type": "Desc","Field": "ViewName"}.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Type": "Desc","Field": "ViewName"}', - ], + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.Log.PodLogNotFound', 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', 'description' => 'Unable to find log [%s] for corresponding pod via podName.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], + ], + 406 => [ + ['errorCode' => 'Spark.App.KillNotAcceptable', 'errorMessage' => 'Can\'t kill the application %s in %s state.', 'description' => 'A Spark application in a non-deletable state cannot be deleted.'], + ], + 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ['errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', 'errorMessage' => 'Can\'t load the content from file: %s', 'description' => 'Failed to load the resource file.'], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202207151211hz0c****\\",\\n \\"Message\\": \\"WARN: Disk is full.\\",\\n \\"Priority\\": \\"NORMAL\\",\\n \\"State\\": \\"SUBMITTED\\",\\n \\"DBClusterId\\": \\"amv-23xxxx\\",\\n \\"Detail\\": {\\n \\"DurationInMillis\\": 100,\\n \\"LogRootPath\\": \\"oss:///logs/driver\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\",\\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\\": \\"s202204291426hzpre60****-0003\\",\\n \\"TerminatedTimeInMillis\\": 1651213645300,\\n \\"ResourceProvisioningDurationInMillis\\": 36000,\\n \\"ExecutionDurationInMillis\\": 36000,\\n \\"WebUiAddress\\": \\"https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\",\\n \\"SubmittedTimeInMillis\\": 1651213645000,\\n \\"StartedTimeInMillis\\": 1651213645010,\\n \\"AppType\\": \\"BATCH\\",\\n \\"ResourceGroupName\\": \\"spark-rg\\"\\n },\\n \\"AppName\\": \\"SparkTest\\"\\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' => 'GetSparkAppInfo', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-11-24T09:19:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-28T01:10:37.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppInfo'], + ], + ], + 'ramActions' => [ [ - 'name' => 'FilterViewName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the view.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_filter', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], ], ], + ], + ], + 'GetSparkAppLog' => [ + 'summary' => 'Queries the logs of a Spark application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The Spark application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~612475~~) operation to query the Spark application ID.', 'type' => 'string', 'required' => true, 'example' => 's202206061441hz22a35ab000****'], ], [ - 'name' => 'FilterViewType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'\\-VIRTUAL_VIEW'."\n" - ."\n" - .'\\-MATERIALIZED_VIEW'."\n" - ."\n" - .'Default value: null.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'VIRTUAL_VIEW', - ], + 'name' => 'LogLength', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The number of log entries to return. Valid values: 1 to 500. Default value: 300.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '20', 'default' => '300'], ], [ - 'name' => 'FilterOwner', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The owner of the view.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-2ze6fl8ud7t***', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'ShowMvBaseTable', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500', 'default' => '100000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C'], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The queried log.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TableSummaryModels' => [ - 'description' => 'The queried views.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried view.'."\n", - '$ref' => '#/components/schemas/TableSummaryModel', - ], - ], + 'LogContent' => ['title' => '', 'description' => 'The content of the log.'."\n", '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' => 'The alert message returned for the request, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", 'type' => 'string', 'example' => 'WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/'], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-clusterxxx', 'title' => ''], + 'LogSize' => ['description' => 'The number of log entries. A value of 0 indicates that no valid logs are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3517972480', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.Oss.InternalError', 'errorMessage' => 'An OSS internal error occurred: %s', 'description' => 'OSS internal error. The request failed.'], + ['errorCode' => 'Spark.Log.IllegalPath', 'errorMessage' => 'Invalid job log URI: %s.', 'description' => 'The Spark log path is invalid.'], + ['errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], ], 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.Log.PodLogNotFound', 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', 'description' => 'Unable to find log [%s] for corresponding pod via podName.'], + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'GetViewObjects', + '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' => 'GetSparkAppLog', 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'GetDatabaseObjects' => [ - 'summary' => 'Queries the information about databases.', - 'methods' => [ - 'get', - 'post', + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-01-18T12:41:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-11-24T09:19:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-06-28T01:10:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppLog'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], + ], + ], ], + ], + 'GetSparkAppMetrics' => [ + 'summary' => 'Queries the metrics of a Spark application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -29264,236 +22795,153 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], + 'abilityTreeCode' => '169120', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which you want to sort the query results. Valid values:'."\n" - ."\n" - .'* Asc'."\n" - .'* Desc'."\n" - ."\n" - .'Valid values for Field: DatabaseName, CreateTime, and UpdateTime. -CreateTime; -UpdateTime;'."\n" - ."\n" - .'Default value: {"Type": "Desc","Field": "DatabaseName"}.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Type": "Desc","Field": "DbName"}', - ], - ], - [ - 'name' => 'FilterSchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* 30'."\n" - .'* 50'."\n" - .'* 100'."\n" - ."\n" - .'Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the Spark application.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202204221525hzca7d8140000003', 'maxLength' => 64], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'am-bp1565u55p32****', - ], - ], - [ - 'name' => 'FilterOwner', - 'in' => 'query', - 'schema' => [ - 'description' => 'The owner of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-bp1ggnu61d77****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '863D51B7-5321-41D8-A0B6-A088B0******', - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'DatabaseSummaryModels' => [ - 'description' => 'The queried databases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried database.'."\n", - '$ref' => '#/components/schemas/DatabaseSummaryModel', + 'AppId' => ['description' => 'The ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202302051515shfa865f8000****', 'title' => ''], + 'AttemptId' => ['description' => 'The attempt ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202301061000hz57d797b0000201-****', 'title' => ''], + 'Finished' => ['description' => 'Indicates whether parsing is complete. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'EventLogPath' => ['description' => 'The path of the event log.'."\n", 'type' => 'string', 'example' => 'oss://path/to/eventLog', 'title' => ''], + 'ScanMetrics' => [ + 'description' => 'The metrics.'."\n", + 'type' => 'object', + 'properties' => [ + 'OutputRowsCount' => ['description' => 'The number of scanned rows.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'TotalReadFileSizeInByte' => ['description' => 'The number of scanned bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], ], - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* 30'."\n" - .'* 50'."\n" - .'* 100'."\n" - ."\n" - .'Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%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.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.KillOperationFailed', 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', 'description' => 'Failed to kill the Spark application. Try again later.'], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.CancelNotebookStatementFailed', 'errorMessage' => 'Failed to cancel the execution of notebook statements.', 'description' => ''], + ['errorCode' => 'Spark.CloseNotebookKernelFailed', 'errorMessage' => 'Failed to disable the notebook kernel.', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.ExecuteNotebookStatementFailed', 'errorMessage' => 'Failed to execute notebook statements.', 'description' => ''], + ['errorCode' => 'Spark.GetNotebookKernelFailed', 'errorMessage' => 'Failed to start the notebook kernel. Try again later.', 'description' => ''], + ['errorCode' => 'Spark.GetNotebookKernelStateFailed', 'errorMessage' => 'Failed to obtain the status of the notebook kernel.', 'description' => 'Failed to query the notebook kernel state.'], + ['errorCode' => 'Spark.GetNotebookStatementLogFailed', 'errorMessage' => 'Failed to obtain notebook statement logs.', 'description' => ''], + ['errorCode' => 'Spark.GetNotebookStatementResultFailed', 'errorMessage' => 'Failed to obtain notebook statement execution results.', 'description' => ''], + ['errorCode' => 'Spark.GetNotebookStatementUiFailed', 'errorMessage' => 'Failed to obtain notebook statement UI.', 'description' => ''], + ['errorCode' => 'Spark.Log.IllegalPath', 'errorMessage' => 'Invalid job log URI: %s.', 'description' => 'The Spark log path is invalid.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.NotebookKernelBusy', 'errorMessage' => 'Too many jobs in the notebook kernel. Try again later.', 'description' => ''], + ['errorCode' => 'Spark.NotebookKernelExpired', 'errorMessage' => 'The notebook kernel has expired. Restart the kernel.', 'description' => ''], + ['errorCode' => 'Spark.NotebookKernelInvalidStatus', 'errorMessage' => 'The status of the notebook kernel is invalid.', 'description' => ''], + ['errorCode' => 'Spark.NotebookKernelNotStartup', 'errorMessage' => 'The notebook kernel has not been started', 'description' => ''], + ['errorCode' => 'Spark.NotebookKernelStarting', 'errorMessage' => 'The notebook kernel is starting. Try again later.', 'description' => ''], + ['errorCode' => 'Spark.NotebookNamingDuplicate', 'errorMessage' => 'The name of the notebook is duplicated, please change the name', 'description' => 'The notebook name is duplicate. Rename the notebook.'], + ['errorCode' => 'Spark.NotebookNotFound', 'errorMessage' => 'The notebook is not found', 'description' => 'The notebook does not exist. Contact the administrator.'], + ['errorCode' => 'Spark.NotebookParagraphMissingProgramCode', 'errorMessage' => 'The notebook paragraph program code is missing', 'description' => 'Execution code is missing from the notebook paragraph.'], + ['errorCode' => 'Spark.NotebookParagraphNotFound', 'errorMessage' => 'The notebook paragraph is not found', 'description' => 'The notebook paragraph does not exist. Contact the administrator.'], + ['errorCode' => 'Spark.NotebookParagraphNotRunning', 'errorMessage' => 'The notebook paragraph has not been running', 'description' => 'The notebook paragraph is not running. Execute the statement first.'], + ['errorCode' => 'Spark.Oss.InternalError', 'errorMessage' => 'An OSS internal error occurred: %s', 'description' => 'OSS internal error. The request failed.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ['errorCode' => 'Spark.TemplateFile.BadFileType', 'errorMessage' => 'The requested template %s is not a file.', 'description' => 'The specified template file ID is not of the file type.'], ], 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.Log.PodLogNotFound', 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', 'description' => 'Unable to find log [%s] for corresponding pod via podName.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], + ], + 406 => [ + ['errorCode' => 'Spark.App.KillNotAcceptable', 'errorMessage' => 'Can\'t kill the application %s in %s state.', 'description' => 'A Spark application in a non-deletable state cannot be deleted.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ['errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', 'errorMessage' => 'Can\'t load the content from file: %s', 'description' => 'Failed to load the resource file.'], ], ], - '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' => 'GetDatabaseObjects', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'GetTable' => [ - 'summary' => 'Queries the information about a table.', - 'methods' => [ - 'post', - 'get', + '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' => 'GetSparkAppMetrics', + 'description' => '* Before you call this operation, you must call the [PreloadSparkAppMetrics](~~612447~~) operation to preload the metrics of a Spark application.'."\n" + .'* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-11-24T09:19:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-28T01:10:36.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppMetrics'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppMetrics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'SparkApplication', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], + ], + ], ], + ], + 'GetSparkAppState' => [ + 'summary' => 'Queries the status of a Spark application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -29501,155 +22949,119 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '160312', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DbName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'dbName', - 'default' => 'MYSQL', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'tableName', - 'default' => 'USER', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The Spark application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202204191546hzpread6a896000****', 'maxLength' => 64], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-*******', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the cluster resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-bp1h405854m****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Code' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Success' => [ - 'description' => 'Indicates whether the query succeeded.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Table' => [ - 'description' => 'The information about the table.'."\n", - '$ref' => '#/components/schemas/TableModel', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380'], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppId' => ['description' => 'The Spark application ID.'."\n", 'type' => 'string', 'example' => 's202204191546hzpread6a896000****', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Message' => ['description' => 'The alert message returned for the operation, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", 'type' => 'string', 'example' => 'Insufficient resources.', 'title' => ''], + 'State' => ['title' => '', 'description' => 'The execution state of the application. Valid values:'."\n" + ."\n" + .'* **SUBMITTED**'."\n" + .'* **STARTING**'."\n" + .'* **RUNNING**'."\n" + .'* **FAILING**'."\n" + .'* **FAILED**'."\n" + .'* **KILLING**'."\n" + .'* **KILLED**'."\n" + .'* **SUCCEEDING**'."\n" + .'* **COMPLETED**'."\n" + .'* **FATAL**'."\n" + .'* **UNKNOWN**'."\n", 'type' => 'string', 'example' => 'COMPLETED'], + 'DBClusterId' => ['title' => '', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-bp1h405854m****', 'default' => 'DB_CLUSTER_ID'], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], ], - 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + 404 => [ + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'GetTable', - ], - 'GetTableColumns' => [ - 'summary' => 'Queries the information about columns.', - 'methods' => [ - 'post', - 'get', + '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' => 'GetSparkAppState', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-11-24T09:19:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-06-28T01:10:35.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppState'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppState', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], + ], + ], ], + ], + 'GetSparkAppWebUiAddress' => [ + 'summary' => 'Queries the URL of the web UI for a Spark application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -29659,221 +23071,107 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '157085', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], + 'abilityTreeCode' => '119937', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ [ - 'name' => 'SchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'ColumnName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'assist_user_phone', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The Spark application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202205201533hz1209892000****', 'maxLength' => 64], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-uf6g8w25jacm7****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380'], 'Data' => [ + 'title' => '', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Table' => [ - 'description' => 'The information about the table.'."\n", - '$ref' => '#/components/schemas/TableDetailModel', - ], + 'AppId' => ['title' => '', 'description' => 'The Spark application ID.'."\n", 'type' => 'string', 'example' => 's202205201533hz1209892000****'], + 'ExpirationTimeInMillis' => ['title' => '', 'description' => 'The expiration time. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1655801973000'], + 'WebUiAddress' => ['title' => '', 'description' => 'The URL of the web UI for the Spark application.'."\n", 'type' => 'string', 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****'], + 'DBClusterId' => ['title' => '', 'description' => 'The database ID.'."\n", 'type' => 'string', 'example' => 'amv-clusterxxx', 'default' => 'DB_CLUSTER_ID'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], ], - 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + 404 => [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'GetTableColumns', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + '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' => 'GetSparkAppWebUiAddress', + 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" + .'* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'GetTableDDL' => [ - 'summary' => 'Queries the statement that is used to create a table.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-24T09:19:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-06-28T01:10:34.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppWebUiAddress'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppWebUiAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], + ], + ], ], + ], + 'GetSparkConfigLogPath' => [ + 'summary' => 'Queries the Spark log configuration of an AnalyticDB for MySQL cluster, including the default Spark log path.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -29885,136 +23183,99 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '157088', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], + 'abilityTreeCode' => '156541', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ [ - 'name' => 'SchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1ub9grke1****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp19lm077co*****', 'maxLength' => 64], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '863D51B7-5321-41D8-A0B6-A088B0******', - ], - 'SQL' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'example' => 'create table ('."\n" - .' id varchar(32)'."\n" - .');', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1919-xxx-ssdfsdff'], + 'Data' => [ + 'description' => 'The queried Spark log configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsLogPathExists' => ['title' => '', 'description' => 'Indicates whether a log path exists.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RecordedLogPath' => ['title' => '', 'description' => 'The recorded log path.'."\n", 'type' => 'string', 'example' => 'oss://test/spark-logs/'], + 'ModifiedUid' => ['title' => '', 'description' => 'The account ID of the modifier.'."\n", 'type' => 'string', 'example' => '10130223128xxx'], + 'ModifiedTimestamp' => ['title' => '', 'description' => 'The last modification time.'."\n", 'type' => 'string', 'example' => '1675654361000'], + 'DefaultLogPath' => ['title' => '', 'description' => 'The default log path.'."\n", 'type' => 'string', 'example' => 'oss://aliyun-oa-adb-spark-****-oss-cn-hanghzou/spark-logs'], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.Config.InvalidAppFilePath', 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', 'description' => 'The main driver file address must be a valid OSS address. The current address is %s.'], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidDiskConfig', 'errorMessage' => 'The requested disk mount parameter is invalid: %s', 'description' => 'The disk mount configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidHostAliasConfig', 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', 'description' => 'The domain name mapping configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidLogOssPath', 'errorMessage' => 'The OSS address for log storage is illegal: %s', 'description' => 'The OSS address for storing logs is invalid.'], + ['errorCode' => 'Spark.Config.InvalidRoleArnFormat', 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', 'description' => 'The configured RoleARN format is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidTimeZone', 'errorMessage' => 'Unable to parse time zone configuration %s : %s', 'description' => 'The time zone configuration is incorrect.'], + ['errorCode' => 'Spark.Config.MainAppFileNotExists', 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', 'description' => 'The main driver file is missing. The file or sqls configuration must not be empty.'], + ['errorCode' => 'Spark.Config.OSSPathAccessError', 'errorMessage' => 'The configured OSS address %s cannot be accessed.', 'description' => 'The configured OSS path is inaccessible.'], + ['errorCode' => 'Spark.Config.OSSPathNotExists', 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', 'description' => 'The OSS path does not exist or the current user does not have permission to access it.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Config.SecurityGroupNotFound', 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.'], + ['errorCode' => 'Spark.Config.VswitchNotFound', 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured vSwitch cannot be found, or the current account has insufficient permissions. %s.'], ], 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'GetTableDDL', + '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' => 'GetSparkConfigLogPath', 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'GetTableObjects' => [ - 'summary' => 'Query the details of one or more tables.', - 'methods' => [ - 'post', - 'get', + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-07-27T06:45:58.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkConfigLogPath'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkConfigLogPath', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'GetSparkLogAnalyzeTask' => [ + 'summary' => 'Queries the results of a Spark log analysis task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30022,285 +23283,209 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '157079', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'SchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the Spark log analysis task. You can call the ListSparkLogAnalyzeTasks operation to query the IDs of all Spark log analysis tasks that are submitted in the current cluster.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '12'], ], - [ - 'name' => 'OrderBy', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The order in which the fields to be returned are sorted.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Asc'."\n" - .'* Desc'."\n" - ."\n" - .'Values for fields:'."\n" - ."\n" - .'TableName'."\n" - ."\n" - .'TableSize'."\n" - ."\n" - .'CreateTime'."\n" - ."\n" - .'UpdateTime'."\n" - ."\n" - .'Default value: {"Type": "Desc","Field": "TableName"};'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Type": "Desc","Field": "TableName"}', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709'], + 'Data' => ['description' => 'The information about the Spark log analysis task.'."\n", '$ref' => '#/components/schemas/SparkAnalyzeLogTask', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'FilterTblName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_tbl', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. The value is an integer that is greater than 0. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values:'."\n" - ."\n" - .'* 30'."\n" - .'* 50'."\n" - .'* 100'."\n" - ."\n" - .'Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1565u55p32****', - ], + ], + '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: cpu is exceeded limits 12/10\\",\\n \\"AppErrorAdvice\\": \\"Please increase cpu quota for your resource group\\"\\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' => 'GetSparkLogAnalyzeTask', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-07-27T06:45:57.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkLogAnalyzeTask'], ], + ], + 'ramActions' => [ [ - 'name' => 'FilterTblType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the table.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'DIMENSION_TABLE'."\n" - ."\n" - .'FACT_TABLE'."\n" - ."\n" - .'EXTERNAL_TABLE'."\n" - ."\n" - .'Default value: null.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FACT_TABLE', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkLogAnalyzeTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/task/{#SparkTaskId}'], + ], ], ], + ], + ], + 'GetSparkReplSession' => [ + 'summary' => 'Queries the status of a Spark session.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FilterOwner', - 'in' => 'query', - 'schema' => [ - 'description' => 'The owner of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'FilterDescription', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query all application IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 's202411071444hzdvk486d9d200****', 'default' => 'ADB-Spark-Application'], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the cluster resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the session that executes the code.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '863D51B7-5321-41D8-A0B6-A088B0******', - ], - 'PageNumber' => [ - 'description' => 'The number of the returned page. The value is an integer that is greater than 0. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page. Default value: 30. Valid values:'."\n" - ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4CE6DF97-AEA4-484F-906F-C407EE3770EB'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The number of the returned page. The value is an integer that is greater than 0. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page. Default value: 30. Valid values:'."\n" + 'SessionId' => ['description' => 'The ID of the session that executes the code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'State' => [ + 'description' => 'The status of the session. Valid values:'."\n" ."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + .'* IDLE'."\n" + .'* BUSY'."\n" + .'* DEAD'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'IDEL', + 'title' => '', ], - 'TableSummaryModels' => [ - 'description' => 'Details of the tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/TableSummaryModel', - ], + 'AttemptId' => ['description' => 'The attempt ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202301061000hz57d797b00002****', 'title' => ''], + 'Error' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Session timed out', 'title' => ''], + 'WebUiAddress' => ['description' => 'The URL of the web UI for the Spark application.'."\n", 'type' => 'string', 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', 'title' => ''], + 'AliyunUid' => ['description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", 'type' => 'string', 'example' => '178157466101****', 'title' => ''], + 'Active' => [ + 'description' => 'Indicates whether the session is active. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'true', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.App.ExceedQuotaLimitation', 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', 'description' => ''], + ['errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', 'description' => 'The AppType type is illegal, please refer to using the document to specify the AppType suitable for your business.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ResourceNegativeError', 'errorMessage' => 'The requested resource MUST be positive: %s', 'description' => ''], + ['errorCode' => 'Spark.Config.InvalidAppFilePath', 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', 'description' => 'The main driver file address must be a valid OSS address. The current address is %s.'], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidDiskConfig', 'errorMessage' => 'The requested disk mount parameter is invalid: %s', 'description' => 'The disk mount configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidHostAliasConfig', 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', 'description' => 'The domain name mapping configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidLogOssPath', 'errorMessage' => 'The OSS address for log storage is illegal: %s', 'description' => 'The OSS address for storing logs is invalid.'], + ['errorCode' => 'Spark.Config.InvalidRoleArnFormat', 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', 'description' => 'The configured RoleARN format is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidTimeZone', 'errorMessage' => 'Unable to parse time zone configuration %s : %s', 'description' => 'The time zone configuration is incorrect.'], + ['errorCode' => 'Spark.Config.MainAppFileNotExists', 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', 'description' => 'The main driver file is missing. The file or sqls configuration must not be empty.'], + ['errorCode' => 'Spark.Config.OSSPathAccessError', 'errorMessage' => 'The configured OSS address %s cannot be accessed.', 'description' => 'The configured OSS path is inaccessible.'], + ['errorCode' => 'Spark.Config.OSSPathNotExists', 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', 'description' => 'The OSS path does not exist or the current user does not have permission to access it.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Config.SecurityGroupNotFound', 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.'], + ['errorCode' => 'Spark.Config.VswitchNotFound', 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured vSwitch cannot be found, or the current account has insufficient permissions. %s.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.BlankError', 'errorMessage' => 'Input sql can not be blank string.', 'description' => 'The submitted SQL statement cannot be empty.'], + ['errorCode' => 'Spark.SQL.MultipleSQLError', 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', 'description' => 'The submitted Spark SQL contains multiple executable SQL statements.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], ], 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.App.NotFound', 'errorMessage' => 'The Spark application %s is not found.', 'description' => 'The specified Spark application was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'GetTableObjects', - ], - 'CheckSampleDataSet' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'GetSparkReplSession', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkReplSession'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:GetSparkReplSession', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}/{#sessionid}'], + ], + ], + ], ], + ], + 'GetSparkReplStatement' => [ + 'summary' => 'Queries the execution result of a code block.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30308,22 +23493,24 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-wz9r8f67h4cqz41u', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query Spark application IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 's202411071444hzdvk486d9d200****', 'default' => 'ADB-Spark-Application'], + ], + [ + 'name' => 'StatementId', + 'in' => 'formData', + 'schema' => ['description' => 'The unique ID of the code block in the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the session that executes the code.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -30331,189 +23518,263 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The state of the built-in dataset. Valid values:'."\n" - ."\n" - .'* **SUCCEED**: The dataset is loaded.'."\n" - .'* **INIT**: The dataset is being loaded.'."\n" - .'* **FAILED**: The dataset failed to be loaded.'."\n" - .'* **UNINITIALIZED**: The dataset is not loaded.'."\n", - 'type' => 'string', - 'example' => 'UNINITIALIZED', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0CE655C3-C211-513D-A42F-D4AE2D1A867C', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'StatementId' => ['description' => 'The unique ID of the code block in the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Code' => ['description' => 'The code that is executed.'."\n", 'type' => 'string', 'example' => 'print(1+1)', 'title' => ''], + 'CodeType' => [ + 'description' => 'The code type. Valid values:'."\n" + ."\n" + .'* PYTHON'."\n" + .'* SCALA'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PYTHON', + 'title' => '', + ], + 'CodeState' => [ + 'description' => 'The code execution status. Valid values:'."\n" + ."\n" + .'* CANCELLED'."\n" + .'* RUNNING'."\n" + .'* SUCCEEDED'."\n" + .'* ERROR'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RUNNING', + 'title' => '', + ], + 'AliyunUid' => ['description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '144740799645****', 'title' => ''], + 'OutputType' => [ + 'description' => 'The execution result type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* TABLE'."\n" + .'* TEXT'."\n", + 'type' => 'string', + 'enumValueTitles' => ['TABLE' => '', 'TEXT' => ''], + 'example' => 'TEXT', + 'title' => '', + ], + 'Output' => ['description' => 'The code execution result, which is a JSON string.'."\n", 'type' => 'string', 'example' => '{"text/plain": 2}', 'title' => ''], + 'Columns' => [ + 'description' => 'The column names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The column name.'."\n", 'type' => 'string', 'example' => 'col1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Error' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'stackoverflow error', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1730968194000', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1730968194000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'Spark.App.ExceedQuotaLimitation', 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', 'description' => ''], + ['errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', 'description' => 'The AppType type is illegal, please refer to using the document to specify the AppType suitable for your business.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ResourceNegativeError', 'errorMessage' => 'The requested resource MUST be positive: %s', 'description' => ''], + ['errorCode' => 'Spark.Config.InvalidAppFilePath', 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', 'description' => 'The main driver file address must be a valid OSS address. The current address is %s.'], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidDiskConfig', 'errorMessage' => 'The requested disk mount parameter is invalid: %s', 'description' => 'The disk mount configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidHostAliasConfig', 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', 'description' => 'The domain name mapping configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidLogOssPath', 'errorMessage' => 'The OSS address for log storage is illegal: %s', 'description' => 'The OSS address for storing logs is invalid.'], + ['errorCode' => 'Spark.Config.InvalidRoleArnFormat', 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', 'description' => 'The configured RoleARN format is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidTimeZone', 'errorMessage' => 'Unable to parse time zone configuration %s : %s', 'description' => 'The time zone configuration is incorrect.'], + ['errorCode' => 'Spark.Config.MainAppFileNotExists', 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', 'description' => 'The main driver file is missing. The file or sqls configuration must not be empty.'], + ['errorCode' => 'Spark.Config.OSSPathAccessError', 'errorMessage' => 'The configured OSS address %s cannot be accessed.', 'description' => 'The configured OSS path is inaccessible.'], + ['errorCode' => 'Spark.Config.OSSPathNotExists', 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', 'description' => 'The OSS path does not exist or the current user does not have permission to access it.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Config.SecurityGroupNotFound', 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.'], + ['errorCode' => 'Spark.Config.VswitchNotFound', 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured vSwitch cannot be found, or the current account has insufficient permissions. %s.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.BlankError', 'errorMessage' => 'Input sql can not be blank string.', 'description' => 'The submitted SQL statement cannot be empty.'], + ['errorCode' => 'Spark.SQL.MultipleSQLError', 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', 'description' => 'The submitted Spark SQL contains multiple executable SQL statements.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.App.NotFound', 'errorMessage' => 'The Spark application %s is not found.', 'description' => 'The specified Spark application was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"UNINITIALIZED\\",\\n \\"RequestId\\": \\"0CE655C3-C211-513D-A42F-D4AE2D1A867C\\"\\n}","type":"json"}]', - 'title' => 'CheckSampleDataSet', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeSchemas' => [ - 'summary' => 'Queries a list of databases in an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + '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' => 'GetSparkReplStatement', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkReplStatement'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:GetSparkReplStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}/{#sparkStatmentId}'], + ], + ], + ], ], + ], + 'GetSparkSQLEngineState' => [ + 'summary' => 'Queries the state information about the Spark SQL engine.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', + 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '190445', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], + 'abilityTreeCode' => '152586', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1xxxxxxxx47', - ], + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the job resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_instance', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', - ], - 'Items' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'xxxx-xxx-xx'], + 'Data' => [ + 'description' => 'The state information about the Spark SQL engine.'."\n", 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Schema' => [ - 'description' => 'The queried databases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried database.'."\n", - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp11q28kvl688****', - ], - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - ], - ], - ], + 'AppId' => ['description' => 'The ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202207151211hz0c****', 'title' => ''], + 'MinExecutor' => ['description' => 'The minimum number of started Spark executors.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'MaxExecutor' => ['description' => 'The maximum number of started Spark executors.'."\n", 'type' => 'string', 'example' => '3', 'title' => ''], + 'Jars' => ['description' => 'The third-party JAR package.'."\n", 'type' => 'string', 'example' => 'oss://test-bucket/test.jar', 'title' => ''], + 'SlotNum' => ['description' => 'The slot number of the Spark application.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + 'Config' => ['description' => 'The configuration of the Spark application.'."\n", 'type' => 'string', 'example' => '{"key1": "value1", "key2": "value2"}', 'title' => ''], + 'State' => ['description' => 'The execution state of the application. Valid values:'."\n" + ."\n" + .'* SUBMITTED'."\n" + .'* STARTING'."\n" + .'* RUNNING'."\n" + .'* FAILING'."\n" + .'* FAILED'."\n" + .'* KILLING'."\n" + .'* KILLED'."\n" + .'* SUCCEEDING'."\n" + .'* COMPLETED'."\n" + .'* FATAL'."\n" + .'* UNKNOWN'."\n", 'type' => 'string', 'example' => 'COMPLETED', 'title' => ''], + 'SubmittedTimeInMillis' => ['description' => 'The timestamp when the Spark SQL application was submitted. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1651213645000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], ], - 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + 404 => [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'DescribeSchemas', + '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' => 'GetSparkSQLEngineState', 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeAllDataSource' => [ - 'summary' => 'Queries a list of databases, tables, and columns in an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-06-28T01:10:33.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkSQLEngineState'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetActiveSparkSession', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], + ], + ], + ], ], + ], + 'GetSparkTemplateFileContent' => [ + 'summary' => 'Queries the content of a Spark application template.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30521,250 +23782,184 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '190495', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-8vbn8pq537k8w****', 'maxLength' => 64], ], [ - 'name' => 'DBClusterId', - 'in' => 'query', + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The application template ID.'."\n" + ."\n" + .'> You can call the [GetSparkTemplateFullTree](~~456205~~) operation to query the application template ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '725204'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1pke2pcfavw****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380'], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppType' => ['description' => 'The application type. Valid values:'."\n" + ."\n" + .'* **SQL**'."\n" + .'* **STREAMING**'."\n" + .'* **BATCH**'."\n", 'type' => 'string', 'example' => 'SQL', 'title' => ''], + 'Content' => ['description' => 'The content of the application template.'."\n", '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;', 'title' => ''], + 'Id' => ['description' => 'The application template ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '725204', 'title' => ''], + 'Type' => ['description' => 'The file type. Valid values:'."\n" + ."\n" + .'* **folder**'."\n" + .'* **file**'."\n", 'type' => 'string', 'example' => 'file', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.TemplateFile.BadFileType', 'errorMessage' => 'The requested template %s is not a file.', 'description' => 'The specified template file ID is not of the file type.'], + ], + 404 => [ + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ], + ], + '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' => 'GetSparkTemplateFileContent', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkTemplateFileContent'], + ], + ], + 'ramActions' => [ [ - 'name' => 'SchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkTemplateFileContent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + ], + 'GetSparkTemplateFolderTree' => [ + 'summary' => 'Queries the directory structure of Spark applications.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'maxLength' => 64], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', - ], - 'Tables' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Table' => [ - 'description' => 'The queried tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried table.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The logical name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1pke2pcfavw****', - ], - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - ], - ], - ], - ], - ], - 'Columns' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Column' => [ - 'description' => 'The queried columns.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried column.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The data type of the column.'."\n", - 'type' => 'string', - 'example' => 'bigint', - ], - 'ColumnName' => [ - 'description' => 'The name of the column.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'TableName' => [ - 'description' => 'The logical name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AutoIncrementColumn' => [ - 'description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1pke2pcfavw****', - ], - 'PrimaryKey' => [ - 'description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'SchemaName' => [ - 'description' => 'The logical name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - ], - ], - ], - ], - ], - 'Schemas' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Schema' => [ - 'description' => 'The queried databases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried database.'."\n", - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1pke2pcfavw****', - ], - 'SchemaName' => [ - 'description' => 'The logical name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => ['title' => '', 'description' => 'The directory structure of Spark applications, which is in the tree format. Fields in the response parameter:'."\n" + ."\n" + .'* **Uid**: the UID of the Alibaba Cloud account.'."\n" + ."\n" + .'* **Type**: the application template type. Valid values: **FOLDER**'."\n" + ."\n" + .'* **Parent**: indicates whether a child directory exists. Valid values:'."\n" + ."\n" + .' * **0**: no.'."\n" + .' * **-1**: yes.'."\n" + ."\n" + .'* **Children**: the child directory.'."\n" + ."\n" + .'* **LastModified**: the time when applications in the directory are last modified. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'* **Name**: the name of the directory.'."\n" + ."\n" + .'* **Id**: the directory ID.'."\n", '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" }'], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], ], 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'DescribeAllDataSource', + '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' => 'GetSparkTemplateFolderTree', 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeTables' => [ - 'summary' => 'Queries a list of tables in a database.', - 'methods' => [ - 'post', - 'get', + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-07-27T06:45:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkTemplateFolderTree'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkTemplateFolderTree', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'GetSparkTemplateFullTree' => [ + 'summary' => 'Queries the directory structure of Spark applications.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30772,155 +23967,98 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1xxxxxxxx47', - ], - ], - [ - 'name' => 'SchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'maxLength' => 64], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Table' => [ - 'description' => 'The queried tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried table.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1xxxxxxxx47', - ], - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => ['title' => '', 'description' => 'The directory structure of Spark applications. Fields in the response parameter:'."\n" + ."\n" + .'* **Uid**: the UID of the Alibaba Cloud account.'."\n" + ."\n" + .'* **Type**: the application template type. Valid values:'."\n" + ."\n" + .' * **FOLDER**'."\n" + .' * **FILE**'."\n" + ."\n" + .'* **Parent**: indicates whether a child directory exists. Valid values:'."\n" + ."\n" + .' * **0**: no.'."\n" + .' * **-1**: yes.'."\n" + ."\n" + .'* **Children**: the child directory.'."\n" + ."\n" + .'* **LastModified**: the time when applications are last modified. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'* **AppType**: the application type. Valid values:'."\n" + ."\n" + .' * **SQL**'."\n" + .' * **STREAMING**'."\n" + .' * **BATCH**'."\n" + ."\n" + .'* **Name**: the name of the directory or application.'."\n" + ."\n" + .'* **Id**: the directory ID or application ID.'."\n", '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" }'], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], ], 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], ], 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + ['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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'DescribeTables', + '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' => 'GetSparkTemplateFullTree', 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeColumns' => [ - 'summary' => 'Queries a list of columns in a table.', - 'methods' => [ - 'post', + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-07-27T06:45:56.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkTemplateFullTree'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkTemplateFullTree', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'GetSparkWarehouseBatchSQL' => [ + 'summary' => 'Retrieves the execution results of a Spark SQL statement.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -30932,256 +24070,186 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', - ], + 'abilityTreeCode' => '235568', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'QueryId', + 'in' => 'formData', + 'schema' => ['description' => 'The execution ID of the Spark SQL statement.', 'type' => 'string', 'required' => true, 'example' => 'sq2024123*****', 'title' => ''], ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1xxxxxxxx47', - ], - ], - [ - 'name' => 'SchemaName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'amv-uf6485635f***', 'title' => ''], ], [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'Agency', + 'in' => 'formData', + 'schema' => ['description' => 'The client name for auxiliary logging. The value is a meaningful string of up to 16 characters.', 'type' => 'string', 'default' => 'POPSDK', 'required' => false, 'example' => 'DMS', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-XXX442913CEF', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Column' => [ - 'description' => 'The queried columns.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried column.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The data type of the column.'."\n", - 'type' => 'string', - 'example' => 'bigint', - ], - 'ColumnName' => [ - 'description' => 'The name of the column.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AutoIncrementColumn' => [ - 'description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp111m2cfrdl1****', - ], - 'PrimaryKey' => [ - 'description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3D44EDA0-A9DC-580D-9B5A-019370C075F4'], + 'Data' => ['description' => 'The returned data.', '$ref' => '#/components/schemas/SparkBatchSQL', 'example' => '{\'DBClusterId\': \'amv-uf6485635fz852mn\', \'Statements\': [{\'Code\': \'show databases\', \'State\': \'FINISHED\', \'StatementId\': \'sq202501141001sh8e12e080006846-0000\', \'Result\': \'+--------------------+n', 'title' => ''], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], ], 403 => [ - [ - 'errorCode' => 'MDS.RamAuthAccessDenied', - 'errorMessage' => 'ram auth access denied.', - ], + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], ], - 500 => [ - [ - 'errorCode' => 'MDS.InternalError', - 'errorMessage' => 'An internal MDS error occurred.', - ], - [ - 'errorCode' => 'MDS.MetaVisitError', - 'errorMessage' => 'Failed to access metadata.', - ], + [ + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], ], ], - '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' => 'DescribeColumns', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'LoadSampleDataSet' => [ - 'summary' => 'Loads a built-in dataset.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve spark SQL execution results', + 'description' => '- Public endpoint of a region: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- VPC endpoint of a region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.'."\n" + .'> If you encounter a 409 error when sending requests from China North 1 (Qingdao), China South 1 (Shenzhen), China South 3 (Guangzhou), or Hong Kong (China), contact technical support.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkWarehouseBatchSQL'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkWarehouseBatchSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3D44EDA0-A9DC-580D-9B5A-019370C075F4\\",\\n \\"Data\\": {\\n \\"Uid\\": 0,\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"Query\\": \\"SELECT * FROM db.tb\\",\\n \\"QueryId\\": \\"sq172352176****\\",\\n \\"Schema\\": \\"default\\",\\n \\"QueryEndTime\\": 1723521767000,\\n \\"DBClusterId\\": \\"amv-bp17s73f016****\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"sq1723521767****-0001\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"+---+-----+\\\\n|age| name|\\\\n+---+-----+\\\\n| 14| Tom|\\\\n| 23|Alice|\\\\n+---+-----+\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\",\\n \\"QueryStartTime\\": 1723521767000,\\n \\"ResourceGroupName\\": \\"spark_rg\\"\\n }\\n}","type":"json"}]', + ], + 'GetTable' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '160312', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'MYSQL', 'example' => 'dbName', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The table name to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'USER', 'example' => 'tableName', 'title' => ''], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-2ze0z517o1mgp66a', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-*******', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FA31BE84-ABE8-554A-A769-5F860C34EE10', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-2ze0z517o1mgp66a', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Table' => ['description' => 'The table details.', '$ref' => '#/components/schemas/TableModel', 'title' => '', 'example' => ''], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA31BE84-ABE8-554A-A769-5F860C34EE10\\",\\n \\"DBClusterId\\": \\"amv-2ze0z517o1mg****\\"\\n}","type":"json"}]', - 'title' => 'LoadSampleDataSet', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'GetADBSparkNecessaryRAMPermissions' => [ - 'summary' => 'View the Spark basic permission diagnosis report of the current user.', - 'path' => '', - 'methods' => [ - 'post', + 'title' => 'Query table information', + 'summary' => 'Retrieves table information.', + 'description' => '- Public endpoint of the region: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- VPC endpoint of the region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.', + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:07.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-07-04T08:31:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-21T06:38:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-22T02:16:05.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTable'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getTable', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"TblId\\": 123,\\n \\"DbName\\": \\"example\\",\\n \\"TableName\\": \\"tableName\\",\\n \\"TableType\\": \\"external_table\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"Type\\": \\"long\\",\\n \\"Comment\\": \\"comment\\",\\n \\"DatabaseName\\": \\"databaseName\\",\\n \\"TableName\\": \\"tableName\\",\\n \\"MappedName\\": \\"mappedName\\",\\n \\"DataType\\": \\"long\\",\\n \\"CreateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"UpdateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"PkPosition\\": -1,\\n \\"IsPartitionKey\\": false,\\n \\"OrdinalPosition\\": -1,\\n \\"ColumnRawName\\": \\"ColumnRawName\\",\\n \\"PhysicalColumnName\\": \\"PhysicalColumnName\\",\\n \\"Nullable\\": true,\\n \\"AutoIncrement\\": true,\\n \\"Precision\\": 1,\\n \\"Scale\\": 1,\\n \\"Primarykey\\": true,\\n \\"DefaultValue\\": \\"default\\",\\n \\"Tokenizer\\": \\"tokenizer\\",\\n \\"Encode\\": \\"encode\\",\\n \\"Compression\\": \\"compression\\",\\n \\"Delimiter\\": \\"delimiter\\",\\n \\"ValueType\\": \\"valueType\\",\\n \\"CompressFloatUseShort\\": false,\\n \\"OnUpdate\\": \\"onUpdate\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"key\\": \\"key:value\\"\\n },\\n \\"Sd\\": {\\n \\"SdId\\": 1,\\n \\"Location\\": \\"oss://**************\\",\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"Compressed\\": false,\\n \\"NumBuckets\\": 1,\\n \\"SerDeInfo\\": {\\n \\"SerDeId\\": 123,\\n \\"Name\\": \\"example\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key:value\\"\\n },\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"key:value\\"\\n },\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"CreateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"ViewOriginalText\\": \\"ViewOriginalText\\",\\n \\"ViewExpandedText\\": \\"ViewExpandedText\\",\\n \\"Temporary\\": false,\\n \\"Comment\\": \\"description\\",\\n \\"Cols\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"Type\\": \\"long\\",\\n \\"Comment\\": \\"comment\\",\\n \\"DatabaseName\\": \\"databaseName\\",\\n \\"TableName\\": \\"tableName\\",\\n \\"MappedName\\": \\"mappedName\\",\\n \\"DataType\\": \\"long\\",\\n \\"CreateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"UpdateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"PkPosition\\": -1,\\n \\"IsPartitionKey\\": false,\\n \\"OrdinalPosition\\": -1,\\n \\"ColumnRawName\\": \\"ColumnRawName\\",\\n \\"PhysicalColumnName\\": \\"PhysicalColumnName\\",\\n \\"Nullable\\": true,\\n \\"AutoIncrement\\": true,\\n \\"Precision\\": 1,\\n \\"Scale\\": 1,\\n \\"Primarykey\\": true,\\n \\"DefaultValue\\": \\"default\\",\\n \\"Tokenizer\\": \\"tokenizer\\",\\n \\"Encode\\": \\"encode\\",\\n \\"Compression\\": \\"compression\\",\\n \\"Delimiter\\": \\"delimiter\\",\\n \\"ValueType\\": \\"valueType\\",\\n \\"CompressFloatUseShort\\": false,\\n \\"OnUpdate\\": \\"onUpdate\\"\\n }\\n ],\\n \\"DistributeColumns\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"Type\\": \\"long\\",\\n \\"Comment\\": \\"comment\\",\\n \\"DatabaseName\\": \\"databaseName\\",\\n \\"TableName\\": \\"tableName\\",\\n \\"MappedName\\": \\"mappedName\\",\\n \\"DataType\\": \\"long\\",\\n \\"CreateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"UpdateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"PkPosition\\": -1,\\n \\"IsPartitionKey\\": false,\\n \\"OrdinalPosition\\": -1,\\n \\"ColumnRawName\\": \\"ColumnRawName\\",\\n \\"PhysicalColumnName\\": \\"PhysicalColumnName\\",\\n \\"Nullable\\": true,\\n \\"AutoIncrement\\": true,\\n \\"Precision\\": 1,\\n \\"Scale\\": 1,\\n \\"Primarykey\\": true,\\n \\"DefaultValue\\": \\"default\\",\\n \\"Tokenizer\\": \\"tokenizer\\",\\n \\"Encode\\": \\"encode\\",\\n \\"Compression\\": \\"compression\\",\\n \\"Delimiter\\": \\"delimiter\\",\\n \\"ValueType\\": \\"valueType\\",\\n \\"CompressFloatUseShort\\": false,\\n \\"OnUpdate\\": \\"onUpdate\\"\\n }\\n ],\\n \\"PhysicalTableName\\": \\"physicalTableName\\",\\n \\"PhysicalDatabaseName\\": \\"physicalDatabaseName\\",\\n \\"DistributeType\\": \\"DistributeType\\",\\n \\"PartitionType\\": \\"PartitionType\\",\\n \\"PartitionColumn\\": \\"colName\\",\\n \\"PartitionCount\\": 16,\\n \\"PreviousVersion\\": 1,\\n \\"CurrentVersion\\": 2,\\n \\"UpdateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"TableEngineName\\": \\"hive\\",\\n \\"IsAllIndex\\": true,\\n \\"BlockSize\\": 64,\\n \\"Compression\\": \\"Compression\\",\\n \\"RawTableName\\": \\"RawTableName\\",\\n \\"SubpartitionType\\": \\"SubpartitionColumn\\",\\n \\"SubpartitionColumn\\": \\"SubpartitionColumn\\",\\n \\"SubpartitionCount\\": 64,\\n \\"ArchiveType\\": \\"ArchiveType\\",\\n \\"MaxColumnId\\": 0,\\n \\"EnableDfs\\": false,\\n \\"StoragePolicy\\": \\"StoragePolicy\\",\\n \\"HotPartitionCount\\": 32,\\n \\"IsFulltextDict\\": false,\\n \\"RtIndexAll\\": false,\\n \\"RouteColumns\\": [],\\n \\"RtEngineType\\": \\"RtEngineType\\",\\n \\"RtModeType\\": \\"RtModeType\\",\\n \\"RouteType\\": \\"routeType\\",\\n \\"DictEncode\\": false,\\n \\"BucketCount\\": 16,\\n \\"Bucket\\": 16,\\n \\"ViewSecurityMode\\": \\"ViewSecurityMode\\",\\n \\"Indexes\\": [\\n {\\n \\"DatabaseName\\": \\"exampleDatabase\\",\\n \\"PhysicalTableName\\": \\"physicalDatabase\\",\\n \\"IndexName\\": \\"indexName\\",\\n \\"IndexType\\": \\"NORMAL\\",\\n \\"IndexColumns\\": [],\\n \\"ColumnOrds\\": [\\n \\"ASC/DESC\\"\\n ],\\n \\"Options\\": {\\n \\"key\\": \\"key:value\\"\\n },\\n \\"CreateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"UpdateTime\\": \\"2023-01-05 13:17:55\\"\\n }\\n ],\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetTableColumns' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31193,138 +24261,133 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsUF9CN9', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '157085', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'ColumnName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the column.', 'type' => 'string', 'required' => false, 'example' => 'assist_user_phone', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1r053byu48p****'."\n", - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '642F3512-C628-5D0C-8815-F6670C****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'PageNumber' => ['description' => 'The page number. The value is a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries in the result.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], 'Data' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Passed' => [ - 'description' => 'Check whether the use has the basic permissions to use Analytic DB for Spark.'."\n" - ."\n" - .'* true: The check is passed and the basic permissions are granted.'."\n" - .'* false: The check fails and some permissions are missing.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DeniedDetail' => [ - 'description' => 'When permission check fails, returns diagnostic information related to permission check failure.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceOwnerId' => [ - 'description' => 'The ID of the resource owner.'."\n", - 'type' => 'string', - 'example' => '11685695632****', - ], - 'Action' => [ - 'description' => 'The name of the RAM action that failed the authentication.'."\n", - 'type' => 'string', - 'example' => 'ListSparkApps', - ], - 'PrincipalType' => [ - 'description' => 'The identity type of the current user. Valid values:'."\n" - ."\n" - .'* SubUser: a RAM user'."\n" - .'* AssumedRoleUser: a RAM role'."\n", - 'type' => 'string', - 'example' => 'SubUser', - ], - 'ResourceAuthTargetInfo' => [ - 'description' => 'Authentication object information, can be the current user\'s RAM account ID, or the role information corresponding to the current visitor.'."\n", - 'type' => 'string', - 'example' => '223345695632****'."\n", - ], - 'PolicyType' => [ - 'description' => 'The type of the policy that causes the access denied error.'."\n" - ."\n" - .'* ControlPolicy: control policy'."\n" - .'* SessionPolicy: Temporary Token additional permission policy'."\n" - .'* AssumeRolePolicy: RAM role trust policy'."\n" - .'* AccountLevelIdentityBasedPolicy: Principal policy within account authorization scope, including custom policies and system policies'."\n" - .'* ResourceGroupLevelIdentityBasedPolicy: Principal policy within resource group authorization scope, including custom policies and system policies.'."\n", - 'type' => 'string', - 'example' => 'ControlPolicy', - ], - 'NoPermissionType' => [ - 'description' => 'The type of the policy denial. Valid values:'."\n" - ."\n" - .'* ImplicitDeny: Resource owner has not configured relevant permission policies for the current user, default denial of unauthorized operations.'."\n" - .'* ExplicitDeny: RAM policies configured by the resource owner explicitly deny the current user access to corresponding resources'."\n", - 'type' => 'string', - 'example' => 'ImplicitDeny', - ], - ], - ], - 'Suggestion' => [ - 'description' => 'Based on diagnostic information, recommends configurations for customers to perform in the RAM system.'."\n", - 'type' => 'string', - 'example' => 'Grant the system RAM policy \'AliyunADBDeveloperAccess\' to current RAM user can quickly solve this issue.', - ], + 'PageNumber' => ['description' => 'The page number. The value is a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries in the result.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'Table' => ['description' => 'The details of the table.', '$ref' => '#/components/schemas/TableDetailModel', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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', - ], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Query column information', + 'summary' => 'Queries column information.', + 'description' => '- Public endpoint of the region: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- VPC endpoint of the region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.', + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:08.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-10-25T05:36:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-22T02:16:05.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - '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' => 'GetADBSparkNecessaryRAMPermissions', - 'description' => 'The API diagnosis report contains whether the current user has all permissions required by the AnalyticDB for Spark related features. The scope of the permissions may exceed the minimum requirements of the business. The diagnostic report of the current API is used to quickly initialize the environment of AnalyticDB for Spark. If fine-grained permission configuration is needed, see [Configure fine-grained permissions in AnalyDB for 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)'."\n", - ], - 'KillProcess' => [ - 'summary' => 'Terminates an ongoing query.', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableColumns'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getTableColumns', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"schemaName\\",\\n \\"TableName\\": \\"tableName\\",\\n \\"TableType\\": \\"PHYSICAL_SCHEMA_NAME\\",\\n \\"CreateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"UpdateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"Description\\": \\"Description\\",\\n \\"Owner\\": \\"abc\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"example\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"description\\",\\n \\"SchemaName\\": \\"schemaName\\",\\n \\"TableName\\": \\"tableName\\",\\n \\"CreateTime\\": \\"2023-01-05\'T\'13:17:55\'Z\'\\",\\n \\"UpdateTime\\": \\"2023-01-05\'T\'13:17:55\'Z\'\\",\\n \\"PartitionKey\\": true,\\n \\"Nullable\\": false,\\n \\"PrimaryKey\\": true,\\n \\"DistributeKey\\": false\\n }\\n ],\\n \\"Catalog\\": \\"oss\\",\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n }\\n}","type":"json"}]', + ], + 'GetTableDDL' => [ + 'summary' => 'Queries the statement that is used to create a table.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31333,100 +24396,98 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '189978', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '157088', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-xxxx', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'ProcessId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The query ID.'."\n" - ."\n" - .'> You can call the [DescribeProcessList](~~612277~~) operation to query the IDs of queries that are being executed.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '202011191048151921681492420315100****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-bp1ub9grke1****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial.'."\n", - '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" - .'}', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '863D51B7-5321-41D8-A0B6-A088B0******'], + 'SQL' => ['description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'create table ('."\n" + .' id varchar(32)'."\n" + .');', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], + ], ], - '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' => 'KillProcess', - ], - 'DescribeAdviceServiceEnabled' => [ - 'summary' => 'Queries whether the suggestion feature is enabled.', - 'methods' => [ - 'post', - 'get', + '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' => 'GetTableDDL', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:07.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-10-25T05:36:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-22T02:16:05.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableDDL'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getTableDDL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'GetTableObjects' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31438,85 +24499,177 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '157079', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'The sorting field.'."\n" + ."\n" + .'Valid values for Type:'."\n" + .'- Asc'."\n" + .'- Desc'."\n" + ."\n" + .'Valid values for Field:'."\n" + .'- TableName'."\n" + .'- TableSize'."\n" + .'- CreateTime'."\n" + .'- UpdateTime'."\n" + ."\n" + .'Default value: {"Type": "Desc","Field": "TableName"}.', 'type' => 'string', 'required' => false, 'example' => '{"Type": "Desc","Field": "TableName"}', 'title' => ''], + ], + [ + 'name' => 'FilterTblName', + 'in' => 'query', + 'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => 'test_tbl', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'- 30'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'Default value: 30.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-2ze0vp0j6t3to****', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1565u55p32****', 'title' => ''], + ], + [ + 'name' => 'FilterTblType', + 'in' => 'query', + 'schema' => ['description' => 'The table type.'."\n" + .'Valid values:'."\n" + ."\n" + .'- DIMENSION_TABLE'."\n" + .'- FACT_TABLE'."\n" + .'- EXTERNAL_TABLE'."\n" + ."\n" + .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'FACT_TABLE', 'title' => ''], + ], + [ + 'name' => 'FilterOwner', + 'in' => 'query', + 'schema' => ['description' => 'The owner.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], + ], + [ + 'name' => 'FilterDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'Message', - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a **Success** message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', - ], - 'Result' => [ - 'title' => 'Advice Service Enabled', - 'description' => 'Indicates whether the suggestion feature is enabled. Valid values:'."\n" - ."\n" - .'* **True**'."\n" - .'* **False**'."\n", - 'type' => 'boolean', - 'example' => 'False', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '863D51B7-5321-41D8-A0B6-A088B0******'], + 'PageNumber' => ['description' => 'The page number. The value is a positive integer. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'- **30** (default)'."\n" + .'- **50**'."\n" + .'- **100**.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. The value is a positive integer. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'- **30** (default)'."\n" + .'- **50**'."\n" + .'- **100**.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TableSummaryModels' => [ + 'description' => 'The result array.', + 'type' => 'array', + 'items' => ['description' => 'The table summary information.', '$ref' => '#/components/schemas/TableSummaryModel', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"Result\\": true\\n}","type":"json"}]', - 'title' => 'DescribeAdviceServiceEnabled', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeSparkSQLDiagnosisList' => [ - 'summary' => 'Queries the diagnostic information about Spark SQL queries.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query table information', + 'summary' => 'Queries table information.', + 'description' => '- Public endpoint of a region: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- VPC endpoint of a region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.', + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:08.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-08-20T09:30:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-25T05:36:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-22T02:16:05.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableObjects'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getTableObjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"schemaName\\",\\n \\"TableName\\": \\"tableName\\",\\n \\"TableType\\": \\"PHYSICAL_SCHEMA_NAME\\",\\n \\"TableSize\\": 1234,\\n \\"CreateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"UpdateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"SQL\\": \\"create table(a varchar)\\",\\n \\"Description\\": \\"descrtiption\\",\\n \\"Owner\\": \\"abc\\",\\n \\"MvDetailModel\\": {\\n \\"FirstRefreshTime\\": \\"2025-01-01 09:00:00\\",\\n \\"QueryRewriteEnabled\\": false,\\n \\"ExplicitHit\\": 5,\\n \\"IsInactive\\": false,\\n \\"RemoteSize\\": 1234,\\n \\"LocalSize\\": 1234,\\n \\"RefreshState\\": \\"FAST\\",\\n \\"RefreshInterval\\": \\"(now() + INTERVAL \'10\' SECOND)\\",\\n \\"ImplicitHit\\": 20,\\n \\"UpdatedAt\\": \\"2025-01-01 10:00:00\\",\\n \\"ResourceGroup\\": \\"user_default\\",\\n \\"BaseTableInfos\\": [\\n {\\n \\"SchemaName\\": \\"test_db\\",\\n \\"TableName\\": \\"test_tbl\\",\\n \\"BaseTableIsMv\\": false,\\n \\"TableEngine\\": \\"XUANWU\\"\\n }\\n ],\\n \\"TableEngine\\": \\"XUANWU\\",\\n \\"BaseTableNames\\": [\\n [\\n \\"t1\\"\\n ]\\n ],\\n \\"EnableDelayAlert\\": 0,\\n \\"EnableFailureAlert\\": 0,\\n \\"LatencyTolerance\\": 2\\n },\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetViewDDL' => [ + 'summary' => 'Queries the statement that is used to create a view.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31528,253 +24681,98 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '197113', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '157089', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-2zez35ww415xjwk5', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'StatementId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the code block in the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '20', - ], + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'ViewName', 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON format. Example: `[{"Field":"MaxExclusiveTime","Type":"Asc"}]`.'."\n" - ."\n" - .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" - ."\n" - .' * `MaxExclusiveTime`: the maximum execution duration.'."\n" - .' * `PeakMemory`: the peak memory.'."\n" - .' * `QueryStartTime`: the start time of the query.'."\n" - .' * `QueryWallclockTime`: the execution duration of the query.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values:'."\n" - ."\n" - .' * `Asc`: ascending order.'."\n" - .' * `Desc`: descending order.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you do not specify this parameter, query results are sorted by `MaxExclusiveTime` in ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"Field\\":\\"QueryStartTime\\",\\"Type\\":\\"Desc\\"}]', - ], + 'schema' => ['description' => 'The name of the view.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v_modbus', 'title' => ''], ], [ - 'name' => 'MinStartTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The earliest start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-28 22:00:00', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-bp1ub9grke1****', 'title' => ''], ], [ - 'name' => 'MaxStartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The latest start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-28 23:00:00', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1343', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A91C9D07-7462-5F35-BB47-83629CE6CCAC', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'SQLDiagnosisList' => [ - 'description' => 'The queried diagnostic information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'State' => [ - 'description' => 'The execution status of the query. Valid values:'."\n" - ."\n" - .'* COMPLETED'."\n" - .'* CANCELED'."\n" - .'* ABORTED'."\n" - .'* FAILED'."\n", - 'type' => 'string', - 'example' => 'COMPLETED', - ], - 'SQL' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'example' => 'select * from device where name = \'105506012112790031\'', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~612475~~) operation to query a list of Spark application IDs.'."\n", - 'type' => 'string', - 'example' => 's202404291020bjd448ad40002122', - ], - 'StatementId' => [ - 'description' => 'The unique ID of the code block in the Spark job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'InnerQueryId' => [ - 'description' => 'The ID of the query executed within the Spark application.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-11-20 09:09:00', - ], - 'ElapsedTime' => [ - 'description' => 'The execution duration of the query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxExclusiveTime' => [ - 'description' => 'The maximum operator execution duration. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '90', - ], - 'PeakMemory' => [ - 'description' => 'The maximum operator memory used. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'ScanRowCount' => [ - 'description' => 'The number of entries scanned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - 'description' => 'The queried diagnostic information.', - ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The information about the request denial.'."\n", - 'type' => 'string', - 'example' => '{}', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17'], + 'SQL' => ['description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'CREATE VIEW `test`.`test_view` AS SELECT'."\n" + .' `id`'."\n" + .', `name`'."\n" + .'FROM'."\n" + .' `test_tbl_adb`', 'title' => ''], ], - 'description' => 'The response parameters.', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - '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' => 'DescribeSparkSQLDiagnosisList', - ], - 'DescribeSparkSQLDiagnosisAttribute' => [ - 'summary' => 'Queries the diagnostic information about a Spark SQL query.', - 'methods' => [ - 'post', - 'get', + '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' => 'GetViewDDL', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-05-07T05:42:07.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-10-25T05:36:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-22T02:16:05.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetViewDDL'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getViewDDL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'GetViewObjects' => [ + 'summary' => 'Queries view information.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31786,318 +24784,212 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '197163', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '157080', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-2zeq4788qyy7k662', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1xxxxxxxx47', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'adb_demo', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~612475~~) operation to query a list of Spark application IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202411071444hzdvk486d9d2001****', - ], + 'schema' => ['description' => 'The sorting field.'."\n" + ."\n" + .'Valid values for Type:'."\n" + .'- Asc'."\n" + .'- Desc'."\n" + ."\n" + .'Valid values for Field:'."\n" + .'- ViewName'."\n" + .'- CreateTime'."\n" + .'- UpdateTime'."\n" + ."\n" + .'Default value: {"Type": "Desc","Field": "ViewName"}.', 'type' => 'string', 'required' => false, 'example' => '{"Type": "Desc","Field": "ViewName"}', 'title' => ''], ], [ - 'name' => 'InnerQueryId', + 'name' => 'FilterViewName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the query executed within the Spark application.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'exclusiveMaximum' => true, - 'minimum' => '-2', - 'exclusiveMinimum' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The view name.', 'type' => 'string', 'required' => false, 'example' => 'test_filter', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The language in which to return the query results. Valid values:'."\n" - ."\n" - .'* en: English.'."\n" - .'* zh: Chinese.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'* **30** (default).'."\n" + .'* **50**.'."\n" + .'* **100**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'FilterViewType', + 'in' => 'query', + 'schema' => ['description' => 'The view type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- VIRTUAL_VIEW'."\n" + .'- MATERIALIZED_VIEW'."\n" + ."\n" + .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'VIRTUAL_VIEW', 'title' => ''], + ], + [ + 'name' => 'FilterOwner', + 'in' => 'query', + 'schema' => ['description' => 'The owner.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ShowMvBaseTable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display the base table information of materialized views.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~612475~~) operation to query a list of Spark application IDs.'."\n", - 'type' => 'string', - 'example' => 's202411071444hzdvk486d9d2001****', - ], - 'InnerQueryId' => [ - 'description' => 'The ID of the query executed within the Spark application.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ElapsedTime' => [ - 'description' => 'The execution duration of the query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'DiagnosisInfos' => [ - 'description' => 'The queried diagnostic information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried diagnostic information.'."\n", - '$ref' => '#/components/schemas/Adb4MysqlSparkDiagnosisInfo', - ], - ], - 'OperatorListSortedByMetrics' => [ - 'description' => 'The operators sorted by metrics.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'PageNumber' => ['description' => 'The page number. The value is a positive integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'* **30** (default).'."\n" + .'* **50**.'."\n" + .'* **100**.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Data' => [ + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'OperatorListSortedByMaxMemory' => [ - 'description' => 'The operators sorted by the maximum memory used.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the Spark operator.'."\n", - '$ref' => '#/components/schemas/SparkOperatorInfo', - ], - ], - 'OperatorListSortedByExclusiveTime' => [ - 'description' => 'The operators sorted by the execution duration.'."\n", + 'PageNumber' => ['description' => 'The page number. The value is a positive integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'* **30** (default).'."\n" + .'* **50**.'."\n" + .'* **100**.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TableSummaryModels' => [ + 'description' => 'The result array.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about the Spark operator.'."\n", - '$ref' => '#/components/schemas/SparkOperatorInfo', - ], + 'items' => ['description' => 'The view summary information.', '$ref' => '#/components/schemas/TableSummaryModel', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], - ], - 'Root' => [ - 'description' => 'The Spark execution plan tree.'."\n", - '$ref' => '#/components/schemas/OperatorNode', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The information about the request denial.'."\n", - 'type' => 'string', - 'example' => '{}', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - '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' => 'DescribeSparkSQLDiagnosisAttribute', - ], - 'DescribeOversizeNonPartitionTableInfos' => [ - 'summary' => 'Queries the information about oversized non-partitioned tables in an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query view information', + 'description' => '- Public endpoint of a region: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- VPC endpoint of a region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.', + 'changeSet' => [ + ['createdAt' => '2025-07-28T15:32:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-07T05:42:07.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-04-10T10:59:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-25T05:36:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-22T02:16:05.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetViewObjects'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getViewObjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"schemaName\\",\\n \\"TableName\\": \\"tableName\\",\\n \\"TableType\\": \\"PHYSICAL_SCHEMA_NAME\\",\\n \\"TableSize\\": 1234,\\n \\"CreateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"UpdateTime\\": \\"2023-01-05 13:17:55\\",\\n \\"SQL\\": \\"create table(a varchar)\\",\\n \\"Description\\": \\"descrtiption\\",\\n \\"Owner\\": \\"abc\\",\\n \\"MvDetailModel\\": {\\n \\"FirstRefreshTime\\": \\"2025-01-01 09:00:00\\",\\n \\"QueryRewriteEnabled\\": false,\\n \\"ExplicitHit\\": 5,\\n \\"IsInactive\\": false,\\n \\"RemoteSize\\": 1234,\\n \\"LocalSize\\": 1234,\\n \\"RefreshState\\": \\"FAST\\",\\n \\"RefreshInterval\\": \\"(now() + INTERVAL \'10\' SECOND)\\",\\n \\"ImplicitHit\\": 20,\\n \\"UpdatedAt\\": \\"2025-01-01 10:00:00\\",\\n \\"ResourceGroup\\": \\"user_default\\",\\n \\"BaseTableInfos\\": [\\n {\\n \\"SchemaName\\": \\"test_db\\",\\n \\"TableName\\": \\"test_tbl\\",\\n \\"BaseTableIsMv\\": false,\\n \\"TableEngine\\": \\"XUANWU\\"\\n }\\n ],\\n \\"TableEngine\\": \\"XUANWU\\",\\n \\"BaseTableNames\\": [\\n [\\n \\"t1\\"\\n ]\\n ],\\n \\"EnableDelayAlert\\": 0,\\n \\"EnableFailureAlert\\": 0,\\n \\"LatencyTolerance\\": 2\\n },\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GrantOperatorPermission' => [ + 'summary' => 'Grants permissions to the service account of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '217358', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '214575', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp11q28kvl688****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1565u55p32****', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ExpiredTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n" - ."\n" - .'> '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2024-05-11T05:44Z', - ], + 'schema' => ['description' => 'The expiration time of the service account permissions. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-11-30T00:00:00Z', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Privileges', 'in' => 'query', 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n" + 'description' => 'The name of the permissions. Valid values:'."\n" ."\n" - .'> The end time must be later than the start time. The specified time range must be less than seven days.'."\n", + .'* **Control**: the configuration permissions. The service account is granted the permissions to query and modify cluster configurations.'."\n" + .'* **Data**: the data permissions. The service account is granted the permissions to query schemas, indexes, and SQL statements.'."\n", 'type' => 'string', - 'required' => false, + 'required' => true, 'docRequired' => true, - 'example' => '2024-05-11T05:44Z', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* 30'."\n" - .'* 50'."\n" - .'* 100'."\n" - ."\n" - .'Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of file titles and error messages. Valid values:'."\n" - ."\n" - .'* **zh (default)**: simplified Chinese.'."\n" - .'* **en**: English'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON format.'."\n" - ."\n" - .'Example:'."\n" - ."\n" - .' ['."\n" - ."\n" - .' {'."\n" - ."\n" - .' "Field":"Name",'."\n" - ."\n" - .' "Type":"Asc"'."\n" - ."\n" - .' }'."\n" - ."\n" - .' ]'."\n" - ."\n" - .'Field specifies the field by which to sort the query results. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.'."\n" - ."\n" - .'Field and Type are case-insensitive.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Field":"SchemaName","Type":"Asc"}]', + 'enumValueTitles' => ['Control' => 'Control', 'Data' => 'Data'], + 'example' => 'Control', + 'title' => '', ], ], ], @@ -32106,157 +24998,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'am-bp16t5ci7r74s****', - ], - 'Tables' => [ - 'description' => 'The queried oversized non-partitioned tables.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'RowCount' => [ - 'description' => 'The number of rows in the table.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1222', - ], - 'IndexSize' => [ - 'description' => 'The data size of regular indexes. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '111', - ], - 'DataSize' => [ - 'description' => 'The data size of the table. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2921132457984', - ], - 'LocalDataSize' => [ - 'description' => 'The size of hot data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1223', - ], - 'PrimaryKeySize' => [ - 'description' => 'The data size of the primary key index. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RemoteDataSize' => [ - 'description' => 'The size of cold data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '122', - ], - 'SpaceRatio' => [ - 'description' => 'The percentage of the table size. Unit: %.'."\n" - ."\n" - .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.3', - ], - ], - 'description' => 'The queried oversized non-partitioned table.', - ], - ], - 'DetectionItems' => [ - 'description' => 'The queried detection items and detection results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection item and detection result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the detection item.'."\n", - 'type' => 'string', - 'example' => 'Oversized non-partitioned tables', - ], - 'Message' => [ - 'description' => 'The information about the detection result.'."\n", - 'type' => 'string', - 'example' => 'Multiple oversized non-partitioned tables are detected.', - ], - 'Status' => [ - 'description' => 'The severity level of the detection result.'."\n", - 'type' => 'string', - 'example' => 'NORMAL'."\n" - .'WARNING'."\n" - .'CRITICAL', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A438072A-E2E7-5509-9A3F-66293512A820', 'title' => ''], ], - 'description' => 'The response parameter.', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'RelatedTaskNotFinish', 'errorMessage' => 'The related task does not finish.', 'description' => 'The related task has not finished.'], ], ], - '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' => 'DescribeOversizeNonPartitionTableInfos', - ], - 'DescribeTablePartitionDiagnose' => [ - 'summary' => 'Queries the information about partition diagnostics.', - 'methods' => [ - 'post', - 'get', + 'title' => 'GrantOperatorPermission', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantOperatorPermission'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:GrantOperatorPermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A438072A-E2E7-5509-9A3F-66293512A820\\"\\n}","type":"json"}]', + ], + 'KillProcess' => [ + 'summary' => 'Terminates an ongoing query.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32265,13 +25045,11 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '186721', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '189978', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -32279,89 +25057,23 @@ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp171g24yvbxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-xxxx', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON string format. Example: `[{"Field":"TotalSize","Type":"Desc"}]`.'."\n" - ."\n" - .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" - ."\n" - .' * `SchemaName`: the name of the database to which the table belongs.'."\n" - .' * `TableName`: the name of the table.'."\n" - .' * `TotalSize`: the total data size of the table.'."\n" - .' * `SpaceRatio`: the storage percentage of the table.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values:'."\n" - ."\n" - .' * `Asc`: ascending order.'."\n" - .' * `Desc`: descending order.'."\n" - ."\n" - .'> If you do not specify this parameter, the query results are sorted by the TotalSize field in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"Field\\":\\"TotalSize\\",\\"Type\\":\\"Desc\\"}]', - 'default' => '[{"Field":"SchemaName", "Type": "desc" }]', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'ProcessId', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['description' => 'The query ID.'."\n" + ."\n" + .'> You can call the [DescribeProcessList](~~612277~~) operation to query the IDs of queries that are being executed.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '202011191048151921681492420315100****', 'title' => ''], ], ], 'responses' => [ @@ -32369,222 +25081,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '185', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-bp171g24yvbxxxxx', - ], - 'SuggestMaxRecordsPerPartition' => [ - 'description' => 'The recommended maximum number of rows in each partition.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '640000000', - ], - 'SuggestMinRecordsPerPartition' => [ - 'description' => 'The recommended minimum number of rows in each partition.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '64000000', - ], - 'Items' => [ - 'description' => 'The queried partition diagnostic information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried partition diagnostic information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'user', - ], - 'PartitionDetail' => [ - 'description' => 'The improper partitions.'."\n", - 'type' => 'string', - 'example' => '[20210110, 20210113,20210123]', - ], - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'test_db', - ], - 'PartitionNumber' => [ - 'description' => 'The number of partitions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalSize' => [ - 'description' => 'The total data size of the table. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42949672960', - ], - 'SpaceRatio' => [ - 'description' => 'The storage percentage of the table. Unit: %.'."\n" - ."\n" - .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.', - 'type' => 'number', - 'format' => 'double', - 'example' => '66.23', - ], - ], - ], - ], - 'DetectionItems' => [ - 'description' => 'The queried detection items and detection results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection item and detection result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the detection item.'."\n", - 'type' => 'string', - 'example' => 'Improper partition field diagnostics', - ], - 'Message' => [ - 'description' => 'The detection result.'."\n", - 'type' => 'string', - 'example' => 'Multiple oversized non-partitioned tables are detected.', - ], - 'Status' => [ - 'description' => 'The severity level of the detection result. Valid values:'."\n" - ."\n" - .'* NORMAL'."\n" - .'* WARNING'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'WARNING', - ], - ], - ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The information about the request denial.'."\n", - '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" - .'}', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n", '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" + .'}', 'title' => ''], ], - 'description' => 'The response parameters.', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeTablePartitionDiagnose', - ], - 'DescribeSparkAppDiagnosisInfo' => [ - 'summary' => 'Queries the diagnostic information about a Spark application.', - 'methods' => [ - 'post', - 'get', + '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' => 'KillProcess', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KillProcess'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:KillProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'KillSparkApp' => [ + 'summary' => 'Terminates a Spark application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '189113', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-uf663j39b0jd2***', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query all application IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's202411061017sh0ad564b000****', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the Spark application that you want to terminate.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202204132018hzprec1ac****', 'maxLength' => 64], ], [ - 'name' => 'Language', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The language in which you want to display the results. Valid values:'."\n" - ."\n" - .'* en: English.'."\n" - .'* zh (default): Chinese.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'PYTHON', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-bp1ub9grke1****', 'title' => ''], ], ], 'responses' => [ @@ -32592,533 +25152,353 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FB5AC339-91F6-5000-8E5A-F47065B01B87', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n" - ."\n" - .'> You can call the [ListSparkApps](~~455888~~) operation to query all application IDs.'."\n", - 'type' => 'string', - 'example' => 's202404141952sz6a1391200****', - ], - 'StartedTime' => [ - 'description' => 'The time when the application started to be executed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718329831000', - ], - 'DurationInMillis' => [ - 'description' => 'The execution duration of the application. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '281063', - ], - 'State' => [ - 'description' => 'The status of the asynchronous import or export job. Valid values:'."\n" - ."\n" - .'* **RUNNING**'."\n" - .'* **FINISHED**'."\n" - .'* **FAILED**'."\n", - 'type' => 'string', - 'example' => 'FINISHED', - ], - 'CpuUtilization' => [ - 'description' => 'The CPU utilization. Unit: %.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'PeakMemoryInByte' => [ - 'description' => 'The peak memory usage. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4096000', - ], - 'ShuffleWriteInByte' => [ - 'description' => 'The amount of data used for shuffle writes. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4096000', - ], - 'ShuffleReadInByte' => [ - 'description' => 'The amount of data used for shuffle reads. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4096000', - ], - 'SpillInByte' => [ - 'description' => 'The amount of data spilled to disks when the memory is insufficient. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'JVMGcCostInMillis' => [ - 'description' => 'The amount of time consumed by the Java virtual machine to perform garbage collection operations. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '81055', - ], - 'DiagnosisInfoList' => [ - 'description' => 'The queried diagnostic information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried diagnostic information.'."\n", - '$ref' => '#/components/schemas/Adb4MysqlSparkDiagnosisInfo', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '69D0810B-F9F5-5F4C-A57F-DF36133B63C9'], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppId' => ['title' => '', 'description' => 'The Spark application ID.'."\n", 'type' => 'string', 'example' => 's202204132018hzprec1ac****'], + 'AppName' => ['title' => '', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'test'], + 'Message' => ['title' => '', 'description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => '[Advisor] Advisor feature is not available for instance: amv-bp11q28kvl688****'], + 'State' => ['title' => '', 'description' => 'The execution state of the Spark application. Valid values:'."\n" + ."\n" + .'* **SUBMITTED**'."\n" + .'* **STARTING**'."\n" + .'* **RUNNING**'."\n" + .'* **FAILING**'."\n" + .'* **FAILED**'."\n" + .'* **KILLING**'."\n" + .'* **KILLED**'."\n" + .'* **SUCCEEDING**'."\n" + .'* **COMPLETED**'."\n" + .'* **FATAL**'."\n" + .'* **UNKNOWN**'."\n", 'type' => 'string', 'example' => 'KILLED'], + 'DBClusterId' => ['title' => '', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-bp11q28kvl688****', 'default' => 'DB_CLUSTER_ID'], ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The information about the request denial.'."\n", - '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" - .'}', + 'title' => '', + 'example' => '', ], ], - 'description' => 'The response parameters.', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.App.KillOperationFailed', 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', 'description' => 'Failed to kill the Spark application. Try again later.'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ], + 406 => [ + ['errorCode' => 'Spark.App.KillNotAcceptable', 'errorMessage' => 'Can\'t kill the application %s in %s state.', 'description' => 'A Spark application in a non-deletable state cannot be deleted.'], + ], + 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 LAKEHOUSE-1-1\\n [Advisor] Advisor feature is not available for instance: am-2ze292w4fyglwxxxx\\n running\\n \\n","errorExample":""}]', + 'title' => 'KillSparkApp', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-11-24T09:19:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-06-28T01:10:31.000Z', 'description' => 'Error codes changed'], ], - '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' => 'DescribeSparkAppDiagnosisInfo', - ], - 'EnableAdviceService' => [ - 'summary' => 'Enables the suggestion feature.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KillSparkApp'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:KillSparkApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], + ], + ], ], + ], + 'KillSparkLogAnalyzeTask' => [ + 'summary' => 'Terminates a Spark log analysis task and queries the information about the analysis task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1q10xxzq2z4****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shanghai', - ], + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the Spark log analysis task. You can call the ListSparkLogAnalyzeTasks operation to query the IDs and states of all analysis tasks in the current cluster.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '15'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E1745C03-7CCE-55CF-932E-08121AAFA6AF', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709'], + 'Data' => ['description' => 'The information about the Spark log analysis task.'."\n", '$ref' => '#/components/schemas/SparkAnalyzeLogTask', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1745C03-7CCE-55CF-932E-08121AAFA6AF\\"\\n}","type":"json"}]', - 'title' => 'EnableAdviceService', - ], - 'DescribeAppliedAdvices' => [ - 'summary' => 'Queries the applied optimization suggestions for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], + ], + '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: cpu is exceeded limits 12/10\\",\\n \\"AppErrorAdvice\\": \\"Please increase cpu quota for your resource group\\"\\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' => 'KillSparkLogAnalyzeTask', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-07-27T06:45:55.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KillSparkLogAnalyzeTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:KillSparkLogAnalyzeTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/task/{#SparkTaskId}'], + ], + ], + ], ], + ], + 'KillSparkSQLEngine' => [ + 'summary' => 'Shuts down a Spark SQL engine.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193678', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '152585', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-uf6g8w25jacm7****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-8vbn8pq537k8w****', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'spark_test', 'title' => ''], ], - [ - 'name' => 'StartTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'StartTime', - 'description' => 'The start date of the time range to query. Specify the date in the yyyyMMdd format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20220811', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380'], + 'Data' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => 'EndTime', - 'description' => 'The end date of the time range to query. Specify the date in the yyyyMMdd format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20220824', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.App.KillOperationFailed', 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', 'description' => 'Failed to kill the Spark application. Try again later.'], ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'title' => 'Lang', - 'description' => 'The display language of the suggestion. Valid values:'."\n" - ."\n" - .'* **zh** (default): simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**(Default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - ], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ], + 406 => [ + ['errorCode' => 'Spark.App.KillNotAcceptable', 'errorMessage' => 'Can\'t kill the application %s in %s state.', 'description' => 'A Spark application in a non-deletable state cannot be deleted.'], + ], + 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], + ], + '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' => 'KillSparkSQLEngine', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-06-28T01:10:30.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KillSparkSQLEngine'], ], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => 'PageNumber', - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:KillSparkEngine', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], + ], ], ], + ], + ], + 'ListApsWebhook' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'AdviceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the suggestion. Valid values:'."\n" - ."\n" - .'* **INDEX**: index optimization.'."\n" - .'* **TIERING**: hot and cold data optimization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'INDEX', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsBIVU9O', 'FEATUREadsY28JLD'], + ], + 'parameters' => [ [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to query information by table name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'you_table_name', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-8vbuyjhrih**', 'title' => ''], ], [ - 'name' => 'SchemaTableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table in the **DatabaseName.TableName** format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tpch.lineitem', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON format. Example: `[{"Field":"SchemaName","Type":"Asc"}]`.'."\n" - ."\n" - .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" - ."\n" - .' * `SchemaName`: the name of the database.'."\n" - .' * `TableName`: the name of the table.'."\n" - .' * `JobStatus`: the status of the BUILD job that is triggered on the table.'."\n" - .' * `SubmitTime`: the time when the suggestion was submitted.'."\n" - .' * `Benefit`: the expected benefits of the applied optimization suggestion.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values:'."\n" - ."\n" - .' * `Asc`: ascending order.'."\n" - .' * `Desc`: descending order.'."\n" - ."\n" - .'> If you do not specify this parameter, optimization suggestions are sorted in descending order based on the submission time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"Field\\":\\"AdviceType\\",\\"Type\\":\\"Desc\\"}]', - ], + 'name' => 'JobType', + 'in' => 'formData', + 'schema' => ['description' => '**JobType** '."\n" + .'The task type. Set this parameter to ResultExport for SLS or OSS export tasks.', 'type' => 'string', 'required' => false, 'example' => 'ResultExport', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response message.', 'type' => 'object', 'properties' => [ - 'Items' => [ - 'title' => 'Items', - 'description' => 'The queried applied optimization suggestions.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'exampleRequestId'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The API status code or POP error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Webhook' => [ + 'description' => 'The webhook array.', 'type' => 'array', 'items' => [ - 'description' => 'The queried applied optimization suggestion.'."\n", + 'description' => 'The webhook array.', 'type' => 'object', 'properties' => [ - 'AdviceId' => [ - 'title' => 'AdviceId', - 'description' => 'The suggestion ID.'."\n", - 'type' => 'string', - 'example' => '7417db9c-914d-43f3-a123-4d0e448f****', - ], - 'SubmitTime' => [ - 'title' => 'SubmitTime', - 'description' => 'The time when the suggestion was submitted. The time follows the ISO 8601 standard in the yyMMddHHmm format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2208131600', - ], - 'SubmitStatus' => [ - 'title' => 'SubmitStatus', - 'description' => 'The submission status of the suggestion. Valid values:'."\n" - ."\n" - .'* **SUCCEED**'."\n" - .'* **FAILED**'."\n", - 'type' => 'string', - 'example' => 'SUCCEED', - ], - 'SQL' => [ - 'title' => 'SQL', - 'description' => 'The SQL statement that is used to apply the suggestion.'."\n", - 'type' => 'string', - 'example' => 'alter table `schema1`.`table1` drop key col1_1_idx', - ], - 'RollbackSQL' => [ - 'title' => 'RollbackSQL', - 'description' => 'The SQL statement that is used to roll back the suggestion.'."\n", - 'type' => 'string', - 'example' => 'alter table `schema1`.`table1` add key col1_1_idx(col1)', - ], - 'JobStatus' => [ - 'title' => 'JobStatus', - 'description' => 'The status of the suggestion execution job. Valid values:'."\n" - ."\n" - .'* **SUCCEED**'."\n" - .'* **FAILED**'."\n", - 'type' => 'string', - 'example' => 'SUCCEED', - ], - 'Benefit' => [ - 'title' => 'Benefit', - 'description' => 'The benefit of the suggestion.'."\n", - 'type' => 'string', - 'example' => '0.4 GB of storage saved', - ], - 'BuildSQL' => [ - 'title' => 'Benefit', - 'description' => 'The SQL statement that is used to execute the BUILD job.'."\n", - 'type' => 'string', - 'example' => 'build table `schema1`.`table1`', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**(Default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'PageNumber' => [ - 'title' => 'PageNumber', - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'IndexFields' => [ - 'type' => 'string', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30**(Default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '84489769-3065-5A28-A4CB-977CD426F1C3', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SchemaTableNames' => [ - 'description' => 'The name of the table in the DatabaseName.TableName format.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the table in the DatabaseName.TableName format.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' "tpch.lineitem",'."\n" - .' "tpch.partsupp",'."\n" - .' "tpch.orders"'."\n" - .']', + 'WebhookType' => ['description' => 'The webhook type.', 'type' => 'string', 'example' => 'dingtalk', 'title' => ''], + 'WebhookId' => ['description' => 'The webhook ID.', 'type' => 'string', 'example' => '**35***', 'title' => ''], + 'Url' => ['description' => 'The request URL.', 'type' => 'string', 'example' => 'https://example.com/webhook', 'title' => ''], + 'Key' => ['description' => 'The signing key.', 'type' => 'string', 'example' => 'your_secret_key', 'title' => ''], + 'Name' => ['description' => 'The webhook name.', 'type' => 'string', 'example' => 'webhook_name', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'DescribeAppliedAdvices', - ], - 'DisableAdviceService' => [ - 'summary' => 'Disables the suggestion feature.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query webhooks', + 'summary' => 'Queries the webhook configurations for a specified database cluster.', + 'description' => 'Queries the list of configured webhooks for a specified database cluster based on RegionId, DBClusterId, and the optional JobType parameter. The JobType parameter specifies the task type, such as SLS or OSS export tasks. If JobType is specified, only webhooks associated with the specified task type are returned. If JobType is not specified, webhooks of all types are returned.'."\n" + ."\n" + .'Note: Ensure that the RegionId and DBClusterId values you provide are correct. Otherwise, the webhook information may not be retrieved.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApsWebhook'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:ListApsWebhook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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"}]', + ], + 'ListLakeStorages' => [ + 'summary' => 'Queries a list of lake storages.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33127,297 +25507,368 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'list', + 'abilityTreeCode' => '216928', + 'abilityTreeNodes' => ['FEATUREadsQO9FPM'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-uf67culrr26q2****', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shanghai', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - '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' => 'DisableAdviceService', - ], - 'BatchApplyAdviceByIdList' => [ - 'summary' => 'Applies optimization suggestions.', - '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' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-uf6g8w25jacm7****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'regionId', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AdviceIdList', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the suggestions that you want to apply. Separate multiple IDs with commas (,).', - '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****', - ], + 'schema' => ['title' => '', 'description' => 'The filter parameters that you want to use to query lake storages. Specify multiple parameters in an AND relationship. For example, if you want to query lake storage whose names are in the range of i-a123, or i-b123, and in the Stopped state, set this parameter to \\&Filter. 1.Name=InstanceName\\&Filter. 1.Value.1=i-a123\\&Filter.1.Value.2=i-b123\\&Filter.2.Name=Status\\&Filter. 2.Value=Stopped.'."\n", 'type' => 'string', 'required' => false, 'example' => '-'], ], [ - 'name' => 'AdviceDate', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => 'AdviceDate', - 'description' => 'The date on which you want to apply the suggestion. Format: yyyyMMdd.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20221115', - ], + 'schema' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ApplyType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'BuildImmediately', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-*******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '86F92D26-B774-5FA1-8E53-82CBEEEBB012', - 'title' => 'Id of the request', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '****-964D-****-9D31-****'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['title' => '', 'description' => 'The token that is used for paging when the number of results is greater than the value of MaxResults.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'Items' => [ + 'title' => '', + 'description' => 'The queried lake storages.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'LakeStorageItemType'."\n", + 'type' => 'object', + 'properties' => [ + 'OwnerUid' => ['title' => '', 'description' => 'The queried lake storage.'."\n", 'type' => 'string', 'example' => '123456'], + 'DBClusterId' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", 'type' => 'string', 'example' => 'amv-*******'], + 'TotalRows' => ['title' => '', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'pattern' => '', 'default' => ''], + 'OperatorUid' => ['title' => '', 'description' => 'The operator UID.'."\n", 'type' => 'string', 'example' => '123456'], + 'Permissions' => [ + 'title' => '', + 'description' => 'The permissions on the lake storage.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The permissions.'."\n", + 'type' => 'object', + 'properties' => [ + 'Read' => ['title' => '', 'description' => 'The read permissions.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Write' => ['title' => '', 'description' => 'The write permissions.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'Account' => ['title' => '', 'description' => 'The database account ID.'."\n", 'type' => 'string', 'example' => '-', 'pattern' => '^\\d+$', 'default' => ''], + 'Type' => [ + 'title' => '', + 'description' => 'The type of the database account.'."\n", + 'type' => 'string', + 'example' => '-', + 'enum' => ['CUSTOMER', 'SUB', 'STS'], + ], + ], + 'example' => '-', + ], + 'example' => '-', + ], + 'TableCount' => ['title' => '', 'description' => 'The number of tables.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'pattern' => '', 'default' => ''], + 'Description' => ['title' => '', 'description' => 'The description of the lake storage.'."\n", 'type' => 'string', 'example' => 'Create a role to run ROS StackGroups.'], + 'LakeStorageId' => ['title' => '', 'description' => 'The unique identifier of the lake storage.'."\n", 'type' => 'string', 'example' => '-'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the lake storage was created.'."\n", 'type' => 'string', 'example' => '2021-04-01T09:50:18Z'], + 'TotalStorage' => ['title' => '', 'description' => 'The total storage size.'."\n", 'type' => 'string', 'example' => '111333'], + 'CreatorUid' => ['title' => '', 'description' => 'The creator UID.'."\n", 'type' => 'string', 'example' => '123456'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the lake storage was last updated.'."\n", 'type' => 'string', 'example' => '2024-03-15T02:24:32'], + 'RegionId' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], + 'FileSize' => ['description' => 'The size of data files.'."\n", 'type' => 'string', 'example' => '651', 'title' => ''], + ], + 'example' => '-', + ], + 'example' => '-', ], + 'Success' => ['description' => 'Indicates whether the dry run succeeds. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], ], - 'description' => 'The response parameters.', - 'title' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'ListLakeStorages', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLakeStorages'], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListLakeStorages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"86F92D26-B774-5FA1-8E53-82CBEEEBB012\\"\\n}","type":"json"}]', - 'title' => 'BatchApplyAdviceByIdList', ], - 'ApplyAdviceById' => [ - 'summary' => 'Applies an optimization suggestion.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListResultExportJobHistory' => [ + 'summary' => 'Queries the execution records of result set export jobs of a Resource Access Management (RAM) user.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193679', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '219537', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-uf6g8w25jacm7****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.', 'type' => 'string', 'required' => true, 'example' => 'amv-7xv5ty5m9o4v****', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'regionId', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AdviceId', - 'in' => 'query', + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-01-01T12:01:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-05-25T06:54:00Z', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'AdviceId', - 'description' => 'The suggestion ID.'."\n", - 'type' => 'string', + 'description' => 'The order in which to sort the SQL statements by field, which contains the `Field` and `Type` fields. Specify the order in the JSON format. Example: `[{"Field":"CreateTimee", "Type": "desc" }]`.'."\n" + ."\n" + .'* `Field` specifies the field that is used to sort the SQL statements. Valid values:'."\n" + ."\n" + .' * `CreateTime`: the time when the result set export job was created.'."\n" + .' * `Status`: the execution status.'."\n" + .' * `DatabaseUser`: the name of the database account.'."\n" + .' * `TimeCost`: the execution duration.'."\n" + .' * `ResourceGroup`: the name of the resource group.'."\n" + .' * `ExportRows`: the number of exported rows.'."\n" + .' * `Progress`: the export progress.'."\n" + ."\n" + .'* `Type` specifies the sorting order. Valid values (case-insensitive):'."\n" + ."\n" + .' * `Desc`: descending order.'."\n" + .' * `Asc`: ascending order.'."\n", + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'The field that is used to sort the SQL statements. Valid values:'."\n" + ."\n" + .'* CreateTime'."\n" + .'* DatabaseUser'."\n" + .'* TimeCost'."\n" + .'* ResourceGroup'."\n" + .'* Status'."\n" + .'* Progress'."\n" + .'* ExportRows'."\n", 'type' => 'string', 'required' => false, 'example' => 'DatabaseUser', 'title' => ''], + 'Type' => ['description' => 'The sorting order. Valid values (case-insensitive):'."\n" + ."\n" + .'* **Desc**: descending order.'."\n" + .'* **Asc**: ascending order.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Desc', 'title' => ''], + ], 'required' => false, - 'example' => '0baf1f52-53df-487f-8292-99a03716****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AdviceDate', - 'in' => 'query', + 'name' => 'StatusList', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'AdviceDate', - 'description' => 'The date on which you want to apply the suggestion. Format: yyyyMMdd.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The execution status of result set export jobs. You can use this parameter to query the execution records of export jobs that are in a specific state.'."\n", + 'type' => 'array', + 'items' => ['description' => 'Valid values:'."\n" + ."\n" + .'1. **SUBMITTED**'."\n" + .'2. **RUNNING**'."\n" + .'3. **SUCCEEDED**'."\n" + .'4. **FAILED**'."\n", 'type' => 'string', 'required' => false, 'example' => 'RUNNING', 'title' => ''], 'required' => false, - 'example' => '20221101', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ApplyType', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the resource group that runs the result set export jobs. You can use this parameter to query the execution records of export jobs that are run in a specific resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user_default', 'title' => ''], ], [ - 'name' => 'BuildImmediately', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'name' => 'DatabaseUser', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5DC10091-348D-12B1-906D-AB49D658012E', - 'title' => 'Id of the request', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, an **OK** message is returned.'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => 'InvalidInput', 'title' => ''], + 'Items' => [ + 'description' => 'The queried result set export jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried result set export job.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", 'type' => 'string', 'example' => 'amv-7xv5ty5m9o4v****', 'title' => ''], + 'AliUid' => ['description' => 'The RAM user ID.'."\n", 'type' => 'string', 'example' => '120010511678****', 'title' => ''], + 'Sql' => ['description' => 'The SQL statement that is used in the result set export job.'."\n", 'type' => 'string', 'example' => 'SELECT * FROM `ADB_SampleData_TPCH`.`supplier` LIMIT 20', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the result set export job was created. The time follows the ISO 8601 standard in the *yyyy-mm-ddThh:mm:ssZ* format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-04-01T09:50:18Z', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the result set export job. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-07-03T04:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the result set export job. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time.'."\n", 'type' => 'string', 'example' => '2023-06-15T02:13:00Z', 'title' => ''], + 'DatabaseUser' => ['description' => 'The name of the database account that is associated with the RAM user.'."\n", 'type' => 'string', 'example' => 'ram_user', 'title' => ''], + 'TimeCost' => ['description' => 'The amount of time consumed to export execution records. Unit: milliseconds.'."\n" + ."\n" + .'> The value is the duration between the time when the result set export job starts and the time when the result set export job ends.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '560', 'title' => ''], + 'ExportJobId' => ['description' => 'The unique identifier of the result set export job.'."\n", 'type' => 'string', 'example' => 'export_2024051319271219802100800401300****'."\n", 'title' => ''], + 'ResourceGroup' => ['description' => 'The name of the resource group that runs the result set export job.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Status' => ['description' => 'The execution status of the result set export job. Valid values:'."\n" + ."\n" + .'1. **SUBMITTED**'."\n" + .'2. **RUNNING**'."\n" + .'3. **SUCCEEDED**'."\n" + .'4. **FAILED**'."\n", 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'ExportPath' => ['description' => 'The complete URL of the path to store the exported result set.'."\n", 'type' => 'string', 'example' => 'oss://testBucketName/export_test/result_export/2024/05/13/202405131528400210090110690315154****/result.csv', 'title' => ''], + 'Progress' => ['description' => 'The progress of the result set export job. Unit: %. Valid values: 0 to 100.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], + 'ProcessId' => ['description' => 'The query ID that can be used for diagnostics.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisSQLInfo](~~612337~~) operation to query the execution information about a query.', 'type' => 'string', 'example' => '202306121421111720161451770345339****', 'title' => ''], + 'ExportRows' => ['description' => 'The number of exported rows. This parameter is returned only when the request was successful.'."\n", 'type' => 'string', 'example' => '10000', 'title' => ''], + 'Message' => ['description' => 'The returned message. This parameter is returned only when the request failed.'."\n", 'type' => 'string', 'example' => 'Failed to execute SQL', 'title' => ''], + 'Engine' => ['description' => 'The engine that is used to execute the result set export job. Only XIHE is returned.'."\n", 'type' => 'string', 'example' => 'XIHE', 'title' => ''], + 'Schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'lake_db', 'title' => ''], + 'ExportType' => ['description' => 'The type of the result set export job.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'IsExpired' => ['description' => 'Indicates whether the result set export job has expired. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '174', 'title' => ''], ], - 'description' => 'The response parameters.', - 'title' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"5DC10091-348D-12B1-906D-AB49D658012E\\"\\n}","type":"json"}]', - 'title' => 'ApplyAdviceById', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeAvailableAdvices' => [ - 'summary' => 'Queries the available optimization suggestions for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + '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\\": false\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 174\\n}","type":"json"}]', + 'title' => 'ListResultExportJobHistory', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResultExportJobHistory'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListResultExportJobHistory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'ListSemanticViewNames' => [ + 'summary' => 'Query the list of semantic views', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33429,324 +25880,256 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193677', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-bp198m028ih55****', - ], + 'schema' => ['title' => '', 'description' => 'The ADB cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp*****'], ], [ - 'name' => 'RegionId', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the schema to which the semantic view belongs.', 'type' => 'string', 'required' => false, 'example' => 'adb_demo'], ], - [ - 'name' => 'AdviceDate', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'AdviceDate', - 'description' => 'The date when the suggestion is generated. Specify the date in the yyyyMMdd format.'."\n" - ."\n" - .'> Suggestions are generated after analysis after midnight every day. You must specify a date that is at least one day earlier than the current date. For example, if the current date is 20240627, you must specify 20240626 or an earlier date.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '20221124', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => [ + 'description' => 'The returned result data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result data.', + 'type' => 'object', + 'properties' => [ + 'ViewSchema' => ['description' => 'The schema in which the semantic view resides.', 'type' => 'string', 'example' => 'sales_db', 'title' => ''], + 'ViewName' => ['description' => 'The name of the semantic view.', 'type' => 'string', 'example' => 'revenue_analysis', 'title' => ''], + 'Comment' => ['description' => 'The annotation of the semantic view.', 'type' => 'string', 'example' => '这是一个定义销售额相关指标的视图', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'title' => 'Lang', - 'description' => 'The display language of suggestions. Valid values:'."\n" - ."\n" - .'* **zh** (default): simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'zh', - 'default' => 'zh', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.CatalogAlreadyExist', 'errorMessage' => 'The catalog already exists.', 'description' => 'Catalog already exists'], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ['errorCode' => 'MDS.SemanticViewAlreadyExist', 'errorMessage' => 'The semantic view already exists.', 'description' => 'Semantic view already exists'], + ['errorCode' => 'MDS.SemanticViewNotExist', 'errorMessage' => 'This semantic view does not exist.', 'description' => 'This semantic view does not exist'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '30', - 'default' => '100', - ], + ['errorCode' => 'MDS.InstanceNotExist', 'errorMessage' => 'ADB instance does not exist.', 'description' => 'ADB instance does not exist'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query the list of semantic views', + 'description' => 'For the endpoints of the service, see [Endpoints](~~612373~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": [\\n {\\n \\"ViewSchema\\": \\"sales_db\\",\\n \\"ViewName\\": \\"revenue_analysis\\",\\n \\"Comment\\": \\"这是一个定义销售额相关指标的视图\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListSparkAppAttempts' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => 'PageNumber', - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ [ - 'name' => 'AdviceType', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the suggestion. Valid values:'."\n" - ."\n" - .'* **INDEX**: index optimization.'."\n" - .'* **TIERING**: hot and cold data optimization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'INDEX', - ], + 'schema' => ['title' => '', 'description' => 'The application ID.'."\n" + ."\n" + .'> You can call the [ListSparkApps](~~455888~~) operation to query all application IDs.', 'type' => 'string', 'required' => true, 'example' => 's202204132018hzprec1ac****'], ], [ - 'name' => 'Keyword', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to query information by table name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'you_table_name', - ], + 'schema' => ['title' => '', 'description' => 'The page number. The value must be a positive integer. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'SchemaTableName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table in the DatabaseName.TableName format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tpch.lineitem', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Valid values:'."\n" + .'- **10** (default)'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10'], ], [ - 'name' => 'Order', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON format. Example: `[{"Field":"SchemaName","Type":"Asc"}]`.'."\n" - ."\n" - .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" - ."\n" - .' * `SchemaName`: the name of the database.'."\n" - .' * `TableName`: the name of the table.'."\n" - .' * `Benefit`: the expected benefits of the applied optimization suggestion.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values:'."\n" - ."\n" - .' * `Asc`: ascending order.'."\n" - .' * `Desc`: descending order.'."\n" - ."\n" - .'> If you do not specify this parameter, the query results are sorted in descending order based on the Benefit field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"Field\\":\\"AdviceType\\",\\"Type\\":\\"Desc\\"}]', - ], + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => false, 'example' => 'amv-uf6o6m8p6x***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Items' => [ - 'title' => 'Items', - 'description' => 'The queried suggestions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried suggestion.'."\n", - 'type' => 'object', - 'properties' => [ - 'AdviceId' => [ - 'title' => 'AdviceId', - 'description' => 'The suggestion ID.'."\n", - 'type' => 'string', - 'example' => 'dcd04135-0925-4aed-a5a7-e7d92cb1****', - ], - 'AdviceDate' => [ - 'title' => 'AdviceDate', - 'description' => 'The date when the suggestion is generated. The date is in the yyyyMMdd format.', - 'type' => 'string', - 'example' => '20221124', - ], - 'AdviceType' => [ - 'title' => 'AdviceType', - 'description' => 'The type of the suggestion. Valid values:'."\n" - ."\n" - .'* **INDEX**: index optimization.'."\n" - .'* **TIERING**: hot and cold data optimization.'."\n", - 'type' => 'string', - 'example' => 'INDEX', - ], - 'SQL' => [ - 'title' => 'SQL', - 'description' => 'The SQL statement that is used to apply the suggestion.'."\n", - 'type' => 'string', - 'example' => 'alter table `schema1`.`table1` drop key col1_1_idx', - ], - 'Reason' => [ - 'title' => 'Reason', - 'description' => 'The reason why the suggestion was generated.'."\n", - 'type' => 'string', - 'example' => 'Unused for 15 days, historical usage less than 1%', - ], - 'Benefit' => [ - 'title' => 'Benefit', - 'description' => 'The benefit of the suggestion.'."\n", - 'type' => 'string', - 'example' => '0.4 GB of storage saved', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10192', - ], - 'PageSize' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'PageNumber' => [ - 'title' => 'PageNumber', - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test_table', - ], - 'IndexFields' => [ - 'type' => 'string', - ], - ], - ], - ], - 'PageNumber' => [ - 'title' => 'PageNumber', - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '96A55627-28E9-5E47-B8F6-D786BE551349', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10192', - ], - 'SchemaTableNames' => [ - 'description' => 'The name of the table in the DatabaseName.TableName format.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the table in the DatabaseName.TableName format.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' "tpch.lineitem",'."\n" - .' "tpch.partsupp",'."\n" - .' "tpch.orders"'."\n" - .']', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'AttemptInfoList' => [ + 'description' => 'The list of retry information. Metric description:'."\n" + .'- **AttemptId**: the retry ID.'."\n" + .'- **State**: the execute status of the application. Valid values:'."\n" + .' - **SUBMITTED**: commit.'."\n" + .' - **STARTING**: starting.'."\n" + .' - **RUNNING**: executing.'."\n" + .' - **FAILING**: the node failed and the environment is being cleaned up.'."\n" + .' - **FAILED**: failed.'."\n" + .' - **KILLING**: aborting the task and cleaning up the environment.'."\n" + .' - **KILLED**: the task is aborted.'."\n" + .' - **SUCCEEDING**: the node execution is complete and the environment is being cleaned up.'."\n" + .' - **COMPLETED**: the node execution is complete.'."\n" + .' - **FATAL**: unexpected failure.'."\n" + .' - **UNKNOWN**: unknown fault.'."\n" + .'- **Message**: the alerting message. This parameter is empty if no alerting is generated.'."\n" + .'- **Data**: the Spark application template data.'."\n" + .'- **EstimateExecutionCpuTimeInSeconds**: the CPU time consumed to execute the Spark application, in milliseconds (ms).'."\n" + .'- **LogRootPath**: the storage path of log files.'."\n" + .'- **LastAttemptId**: the ID of the last retry.'."\n" + .'- **WebUiAddress**: the web UI address.'."\n" + .'- **SubmittedTimeInMillis**: the time when the Spark application was committed. This value is a UNIX timestamp in milliseconds (ms).'."\n" + .'- **StartedTimeInMillis**: the time when the Spark application was created. This value is a UNIX timestamp in milliseconds (ms).'."\n" + .'- **LastUpdatedTimeInMillis**: the time when the Spark application was last updated. This value is a UNIX timestamp in milliseconds (ms).'."\n" + .'- **TerminatedTimeInMillis**: the time when the Spark application stopped executing. This value is a UNIX timestamp in milliseconds (ms).'."\n" + .'- **DBClusterId**: the ID of the cluster that executes the Spark application.'."\n" + .'- **ResourceGroupName**: the name of the Job-type resource group.'."\n" + .'- **DurationInMillis**: the execution duration of the Spark application, in milliseconds (ms).', + 'type' => 'array', + 'items' => ['description' => 'The list of retry information. Metric description:'."\n" + .'- **AttemptId**: the retry ID.'."\n" + .'- **State**: the execute status of the application. Valid values:'."\n" + .' - **SUBMITTED**: commit.'."\n" + .' - **STARTING**: starting.'."\n" + .' - **RUNNING**: executing.'."\n" + .' - **FAILING**: the node failed and the environment is being cleaned up.'."\n" + .' - **FAILED**: failed.'."\n" + .' - **KILLING**: aborting the task and cleaning up the environment.'."\n" + .' - **KILLED**: the task is aborted.'."\n" + .' - **SUCCEEDING**: the node execution is complete and the environment is being cleaned up.'."\n" + .' - **COMPLETED**: the node execution is complete.'."\n" + .' - **FATAL**: unexpected failure.'."\n" + .' - **UNKNOWN**: unknown fault.'."\n" + .'- **Message**: the alerting message. This parameter is empty if no alerting is generated.'."\n" + .'- **Data**: the Spark application template data.'."\n" + .'- **EstimateExecutionCpuTimeInSeconds**: the CPU time consumed to execute the Spark application, in milliseconds (ms).'."\n" + .'- **LogRootPath**: the storage path of log files.'."\n" + .'- **LastAttemptId**: the ID of the last retry.'."\n" + .'- **WebUiAddress**: the web UI address.'."\n" + .'- **SubmittedTimeInMillis**: the time when the Spark application was committed. This value is a UNIX timestamp in milliseconds (ms).'."\n" + .'- **StartedTimeInMillis**: the time when the Spark application was created. This value is a UNIX timestamp in milliseconds (ms).'."\n" + .'- **LastUpdatedTimeInMillis**: the time when the Spark application was last updated. This value is a UNIX timestamp in milliseconds (ms).'."\n" + .'- **TerminatedTimeInMillis**: the time when the Spark application stopped executing. This value is a UNIX timestamp in milliseconds (ms).'."\n" + .'- **DBClusterId**: the ID of the cluster that executes the Spark application.'."\n" + .'- **ResourceGroupName**: the name of the Job-type resource group.'."\n" + .'- **DurationInMillis**: the execution duration of the Spark application, in milliseconds (ms).', '$ref' => '#/components/schemas/SparkAttemptInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter.PageSize', - 'errorMessage' => 'The PageSize parameter is required.', - ], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Query retry information of a spark application', + 'summary' => 'Queries the retry information of a specified Spark application.', + 'description' => '- Public endpoint of a region: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- VPC endpoint of a region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.'."\n" + .'> If you encounter a 409 fault when initiating a request from Hong Kong (China), submit a ticket or contact technical support.', + 'changeSet' => [ + ['createdAt' => '2023-11-24T09:19:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-06-28T01:10:29.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-07-19T03:21:06.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'DescribeAvailableAdvices', - ], - 'DescribeDiagnosisSQLInfo' => [ - 'summary' => 'Queries the execution information about an SQL statement, including the execution plan, execution information, resource usage, and self-diagnostics results.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkAppAttempts'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkAppAttempts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'tags' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"AttemptInfoList\\": [\\n {\\n \\"AttemptId\\": \\"s202207151211hz****-0001\\",\\n \\"Message\\": \\"WARN: Disk is full\\",\\n \\"Priority\\": \\"NORMAL\\",\\n \\"State\\": \\"SUBMITTED\\",\\n \\"Detail\\": {\\n \\"DurationInMillis\\": 100,\\n \\"LogRootPath\\": \\"oss:///logs/driver\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\",\\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\\": \\"s202204291426hzpre60****-0003\\",\\n \\"TerminatedTimeInMillis\\": 1651213645300,\\n \\"ResourceProvisioningDurationInMillis\\": 36000,\\n \\"ExecutionDurationInMillis\\": 36000,\\n \\"WebUiAddress\\": \\"https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\",\\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}","type":"json"}]', + ], + 'ListSparkApps' => [ + 'summary' => 'Queries the list of Spark applications.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -33758,217 +26141,185 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '132343', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1r053byu48p', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ProcessId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query ID.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the diagnostic information about SQL statements for an AnalyticDB for MySQL cluster, including the query ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2021070216432217201616806503453', - 'default' => '2023091317073501108614302703151362858', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****'], ], [ - 'name' => 'ProcessStartTime', + 'name' => 'ResourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The execution start time of the SQL statement. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the diagnostic information about SQL statements for an AnalyticDB for MySQL cluster, including the execution start time of the SQL statement.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '1625215402000', - 'default' => '-1', - ], + 'schema' => ['description' => 'The name of the job resource group.', 'type' => 'string', 'required' => false, 'example' => 'test_instance', 'title' => ''], ], [ - 'name' => 'ProcessState', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the SQL statement. Valid values:'."\n" - ."\n" - .'* **running**'."\n" - .'* **finished**'."\n" - .'* **failed**'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the diagnostic information about SQL statements for an AnalyticDB for MySQL cluster, including the status of the SQL statement.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'running', - 'default' => 'running', - ], + 'schema' => ['title' => '', 'description' => 'The page number. The value must be a positive integer. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'Lang', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of file titles and error messages. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" + .'- **10** (default)'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '30', 'title' => ''], ], [ - 'name' => 'ProcessRcHost', + 'name' => 'Filters', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address and port number of the AnalyticDB for MySQL frontend node on which the SQL statement is executed.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the diagnostic information about SQL statements for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster, including the IP address and port number of the frontend node.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '192.45.***.***:3145', - ], + 'schema' => ['description' => 'The filter conditions defined as a JSON-formatted string. The following valid KEY values and their meanings are supported in the JSON string:'."\n" + .'- SubmittedTimeRange: the start time.'."\n" + .'- TerminatedTimeRange: the end time.'."\n" + .'- AppStates: the status of the Spark job.'."\n" + .'- AppId: the ID of the Spark job.'."\n" + .'- AppNameRegex: the regular expression for the name of the Spark job.'."\n" + .'- Tag: the tag information.'."\n" + .'- ResourceGroupName: the name of the resource group.'."\n" + ."\n" + .'For the start time and end time filter conditions, specify the range by using the following substructure:'."\n" + .'- Min: the lower bound of the time range. A value of null indicates no limit.'."\n" + .'- Max: the upper bound of the time range. A value of null indicates no limit.', '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" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DiagnosisSQLInfo' => [ - 'description' => 'The queried execution information, including the SQL statement, statistics, execution plan, and operator information.'."\n", - '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' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'StageInfos' => [ - 'description' => 'The queried execution information by stage.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InputRows' => [ - 'description' => 'The total number of input rows in the stage.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2341', - ], - 'InputDataSize' => [ - 'description' => 'The total amount of input data in the stage. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2341', - ], - 'OutputRows' => [ - 'description' => 'The total number of output rows in the stage.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2341', - ], - 'OutputDataSize' => [ - 'description' => 'The total amount of output data in the stage. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2341', - ], - 'PeakMemory' => [ - 'description' => 'The total peak memory of the stage. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2341', - ], - 'OperatorCost' => [ - 'description' => 'The total amount of time consumed by all operators in the stage. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2341', - ], - 'StageId' => [ - 'description' => 'The stage ID.'."\n", - 'type' => 'string', - 'example' => 'Stage[26]', - ], - 'State' => [ - 'description' => 'The state of the stage.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'Progress' => [ - 'description' => 'The execution progress of the stage.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.3', - ], - 'ExecutionType' => [ - 'type' => 'string', - ], - ], - ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'AppInfoList' => [ + 'description' => 'The list of application information. Response parameter description:'."\n" + .'- **Data**: the Spark application template data.'."\n" + .'- **EstimateExecutionCpuTimeInSeconds**: the CPU time consumed to execute the Spark application, in milliseconds (ms).'."\n" + .'- **LogRootPath**: the storage path of log files.'."\n" + .'- **LastAttemptId**: the retry ID.'."\n" + .'- **WebUiAddress**: the Web UI address.'."\n" + .'- **SubmittedTimeInMillis**: the time when the Spark application was submitted, in UNIX timestamp format, in milliseconds (ms).'."\n" + .'- **StartedTimeInMillis**: the time when the Spark application was created, in UNIX timestamp format, in milliseconds (ms).'."\n" + .'- **LastUpdatedTimeInMillis**: the time when the Spark application was last updated, in UNIX timestamp format, in milliseconds (ms).'."\n" + .'- **TerminatedTimeInMillis**: the time when the Spark application stopped execution, in UNIX timestamp format, in milliseconds (ms).'."\n" + .'- **DBClusterId**: the ID of the cluster that executed the Spark application.'."\n" + .'- **ResourceGroupName**: the name of the job resource group.'."\n" + .'- **DurationInMillis**: the execution duration of the Spark application, in milliseconds (ms).', + 'type' => 'array', + 'items' => ['description' => 'The list of application information. Response parameter description:'."\n" + .'- **Data**: the Spark application template data.'."\n" + .'- **EstimateExecutionCpuTimeInSeconds**: the CPU time consumed to execute the Spark application, in milliseconds (ms).'."\n" + .'- **LogRootPath**: the storage path of log files.'."\n" + .'- **LastAttemptId**: the retry ID.'."\n" + .'- **WebUiAddress**: the Web UI address.'."\n" + .'- **SubmittedTimeInMillis**: the time when the Spark application was submitted, in UNIX timestamp format, in milliseconds (ms).'."\n" + .'- **StartedTimeInMillis**: the time when the Spark application was created, in UNIX timestamp format, in milliseconds (ms).'."\n" + .'- **LastUpdatedTimeInMillis**: the time when the Spark application was last updated, in UNIX timestamp format, in milliseconds (ms).'."\n" + .'- **TerminatedTimeInMillis**: the time when the Spark application stopped execution, in UNIX timestamp format, in milliseconds (ms).'."\n" + .'- **DBClusterId**: the ID of the cluster that executed the Spark application.'."\n" + .'- **ResourceGroupName**: the name of the job resource group.'."\n" + .'- **DurationInMillis**: the execution duration of the Spark application, in milliseconds (ms).', '$ref' => '#/components/schemas/SparkAppInfo', '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" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], ], - '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' => 'DescribeDiagnosisSQLInfo', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeDiagnosisDimensions' => [ - 'summary' => 'Queries the deduplicated statistics of resource groups, databases, usernames, and source IP addresses about SQL statements that meet a query condition for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query spark application list', + 'description' => '- Public endpoint of a region: `adb..aliyuncs.com`. Example: `adb.ap-southeast-1.aliyuncs.com`.'."\n" + .'- VPC endpoint of a region: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.ap-southeast-1.aliyuncs.com`.'."\n" + .'> If you encounter a 409 fault when initiating a request from Hong Kong (China), contact technical support.', + 'changeSet' => [ + ['createdAt' => '2025-02-11T03:16:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-28T01:10:29.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-07-19T03:21:07.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkApps'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkApps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppInfoList\\": [\\n {\\n \\"AppId\\": \\"s202207151211hz0c****\\",\\n \\"Message\\": \\"WARN: Disk is full.\\",\\n \\"Priority\\": \\"NORMAL\\",\\n \\"State\\": \\"SUBMITTED\\",\\n \\"DBClusterId\\": \\"amv-23xxxx\\",\\n \\"Detail\\": {\\n \\"DurationInMillis\\": 100,\\n \\"LogRootPath\\": \\"oss:///logs/driver\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\",\\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\\": \\"s202204291426hzpre60****-0003\\",\\n \\"TerminatedTimeInMillis\\": 1651213645300,\\n \\"ResourceProvisioningDurationInMillis\\": 36000,\\n \\"ExecutionDurationInMillis\\": 36000,\\n \\"WebUiAddress\\": \\"https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\",\\n \\"SubmittedTimeInMillis\\": 1651213645000,\\n \\"StartedTimeInMillis\\": 1651213645010,\\n \\"AppType\\": \\"BATCH\\",\\n \\"ResourceGroupName\\": \\"spark-rg\\"\\n },\\n \\"AppName\\": \\"SparkTest\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1\\n }\\n}","type":"json"}]', + ], + 'ListSparkLogAnalyzeTasks' => [ + 'summary' => 'Queries a list of Spark log analysis tasks.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -33976,173 +26327,179 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '132346', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bt6u59zcmd945****', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-9scxs****'], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> You can query data only within the last 14 days.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1625220210000', - ], + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'EndTime', - 'in' => 'query', + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The end of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The end time must be later than the start time.'."\n" - ."\n" - .'* The maximum time range that can be specified is 24 hours.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1625220213000', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709'], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskList' => [ + 'title' => '', + 'description' => 'The queried Spark log analysis tasks.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried Spark log analysis task.'."\n", '$ref' => '#/components/schemas/SparkAnalyzeLogTask', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'PageNumber' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], + ], + '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: cpu is exceeded limits 12/10\\",\\n \\"AppErrorAdvice\\": \\"Please increase cpu quota for your resource group\\"\\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' => 'ListSparkLogAnalyzeTasks', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-07-27T06:45:54.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkLogAnalyzeTasks'], + ], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkLogAnalyzeTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + ], + 'ListSparkTemplateFileIds' => [ + 'summary' => 'Queries a list of Spark template file IDs for AnalyticDB for MySQL clusters.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'QueryCondition', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query condition for SQL statements, which can contain the `Type`, `Value`, `Min`, and `Max` fields. Specify the condition in the JSON format. `Type` specifies the query dimension. Valid values for Type: `maxCost`, `status`, and `cost`. `Value`, `Min`, or `Max` specifies the query range for the dimension. Valid values:'."\n" - ."\n" - .'* `{"Type":"maxCost","Value":"100"}`: queries the top 100 most time-consuming SQL statements. Set `Value` to 100.'."\n" - .'* `{"Type":"status","Value":"finished"}`: queries the executed SQL statements. You can set `Value` to `running` to query the SQL statements that are being executed. You can also set Value to `failed` to query the SQL statements that failed to be executed.'."\n" - .'* `{"Type":"cost","Min":"10","Max":"200"}`: queries the SQL statements whose execution duration is in the range of 10 to 200 milliseconds. You can also specify custom values for the Min and Max fields.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Type":"maxCost","Value":"100"}', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* **zh-CN** (default): simplified Chinese.'."\n" - .'* **en-US**: English.'."\n" - .'* **ja**: Japanese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'ClientIps' => [ - 'description' => 'The queried source IP addresses.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried source IP address.'."\n", - 'type' => 'string', - 'example' => '106.11.xx.xx', - ], - ], - 'ResourceGroups' => [ - 'description' => 'The queried resource group names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried resource group name.'."\n", - 'type' => 'string', - 'example' => 'user_defaul', - ], - ], - 'UserNames' => [ - 'description' => 'The queried usernames.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried username.'."\n", - 'type' => 'string', - 'example' => 'test_user', - ], - ], - 'Databases' => [ - 'description' => 'The queried database names.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => [ + 'title' => '', + 'description' => 'The IDs of Spark template files.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The queried database name.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DEA97C6B-D7A4-5E69-9EFC-D7F88737CED5', + 'items' => ['description' => 'The ID of the Spark template file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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' => 'ListSparkTemplateFileIds', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-07-27T06:45:54.000Z', 'description' => 'Error codes changed'], ], - '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' => 'DescribeDiagnosisDimensions', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DownloadDiagnosisRecords' => [ - 'summary' => 'Downloads the diagnostic information about SQL statements that meet a query condition for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkTemplateFileIds'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkTemplateFileIds', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'ListSparkWarehouseBatchSQL' => [ + 'summary' => 'Queries a list of Spark SQL statements.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -34151,199 +26508,265 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '132341', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '236211', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1q8bu9a****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-bp1ub9grke1****', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> You can query data only within the last 14 days.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1662364330000', - ], + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the interactive resource group for which the Spark engine is enabled.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The end time must be later than the start time.'."\n" - ."\n" - .'* The maximum time range that can be specified is 24 hours.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1662450730000', - ], + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'required' => false, 'example' => '30', 'default' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Queries' => [ + 'description' => 'The queried Spark SQL statements.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried Spark SQL statement.'."\n", 'example' => '[{\\"doc_id\\":[\\"1293619227704606720\\"]}]', '$ref' => '#/components/schemas/SparkBatchSQL', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], [ - 'name' => 'QueryCondition', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query condition for SQL statements, which can contain the `Type`, `Value`, `Min`, and `Max` fields. Specify the condition in the JSON format. `Type` specifies the query dimension. Valid values for Type: `maxCost`, `status`, and `cost`. `Value`, `Min`, or `Max` specifies the query range for the dimension. Valid values:'."\n" - ."\n" - .'* `{"Type":"maxCost","Value":"100"}`: queries the top 100 most time-consuming SQL statements. Set `Value` to 100.'."\n" - .'* `{"Type":"status","Value":"finished"}`: queries the executed SQL statements. You can set `Value` to `running` to query the SQL statements that are being executed. You can also set Value to `failed` to query the SQL statements that failed to be executed.'."\n" - .'* `{"Type":"cost","Min":"10","Max":"200"}`: queries the SQL statements whose execution duration is in the range of 10 to 200 milliseconds. You can also specify custom values for the Min and Max fields.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"Type":"status","Value":"finished"}', - ], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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 \\"Uid\\": 0,\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"Query\\": \\"SELECT * FROM db.tb\\",\\n \\"QueryId\\": \\"sq172352176****\\",\\n \\"Schema\\": \\"default\\",\\n \\"QueryEndTime\\": 1723521767000,\\n \\"DBClusterId\\": \\"amv-bp17s73f016****\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"sq1723521767****-0001\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"+---+-----+\\\\n|age| name|\\\\n+---+-----+\\\\n| 14| Tom|\\\\n| 23|Alice|\\\\n+---+-----+\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\",\\n \\"QueryStartTime\\": 1723521767000,\\n \\"ResourceGroupName\\": \\"spark_rg\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListSparkWarehouseBatchSQL', + '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错误，请联系技术支持。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkWarehouseBatchSQL'], ], + ], + 'ramActions' => [ [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query keyword of the SQL statements.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'select', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkWarehouseBatchSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags that are added to AnalyticDB for MySQL clusters, or the AnalyticDB for MySQL clusters that have tags added.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MinPeakMemory', - 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum peak memory of the SQL statements. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '88000000', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsSUMGII'], + ], + 'parameters' => [ [ - 'name' => 'MaxPeakMemory', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum peak memory of the SQL statements. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '88000000', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MinScanSize', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum scan size of the SQL statements. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1073741824', - ], + 'schema' => ['description' => 'The resource type. Set the value to **dbclusterlakeversion**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dbclusterlakeversion', 'title' => ''], ], [ - 'name' => 'MaxScanSize', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum scan size of the SQL statements. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '64424509440', - ], + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707ec21345', 'title' => ''], ], [ - 'name' => 'ResourceGroup', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The resource group to which the SQL statements belong.'."\n" + 'description' => 'The cluster ID. You can specify N cluster IDs. Valid values of N: 1 to 50.'."\n" ."\n" - .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", - 'type' => 'string', + .'> You must specify at least one of the ResourceId.N and Tag.N.Key parameters.', + 'type' => 'array', + 'items' => ['description' => 'The cluster ID. You can specify N cluster IDs. Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the ResourceId.N and Tag.N.Key parameters.', 'type' => 'string', 'required' => false, 'example' => 'amv-bp1l20nxxxxxxxxxx', 'title' => ''], 'required' => false, - 'example' => 'user_default', + 'maxItems' => 51, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UserName', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The username that is used to execute the SQL statements.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisDimensions](~~~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", - 'type' => 'string', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. You can specify N tag keys. The tag key cannot be an empty string. Valid values of N: 1 to 20.'."\n" + ."\n" + .'> You must specify at least one of the ResourceId.N and Tag.N.Key parameters.', 'type' => 'string', 'required' => false, 'example' => 'testkey1', 'title' => ''], + 'Value' => ['description' => 'The tag value. You can specify N tag values. The tag value can be an empty string. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'testvalue1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'test_user', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Database', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the database on which the SQL statements are executed.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707ec21345', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '184DE106-CB2C-4DD2-B57F-396652E6C8F8', 'title' => ''], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => 'The queried clusters and tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The queried cluster and tag.', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'dbclusterlakeversion', 'title' => ''], + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'testvalue1', 'title' => ''], + 'ResourceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'amv-bp1l20nxxxxxxxxxx', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'testkey1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ListTagResources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ClientIp', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source IP address.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '106.11.XX.XX', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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"}]', + 'translator' => 'manual', + ], + 'LoadSampleDataSet' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Lang', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-2ze0z517o1mg****', 'title' => ''], ], ], 'responses' => [ @@ -34351,605 +26774,492 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DownloadId' => [ - 'description' => 'The download ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25494', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '845774AC-5D43-53A2-AAB8-C73828E68508', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FA31BE84-ABE8-554A-A769-5F860C34EE10', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-2ze0z517o1mg****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], ], - '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' => 'DownloadDiagnosisRecords', + 'title' => 'LoadSampleDataSet', + 'summary' => 'Loads a built-in dataset.', 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeDiagnosisRecords' => [ - 'summary' => 'Queries the diagnostic information about SQL statements that meet a query condition for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LoadSampleDataSet'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:LoadSampleDataSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA31BE84-ABE8-554A-A769-5F860C34EE10\\",\\n \\"DBClusterId\\": \\"amv-2ze0z517o1mg****\\"\\n}","type":"json"}]', + ], + 'ModifyAccountDescription' => [ + 'summary' => 'Modifies the description of a database account for an AnalyticDB for MySQL cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '131519', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '130693', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1scs48yc125****', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> You can query data only within the last 14 days.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1632931200000', - ], + 'schema' => ['description' => 'The name of the database account.'."\n" + ."\n" + .'> You can call the [DescribeAccounts](~~612430~~) operation to query the information about database accounts of an AnalyticDB for MySQL cluster, including database account names.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'AccountDescription', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The end time must be later than the start time.'."\n" - ."\n" - .'* The maximum time range that can be specified is 24 hours.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1633017540000', - ], + 'schema' => ['description' => 'The description of the database account.'."\n" + ."\n" + .'* The description cannot start with `http://` or `https://`.'."\n" + .'* The description must be 2 to 256 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'AccDesc', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Engine', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" + 'description' => 'The database engine of the cluster. Valid values:'."\n" ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", + .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" + .'* **Clickhouse**: the wide table engine.'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Clickhouse', + 'title' => '', ], ], - [ - 'name' => 'QueryCondition', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The query condition for SQL statements, which can contain the `Type`, `Value`, `Min`, and `Max` fields. Specify the condition in the JSON format. `Type` specifies the query dimension. Valid values for Type: `maxCost`, `status`, and `cost`. `Value`, `Min`, or `Max` specifies the query range for the dimension. Valid values:'."\n" - ."\n" - .'* `{"Type":"maxCost","Value":"100"}`: queries the top 100 most time-consuming SQL statements. Set `Value` to 100.'."\n" - .'* `{"Type":"status","Value":"finished"}`: queries the executed SQL statements. You can set `Value` to `running` to query the SQL statements that are being executed. You can also set Value to `failed` to query the SQL statements that failed to be executed.'."\n" - .'* `{"Type":"cost","Min":"10","Max":"200"}`: queries the SQL statements whose execution duration is in the range of 10 to 200 milliseconds. You can also specify custom values for the Min and Max fields.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"Type":"status","Value":"finished"}', + 'title' => '', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => 'The AccountDescription parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + ], + 'title' => 'ModifyAccountDescription', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2024-06-13T13:53:51.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2023-03-31T07:03:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:57.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query keyword of the SQL statements.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'select', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyAccountDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + ], + 'ModifyAccountPrivileges' => [ + 'summary' => 'Modifies the permissions of a database account.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MinPeakMemory', - 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum peak memory of the SQL statements. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '159109', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], + ], + 'parameters' => [ [ - 'name' => 'MaxPeakMemory', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum peak memory of the SQL statements. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '89000000', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MinScanSize', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum scan size of the SQL statements. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1k5p066e1a****', 'title' => ''], ], [ - 'name' => 'MaxScanSize', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum scan size of the SQL statements. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1024000000', - ], + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'account1', 'title' => ''], ], [ - 'name' => 'ResourceGroup', + 'name' => 'AccountPrivileges', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The resource group to which the SQL statements belong.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user_default', + 'description' => 'The permissions that you want to grant to the database account.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrivilegeObject' => [ + 'description' => 'The objects on which you want to grant permissions, including databases, tables, and columns.'."\n", + 'type' => 'object', + 'properties' => [ + 'Database' => ['description' => 'The databases on which you want to grant permissions. This parameter must be specified when the PrivilegeType parameter is set to Database, Table, or Column.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tsdb1', 'title' => ''], + 'Table' => ['description' => 'The tables on which you want to grant permissions. This parameter must be specified when the PrivilegeType parameter is set to Table or Column.'."\n", 'type' => 'string', 'required' => false, 'example' => 'table1', 'title' => ''], + 'Column' => ['description' => 'The columns on which you want to grant permissions. This parameter must be specified when the PrivilegeType parameter is set to Column.'."\n", 'type' => 'string', 'required' => false, 'example' => 'column1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Privileges' => [ + 'description' => 'The permissions that you want to grant to the database account.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The permission that you want to grant to the database account. You can call the `DescribeEnabledPrivileges` operation to query the permissions that can be granted to the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'select', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PrivilegeType' => ['description' => 'The permission level that you want to assign to the database account. You can call the `DescribeEnabledPrivileges` operation to query the permission level that can be assigned to the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Global', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'UserName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The username that is used to execute the SQL statements. You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_user', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9DD88DE7-824F-1082-AA57-575AFC6517A8'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ACS.Privilege.ModifyFailed', 'errorMessage' => 'Failed to modify the account privilege. Make sure that bound account have sufficient database privileges.', 'description' => 'Failed to modify the database account permissions. Check whether the database account that is associated with the RAM user has sufficient database permissions.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.Parameter.Malformed', 'errorMessage' => 'The following required parameters are not specified: %s', 'description' => 'You must specify the required parameters.'], + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => ''], + ['errorCode' => 'ACS.User.NotBindDatabaseAccount', 'errorMessage' => 'The user has not been associated with a database account.', 'description' => 'The user is not associated with the database account.'], + ], + ], + 'title' => 'ModifyAccountPrivileges', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2024-04-09T11:07:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-04-20T14:39:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-24T06:25:38.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountPrivileges'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Database', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database on which the SQL statements are executed.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adb_demo', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyAccountPrivileges', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DD88DE7-824F-1082-AA57-575AFC6517A8\\"\\n}","type":"json"}]', + ], + 'ModifyApsDatasoure' => [ + 'summary' => 'Modifies an AnalyticDB Pipeline Service (APS) data source.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClientIp', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source IP address.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '59.82.XX.XX', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD'], + ], + 'parameters' => [ [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-*******', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sls-******', 'title' => ''], + ], + [ + 'name' => 'DatasourceDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'SlsInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The order in which to sort the SQL statements by field, which contains the `Field` and `Type` fields. Specify the order in the JSON format. Example: `[{"Field":"StartTime", "Type": "desc"}]`. Fields:'."\n" - ."\n" - .'* `Field` specifies the field that is used to sort the SQL statements. Valid values:'."\n" - ."\n" - .' * `StartTime`: the execution start time.'."\n" - .' * `Status`: the execution status.'."\n" - .' * `UserName`: the username.'."\n" - .' * `Cost`: the execution duration.'."\n" - .' * `PeakMemory`: the peak memory.'."\n" - .' * `ScanSize`: the amount of data that is scanned.'."\n" - .' * `Database`: the name of the database.'."\n" - .' * `ClientIp`: the source IP address.'."\n" - .' * `ResourceGroup`: the name of the resource group.'."\n" - .' * `QueueTime`: the amount of time that is consumed for queuing.'."\n" - .' * `OutputRows`: the number of output rows.'."\n" - .' * `OutputDataSize`: the amount of output data.'."\n" - .' * `ResourceCostRank`: the execution duration rank of operators that are used in the SQL statements. This value takes effect only when `QueryCondition` is set to `{"Type":"status","Value":"running"}`.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values (case-insensitive):'."\n" - ."\n" - .' * `Desc`: descending order.'."\n" - .' * `Asc`: ascending order.'."\n", - 'type' => 'string', + 'description' => 'The information about Simple Log Service (SLS).'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceRegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + 'Across' => ['description' => 'Specifies whether to use a cross-account resource as the data source. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'AcrossUid' => ['description' => 'The cross-account UID.'."\n", 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + 'AcrossRole' => ['description' => 'The name of the cross-account role.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-role', 'title' => ''], + ], 'required' => false, - 'example' => '[{"Field":"StartTime", "Type": "desc" }]', + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'KafkaInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The information about the Kafka instance.', + 'type' => 'object', + 'properties' => [ + 'KafkaClusterId' => ['description' => 'The ID of the Kafka instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + 'KafkaTopic' => ['description' => 'The topic of the Kafka instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-topic', 'title' => ''], + ], 'required' => false, - 'example' => '1', + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'LakehouseId', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The lakehouse ID.'."\n", + 'type' => 'object', + 'properties' => [ + 'Vswitch' => ['description' => 'The name of the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-******', 'title' => ''], + 'SecurityGroup' => ['description' => 'The name of the security group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-******', 'title' => ''], + 'VpcId' => ['description' => 'The virtual private cloud (VPC) ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-******', 'title' => ''], + ], 'required' => false, - 'example' => '30', + 'example' => '123', + 'title' => '', ], ], [ - 'name' => 'Lang', - 'in' => 'query', + 'name' => 'RdsMysqlInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The language of file titles and error messages. Valid values:'."\n" - ."\n" - .'* **zh** (default): simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', + 'description' => 'The parameter is no longer supported.', + 'type' => 'object', + 'properties' => [ + 'UserName' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + 'Password' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + 'RegionId' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + 'ConnectUrl' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + ], 'required' => false, - 'example' => 'zh', + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'PatternId', - 'in' => 'query', + 'name' => 'PolarDBMysqlInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The SQL pattern ID.'."\n", - 'type' => 'string', + 'description' => 'The parameter is no longer supported.', + 'type' => 'object', + 'properties' => [ + 'UserName' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + 'Password' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + 'RegionId' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + 'ConnectUrl' => ['description' => 'The parameter is no longer supported.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + ], 'required' => false, - 'example' => '5575924945138******', + 'example' => '-', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Querys' => [ - 'description' => 'The queried SQL statements.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried SQL statement.'."\n", - 'type' => 'object', - 'properties' => [ - 'SQL' => [ - 'description' => 'The queried SQL statement.'."\n" - ."\n" - .'> For performance considerations, an SQL statement cannot exceed 5,120 characters in length. Otherwise, the SQL statement is truncated. You can call the [DownloadDiagnosisRecords](~~308212~~) operation to download the information about SQL statements that meet a query condition for an AnalyticDB for MySQL cluster, including the complete SQL statements.'."\n", - 'type' => 'string', - 'example' => 'SELECT count(*)\\nFROM nation', - ], - 'SQLTruncatedThreshold' => [ - 'description' => 'The maximum length of the SQL statement. 5120 is returned. Unit: characters. SQL statements that exceed this limit are truncated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5120', - ], - 'Status' => [ - 'description' => 'The state of the SQL statement. Valid values:'."\n" - ."\n" - .'* **running**'."\n" - .'* **finished**'."\n" - .'* **failed**'."\n", - 'type' => 'string', - 'example' => 'finished', - ], - 'OutputDataSize' => [ - 'description' => 'The amount of returned data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'Cost' => [ - 'description' => 'The total execution duration. Unit: milliseconds.'."\n" - ."\n" - .'> This value is the cumulative value of the `QueuedTime`, `TotalPlanningTime`, and `ExecutionTime` parameters.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'OutputRows' => [ - 'description' => 'The number of rows returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RcHost' => [ - 'description' => 'The IP address and port number of the AnalyticDB for MySQL frontend node on which the SQL statement is executed.'."\n", - 'type' => 'string', - 'example' => '10.0.XX.XX:3004', - ], - 'ScanSize' => [ - 'description' => 'The amount of scanned data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'ProcessId' => [ - 'description' => 'The query ID.'."\n", - 'type' => 'string', - 'example' => '2021093000414401000000023503151******', - ], - 'StartTime' => [ - 'description' => 'The execution start time of the SQL statement. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632933704000', - ], - 'SQLTruncated' => [ - 'description' => 'Indicates whether the SQL statement is truncated. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Database' => [ - 'description' => 'The name of the database on which the SQL statement is executed.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - 'ScanRows' => [ - 'description' => 'The number of rows scanned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ResourceCostRank' => [ - 'description' => 'The execution duration rank of operators that are used in the SQL statement.'."\n" - ."\n" - .'> This parameter is returned only for SQL statements whose `Status` parameter is `running`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ClientIp' => [ - 'description' => 'The source IP address.'."\n", - 'type' => 'string', - 'example' => '59.82.XX.XX', - ], - 'PeakMemory' => [ - 'description' => 'The peak memory. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16648', - ], - 'QueueTime' => [ - 'description' => 'The amount of time that is consumed for queuing. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'ResourceGroup' => [ - 'description' => 'The resource group to which the SQL statement belongs.'."\n", - 'type' => 'string', - 'example' => 'user_default', - ], - 'UserName' => [ - 'description' => 'The username that is used to execute the SQL statements.'."\n", - 'type' => 'string', - 'example' => 'test_user', - ], - 'ExecutionTime' => [ - 'description' => 'The execution duration. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'TotalPlanningTime' => [ - 'description' => 'The amount of time that is consumed to generate an execution plan. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'EtlWriteRows' => [ - 'description' => 'The number of rows written to the table by an extract-transform-load (ETL) job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalStages' => [ - 'description' => 'The total number of stages generated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'QueryProperties' => [ - 'description' => 'The query properties.'."\n" - ."\n" - .'> For information about common properties, see [Config and hint configuration parameters](~~408955~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'max_select_items_count', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1024', - ], - ], - ], - ], - 'PatternId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '-5575924945138******', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7F88BEFA-CF0B-5C95-8BB1-92EC9F09E40D', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A3EB3BCD-D974-52D4-B75C-BB06505916CB'], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'string', 'example' => '150', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'string', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => 'InvalidInput'."\n", 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'ModifyApsDatasoure', + 'description' => '### [](#)'."\n" + ."\n" + .'* You can call this operation only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition that have 32 cores or more.'."\n" + .'* You cannot modify the number of nodes for the USER_DEFAULT resource group.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApsDatasoure'], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyApsDatasoure', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - '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' => 'DescribeDiagnosisRecords', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see Endpoints.'."\n", ], - 'DescribeDownloadRecords' => [ - 'summary' => 'Queries the last five SQL query download tasks of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyApsJob' => [ + 'summary' => 'Modifies an AnalyticDB Pipeline Service (APS) job.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '132356', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '183077', + 'abilityTreeNodes' => ['FEATUREadsH8FO36'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-8vb6ha79k6e****', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-bj1xxxxxx', 'title' => ''], ], [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the returned data. Valid values:'."\n" - ."\n" - .'* **zh**: simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'deprecated' => true, - ], + 'name' => 'DbList', + 'in' => 'formData', + 'schema' => ['description' => 'The objects to be synchronized.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"EntireInstance":true}', 'title' => ''], + ], + [ + 'name' => 'PartitionList', + 'in' => 'formData', + 'schema' => ['description' => 'The partitions.'."\n", 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], ], 'responses' => [ @@ -34957,219 +27267,154 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Records' => [ - 'description' => 'The queried download tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the download job. Valid values:'."\n" - ."\n" - .'* **running**'."\n" - .'* **finished**'."\n" - .'* **failed**'."\n", - 'type' => 'string', - 'example' => 'finished', - ], - 'DownloadId' => [ - 'description' => 'The download job ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '636890', - ], - 'ExceptionMsg' => [ - 'description' => 'The error message returned if the download job failed.'."\n", - 'type' => 'string', - 'example' => 'The query result is empty.', - ], - 'Url' => [ - 'description' => 'The download URL of the file.'."\n", - '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' => 'The name of the downloaded file.'."\n", - 'type' => 'string', - 'example' => '20210806094635-20210806095135', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D761DA51-12F8-5457-AAA9-F52B9F436D2D', - ], - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], + 'HttpStatusCode' => ['description' => 'The status code. A value of 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ApsJobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'aps-bj1xxxxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-******-9F06-******', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ErrCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message returned if the request failed.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request is successful.'."\n", 'type' => 'string', 'example' => 'InvalidInput'."\n", 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeDownloadRecords', + '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' => 'ModifyApsJob', 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeSqlPattern' => [ - 'summary' => 'Queries the information about SQL patterns of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster within a time range.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApsJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyApsJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyApsSlsADBJob' => [ + 'summary' => 'Modifies an AnalyticDB Pipeline Service (APS) job from Simple Log Service (SLS) to an AnalyticDB for MySQL Data Warehouse Edition cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '132339', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'abilityTreeCode' => '209632', + 'abilityTreeNodes' => ['FEATUREads1II0UT'], ], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd format. The time must be in UTC.'."\n" - ."\n" - .'> Only data within the last 30 days can be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-08-30T12:10:00Z', - ], + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aps-******', 'title' => ''], ], [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON string format. Example: `[{"Field":"Pattern","Type":"Asc"}]`. Parameters:'."\n" - ."\n" - .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" - ."\n" - .' * `Pattern`: the SQL pattern.'."\n" - .' * `AccessIP`: the IP address of the client.'."\n" - .' * `User`: the username.'."\n" - .' * `QueryCount`: the number of queries performed in association with the SQL pattern within the time range to query.'."\n" - .' * `AvgPeakMemory`: the average peak memory usage of the SQL pattern within the time range to query. Unit: KB.'."\n" - .' * `MaxPeakMemory`: the maximum peak memory usage of the SQL pattern within the time range to query. Unit: KB.'."\n" - .' * `AvgCpuTime`: the average execution duration of the SQL pattern within the time range to query. Unit: milliseconds.'."\n" - .' * `MaxCpuTime`: the maximum execution duration of the SQL pattern within the time range to query. Unit: milliseconds.'."\n" - .' * `AvgStageCount`: the average number of stages.'."\n" - .' * `MaxStageCount`: the maximum number of stages.'."\n" - .' * `AvgTaskCount`: the average number of tasks.'."\n" - .' * `MaxTaskCount`: the maximum number of tasks.'."\n" - .' * `AvgScanSize`: the average amount of data scanned based on the SQL pattern within the time range to query. Unit: KB.'."\n" - .' * `MaxScanSize`: the maximum amount of data scanned based on the SQL pattern within the time range to query. Unit: KB.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values:'."\n" - ."\n" - .' * `Asc`: ascending order.'."\n" - .' * `Desc`: descending order.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If you do not specify this parameter, query results are sorted in ascending order of `Pattern`.'."\n" - ."\n" - .'* If you want to sort query results by `AccessIP`, you must set the `Type` parameter to `accessip`. If you want to sort query results by `User`, you must leave the `Type` parameter empty or set it to `user`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[{"Field":"Pattern","Type":"Asc"}]', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-*******', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'name' => 'StartingOffsets', + 'in' => 'formData', + 'schema' => ['description' => 'The start offset.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'end_cursor', 'title' => ''], ], [ - 'name' => 'SqlPattern', - 'in' => 'query', + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The keyword that is used for the query.'."\n" - ."\n" - .'> If you do not specify this parameter, all SQL patterns of the AnalyticDB for MySQL cluster within the time period specified by `StartTime` are returned.'."\n", - 'type' => 'string', + 'description' => 'The information about columns.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about columns.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the column.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_name', 'title' => ''], + 'MapName' => ['description' => 'The name of the mapping.'."\n", 'type' => 'string', 'required' => false, 'example' => 'map_name', 'title' => ''], + 'Type' => ['description' => 'The data type of the column.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bigint', 'title' => ''], + 'MapType' => ['description' => 'The type of the mapping.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bigint', 'title' => ''], + ], + 'required' => false, + 'example' => '-', + 'title' => '', + ], 'required' => false, - 'example' => 'SELECT', + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The dimension by which to aggregate the SQL patterns. Valid values:'."\n" - ."\n" - .'* `user`: aggregates the SQL patterns by user.'."\n" - .'* `accessip`: aggregates the SQL patterns by client IP address.'."\n" - ."\n" - .'> If you do not specify this parameter, the SQL patterns are aggregated by `user`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1ej1nq9n6****', - ], + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workload.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-name', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **10** (default)'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dbName', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'DirtyDataProcessPattern', + 'in' => 'formData', + 'schema' => ['description' => 'The dirty data processing mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'STOP', 'title' => ''], + ], + [ + 'name' => 'ExactlyOnce', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the consistency check.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'UnixTimestampConvert', + 'in' => 'formData', + 'schema' => ['description' => 'The timestamp conversion.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user-name', 'title' => ''], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => ['description' => 'The password of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_123', 'title' => ''], ], ], 'responses' => [ @@ -35177,302 +27422,185 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'Items' => [ - 'description' => 'The queried SQL pattern.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AvgStageCount' => [ - 'description' => 'The average number of scanned rows.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'MaxCpuTime' => [ - 'description' => 'The maximum execution duration of the SQL pattern within the query time range. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '17', - ], - 'AccessIP' => [ - 'description' => 'The IP address of the client.'."\n" - ."\n" - .'> This parameter is returned only when **Type** is set to **accessip**.'."\n", - 'type' => 'string', - 'example' => '100.104.xx.xx', - ], - 'AvgScanSize' => [ - 'description' => 'The average amount of data scanned based on the SQL pattern within the query time range. Unit: KB.'."\n", - 'type' => 'string', - 'example' => '244', - ], - 'MaxScanSize' => [ - 'description' => 'The maximum amount of data scanned based on the SQL pattern within the query time range. Unit: KB.'."\n", - 'type' => 'string', - 'example' => '1024', - ], - 'MaxPeakMemory' => [ - 'description' => 'The maximum peak memory usage of the SQL pattern within the query time range. Unit: KB.'."\n", - 'type' => 'string', - 'example' => '480096', - ], - 'AvgCpuTime' => [ - 'description' => 'The average execution duration of the SQL pattern within the query time range. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1.0625', - ], - 'User' => [ - 'description' => 'The username.'."\n" - ."\n" - .'> This parameter is returned only when **Type** is left empty or set to **user**.'."\n", - 'type' => 'string', - 'example' => 'test_acc', - ], - 'AvgPeakMemory' => [ - 'description' => 'The average peak memory usage of the SQL pattern within the query time range. Unit: KB.'."\n", - 'type' => 'string', - 'example' => '240048', - ], - 'MaxStageCount' => [ - 'description' => 'The maximum number of stages.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'MaxTaskCount' => [ - 'description' => 'The maximum number of tasks.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'InstanceName' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1ej1nq9n6****', - ], - 'QueryCount' => [ - 'description' => 'The number of queries performed in association with the SQL pattern within the query time range.'."\n", - 'type' => 'string', - 'example' => '16', - ], - 'ReportDate' => [ - 'description' => 'The start date of the query.'."\n", - 'type' => 'string', - 'example' => '2022-08-30', - ], - 'Pattern' => [ - 'description' => 'The SQL pattern.'."\n", - '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' => 'The average number of tasks.'."\n", - 'type' => 'string', - 'example' => '2', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DB1F6C23-CBCA-5260-9366-BA7BB5EBF6F1', - ], + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'object', 'example' => '-', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-******-9F06-******', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => 'InvalidInput', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], ], - 'description' => '', + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeSqlPattern', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeSQLPatterns' => [ - 'summary' => 'Queries a list of SQL patterns for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster within a time range.', - 'methods' => [ - 'post', - 'get', + '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' => 'ModifyApsSlsADBJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApsSlsADBJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyApsSlsADBJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'ModifyApsWorkloadName' => [ + 'summary' => 'Modifies the AnalyticDB Pipeline Service (APS) workload name.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '132328', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '170156', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-8vb8de93v9b****', - ], + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n" - ."\n" - .'> * Only data within the last 14 days can be queried.'."\n" - .'> * The maximum time range that can be specified is 24 hours.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-09-06T03:06:00Z', - ], + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-*******', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-09-07T03:06:00Z', - ], + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-******', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'query', + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workload.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sls-2024***93014', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The status code. A value of 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The returned data.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-******-9F06-******', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => 'InvalidInput'."\n", 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'ModifyApsWorkloadName', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApsWorkloadName'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used for the query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyApsWorkloadName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + ], + 'ModifyAuditLogConfig' => [ + 'summary' => 'Modifies the SQL audit settings of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON format. Example: `[{"Field":"AverageQueryTime","Type":"Asc"}]`.'."\n" - ."\n" - .'* `Field` specifies the field by which to sort the query results. Valid values:'."\n" - ."\n" - .' * `PatternCreationTime`: the earliest commit time of the SQL pattern within the time range to query.'."\n" - .' * `AverageQueryTime`: the average total amount of time consumed by the SQL pattern within the time range to query.'."\n" - .' * `MaxQueryTime`: the maximum total amount of time consumed by the SQL pattern within the time range to query.'."\n" - .' * `AverageExecutionTime`: the average execution duration of the SQL pattern within the time range to query.'."\n" - .' * `MaxExecutionTime`: the maximum execution duration of the SQL pattern within the time range to query.'."\n" - .' * `AveragePeakMemory`: the average peak memory usage of the SQL pattern within the time range to query.'."\n" - .' * `MaxPeakMemory`: the maximum peak memory usage of the SQL pattern within the time range to query.'."\n" - .' * `AverageScanSize`: the average amount of data scanned based on the SQL pattern within the time range to query.'."\n" - .' * `MaxScanSize`: the maximum amount of data scanned based on the SQL pattern within the time range to query.'."\n" - .' * `QueryCount`: the number of queries performed in association with the SQL pattern within the time range to query.'."\n" - .' * `FailedCount`: the number of failed queries performed in association with the SQL pattern within the time range to query.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values (case-insensitive):'."\n" - ."\n" - .' * `Asc`: ascending order.'."\n" - .' * `Desc`: descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Field":"AverageQueryTime","Type":"Asc"}]', - 'default' => '[{"Type":"desc","Field":"AveragePeakMemory"}]', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132366', + 'abilityTreeNodes' => ['FEATUREadsGAMOR7'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-t4nj8619bz2w3****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **10** (default)'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'AuditLogStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* **zh** (default): simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The status to which you want to change the SQL audit feature. Valid values:'."\n" + ."\n" + .'* **on**'."\n" + .'* **off**'."\n" + ."\n" + .'> After you disable the SQL audit feature, all SQL audit logs are deleted. You must query and export SQL audit logs before you disable SQL audit. For more information, see [DescribeAuditLogRecords](~~612426~~). When you re-enable SQL audit, audit logs that are generated from the time when SQL audit was last enabled are available for queries.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'on', 'title' => ''], ], [ - 'name' => 'UserName', + 'name' => 'EngineType', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The type of the compute engine. Valid values:'."\n" + ."\n" + .'* XIHE (**default**)'."\n" + .'* SPARK'."\n", 'type' => 'string', 'required' => false, 'example' => 'XIHE', 'title' => ''], ], ], 'responses' => [ @@ -35481,310 +27609,104 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'PatternDetails' => [ - 'description' => 'The queried SQL patterns.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried SQL pattern.'."\n", - 'type' => 'object', - 'properties' => [ - 'SQLPattern' => [ - 'description' => 'The statement of the SQL pattern.'."\n", - 'type' => 'string', - 'example' => 'SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)', - ], - 'PatternId' => [ - 'description' => 'The ID of the SQL pattern.'."\n", - 'type' => 'string', - 'example' => '5575924945138******', - ], - 'User' => [ - 'description' => 'The name of the database account that is used to commit the SQL pattern.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AccessIp' => [ - 'description' => 'The IP address of the SQL client that commits the SQL pattern.'."\n", - 'type' => 'string', - 'example' => '192.168.xx.xx', - ], - 'Tables' => [ - 'description' => 'The tables scanned based on the SQL pattern.'."\n", - 'type' => 'string', - 'example' => 'tpch.orders', - ], - 'PatternCreationTime' => [ - 'description' => 'The earliest commit time of the SQL pattern within the query time range.'."\n", - 'type' => 'string', - 'example' => '2022-09-06 05:06:00', - ], - 'AverageQueryTime' => [ - 'description' => 'The average total amount of time consumed by the SQL pattern within the query time range. Unit: milliseconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '4', - ], - 'MaxQueryTime' => [ - 'description' => 'The maximum total amount of time consumed by the SQL pattern within the query time range. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2341', - ], - 'AverageExecutionTime' => [ - 'description' => 'The average execution duration of the SQL pattern within the query time range. Unit: milliseconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '234.78', - ], - 'MaxExecutionTime' => [ - 'description' => 'The maximum execution duration of the SQL pattern within the query time range. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2142', - ], - 'AveragePeakMemory' => [ - 'description' => 'The average peak memory usage of the SQL pattern within the query time range. Unit: bytes.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '234.22', - ], - 'MaxPeakMemory' => [ - 'description' => 'The maximum peak memory usage of the SQL pattern within the query time range. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234149', - ], - 'AverageScanSize' => [ - 'description' => 'The average amount of data scanned based on the SQL pattern within the query time range. Unit: bytes.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '234149.23', - ], - 'MaxScanSize' => [ - 'description' => 'The maximum amount of data scanned based on the SQL pattern within the query time range. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32212254', - ], - 'QueryCount' => [ - 'description' => 'The number of queries executed in association with the SQL pattern within the query time range.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '345', - ], - 'FailedCount' => [ - 'description' => 'The number of failed queries executed in association with the SQL pattern within the query time range.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - ], - 'Blockable' => [ - 'description' => 'Indicates whether the execution of the SQL pattern can be intercepted. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n" - ."\n" - .'> Only SELECT and INSERT statements can be intercepted.'."\n", - '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' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F3174013-5B7A-5A47-9FE0-6B5D397BD86B', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", - '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" - .'}', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CDC59E56-BD07-56CA-A05F-B7907DE5C862', 'title' => ''], + 'UpdateSucceed' => ['description' => 'Indicates whether the status of SQL audit is updated. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeSQLPatterns', - 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" - .'* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribePatternPerformance' => [ - 'summary' => 'Queries the information about performance metrics of an SQL pattern such as the query duration and average memory usage for an AnalyticDB for MySQL cluster within a time range.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + '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' => 'ModifyAuditLogConfig', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2024-08-20T07:40:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T04:03:32.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAuditLogConfig'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyAuditLogConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'ModifyAutoRenewalAttribute' => [ + 'summary' => 'Configures auto-renewal for a subscription cluster.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '132321', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '10841', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-uf6li1r3do8m****', - ], + 'schema' => ['description' => 'The ID of cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-uf6pl56w1j8h****', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the current date is August 22, 2022 (UTC+8), you can query the data of August 9, 2022 (2022-08-08T16:00:00Z) to the earliest extent. If you want to query the data that is earlier than August 9, 2022 (2022-08-08T16:00:00Z), null is returned.'."\n" - ."\n" - .'* The maximum time range that can be specified is 24 hours.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-08-21T02:15:00Z', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'AutoRenewalStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-08-22T01:06:00Z', - ], + 'schema' => ['description' => 'The renewal method. Valid values:'."\n" + ."\n" + .'* **AutoRenewal**: The cluster is automatically renewed.'."\n" + .'* **Normal**: The cluster is manually renewed. Before the cluster expires, the system sends you a reminder by SMS message.'."\n" + .'* **NotRenewal**: The cluster is not renewed. Reminders are only sent three days before cluster expiration.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AutoRenewal', 'default' => 'AutoRenewal', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'AutoRenewalPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The duration of the auto-renewal. Default value: 1. Valid values:'."\n" + ."\n" + .'* When **AutoRenewalPeriod** is set to **Month**, the value ranges from 1 to 11 (integer).'."\n" + .'* When **AutoRenewalPeriod** is set to **Month**, the valid values are 1, 2, 3, and 5 (integer).'."\n" + ."\n" + .'> Longer renewal periods offer better pricing. Renewing for 1 year is more cost-effective than renewing for 10 or 11 months.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PatternId', + 'name' => 'AutoRenewalPeriodUnit', 'in' => 'query', - 'schema' => [ - 'description' => 'The SQL pattern ID.'."\n" - ."\n" - .'> You can call the [DescribeSQLPatterns](~~321868~~) operation to query the information about all SQL patterns in an AnalyticDB for MySQL cluster within a period of time, including SQL pattern IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3847585356974******', - 'default' => '-1', - ], + 'schema' => ['description' => 'Auto-renewal duration. Valid values:'."\n" + ."\n" + .'* Year.'."\n" + .'* Month.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Year', 'default' => 'Month', 'title' => ''], ], ], 'responses' => [ @@ -35792,182 +27714,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-08-22T01:06:00Z', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F21AF487-B8C9-57E0-8E3A-A92BC3611FB6', - ], - 'StartTime' => [ - 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-08-21T02:15:00Z', - ], - 'Performances' => [ - 'description' => 'The queried performance metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The values of the performance metric at different points in time.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The queried performance metric. Valid values:'."\n" - ."\n" - .'* **AnalyticDB_PatternQueryCount**: the total number of queries executed in association with the SQL pattern.'."\n" - .'* **AnalyticDB_PatternQueryTime**: the total amount of time consumed by the queries executed in association with the SQL pattern.'."\n" - .'* **AnalyticDB_PatternExecutionTime**: the execution duration of the queries executed in association with the SQL pattern.'."\n" - .'* **AnalyticDB_PatternPeakMemory**: the peak memory usage of the queries executed in association with the SQL pattern.'."\n" - .'* **AnalyticDB_PatternScanSize**: the amount of data scanned in the queries executed in association with the SQL pattern.'."\n", - 'type' => 'string', - 'example' => 'AnalyticDB_PatternExecutionTime', - ], - 'Unit' => [ - 'description' => 'The unit of the performance metric. Valid values:'."\n" - ."\n" - .'* If the performance metric is related to the query time (the value of `Key` is `AnalyticDB_PatternQueryTime` or `AnalyticDB_PatternExecutionTime`), **ms** is returned.'."\n" - .'* If the performance metric is related to the peak memory usage (the value of `Key` is `AnalyticDB_PatternPeakMemory`), **MB** is returned.'."\n" - .'* If the performance metric is related to the amount of data scanned (the value of `Key` is `AnalyticDB_PatternScanSize`), **MB** is returned.'."\n" - .'* If the performance metric is related to the number of queries (the value of `Key` is `AnalyticDB_PatternQueryCount`), null is returned.'."\n", - 'type' => 'string', - 'example' => 'ms', - ], - 'Series' => [ - 'description' => 'The values of the performance metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Values' => [ - 'description' => 'The values of the performance metric.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the performance metric at a point in time.'."\n", - 'type' => 'string', - 'example' => '[ "2021-11-18 13:38:00", "224" ]', - ], - ], - 'Name' => [ - 'description' => 'The name of the performance metric value. Valid values:'."\n" - ."\n" - .'* If the value of `Key` is `AnalyticDB_PatternQueryCount`, `pattern_query_count` is returned, which indicates the number of executions of the SQL statements in association with the SQL pattern.'."\n" - ."\n" - .'* If the value of `Key` is `AnalyticDB_PatternQueryTime`, the following values are returned:'."\n" - ."\n" - .' * `average_query_time`, which indicates the average total amount of time consumed by the SQL statements in association with the SQL pattern.'."\n" - .' * `max_query_time`, which indicates the maximum total amount of time consumed by the SQL statements in association with the SQL pattern.'."\n" - ."\n" - .'* If the value of `Key` is `AnalyticDB_PatternExecutionTime`, the following values are returned:'."\n" - ."\n" - .' * `average_execution_time`, which indicates the average execution duration of the SQL statements in association with the SQL pattern.'."\n" - .' * `max_execution_time`, which indicates the maximum execution duration of the SQL statements in association with the SQL pattern.'."\n" - ."\n" - .'* If the value of `Key` is `AnalyticDB_PatternPeakMemory`, the following values are returned:'."\n" - ."\n" - .' * `average_peak_memory`, which indicates the average peak memory usage of the SQL statements in association with the SQL pattern.'."\n" - .' * `max_peak_memory`, which indicates the maximum peak memory usage of the SQL statements in association with the SQL pattern.'."\n" - ."\n" - .'* If the value of `Key` is `AnalyticDB_PatternScanSize`, the following values are returned:'."\n" - ."\n" - .' * `average_scan_size`, which indicates the average amount of data scanned by the SQL statements in association with the SQL pattern.'."\n" - .' * `max_scan_size`, which indicates the maximum amount of data scanned by the SQL statements in association with the SQL pattern.'."\n", - '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', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribePatternPerformance', - 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" - .'* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeDBClusterSpaceSummary' => [ - 'summary' => 'Queries the storage overview information of an AnalyticDB for MySQL cluster, such as the total data size, hot data size, cold data size, and data growth.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\"\\n}","type":"json"}]', + 'title' => 'ModifyAutoRenewalAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAutoRenewalAttribute'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyAutoRenewalAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'tags' => [], + ], + 'ModifyBackupPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '212723', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'update', + 'abilityTreeCode' => '155194', + 'abilityTreeNodes' => ['FEATUREadsM6VDCK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-wz9v5sa7mm79z4l2', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-bp1xxxxxxxx47', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'PreferredBackupTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The start time to perform a full backup. Specify the time in the HH:mmZ-HH:mmZ format. The time must be in UTC.'."\n" + ."\n" + .'> The time range must be 1 hour.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '18:00Z-19:00Z', 'title' => ''], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => ['description' => 'The days of the week on which to perform a full backup. Separate multiple values with commas (,). Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n" + ."\n" + .'> To ensure data security, we recommend that you specify at least two values.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Monday,Wednesday,Friday,Sunday', 'title' => ''], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => ['description' => 'The number of days for which to retain full backup files. Valid values: 7 to 730.'."\n" + ."\n" + .'> If you do not specify this parameter, the default value 7 is used.'."\n", 'type' => 'string', 'required' => false, 'example' => '7', 'default' => '7', 'title' => ''], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable log backup. Valid values:'."\n" + ."\n" + .'* **Enable**'."\n" + .'* **Disable**'."\n" + ."\n" + .'> If you do not specify this parameter, the default value Enable is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Enable', 'title' => ''], + ], + [ + 'name' => 'LogBackupRetentionPeriod', + 'in' => 'query', + 'schema' => ['description' => 'The number of days for which to retain log backup files. Valid values: 7 to 730.'."\n" + ."\n" + .'> If you do not specify this parameter, the default value 7 is used.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '730', 'minimum' => '7', 'example' => '7', 'default' => '7', 'title' => ''], ], ], 'responses' => [ @@ -35975,502 +27817,210 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Data' => [ - 'description' => 'The queried storage overview information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => 'The total data size. Unit: bytes.'."\n" - ."\n" - .'> Formula: Total data size = Hot data size+ Cold data size.'."\n", - 'type' => 'string', - 'example' => '8388608', - ], - 'HotData' => [ - 'description' => 'The hot data.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => 'The hot data size. Unit: bytes.'."\n" - ."\n" - .'> Formula: Hot data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4194304', - ], - 'DataSize' => [ - 'description' => 'The data size of table records. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - 'IndexSize' => [ - 'description' => 'The data size of regular indexes. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - 'PrimaryKeyIndexSize' => [ - 'description' => 'The data size of primary key indexes. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - 'OtherSize' => [ - 'description' => 'The data size of other data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - ], - ], - 'ColdData' => [ - 'description' => 'The cold data.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => 'The cold data size. Unit: bytes.'."\n" - ."\n" - .'> Formula: Cold data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4194304', - ], - 'DataSize' => [ - 'description' => 'The data size of table records. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - 'IndexSize' => [ - 'description' => 'The data size of regular indexes. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - 'PrimaryKeyIndexSize' => [ - 'description' => 'The data size of primary key indexes. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - 'OtherSize' => [ - 'description' => 'The data size of other data. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - ], - ], - 'DataGrowth' => [ - 'description' => 'The data growth.'."\n", - 'type' => 'object', - 'properties' => [ - 'DayGrowth' => [ - 'description' => 'The data growth within the last day. Unit: bytes.'."\n" - ."\n" - .'> Formula: Data growth within the last day = Current data size - Data size one day ago.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - 'WeekGrowth' => [ - 'description' => 'The daily data growth within the last seven days. Unit: bytes.'."\n" - ."\n" - .'> Formula: Daily data growth within the last seven days = (Current data size - Data size seven days ago)/7.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1048576', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPreferredBackupTime.Malformed', 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', 'description' => 'The PreferredBackupTime parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPreferredBackupPeriod.Malformed', 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', 'description' => 'PreferredBackupPeriod'], + ['errorCode' => 'InvalidBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter "BackupRetentionPeriod" should be within [7-%s] days.', 'description' => '%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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' => 'DescribeDBClusterSpaceSummary', + 'title' => 'ModifyBackupPolicy', + 'summary' => 'Modifies the backup policy of an AnalyticDB for MySQL cluster.', 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeExcessivePrimaryKeys' => [ - 'summary' => 'Queries the information about tables that have excessive primary key fields in an AnalyticDB for MySQL Data Lakehouse Edition (V5.0) cluster.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-10-12T03:26:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-10-12T01:59:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-16T06:02:18.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + ], + 'ModifyClickhouseEngine' => [ + 'summary' => 'Enables the wide table engine feature for an AnalyticDB for MySQL cluster or modifies the disk cache size of the wide table engine of an AnalyticDB for MySQL cluster for which you enabled the wide table engine feature.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '217360', - 'abilityTreeNodes' => [ - 'FEATUREadsDAZVRM', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'chargeType' => 'paid', + 'abilityTreeCode' => '208236', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'am-bp1xxxxxxxx47', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2019-06-01T16:00:00Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2019-06-01T16:00:00Z', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Enabled', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" + 'description' => 'Specifies whether to enable the wide table engine feature. Valid values:'."\n" ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '30', - 'default' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of file titles and error messages. Valid values:'."\n" + .'- true'."\n" ."\n" - .'* **zh (default)**: simplified Chinese.'."\n" - .'* **en**: English.'."\n" - .'* **ja**: Japanese.'."\n" - .'* **zh-tw**: traditional Chinese.'."\n", - 'type' => 'string', + .'- false', + 'type' => 'boolean', 'required' => false, - 'example' => 'zh', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'Order', + 'name' => 'CacheSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which table fields are sorted. Specify the value in the JSON format.'."\n" - ."\n" - .'Example:'."\n" - ."\n" - .' ['."\n" - ."\n" - .' {'."\n" - ."\n" - .' "Field":"Name",'."\n" - ."\n" - .' "Type":"Asc"'."\n" - ."\n" - .' }'."\n" - ."\n" - .' ]'."\n" - ."\n" - .'In the preceding code, Field specifies the field that is used to sort the table data. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.'."\n" - ."\n" - .'Field and Type are case-insensitive.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Field":"TableName", "Type": "Desc" }]', - ], + 'schema' => ['description' => 'The disk cache size of the wide table engine. Unit: GB. Default value: 100. Valid values: 100 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '300', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '10', - 'example' => '30', - 'default' => '10', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '863D51B7-5321-41D8-A0B6-A088B0******', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'am-bp1ub9grke1****', - ], - 'Tables' => [ - 'description' => 'The queried tables that have excessive primary key fields.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'SchemaName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'adb_demo', - ], - 'ColumnCount' => [ - 'description' => 'The total number of columns.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '21', - ], - 'PrimaryKeyCount' => [ - 'description' => 'The number of primary key fields.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'PrimaryKeyColumns' => [ - 'description' => 'The queried primary key fields.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'SpaceRatio' => [ - 'description' => 'The percentage of the table size. Unit: %.'."\n" - ."\n" - .'> Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '23', - ], - 'TotalSize' => [ - 'description' => 'The cold data size. Unit: bytes.'."\n" - ."\n" - .'> Formula: Cold data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'PrimaryKeyIndexSize' => [ - 'description' => 'The data size of primary key indexes. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '222', - ], - ], - 'description' => '', - ], - ], - 'DetectionItems' => [ - 'description' => 'The queried detection items and detection results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection item and detection result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the detection item.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Message' => [ - 'description' => 'The detection result.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Status' => [ - 'description' => 'The severity level of the detection result.'."\n", - 'type' => 'string', - 'example' => 'NORMAL'."\n" - .'WARNNING'."\n" - .'CRITICAL', - ], - ], - ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The queried information about the request denial.'."\n", - '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" - .' }', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D761DA51-12F8-5457-AAA9-F52B9F436D2D'], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - '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' => 'DescribeExcessivePrimaryKeys', - ], - 'ModifyDBClusterMaintainTime' => [ - 'summary' => 'Modifies the maintenance window of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ModifyClickhouseEngine', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClickhouseEngine'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyClickhouseEngine', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D761DA51-12F8-5457-AAA9-F52B9F436D2D\\"\\n}","type":"json"}]', + ], + 'ModifyClusterAccessWhiteList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'abilityTreeNodes' => ['FEATUREadsG383TB'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1r053byu48p****', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'MaintainTime', + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => ['description' => 'The IP addresses in an IP address whitelist of a cluster. Separate multiple IP addresses with commas (,). You can add a maximum of 500 different IP addresses to a whitelist. The entries in the IP address whitelist must be in one of the following formats:'."\n" + ."\n" + .'* IP addresses, such as 10.23.XX.XX.'."\n" + .'* CIDR blocks, such as 10.23.xx.xx/24. In this example, 24 indicates that the prefix of each IP address in the IP whitelist is 24 bits in length. You can replace 24 with a value within the range of 1 to 32.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10.23.xx.xx', 'title' => ''], + ], + [ + 'name' => 'DBClusterIPArrayName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the IP address whitelist. If you do not specify this parameter, the Default whitelist is modified.'."\n" + ."\n" + .'* The whitelist name must be 2 to 32 characters in length. The name can contain lowercase letters, digits, and underscores (\\_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" + .'* Each cluster supports up to 50 IP address whitelists.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'default' => 'default', 'title' => ''], + ], + [ + 'name' => 'DBClusterIPArrayAttribute', + 'in' => 'query', + 'schema' => ['description' => 'The attribute of the IP address whitelist. By default, this parameter is empty.'."\n" + ."\n" + .'> IP address whitelists with the hidden attribute are not displayed in the console. Those whitelists are used to access Data Transmission Service (DTS) and PolarDB.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hidden', 'title' => ''], + ], + [ + 'name' => 'ModifyMode', 'in' => 'query', 'schema' => [ - 'description' => 'The maintenance window of the cluster. It must be in the hh:mmZ-hh:mmZ format.'."\n" + 'description' => 'The method used to modify the IP address whitelist. Valid values:'."\n" ."\n" - .'> The interval must be 1 hour and start and end at the beginning of an hour.', + .'* **Cover** (default)'."\n" + .'* **Append**'."\n" + .'* **Delete**'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '22:00Z-23:00Z', + 'required' => false, + 'example' => 'Cover', + 'default' => 'Cover', + 'enum' => ['Cover', 'Append', 'Delete'], + 'title' => '', ], ], ], @@ -36479,80 +28029,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', - ], + 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1564657730', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '370D09FD-442A-5225-AAD3-7362CAE39177', 'title' => ''], + 'DBClusterId' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'SecurityIPList.Duplicate', 'errorMessage' => 'The specified IP address is duplicate.', 'description' => 'The specified IP address is duplicate.'], + ['errorCode' => 'InvalidDBClusterIPArrayName.Malformed', 'errorMessage' => 'The specified parameter DBClusterIPArrayName is not valid.', 'description' => 'The DBClusterIPArrayName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidSecurityIPList.Malformed', 'errorMessage' => 'The specified SecurityIPList is incorrectly formatted.', 'description' => 'The specified security group parameter is invalid.'], + ['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => 'The specified IP address is duplicate. Specify a valid IP address.'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is 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' => 'ModifyDBClusterMaintainTime', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'ModifyDBClusterResourceGroup' => [ - 'summary' => 'Changes the resource group to which an AnalyticDB for MySQL cluster belongs.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyClusterAccessWhiteList', + 'summary' => 'Modifies the IP address whitelist of an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see Endpoints.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-04-08T07:03:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-31T07:03:57.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ['createdAt' => '2022-06-11T16:51:52.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClusterAccessWhiteList'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyClusterAccessWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', + '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":""}]', + ], + 'ModifyCompactionServiceSwitch' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bpxxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp14t95lun0w****', 'title' => ''], ], [ - 'name' => 'NewResourceGroupId', + 'name' => 'EnableCompactionService', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the resource group to which you want to move the AnalyticDB for MySQL cluster.'."\n" + 'description' => 'Specifies whether to enable the remote build feature.'."\n" ."\n" - .'> You can use resource groups to manage resources within your Alibaba Cloud account by group. This helps you resolve issues such as resource grouping and permission management within a single Alibaba Cloud account. For more information, see [What is Resource Management?](~~94475~~)'."\n", - 'type' => 'string', + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false', + 'type' => 'boolean', 'required' => true, 'docRequired' => true, - 'example' => 'rg-acxxxxx', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', + 'title' => '', ], ], ], @@ -36561,147 +28119,135 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '21ABF219-10E0-571B-94B8-9C9AE5022BF8', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMaintainTime.Malformed', 'errorMessage' => 'The specified parameter MaintainTime is not valid.', 'description' => 'The MaintainTime parameter is invalid. Check the parameter.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]', - 'title' => 'ModifyDBClusterResourceGroup', - ], - 'ListTagResources' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyCompactionServiceSwitch', + 'summary' => 'Modifies the status of the remote build feature in the query acceleration configuration of an AnalyticDB for MySQL cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCompactionServiceSwitch'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyCompactionServiceSwitch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21ABF219-10E0-571B-94B8-9C9AE5022BF8\\"\\n}","type":"json"}]', + ], + 'ModifyDBCluster' => [ + 'summary' => 'Scales a Data Lakehouse cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '132381', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Data Lakehouse cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1r053byu48p****', 'title' => ''], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the region ID of the specified Data Lakehouse cluster.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'StorageResource', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type. Set the value to **dbclusterlakeversion**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dbclusterlakeversion', - ], + 'schema' => ['description' => 'The reserved storage resource. Valid values: 0 to 2,064 ACU, in increments of 24. One ACU is approximately 1 core and 4 GB of memory.'."\n" + ."\n" + .'> Include the unit in the value.', 'type' => 'string', 'required' => false, 'example' => '24ACU', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'ComputeResource', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '212db86sca4384811e0b5e8707ec21345', - ], + 'schema' => ['description' => 'The reserved compute resource. Valid values: 0 to 4,096 ACU, in increments of 16. One ACU is approximately 1 core and 4 GB of memory.'."\n" + ."\n" + .'> Include the unit in the value.', 'type' => 'string', 'required' => false, 'example' => '16ACU', 'title' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'EnableDefaultResourcePool', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to allocate all reserved compute resources to the `user_default` default resource group. Valid values:'."\n" + ."\n" + .'- true (Default)'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ProductForm', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The cluster ID. You can specify N cluster IDs. Valid values of N: 1 to 50.'."\n" + 'description' => 'The product form. Valid values:'."\n" ."\n" - .'> You must specify at least one of the ResourceId.N and Tag.N.Key parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cluster ID. You can specify N cluster IDs. Valid values of N: 1 to 50.'."\n" - ."\n" - .'> You must specify at least one of the ResourceId.N and Tag.N.Key parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp1l20nxxxxxxxxxx', - ], + .'- **IntegrationForm**: integrated form.'."\n" + ."\n" + .'- **LegacyForm**: Data Lakehouse Edition.', + 'type' => 'string', + 'example' => 'LegacyForm', + 'default' => 'LegacyForm', + 'enum' => ['IntegrationForm', 'LegacyForm'], 'required' => false, - 'maxItems' => 51, + 'title' => '', ], ], [ - 'name' => 'Tag', + 'name' => 'ReservedNodeSize', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key. You can specify N tag keys. The tag key cannot be an empty string. Valid values of N: 1 to 20.'."\n" - ."\n" - .'> You must specify at least one of the ResourceId.N and Tag.N.Key parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testkey1', - ], - 'Value' => [ - 'description' => 'The tag value. You can specify N tag values. The tag value can be an empty string. Valid values of N: 1 to 20.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testvalue1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The node specification for the reserved storage resource. Valid values: `8ACU`, `12ACU`, and `16ACU`.'."\n" + ."\n" + .'> Include the unit in the value. This parameter is valid only when `ProductForm` is set to `IntegrationForm`.', 'type' => 'string', 'required' => false, 'example' => '8ACU', 'title' => ''], + ], + [ + 'name' => 'ReservedNodeCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of reserved nodes.'."\n" + ."\n" + .'- For Enterprise Edition, the default value is 3, and the value must be in increments of 3.'."\n" + ."\n" + .'- For Basic Edition, the default value is 1.'."\n" + ."\n" + .'> This parameter is valid only when `ProductForm` is set to `IntegrationForm`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], ], 'responses' => [ @@ -36709,254 +28255,227 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => '212db86sca4384811e0b5e8707ec21345', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '184DE106-CB2C-4DD2-B57F-396652E6C8F8', - ], - 'TagResources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagResource' => [ - 'description' => 'The queried clusters and tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried cluster and tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceType' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'example' => 'dbclusterlakeversion', - ], - 'TagValue' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'testvalue1', - ], - 'ResourceId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1l20nxxxxxxxxxx', - ], - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'testkey1', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0D6BF3E2-41D8-57F6-9A62-A13A70377952', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'amv-bp1r053byu48p****', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035629****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListTagResources', - 'summary' => 'Queries the tags that are added to AnalyticDB for MySQL clusters, or the AnalyticDB for MySQL clusters that have tags added.', - ], - 'DescribeAutoRenewalAttribute' => [ - 'summary' => 'Queries the auto-renewal status of a subscription cluster.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ACS.Cluster.InvalidWorkerState', 'errorMessage' => 'The state of the worker does not support this operation.', 'description' => 'This operation is not supported due to the current state of the storage node.'], + ['errorCode' => 'ACS.Cluster.ElasticPlanJobsExists', 'errorMessage' => 'Operation failed. Ongoing elastic plan jobs exist.', 'description' => 'Failed to perform this operation because a storage scaling plan job is running.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D6BF3E2-41D8-57F6-9A62-A13A70377952\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\",\\n \\"OrderId\\": \\"2035629****\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBCluster', + 'description' => '### Usage notes'."\n" + ."\n" + .'- During scaling, you cannot submit an asynchronous job by using the `submit job` command. If your business relies on this feature, we recommend that you scale the cluster during off-peak hours.'."\n" + ."\n" + .'- A scaling operation triggers data redistribution, and the migration time is proportional to the data volume. Service is not interrupted during scaling. When you scale down a cluster, data migration can take several hours or longer. Be cautious when you scale down clusters with large data volumes.'."\n" + ."\n" + .'- If a built-in dataset is loaded to the cluster, ensure that the cluster has at least 24 ACU of reserved storage resource when you scale it down. Otherwise, the built-in dataset becomes unavailable.'."\n" + ."\n" + .'- A transient connection failure may occur near the end of the scaling process. We recommend that you perform scaling during off-peak hours or ensure that your application has an automatic reconnection mechanism.'."\n" + ."\n" + .'- You cannot change a Data Lakehouse Edition cluster to a Data Warehouse Edition cluster. However, you can change a Data Warehouse Edition cluster to a Data Lakehouse Edition cluster. For more information, see Change a Data Warehouse Edition cluster to a Data Lakehouse Edition cluster.'."\n" + ."\n" + .'- For information about service endpoints, see [Service Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-09-18T14:10:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-09T03:29:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-27T11:22:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-21T03:39:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-08T16:28:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-13T11:20:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-11-03T03:01:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-11T16:51:52.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBCluster'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ModifyDBClusterDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '10788', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1r053byu48p****', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The description of the cluster.'."\n" + ."\n" + .'* The description cannot start with `http://` or `https`.'."\n" + .'* The description must be 2 to 256 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'adb_test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The cluster IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'am-bp1u8c0mgfg58****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', 'title' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries returned on each page. Valid values:'."\n" - ."\n" - .'* **30**(Default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterDescription.Malformed', 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', 'description' => 'The DBClusterDescription parameter is invalid. Check the parameter.'], ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + 'title' => 'ModifyDBClusterDescription', + 'summary' => 'Modifies the description of an AnalyticDB for MySQL cluster to facilitate the maintenance and management of the cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-03-31T07:03:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:36.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterDescription'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. A positive integer greater than 0 and not exceeding the maximum value of the Integer data type. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\n","errorExample":""}]', + ], + 'ModifyDBClusterMaintainTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-4690g37929****', - ], + 'AK' => [], ], ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1r053byu48p****', 'title' => ''], + ], + [ + 'name' => 'MaintainTime', + 'in' => 'query', + 'schema' => ['description' => 'The maintenance window of the cluster. It must be in the hh:mmZ-hh:mmZ format.'."\n" + ."\n" + .'> The interval must be 1 hour and start and end at the beginning of an hour.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '22:00Z-23:00Z', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'PageRecordCount' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BA0F6761-7A8C-59F8-9624-FB56788C0EDF', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AutoRenewalAttribute' => [ - 'description' => 'The list of auto-renewal details.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-uf6485635fz8****', - ], - 'AutoRenewalPeriodUnit' => [ - 'description' => 'The unit of auto-renewal duration. Valid values:'."\n" - ."\n" - .'* **Year**'."\n" - .'* **Month**'."\n", - 'type' => 'string', - 'example' => 'Year', - ], - 'AutoRenewalPeriod' => [ - 'description' => 'The auto-renewal duration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AutoRenewalStatus' => [ - 'description' => 'The renewal method. Valid values:'."\n" - ."\n" - .'* **AutoRenewal**: The cluster is automatically renewed.'."\n" - .'* **Normal**: The cluster is manually renewed. Before the cluster expires, the system sends you a reminder by SMS message.'."\n" - .'* **NotRenewal**: The cluster is not renewed. Reminders are only sent three days before cluster expiration.'."\n", - 'type' => 'string', - 'example' => 'AutoRenewal', - ], - 'AutoRenewalEnabled' => [ - 'description' => 'Indicates whether auto-renewal is enabled for the cluster. Valid values:'."\n" - ."\n" - .'* **true**: Enables.'."\n" - .'* **false**: Disables.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeAutoRenewalAttribute', - ], - 'ModifyAutoRenewalAttribute' => [ - 'summary' => 'Configures auto-renewal for a subscription cluster.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMaintainTime.Malformed', 'errorMessage' => 'The specified parameter MaintainTime is not valid.', 'description' => 'The MaintainTime parameter is invalid. Check the parameter.'], + ], + ], + 'title' => 'ModifyDBClusterMaintainTime', + 'summary' => 'Modifies the maintenance window of an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-03-31T07:03:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:52.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterMaintainTime'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterMaintainTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n","errorExample":""}]', + ], + 'ModifyDBClusterResourceGroup' => [ + 'summary' => 'Changes the resource group to which an AnalyticDB for MySQL cluster belongs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -36964,81 +28483,110 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '10841', - 'abilityTreeNodes' => [ - 'FEATUREadsQEKELU', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of cluster.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-uf6pl56w1j8h****', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bpxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'NewResourceGroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group to which you want to move the AnalyticDB for MySQL cluster.'."\n" + ."\n" + .'> You can use resource groups to manage resources within your Alibaba Cloud account by group. This helps you resolve issues such as resource grouping and permission management within a single Alibaba Cloud account. For more information, see [What is Resource Management?](~~94475~~)'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-acxxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPreferredBackupTime.Malformed', 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', 'description' => 'The PreferredBackupTime parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPreferredBackupPeriod.Malformed', 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', 'description' => 'PreferredBackupPeriod'], + ['errorCode' => 'InvalidBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter BackupRetentionPeriod is not valid.', 'description' => 'The BackupRetentionPeriod parameter is invalid. Check the parameter.'], + ], + ], + 'title' => 'ModifyDBClusterResourceGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterResourceGroup'], + ], + ], + 'ramActions' => [ [ - 'name' => 'AutoRenewalStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The renewal method. Valid values:'."\n" - ."\n" - .'* **AutoRenewal**: The cluster is automatically renewed.'."\n" - .'* **Normal**: The cluster is manually renewed. Before the cluster expires, the system sends you a reminder by SMS message.'."\n" - .'* **NotRenewal**: The cluster is not renewed. Reminders are only sent three days before cluster expiration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AutoRenewal', - 'default' => 'AutoRenewal', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]', + ], + 'ModifyDBClusterSSL' => [ + 'summary' => 'Modifies the SSL link configuration of a cluster.', + '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' => 'AutoRenewalPeriod', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The duration of the auto-renewal. Default value: 1. Valid values:'."\n" - ."\n" - .'* When **AutoRenewalPeriod** is set to **Month**, the value ranges from 1 to 11 (integer).'."\n" - .'* When **AutoRenewalPeriod** is set to **Month**, the valid values are 1, 2, 3, and 5 (integer).'."\n" - ."\n" - .'> Longer renewal periods offer better pricing. Renewing for 1 year is more cost-effective than renewing for 10 or 11 months.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-************', 'title' => ''], ], [ - 'name' => 'AutoRenewalPeriodUnit', + 'name' => 'EnableSSL', 'in' => 'query', - 'schema' => [ - 'description' => 'Auto-renewal duration. Valid values:'."\n" - ."\n" - .'* Year.'."\n" - .'* Month.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Year', - 'default' => 'Month', - ], + 'schema' => ['description' => 'Specifies whether to enable SSL encryption. Valid values:'."\n" + ."\n" + .'* **true**: enabled'."\n" + .'* **false**: disabled'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => ['description' => 'The private or public endpoint for which the server certificate needs to be created or updated.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'amv-***********.ads.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -37046,1586 +28594,1272 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', - ], + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\"\\n}","type":"json"}]', - 'title' => 'ModifyAutoRenewalAttribute', - ], - 'DescribeApsResourceGroups' => [ - 'summary' => 'Queries the information about resource groups of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ModifyDBClusterSSL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterSSL'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + ], + 'ModifyDBClusterVip' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '146751', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsY28JLD', - ], + 'abilityTreeCode' => '212368', + 'abilityTreeNodes' => ['FEATUREads3N2V5J'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-2ze8mbuai97*****', 'title' => ''], ], [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp1t6rym21****', - ], + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['description' => 'The VPC ID.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The new **VPC** must reside in the same region as the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1at5ze0t5u3xtqn****', 'title' => ''], ], [ - 'name' => 'WorkloadId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the data synchronization job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aps-hz1686v37sx****', - ], + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The vSwitch ID.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The new vSwitch must reside in the same zone as the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1aadw9k19x6cis9****', 'title' => ''], + ], + [ + 'name' => 'ConnectString', + 'in' => 'query', + 'schema' => ['description' => 'The endpoint of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-2ze8mbuai974s4y2500000169.ads.aliyuncs.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6FC370D7-1D4C-5A8E-805E-F73366382C66', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request was successful, a success message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The queried resource groups.'."\n", - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'description' => 'The step size of resources. Unit: AnalyticDB compute units (ACUs).'."\n" - ."\n" - .'* If the value of GroupType is **Interactive**, 16 is returned.'."\n" - .'* If the value of GroupType is **Job**, 8 is returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'ResourceGroups' => [ - 'description' => 'The queried resource groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CuOptions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '', - ], - ], - 'MaxComputeResource' => [ - 'description' => 'The maximum amount of reserved computing resources. Unit: ACUs.'."\n" - ."\n" - .'* If the value of GroupType is **Interactive**, the amount of reserved computing resources that are not allocated in the cluster is returned in increments of 16 ACUs.'."\n" - .'* If the value of GroupType is **Job**, the amount of reserved computing resources that are not allocated in the cluster is returned in increments of 8 ACUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '512', - ], - 'LeftComputeResource' => [ - 'description' => 'The amount of remaining computing resources. Unit: ACUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '512', - ], - 'MinComputeResource' => [ - 'description' => 'The minimum amount of reserved computing resources. Unit: ACUs.'."\n" - ."\n" - .'* If the value of GroupType is **Interactive**, 16 is returned.'."\n" - .'* If the value of GroupType is **Job**, 0 is returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'GroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GroupType' => [ - 'description' => 'The type of the resource group. Valid values:'."\n" - ."\n" - .'* **Interactive**'."\n" - .'* **Job**'."\n" - ."\n" - .'> For more information about resource groups, see [Resource groups](~~428610~~).'."\n", - 'type' => 'string', - 'example' => 'Job', - ], - 'Available' => [ - 'description' => 'Indicates whether the resource group is available. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], - ], - ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-****-4A42-BF6D-8A4442913CEF'], ], + 'example' => '', ], ], ], - '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' => 'DescribeApsResourceGroups', - 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'DescribeApsJobDetail' => [ - 'summary' => 'Queries the information about an AnalyticDB Pipeline Service (APS) job.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '180625', - 'abilityTreeNodes' => [ - 'FEATUREadsH8FO36', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ACS.Cluster.InvalidState', 'errorMessage' => 'The state of the cluster does not support this operation.', 'description' => 'The status of the cluster does not support the current operation.'], + ['errorCode' => 'InvalidConnectionString.Malformed', 'errorMessage' => 'The specified parameter "ConnectionString" is not valid.', 'description' => 'The specified parameter "ConnectionString" is not valid.'], + ['errorCode' => 'InvalidConnectionString.UnSupported', 'errorMessage' => 'The specified parameter "ConnectionString" Only support vpc address.', 'description' => 'Parameter ConnectString only supports VPC addresses'], + ['errorCode' => 'ACS.InvalidParameter.%s', 'errorMessage' => 'Parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ACS.UnsupportedAvailableZone', 'errorMessage' => 'The specified available zone is not supported.', 'description' => 'The specified zone is not supported.'], ], - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 403 => [ + ['errorCode' => 'ACS.ServerError', 'errorMessage' => 'ADB Cloud Service failed to process your request.', 'description' => 'An internal service error occurred.'], ], [ - 'name' => 'ApsJobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-******', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-E606-4A42-BF6D-******', - ], - 'APSJobDetail' => [ - 'description' => 'The queried job.'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceEndpointRegion' => [ - 'description' => 'The region of the source instance.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'SourceEndpointInstanceID' => [ - 'description' => 'The ID of the source instance.'."\n", - 'type' => 'string', - 'example' => 'pc-*******', - ], - 'DestinationEndpointRegion' => [ - 'description' => 'The region of the destination cluster.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'DestinationEndpointInstanceID' => [ - 'description' => 'The ID of the destination cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-******', - ], - 'PartitionList' => [ - 'description' => 'The partitions.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'DbList' => [ - 'description' => 'The objects that are synchronized.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'TargetTableMode' => [ - 'description' => 'The mode of the destination table.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Status' => [ - 'description' => 'The status of the job.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - ], - 'example' => '-', - ], - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ModifyDBClusterVip', + 'summary' => 'Changes the virtual IP address (VIP) that is used to connect to an AnalyticDB for MySQL cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterVip'], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidInput', - 'errorMessage' => 'The specified parameter is invalid.', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterVip', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - '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' => 'DescribeApsJobDetail', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-****-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', ], - 'CreateApsWebhook' => [ - 'summary' => 'Creates a new webhook for the specified cluster or task type.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ModifyDBResourceGroup' => [ + 'summary' => 'Changes the resource group of a cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsBIVU9O', - 'FEATUREadsY28JLD', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '136445', + 'abilityTreeNodes' => ['FEATUREadsYXZ2UA'], ], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Data Lakehouse Edition, Enterprise Edition, or Basic Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp1r053byu48p****', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the region in which to create the dedicated block storage cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the resource group name for a specific cluster.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'JobType', - 'in' => 'formData', + 'name' => 'GroupType', + 'in' => 'query', 'schema' => [ - 'description' => 'The type of the task. Valid value: Task type. SLS or OSS Export Task: ResultExport.'."\n", + 'description' => 'The type of the resource group. Valid values:'."\n" + ."\n" + .'- **Interactive**'."\n" + ."\n" + .'- **Job**'."\n" + ."\n" + .'> For more information about resource groups in Data Lakehouse Edition clusters, see [Resource groups](~~428610~~).', 'type' => 'string', 'required' => true, - 'example' => 'ResultExport', + 'docRequired' => true, + 'enum' => [], + 'example' => 'Interactive', + 'title' => '', ], ], [ - 'name' => 'Webhook', - 'in' => 'formData', + 'name' => 'MinComputeResource', + 'in' => 'query', + 'schema' => ['description' => 'The minimum amount of reserved computing resources.'."\n" + ."\n" + .'- If the resource group type is `Interactive`, the minimum amount of reserved computing resources is 16 ACU.'."\n" + ."\n" + .'- If the resource group type is `Job`, the minimum amount of reserved computing resources is 0 ACU.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '0ACU'], + ], + [ + 'name' => 'MaxComputeResource', + 'in' => 'query', + 'schema' => ['description' => 'The maximum amount of reserved computing resources. The value cannot exceed the unallocated computing resources of the cluster.'."\n" + ."\n" + .'- If the resource group type is `Interactive`, the value is specified in increments of 16 ACU.'."\n" + ."\n" + .'- If the resource group type is `Job`, the value is specified in increments of 8 ACU.', 'type' => 'string', 'required' => false, 'example' => '48ACU', 'title' => ''], + ], + [ + 'name' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], + ], + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '无'."\n", 'title' => ''], + ], + [ + 'name' => 'MaxClusterCount', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '无', 'title' => ''], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], + ], + [ + 'name' => 'EnableSpot', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the spot instance feature for the resource group. This feature provides resources at a lower unit price, but they can be reclaimed at any time. Only `Job` resource groups support this feature. Valid values:'."\n" + ."\n" + .'- **True**: enables the spot instance feature.'."\n" + ."\n" + .'- **False**: disables the spot instance feature.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query available regions.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Rules', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The array of webhooks.'."\n", + 'description' => 'The job submission rules.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the webhook.'."\n", + 'description' => 'A job submission rule.', 'type' => 'object', 'properties' => [ - 'WebhookType' => [ - 'description' => 'The notification method. Valid values: dingtalk. lark.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dingtalk', - ], - 'Url' => [ - 'description' => 'The request path.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://example.com/webhook', - ], - 'Key' => [ - 'description' => 'Signed key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], - 'Name' => [ - 'description' => 'The name of the webhook.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MyWebhookName', - ], + 'GroupName' => ['description' => 'The name of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'user_default', 'title' => ''], + 'QueryTime' => ['description' => 'The query execution time threshold, in milliseconds (ms).', 'type' => 'string', 'required' => false, 'example' => '180000'."\n", 'title' => ''], + 'TargetGroupName' => ['description' => 'The name of the target resource group.', 'type' => 'string', 'required' => false, 'example' => 'job'."\n", 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => '1234567890abcdef', - ], - 'Data' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'The code returned for the request.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + [ + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The engine configuration.', 'type' => 'object', 'required' => false, 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', 'title' => ''], ], - ], - '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' => 'CreateApsWebhook', - ], - 'DeleteApsWebhook' => [ - 'summary' => 'Deletes a specific webhook in a specified cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AutoStopInterval', + 'in' => 'query', + 'schema' => ['description' => 'The idle duration after which the resource group is automatically stopped.', 'type' => 'string', 'required' => false, 'example' => '5m', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsBIVU9O', - 'FEATUREadsY28JLD', + [ + 'name' => 'SpecName', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'Reserved parameter. Not applicable.', 'required' => false, 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-uf63i4ij56b***', - ], + 'name' => 'MinGpuQuantity', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved.', 'type' => 'integer', 'example' => 'Reserved parameter. Not applicable.', 'format' => 'int32', 'required' => false, 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'MaxGpuQuantity', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved.', 'type' => 'integer', 'example' => 'Reserved parameter. Not applicable.', 'format' => 'int32', 'required' => false, 'title' => ''], ], [ - 'name' => 'WebhookId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the webhook to be deleted.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '***1*595*', - ], + 'name' => 'TargetResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'Reserved parameter. Not applicable.', 'required' => false, 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The desired state of the resource group. Specify **starting** to start the resource group or **stopping** to stop it.', 'type' => 'string', 'required' => false, 'example' => 'starting', 'title' => ''], + ], + [ + 'name' => 'RayConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The unique ID of the request.'."\n", + 'EnableUserEni' => ['description' => 'Specifies whether to enable the ENI.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + 'HeadSpecType' => [ + 'description' => 'The resource type of the head node.', 'type' => 'string', - 'example' => 'exampleRequestId', + 'default' => 'CPU', + 'enum' => ['CPU', 'GPU'], + 'required' => false, + 'example' => 'CPU', + 'title' => '', ], - 'Data' => [ - 'description' => 'The returned data.'."\n", + 'HeadSpec' => ['description' => 'The specifications of the head node.', 'type' => 'string', 'required' => false, 'example' => 'xlarge', 'title' => ''], + 'HeadAllocateUnit' => ['description' => 'The allocation unit of the head node.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'HeadDiskCapacity' => ['description' => 'The disk size of the head node.', 'type' => 'string', 'required' => false, 'example' => '100G', 'title' => ''], + 'Category' => [ + 'description' => 'The type of the Ray cluster. Valid values:'."\n" + ."\n" + .'- **BASIC**: A basic, non-high-availability cluster.'."\n" + ."\n" + .'- **HIGH\\_AVAILABILITY**: A high-availability cluster.', 'type' => 'string', - 'example' => '[]', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'enum' => ['BASIC', 'HIGH_AVAILABILITY'], + 'required' => false, + 'example' => 'BASIC', + 'title' => '', ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', + 'WorkerGroups' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AllocateUnit' => ['description' => 'The allocation unit.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'GroupName' => ['description' => 'The name of the worker group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'MaxWorkerQuantity' => ['description' => 'The maximum number of worker nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'MinWorkerQuantity' => ['description' => 'The minimum number of worker nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'WorkerDiskCapacity' => ['description' => 'The disk size of a worker node.', 'type' => 'string', 'required' => false, 'example' => '100G', 'title' => ''], + 'WorkerSpecName' => ['description' => 'The specifications of a worker node.', 'type' => 'string', 'required' => false, 'example' => 'xlarge', 'title' => ''], + 'WorkerSpecType' => [ + 'description' => 'The resource type of a worker node.', + 'type' => 'string', + 'enum' => ['CPU', 'GPU'], + 'required' => false, + 'example' => 'GPU', + 'title' => '', + ], + ], + 'required' => false, + 'description' => 'The configuration of a Ray worker group.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'description' => 'A list of configurations for Ray worker groups.', + 'title' => '', 'example' => '', ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-uf63i4ij56b***'."\n", - ], - 'Code' => [ - 'description' => 'API status or POP error code.'."\n", - 'type' => 'string', - 'example' => '200', + 'AppConfig' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'app01', 'title' => '', 'required' => false], + 'AppType' => ['description' => 'The application type.', 'type' => 'string', 'example' => 'IsaacLab', 'title' => '', 'required' => false], + 'ImageSelector' => [ + 'type' => 'object', + 'properties' => [ + 'Image' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'lab2.10.0-ray2.43.0', 'title' => '', 'required' => false], + 'InferenceEngine' => ['description' => 'The inference engine.', 'type' => 'string', 'example' => 'vLLM', 'title' => '', 'required' => false], + 'LlmModel' => ['description' => 'The large language model (LLM).', 'type' => 'string', 'example' => 'Deepseek-R1', 'title' => '', 'required' => false], + ], + 'title' => '', + 'required' => false, + 'description' => 'The image configuration.', + 'example' => '', + ], + ], + 'title' => '', + 'required' => false, + 'description' => 'The Ray application configuration.', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'StorageMounts' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StorageId' => ['description' => 'The storage ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], + 'MountPath' => ['description' => 'The mount path.', 'type' => 'string', 'example' => '/mnt/data01', 'title' => '', 'required' => false], + ], + 'title' => '', + 'required' => false, + 'description' => 'A storage mount.', + 'example' => '', + ], + 'title' => '', + 'required' => false, + 'description' => 'A list of storage mounts.', + 'example' => '', ], + 'UserDefinedRequirements' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - ], - ], - ], - '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' => 'DeleteApsWebhook', - 'description' => 'This API allows users to delete an existing webhook configuration by providing `RegionId`, `DBClusterId`, and `WebhookId`. Make sure that the provided parameter values are accurate to avoid deleting important settings by mistake.'."\n", - ], - 'UpdateApsWebhook' => [ - 'summary' => 'Updates the webhook configuration of a specified cluster.', - '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' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'exampleDBClusterId', + 'required' => false, + 'description' => 'The Ray configuration. This parameter is required if the resource group is an AI group and uses a Ray cluster as its engine.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RegionId', - 'in' => 'formData', + 'name' => 'GpuElasticPlan', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'exampleRegionId', + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['description' => 'Specifies whether to enable the scaling plan immediately upon creation.'."\n" + .'Valid values:'."\n" + ."\n" + .'- **true**: The plan is enabled.'."\n" + ."\n" + .'- **false**: The plan is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Rules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartCronExpression' => ['description' => 'The start time of the scaling window, specified as a cron expression. The duration between the start and end times must be at least one hour.', 'type' => 'string', 'required' => false, 'example' => '0 0 2 * * ?', 'title' => ''], + 'EndCronExpression' => ['description' => 'The end time of the scaling window, specified as a cron expression.', 'type' => 'string', 'required' => false, 'example' => '0 0 3 * * ?', 'title' => ''], + ], + 'required' => false, + 'description' => 'A rule.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'description' => 'A list of rules.', + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => 'The time-based scaling plan for GPUs.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Webhook', - 'in' => 'formData', + 'name' => 'AtmConfig', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The array of webhooks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The array of webhooks.'."\n", - 'type' => 'object', - 'properties' => [ - 'WebhookId' => [ - 'description' => 'The ID of the webhook.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '**355****', - ], - 'Url' => [ - 'description' => 'The URL of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://example.com/webhook', - ], - 'Key' => [ - 'description' => 'Signed key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ABC**', - ], - 'WebhookType' => [ - 'description' => 'The notification method. Valid values: dingtalk. lark.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dingtalk', - ], - 'Name' => [ - 'description' => 'The name of the webhook.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'exampleWebhookName', - ], + 'type' => 'object', + 'properties' => [ + 'SelectNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'title' => '', 'description' => ''], + 'SelectNodeNum' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'description' => ''], + 'SelectNodeCacheSize' => ['type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'description' => ''], + 'StorageNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'title' => '', 'description' => ''], + 'StorageNodeNum' => ['type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => '', 'description' => ''], + 'StorageNodeDiskSize' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'description' => ''], + 'StorageNodeDiskType' => [ + 'type' => 'string', + 'example' => 'essd_pl1', + 'enum' => ['essd_pl1', 'essd_pl2'], + 'title' => '', + 'description' => '', ], - 'required' => false, + 'InsertNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'title' => '', 'description' => ''], + 'InsertNodeNum' => ['type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => '', 'description' => ''], + 'AuthNodeSpec' => ['type' => 'string', 'example' => '8ACU', 'title' => '', 'description' => ''], + 'AuthNodeNum' => ['type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => '', 'description' => ''], ], - 'required' => false, + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'exampleRequestId', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-bp11q28kvl688****', - ], - 'Code' => [ - 'description' => 'The code of the returned result.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '805F14E1-0186-520E-A6D5-30188D94E8DA'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidPoolName.Malformed', 'errorMessage' => 'The specified parameter PoolName is not valid.', 'description' => 'The PoolName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolUser.Malformed', 'errorMessage' => 'The specified parameter PoolUser is not valid.', 'description' => 'The PoolUser parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolType.Malformed', 'errorMessage' => 'The specified parameter PoolType is not valid.', 'description' => 'The PoolType parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMinComputeResource.Malformed', 'errorMessage' => 'The specified parameter MinComputeResource is not valid.', 'description' => 'The MinComputeResource parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMaxComputeResource.Malformed', 'errorMessage' => 'The specified parameter MaxComputeResource is not valid.', 'description' => 'The MaxComputeResource parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.ResourceGroup.ElasticPlanExists', 'errorMessage' => 'This resource group does not support this operation. Elastic plans that have been enabled already exist.', 'description' => 'This operation is not supported for the current resource group because a scaling plan has been enabled.'], + ['errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', 'errorMessage' => 'The state of this resource group does not support this operation.', 'description' => 'This operation is not supported due to the current state of the resource group.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"805F14E1-0186-520E-A6D5-30188D94E8DA\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBResourceGroup', + 'description' => 'For service endpoints, see [endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2025-12-02T15:07:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-17T13:49:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-20T12:54:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-31T12:12:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-15T17:29:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-13T16:32:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-25T02:12:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-26T02:37:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-19T08:51:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-25T10:08:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-13T11:20:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-31T07:03:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:36.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBResourceGroup'], + ], ], - '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' => 'UpdateApsWebhook', - ], - 'ListApsWebhook' => [ - 'summary' => 'Queries the Webhook configurations of a specified database cluster.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'machine', + ], + 'ModifyElasticPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsBIVU9O', - 'FEATUREadsY28JLD', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-8vbuyjhrih**', - ], + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the scaling plan.'."\n" + ."\n" + .'> You can call the [DescribeElasticPlans](~~601334~~) operation to query the names of scaling plans.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the scaling plan.'."\n" + ."\n" + .'> Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-01-01T12:01:00Z', 'title' => ''], ], [ - 'name' => 'JobType', - 'in' => 'formData', - 'schema' => [ - 'description' => '**JobType**\\'."\n" - .'Job type. SLS or OSS Export Task: ResultExport.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ResultExport', - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the scaling plan.'."\n" + ."\n" + .'> Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2025-01-01T12:01:00Z', 'title' => ''], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => ['description' => 'A CORN expression that specifies the scaling cycle and time for the scaling plan.'."\n", 'type' => 'string', 'required' => false, 'example' => '0 20 14 * * ?', 'title' => ''], + ], + [ + 'name' => 'TargetSize', + 'in' => 'query', + 'schema' => ['description' => 'The desired specifications of elastic resources after scaling.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If the scaling plan uses **EIUs** and **Default Proportional Scaling for EIUs** is enabled, you do not need to specify this parameter. In other cases, you must specify this parameter.'."\n" + ."\n" + .'* You can call the [DescribeElasticPlanSpecifications](~~601278~~) operation to query the specifications that are supported for scaling plans.'."\n", 'type' => 'string', 'required' => false, 'example' => '32ACU', 'title' => ''], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz9509beptiz****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned message.'."\n", + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'exampleRequestId', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'API status or POP error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Webhook' => [ - 'description' => 'The array of webhooks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The array of webhooks.'."\n", - 'type' => 'object', - 'properties' => [ - 'WebhookType' => [ - 'description' => 'Webhook type.'."\n", - 'type' => 'string', - 'example' => 'dingtalk', - ], - 'WebhookId' => [ - 'description' => 'The ID of the webhook that you want to delete.'."\n", - 'type' => 'string', - 'example' => '**35***', - ], - 'Url' => [ - 'description' => 'The request URL.'."\n", - 'type' => 'string', - 'example' => 'https://example.com/webhook', - ], - 'Key' => [ - 'description' => 'Signing key'."\n", - 'type' => 'string', - 'example' => 'your_secret_key', - ], - 'Name' => [ - 'description' => 'The name of the webhook.'."\n", - 'type' => 'string', - 'example' => 'webhook_name', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], ], - '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' => 'ListApsWebhook', - 'description' => 'This API allows you to obtain a list of configured webhooks based on `RegionId`, `DBClusterId`, and optional `JobType`. The `JobType` parameter specifies the task type, such as SLS/OSS export task. If the parameter is provided, webhooks related to the task type are returned. If the parameter is not provided, all types of webhooks are returned.'."\n" - ."\n" - .'Note: Make sure that the `RegionId` and `DBClusterId` you provided are correct. Otherwise, the webhook information may not be obtained correctly.'."\n", - ], - 'CreateApsKafkaHudiJob' => [ - 'summary' => 'Creates a data ingestion task to load data from an Apache Kafka topic into an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.', - 'methods' => [ - 'get', - 'post', + 'title' => 'ModifyElasticPlan', + 'summary' => 'Modifies a scaling plan for an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see Endpoints.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-12-12T10:09:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-13T11:20:15.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyElasticPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5C433C2-001F-58E3-99F5-3274C14DF8BD\\n","errorExample":""}]', + ], + 'ModifyEssdCacheConfig' => [ + 'summary' => 'Modifies the disk cache size in the query acceleration configuration of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '157674', - 'abilityTreeNodes' => [ - 'FEATUREadsY28JLD', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all clusters in a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp11q28kvl688****', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp10yt0gva71ei7d', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'formData', + 'name' => 'EnableEssdCache', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable the disk cache feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', 'required' => true, - 'example' => 'cn-hangzhou', + 'docRequired' => true, + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'PartitionSpecs', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'EssdCacheSize', + 'in' => 'query', + 'schema' => ['description' => 'The disk cache size. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '500', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The partition information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '"SourceColumn": the name of the source partition field. "Strategy": The policy.'."\n" - ."\n" - .'1. Format the date as follows: "ParseAsTimeAndFormat".'."\n" - .'2. Specify the partition field:"CustomSpecify". �� "SourceTypeFormat": source type format. "TargetTypeFormat": destination type format. "TargetColumn": the name of the destination partition field.'."\n" - ."\n" - .'The SourceTypeFormat enumeration and meaning are as follows, and the right side corresponds to the time precision. Timestamp Accurate to Milliseconds Timestamp Accurate to Microseconds Timestamp Accurate to Seconds yyyy-MM-dd HH:mm:ss.SSS APSMIDyyyyMMddHHmmss -> yyyy-MM-dd HH:mm:ss APSMIDyyyyMMdd -> yyyy-MM-dd. APSyyyyMMddHHmmss -> yyyyMMddHHmmss. �� APSyyyyMMdd -> yyyMMdd. APSyyyyMM -> yyyMM. YYYY/MM/DD YYYY/MM/DD'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '[{ "SourceColumn": "NetOutFlow", "Strategy": "ParseAsTimeAndFormat", "SourceTypeFormat": "APSLiteralTimestampSecond", "TargetTypeFormat": "yyyy-MM-dd", "TargetColumn": "NetOutFlow" }]', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '115F9CCA-EF2E-5F91-AB60-4961D52FEAB4', 'title' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidMaintainTime.Malformed', 'errorMessage' => 'The specified parameter MaintainTime is not valid.', 'description' => 'The MaintainTime parameter is invalid. Check the parameter.'], + ], + ], + 'title' => 'ModifyEssdCacheConfig', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEssdCacheConfig'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Columns', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The column information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The column information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the source column to use for partitioning.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'MapName' => [ - 'description' => 'The name of the partition column in the destination table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b', - ], - 'Type' => [ - 'description' => 'The format of the source field. See the table below for valid values.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'string', - ], - 'MapType' => [ - 'description' => 'The desired format for the destination partition column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'string', - ], - ], - 'required' => false, + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyEssdCacheConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - 'required' => true, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"115F9CCA-EF2E-5F91-AB60-4961D52FEAB4\\"\\n}","type":"json"}]', + ], + 'ModifyLakeCacheSize' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '214852', + 'abilityTreeNodes' => ['FEATUREadsCQJTKP'], + ], + 'parameters' => [ [ - 'name' => 'PrimaryKeyDefinition', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The primary key settings. Contains the uuid policy and mapping policy. The explanation is as follows. Uuid policy: "Strategy": "uuid". Mapping policy: "Strategy": "mapping", "Values":\\[ "f1", "f2" ], "RecordVersionField","xxx" The meaning of the RecordVersionField is the HUDI record version.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"Strategy": "mapping"', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp10yt0gva71ei7d', 'title' => ''], ], [ - 'name' => 'WorkloadName', - 'in' => 'formData', + 'name' => 'EnableLakeCache', + 'in' => 'query', 'schema' => [ - 'description' => 'The name of the workload.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable the lake cache feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', 'required' => true, - 'example' => 'test', + 'docRequired' => true, + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'LakehouseId', - 'in' => 'formData', + 'name' => 'Capacity', + 'in' => 'query', + 'schema' => ['description' => 'The lake cache size that you want to set. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the lakehouse.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '494486CE-6F49-574E-B304-29127EA12E36', 'title' => ''], + 'Code' => ['description' => 'The status code. The value 200 indicates that the request is successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Instances' => [ + 'description' => 'The clusters that share the lake cache space.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'amv-bp10yt0gva71ei7d', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Capacity' => ['description' => 'The size of the lake cache space. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'DataSize' => ['description' => 'The size of the data that occupies the lake cache space. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'title' => 'ModifyLakeCacheSize', + 'summary' => 'Modifies the lake cache size of an AnalyticDB for MySQL cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyLakeCacheSize'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ResourceGroup', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The resource group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:ModifyLakeCacheSize', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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"}]', + ], + 'ModifyMaterializedView' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'HudiAdvancedConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The HUDI configuration of the destination.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hoodie.keep.min.commits=20', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsTYGUV3'], + ], + 'parameters' => [ [ - 'name' => 'AdvancedConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The advanced configurations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'FullComputeUnit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The full synchronization configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2ACU', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-******'], ], [ - 'name' => 'IncrementalComputeUnit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The incremental synchronization configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2ACU', - ], + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the materialized view.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mv_1'], ], [ - 'name' => 'KafkaClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Apache Kafka instance. You can get it in the Kafka console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'name' => 'DbName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the database where the materialized view resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'myDB'], ], [ - 'name' => 'KafkaTopic', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Kafka Topic ID. You can get it in the Kafka console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the resource group to which the materialized view is bound.'."\n", 'type' => 'string', 'required' => false, 'example' => 'res_1'], ], [ - 'name' => 'StartingOffsets', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies the position from which to start consuming messages. Valid values: begin_cursor/end_cursor/timestamp Each corresponds to the earliest /latest /specified time respectively.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'begincursor', - ], + 'name' => 'QueryWrite', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable query rewrite. Valid values:'."\n" + ."\n" + .'* true: Enables query rewrite.'."\n" + .'* false: Disables query rewrite.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'MaxOffsetsPerTrigger', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum number of records to fetch in a single batch.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50000', - ], + 'name' => 'EnableFailureAlert', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to send alerts when the refresh task fails. Valid values:'."\n" + ."\n" + .'* true: Send alerts.'."\n" + .'* false: Alerts disabled.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'DbName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the user-defined database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testDB', - ], + 'name' => 'EnableDelayAlert', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Enable the refresh delay alert. Valid values:'."\n" + ."\n" + .'* true: Enables alert.'."\n" + .'* false: Disables alert.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'TableName', - 'in' => 'formData', + 'name' => 'LatencyTolerance', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Refresh delay tolerance (in minutes).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the user-defined table.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testTB', + 'title' => '', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'CF8BA882-C9D8-5BEF-AAA3-AD03875F3E18'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ModifyMaterializedView', + 'summary' => 'Modifies materialized views.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMaterializedView'], + ], + ], + 'ramActions' => [ [ - 'name' => 'OutputFormat', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The format of the output data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HUDI', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyMaterializedView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF8BA882-C9D8-5BEF-AAA3-AD03875F3E18\\"\\n}","type":"json"}]', + ], + 'ModifyMaterializedViewRecommend' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TargetType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The destination type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsTYGUV3'], + ], + 'parameters' => [ [ - 'name' => 'TargetGenerateRule', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The rules for generating the destination database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AcrossUid', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the source Kafka belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123************', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'amv-uf6o*****', 'title' => ''], ], [ - 'name' => 'AcrossRole', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Resource Access Management (RAM) role that is created for the trusted Alibaba Cloud account. For more information, see Create a RAM role for a trusted Alibaba Cloud account. The ARN of the RAM role that grants AnalyticDB for MySQL permission to access resources in the source account. Required for cross-account data ingestion.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aps', - ], + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the materialized view recommendation task.', 'type' => 'string', 'required' => true, 'example' => 'task_n1'], ], [ - 'name' => 'SourceRegionId', - 'in' => 'formData', + 'name' => 'SchedulingPolicy', + 'in' => 'query', 'schema' => [ - 'description' => '地域ID。', + 'title' => '', + 'description' => 'The recommendation policy. Valid values: '."\n" + .'- daliy: scheduled on a daily basis.'."\n" + .'- weekly: scheduled on a weekly basis.', 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou', + 'enum' => ['daily', 'weekly'], + 'example' => 'weekly', ], ], [ - 'name' => 'JsonParseLevel', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of layers that are parsed for nested JSON fields. Valid values: 0: Nested JSON fields are not parsed. 1: parses one layer. 2: Two layers are parsed. 3: Three layers are parsed. 4: Four layers are parsed. By default, one layer is parsed. For more information about how nested JSON fields are parsed, see the Examples of schema fields parsed with different numbers of layers section of this topic.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'SchedulingDay', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Valid only when SchedulingPolicy is set to weekly. Valid values:'."\n" + .'- Monday'."\n" + .'- Tuesday'."\n" + .'- Wednesday'."\n" + .'- Thursday'."\n" + .'- Friday'."\n" + .'- Saturday'."\n" + .'- Sunday'."\n" + ."\n" + .'Separate multiple days with commas.', 'type' => 'string', 'required' => false, 'example' => 'Monday;Wednesday'], ], [ - 'name' => 'DataOutputFormat', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Enumeration value and description. Single: The source is a single-row JSON record. Multi: source is a JSON array. Output a single JSON record.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Single', - ], + 'name' => 'SpecifiedTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The execution time of the task in the format HH:MM:SS.', 'type' => 'string', 'required' => false, 'example' => '10:00:00'], ], [ - 'name' => 'OssLocation', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the destination data lakehouse in an Object Storage Service (OSS) bucket.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://test-xx-zzz/yyy/', - ], + 'name' => 'ScanQueriesRange', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The scan time range, in days. Default value: 3.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], ], [ - 'name' => 'DatasourceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The description of the recommendation task.', 'type' => 'string', 'required' => false, 'example' => 'task desc'], ], [ - 'name' => 'DataFormatType', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Kafka消息类型，支持的消息类型为：json、general_canal_json、mongo_canal_json、dataworks_json和shareplex_json', - 'type' => 'string', - ], + 'name' => 'SlowQueryThreshold', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The slow query threshold.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'MinRewriteQueryPattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The minimum number of patterns that can be accelerated.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'MinRewriteQueryCount', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The minimum number of slow queries matched by a pattern.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '3'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Returns the ID of the created task.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1A943417-5B0E-1DB9-A8**-A566****C3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. true: The request is successful. false: The message group failed to be unmuted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'Same as HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6'], ], - 'description' => '', + 'example' => '', ], ], ], - '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' => 'CreateApsKafkaHudiJob', - ], - 'ListApsLifecycleStrategy' => [ - 'summary' => 'Queries a list of lifecycle management policies of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify automatic materialized view recommendation task', + 'summary' => 'Modifies an automatic materialized view recommendation task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMaterializedViewRecommend'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyMaterializedViewRecommend', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ModifyPerformanceView' => [ + 'summary' => 'Modifies the information about a custom monitoring view.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['Perth'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '200829', - 'abilityTreeNodes' => [ - 'FEATUREadsNQ1ZDK', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220840', + 'abilityTreeNodes' => ['FEATUREadsDAZVRM'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-*******', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-01-01T11:22Z', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612397~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1ub9grke1****', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-01-02T11:22Z', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring view.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Custom-All metrics-2 columns-Linked', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'ViewDetail', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'ResultData', - 'description' => 'The response parameters.'."\n", + 'description' => 'The new information about the monitoring view.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Items' => [ - 'description' => 'The queried lifecycle management policies.'."\n", + 'ChartsPerLine' => ['description' => 'The number of charts to display in each row.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'ChartLinked' => ['description' => 'Specifies whether to enable the filter interaction feature. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Categories' => [ + 'description' => 'The metric categories.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The queried list of lifecycle management policies of an AnalyticDB for MySQL cluster.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'OperationTables' => [ - 'description' => 'The operation tables.', + 'Category' => ['description' => 'The name of the metric category. Valid values:'."\n" + ."\n" + .'* **Node**'."\n" + .'* **DiskData**'."\n" + .'* **WorkLoad**'."\n" + .'* **ResourceGroup**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Node', 'title' => ''], + 'Keys' => [ + 'description' => 'The metrics.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The operation tables.', + 'description' => '', 'type' => 'object', 'properties' => [ - 'DatabaseName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProcessAll' => [ - 'description' => 'Indicates whether all tables in the database are selected.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'TableNames' => [ - 'description' => 'The names of the tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], + 'KeyName' => ['description' => 'The name of the metric.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AnalyticDB_CPU', 'title' => ''], + 'Selected' => ['description' => 'Specifies whether to select the metric. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - 'StrategyDesc' => [ - 'description' => 'The description of the lifecycle management policy.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'StrategyName' => [ - 'description' => 'The name of the lifecycle management policy.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'StrategyType' => [ - 'description' => 'The type of the lifecycle management policy.'."\n", - 'type' => 'string', - 'example' => 'KEEP_BY_TIME', - ], - 'StrategyValue' => [ - 'description' => 'The value of the lifecycle management policy.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Status' => [ - 'description' => 'The status of the lifecycle management policy. Valid values:'."\n" - ."\n" - .'1. on: enables the current policy.'."\n" - .'2. off: disables the current policy.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'CreatedTime' => [ - 'description' => 'The time when the policy was created.'."\n", - 'type' => 'string', - 'example' => '2021-06-30T02:44:27Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the policy was modified.'."\n", - 'type' => 'string', - 'example' => '2021-07-03T06:33:00Z', - ], - 'ApsJobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'aps-******', - ], - 'StrategyDatabases' => [ - 'description' => 'The number of databases that are managed during the lifecycle management.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'StrategyTables' => [ - 'description' => 'The number of tables that are managed during the lifecycle management.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-*******', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', 'title' => ''], + 'ModifyStatus' => ['description' => 'The modification result. Valid values:'."\n" + ."\n" + .'* **SUCCESS**'."\n" + .'* **FAILED**'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", '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" + .'}', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListApsLifecycleStrategy', - ], - 'GetApsManagedDatabases' => [ - 'summary' => 'Queries a list of databases.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], + ], + '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' => 'ModifyPerformanceView', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPerformanceView'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyPerformanceView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'ModifySqlTemplatePosition' => [ + 'summary' => 'Modifies the directory location of SQL templates.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '200691', - 'abilityTreeNodes' => [ - 'FEATUREadsNQ1ZDK', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-******', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-uf6wjk5xxxxxxxxxx'], ], [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The template ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '210208'], + ], + [ + 'name' => 'TargetTemplateGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the template group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ @@ -38633,59 +29867,51 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => '-', - ], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request is successful, a **SUCCESS** message is returned.'."\n" + .'* If the request is abnormal, the detailed error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5DC10091-348D-12B1-906D-AB49D658012E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: Succeeded.'."\n" + .'* **false**: Failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + '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' => 'GetApsManagedDatabases', - ], - 'CreateApsSlsADBJob' => [ - 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) job from Simple Log Service (SLS) to an AnalyticDB for MySQL Data Warehouse Edition cluster.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5DC10091-348D-12B1-906D-AB49D658012E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ModifySqlTemplatePosition', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySqlTemplatePosition'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:ModifySqlTemplatePosition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyUserEniVswitchOptions' => [ + 'summary' => 'Modifies the vSwitches that are connected to elastic network interfaces (ENIs).', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -38694,1191 +29920,970 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '207599', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads3N2V5J'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-*********', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'PartitionSpecs', + 'name' => 'VSwitchOptions', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['description' => 'The vSwitches that you want to use. The vSwitches must reside in the same virtual private cloud (VPC) and zone as ENIs. You can specify up to three vSwitches. Separate multiple vSwitches with commas (,).'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The vSwitches that you specify overwrite the existing vSwitches that are connected to ENIs.'."\n" + ."\n" + .'* You can call the [DescribeDBClusterAttribute](~~612399~~) operation to query the network information about ENIs in a cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******'."\n", 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The information about partition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about partition.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '-', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'required' => false, - 'example' => '-', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ModifyUserEniVswitchOptions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUserEniVswitchOptions'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Columns', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about columns.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about columns.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], - 'MapName' => [ - 'description' => 'The name of the mapping.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The data type of the column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', - ], - 'MapType' => [ - 'description' => 'The type of the mapping.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'int', - ], - ], - 'required' => false, - 'example' => '-', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyUserEniVswitchOptions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - 'required' => true, - 'example' => '-', ], ], + ], + '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"}]', + ], + 'PreloadSparkAppMetrics' => [ + 'summary' => 'Preloads metrics for a Spark application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PrimaryKeyDefinition', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The definition of the primary key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '169119', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], + ], + 'parameters' => [ [ - 'name' => 'WorkloadName', + 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workload.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sls-******', - ], + 'schema' => ['title' => '', 'description' => 'The Spark application ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202204221525hzca7d8140000003', 'maxLength' => 64], ], [ - 'name' => 'LakehouseId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The lakehouse ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'amv-bp1mfe9qmsw1dzyg', 'title' => ''], ], - [ - 'name' => 'ResourceGroup', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '84489769-3065-5A28-A4CB-977CD426F1C3'], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppId' => ['description' => 'The ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202212181815shaccb8be0000253', 'title' => ''], + 'AttemptId' => ['description' => 'The retry ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202301061000hz57d797b0000201-0001', 'title' => ''], + 'Finished' => ['description' => 'Indicates whether parsing is complete. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'EventLogPath' => ['description' => 'The event log path.'."\n", 'type' => 'string', 'example' => 'oss://path/to/eventLog', 'title' => ''], + 'ScanMetrics' => [ + 'description' => 'The metrics.'."\n", + 'type' => 'object', + 'properties' => [ + 'OutputRowsCount' => ['description' => 'The number of rows scanned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'TotalReadFileSizeInByte' => ['description' => 'The size of the scanned data. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'AdvancedConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The advanced configurations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.KillOperationFailed', 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', 'description' => 'Failed to kill the Spark application. Try again later.'], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ['errorCode' => 'Spark.TemplateFile.BadFileType', 'errorMessage' => 'The requested template %s is not a file.', 'description' => 'The specified template file ID is not of the file type.'], ], - [ - 'name' => 'HudiAdvancedConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The advanced configurations of Hudi.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], ], [ - 'name' => 'FullComputeUnit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of full AnalyticDB compute units (ACUs).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '16', - ], + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], ], - [ - 'name' => 'IncrementalComputeUnit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of increment ACUs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '168', - ], + 406 => [ + ['errorCode' => 'Spark.App.KillNotAcceptable', 'errorMessage' => 'Can\'t kill the application %s in %s state.', 'description' => 'A Spark application in a non-deletable state cannot be deleted.'], ], - [ - 'name' => 'Project', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], - [ - 'name' => 'Store', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The SLS Logstore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + ], + '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' => 'PreloadSparkAppMetrics', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-11-24T09:19:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-28T01:10:28.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreloadSparkAppMetrics'], ], + ], + 'ramActions' => [ [ - 'name' => 'StartingOffsets', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The start offset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:PreloadSparkAppMetrics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'SparkApplication', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], ], ], + ], + ], + 'QueryFormationInstsByTaskID' => [ + 'summary' => 'Queries the list of metadata discovery task instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MaxOffsetsPerTrigger', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The latest offset.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '138511', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], + ], + 'parameters' => [ [ - 'name' => 'DbName', + 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dbName', - ], + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~143074~~) to query available region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], [ - 'name' => 'OutputFormat', + 'name' => 'DBClusterId', 'in' => 'formData', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1r053byu48p****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The format of the output file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The returned task list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Deprecated. For more information, see Items.', + 'type' => 'object', + 'properties' => [ + 'LastTaskInstID' => ['description' => 'The instance ID of the most recent task.', 'type' => 'string', 'example' => '1223', 'title' => ''], + 'Schema' => ['description' => 'The schema ID assigned to the instance by the system.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2023-05-15T07:24:58Z', 'title' => ''], + 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'doc_test_daily', 'title' => ''], + 'SourceType' => ['description' => 'The task source. Valid values:'."\n" + .'- **system**: system.'."\n" + .'- **custom**: custom.', 'type' => 'string', 'example' => 'shareScreen', 'title' => ''], + 'LastTaskInstState' => ['description' => 'The instance status of the most recent node.', 'type' => 'string', 'example' => 'FINISH', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'Update\\"\'', 'title' => ''], + 'SyncTime' => ['description' => 'The synchronization time, accurate to milliseconds. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2026-01-20t10:01:01z', 'title' => ''], + 'LastTaskInstMessage' => ['description' => 'The error message of the most recent task.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'LastTaskInstCostTime' => ['description' => 'The execution duration of the most recent task.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ScheduleState' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message. OK is returned if the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The total number of pages.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Items' => [ + 'description' => 'The task list.', + 'type' => 'array', + 'items' => ['description' => 'The task list.', 'type' => 'object', 'example' => '{'."\n" + .' "gmtModified":"2026-07-08T12:00:43.000+00:00",'."\n" + .' "gmtCreated":"2026-07-08T12:00:33.000+00:00",'."\n" + .' "type":"CRAWLER",'."\n" + .' "message":"{\\"summary\\":\\"Table created:1; Table updated:0; add partition num:0; invalid dir num:0; source list warned:0; can not infer file:0; generate ddl failed:0; syncMeta failed:0.\\",\\"reportDetail\\":[]}",'."\n" + .' "content":"{\\"scheduleState\\":\\"STOP\\",\\"stat\\":{\\"actualStartTime\\":\\"2026-07-08 20:00:40\\",\\"stage\\":\\"SUCCESS\\",\\"isKilled\\":false,\\"timeCost\\":2},\\"configuration\\":{\\"adb.crawler.csv.columns.specify.delimiter.char\\":\\"auto\\",\\"adb.crawler.csv.columns.specify.quote.char\\":\\"auto\\"},\\"gmtCreated\\":1783501525000,\\"dbName\\":\\"sales_db\\",\\"schemaChangePolicy\\":{\\"deleteRule\\":\\"IGNORE\\",\\"updateRule\\":\\"ONLY_ADD_COLUMN\\"},\\"frequency\\":{\\"cron\\":\\"\\",\\"type\\":\\"run_on_demand\\"},\\"uid\\":\\"***\\",\\"sourceInfo\\":{\\"ossSourceInfo\\":{\\"sourceMode\\":\\"WAREHOUSE\\",\\"ossLocations\\":[\\"oss://crawler-test/***/***/\\"],\\"exclusions\\":[],\\"inclusions\\":[]}},\\"failedCount\\":0,\\"dbClusterId\\":\\"amv-bp***\\",\\"sourceType\\":\\"OSSWAREHOUSE\\",\\"classifiers\\":[\\"csv\\"],\\"taskName\\":\\"[\\\\\\"oss://crawler-test/***/***/\\\\\\"] -> sales_db\\",\\"id\\":36}",'."\n" + .' "parentId":-1,'."\n" + .' "retryTimes":0,'."\n" + .' "uid":"***",'."\n" + .' "dbClusterId":"amv-bp***",'."\n" + .' "sourceType":"OSSWAREHOUSE",'."\n" + .' "name":"[\\"oss://crawler-test/***/***/\\"] -> sales_db",'."\n" + .' "timeCostInSeconds":2,'."\n" + .' "startTime":"2026-07-08T12:00:33.000+00:00",'."\n" + .' "id":46872,'."\n" + .' "state":"SUCCESS",'."\n" + .' "operatorUid":"***",'."\n" + .' "taskId":36'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Query metadata discovery task instances', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"LastTaskInstID\\": \\"1223\\",\\n \\"Schema\\": \\"default\\",\\n \\"CreateTime\\": \\"2023-05-15T07:24:58Z\\",\\n \\"TaskName\\": \\"doc_test_daily\\",\\n \\"SourceType\\": \\"shareScreen\\",\\n \\"LastTaskInstState\\": \\"FINISH\\",\\n \\"TaskType\\": \\"Update\\\\\\\\\\\\\\"\'\\",\\n \\"SyncTime\\": \\"2026-01-20t10:01:01z\\",\\n \\"LastTaskInstMessage\\": \\"error\\",\\n \\"LastTaskInstCostTime\\": \\"8\\",\\n \\"TaskId\\": \\"10\\",\\n \\"ScheduleState\\": \\"NORMAL\\"\\n }\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"gmtModified\\": \\"2026-07-08T12:00:43.000+00:00\\",\\n \\"gmtCreated\\": \\"2026-07-08T12:00:33.000+00:00\\",\\n \\"type\\": \\"CRAWLER\\",\\n \\"message\\": \\"{\\\\\\"summary\\\\\\":\\\\\\"Table created:1; Table updated:0; add partition num:0; invalid dir num:0; source list warned:0; can not infer file:0; generate ddl failed:0; syncMeta failed:0.\\\\\\",\\\\\\"reportDetail\\\\\\":[]}\\",\\n \\"content\\": \\"{\\\\\\"scheduleState\\\\\\":\\\\\\"STOP\\\\\\",\\\\\\"stat\\\\\\":{\\\\\\"actualStartTime\\\\\\":\\\\\\"2026-07-08 20:00:40\\\\\\",\\\\\\"stage\\\\\\":\\\\\\"SUCCESS\\\\\\",\\\\\\"isKilled\\\\\\":false,\\\\\\"timeCost\\\\\\":2},\\\\\\"configuration\\\\\\":{\\\\\\"adb.crawler.csv.columns.specify.delimiter.char\\\\\\":\\\\\\"auto\\\\\\",\\\\\\"adb.crawler.csv.columns.specify.quote.char\\\\\\":\\\\\\"auto\\\\\\"},\\\\\\"gmtCreated\\\\\\":1783501525000,\\\\\\"dbName\\\\\\":\\\\\\"sales_db\\\\\\",\\\\\\"schemaChangePolicy\\\\\\":{\\\\\\"deleteRule\\\\\\":\\\\\\"IGNORE\\\\\\",\\\\\\"updateRule\\\\\\":\\\\\\"ONLY_ADD_COLUMN\\\\\\"},\\\\\\"frequency\\\\\\":{\\\\\\"cron\\\\\\":\\\\\\"\\\\\\",\\\\\\"type\\\\\\":\\\\\\"run_on_demand\\\\\\"},\\\\\\"uid\\\\\\":\\\\\\"***\\\\\\",\\\\\\"sourceInfo\\\\\\":{\\\\\\"ossSourceInfo\\\\\\":{\\\\\\"sourceMode\\\\\\":\\\\\\"WAREHOUSE\\\\\\",\\\\\\"ossLocations\\\\\\":[\\\\\\"oss://crawler-test/***/***/\\\\\\"],\\\\\\"exclusions\\\\\\":[],\\\\\\"inclusions\\\\\\":[]}},\\\\\\"failedCount\\\\\\":0,\\\\\\"dbClusterId\\\\\\":\\\\\\"amv-bp***\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"OSSWAREHOUSE\\\\\\",\\\\\\"classifiers\\\\\\":[\\\\\\"csv\\\\\\"],\\\\\\"taskName\\\\\\":\\\\\\"[\\\\\\\\\\\\\\"oss://crawler-test/***/***/\\\\\\\\\\\\\\"] -> sales_db\\\\\\",\\\\\\"id\\\\\\":36}\\",\\n \\"parentId\\": -1,\\n \\"retryTimes\\": 0,\\n \\"uid\\": \\"***\\",\\n \\"dbClusterId\\": \\"amv-bp***\\",\\n \\"sourceType\\": \\"OSSWAREHOUSE\\",\\n \\"name\\": \\"[\\\\\\"oss://crawler-test/***/***/\\\\\\"] -> sales_db\\",\\n \\"timeCostInSeconds\\": 2,\\n \\"startTime\\": \\"2026-07-08T12:00:33.000+00:00\\",\\n \\"id\\": 46872,\\n \\"state\\": \\"SUCCESS\\",\\n \\"operatorUid\\": \\"***\\",\\n \\"taskId\\": 36\\n }\\n ]\\n}","type":"json"}]', + ], + 'QueryFormationTaskByID' => [ + 'summary' => 'Queries a metadata discovery task by ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TargetType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The destination type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ADB', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '138855', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD'], + ], + 'parameters' => [ [ - 'name' => 'TargetGenerateRule', + 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The rules for generating the destination database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AcrossUid', + 'name' => 'TaskType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The cross-account UID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => true, 'example' => '["CRAWLER"]', 'title' => ''], ], [ - 'name' => 'AcrossRole', + 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the cross-account role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-role', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '36', 'title' => ''], ], [ - 'name' => 'SourceRegionId', + 'name' => 'DBClusterId', 'in' => 'formData', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1ub9grke1****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID of the source cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The task details.', 'type' => 'string', 'example' => '{'."\n" + .' "id": 123,'."\n" + .' "taskName": "sale_db",'."\n" + .' "scheduleState": "NORMAL",'."\n" + .' "frequency": {"type": "custom", "cron": "0 0/1 * * * ?"},'."\n" + .' "failedCount": 0,'."\n" + .' "lastTaskInstContent": "{\\"task_inst_id\\":67890,\\"state\\":\\"SUCCESS\\"}"'."\n" + .' }', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5DC10091-348D-12B1-906D-AB49D658012E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + .'- true: The request was successful.'."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Query a metadata discovery task by ID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{\\\\n \\\\\\"id\\\\\\": 123,\\\\n \\\\\\"taskName\\\\\\": \\\\\\"sale_db\\\\\\",\\\\n \\\\\\"scheduleState\\\\\\": \\\\\\"NORMAL\\\\\\",\\\\n \\\\\\"frequency\\\\\\": {\\\\\\"type\\\\\\": \\\\\\"custom\\\\\\", \\\\\\"cron\\\\\\": \\\\\\"0 0/1 * * * ?\\\\\\"},\\\\n \\\\\\"failedCount\\\\\\": 0,\\\\n \\\\\\"lastTaskInstContent\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"task_inst_id\\\\\\\\\\\\\\":67890,\\\\\\\\\\\\\\"state\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SUCCESS\\\\\\\\\\\\\\"}\\\\\\"\\\\n }\\",\\n \\"RequestId\\": \\"5DC10091-348D-12B1-906D-AB49D658012E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'QueryFormationTasksByType' => [ + 'summary' => 'Queries metadata discovery tasks by task type.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OssLocation', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Object Storage Service (OSS) URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://test*', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '138509', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], + ], + 'parameters' => [ [ - 'name' => 'DatasourceId', + 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '327', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the supported regions and zones, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DirtyDataProcessPattern', + 'name' => 'TaskType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The dirty data processing mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'STOP', - ], + 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => true, 'example' => '["CRAWLER"]', 'title' => ''], ], [ - 'name' => 'ExactlyOnce', + 'name' => 'DBClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the consistency check.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The cluster ID.'."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the details of all AnalyticDB for MySQL clusters in a region, including cluster IDs.', 'type' => 'string', 'required' => true, 'example' => 'am-uf6g8w25jacm7****', 'title' => ''], ], - [ - 'name' => 'UnixTimestampConvert', - 'in' => 'formData', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The timestamp conversion.'."\n", 'type' => 'object', 'properties' => [ - 'Convert' => [ - 'description' => 'Specifies whether to enable the conversion of timestamps.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - 'Format' => [ - 'description' => 'The format of the timestamp.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'yyyyMMdd', - ], - 'Transform' => [ - 'description' => 'Specifies whether to enable the timestamp conversion.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The task list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'LastTaskInstID' => ['description' => 'The instance ID of the most recent task.', 'type' => 'string', 'example' => '46872', 'title' => ''], + 'Schema' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'sales_db', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-07-08 17:05:25', 'title' => ''], + 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => '[\\"oss://test-bucket/**/**/\\"] -> sales_db', 'title' => ''], + 'SourceType' => ['description' => 'The source type.', 'type' => 'string', 'example' => 'OSSWAREHOUSE', 'title' => ''], + 'LastTaskInstState' => ['description' => 'The instance status of the most recent node.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'CRAWLER', 'title' => ''], + 'SyncTime' => ['description' => 'The scheduling frequency.', 'type' => 'string', 'example' => '{\\"cron\\":\\"\\",\\"type\\":\\"run_on_demand\\"}', 'title' => ''], + 'LastTaskInstMessage' => ['description' => 'The error message of the most recent task.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'LastTaskInstCostTime' => ['description' => 'The execution duration of the most recent task.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ScheduleState' => ['description' => 'The scheduling status.', 'type' => 'string', 'example' => 'STOP', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message. OK is returned if the call was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], - 'required' => false, - 'example' => '-', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Query metadata discovery tasks by task type', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"LastTaskInstID\\": \\"46872\\",\\n \\"Schema\\": \\"sales_db\\",\\n \\"CreateTime\\": \\"2026-07-08 17:05:25\\",\\n \\"TaskName\\": \\"[\\\\\\\\\\\\\\"oss://test-bucket/**/**/\\\\\\\\\\\\\\"] -> sales_db\\",\\n \\"SourceType\\": \\"OSSWAREHOUSE\\",\\n \\"LastTaskInstState\\": \\"SUCCESS\\",\\n \\"TaskType\\": \\"CRAWLER\\",\\n \\"SyncTime\\": \\"{\\\\\\\\\\\\\\"cron\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"run_on_demand\\\\\\\\\\\\\\"}\\",\\n \\"LastTaskInstMessage\\": \\"xxx\\",\\n \\"LastTaskInstCostTime\\": \\"2\\",\\n \\"TaskId\\": \\"10\\",\\n \\"ScheduleState\\": \\"STOP\\"\\n }\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'ReleaseClusterPublicConnection' => [ + 'summary' => 'Releases the public endpoint of a specified cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'UserName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user_test', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131192', + 'abilityTreeNodes' => ['FEATUREads4DZDZG'], + ], + 'parameters' => [ [ - 'name' => 'Password', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The password of the database account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_user', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of the Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'DirtyDataHandleMode', - 'in' => 'formData', + 'name' => 'Engine', + 'in' => 'query', 'schema' => [ - 'description' => 'The dirty data processing mode.'."\n", + 'description' => 'The database engine. Valid values:'."\n" + ."\n" + .'- **AnalyticDB** (Default): AnalyticDB for MySQL.'."\n" + ."\n" + .'- **ClickHouse**: a wide table engine.', + 'enumValueTitles' => ['AnalyticDB' => 'AnalyticDB', 'Clickhouse' => 'ClickHouse'], 'type' => 'string', - 'required' => true, - 'example' => '-', + 'required' => false, + 'example' => 'Clickhouse', + 'title' => '', ], ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the dry run succeeds. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.'."\n" - .'* If the request failed, an error message is returned.', - 'type' => 'string', - 'example' => 'Success', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD5', 'title' => ''], ], - 'description' => 'The response parameters.', + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ], ], - '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' => 'CreateApsSlsADBJob', - ], - 'ListApsOptimizationTasks' => [ - 'summary' => 'Queries a list of optimization jobs executed based on a lifecycle management policy. The system runs optimization jobs on a regular basis based on lifecycle management policies.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ReleaseClusterPublicConnection', + 'description' => 'For the endpoints of this service, see [Endpoints](~~612373~~).', + 'changeSet' => [ + ['createdAt' => '2024-06-13T13:53:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-11T16:51:57.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseClusterPublicConnection'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:ReleaseClusterPublicConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD5\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'RenameSemanticView' => [ + 'summary' => 'Modifies the name of a semantic view.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '200821', - 'abilityTreeNodes' => [ - 'FEATUREadsNQ1ZDK', - ], + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsTYGUV3'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-*******', - ], - ], - [ - 'name' => 'StrategyType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the lifecycle management policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'StrategyValue', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL cluster.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1u8c0mgfg58****'], ], [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-23T02:18Z', - ], + 'name' => 'NewSchemaName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The new schema name in which the semantic view resides.', 'type' => 'string', 'required' => true, 'example' => 'adb_sv'], ], [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-09-30T00:15Z', - ], + 'name' => 'NewViewName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The new name of the semantic view.', 'type' => 'string', 'required' => true, 'example' => 'new_sv_name'], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'OldSchemaName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The original schema name in which the semantic view resides.', 'type' => 'string', 'required' => true, 'example' => 'adb_sv_old'], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'name' => 'OldViewName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The original name of the semantic view.', 'type' => 'string', 'required' => true, 'example' => 'old_sv_name'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PageResult', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Items' => [ - 'description' => 'The queried optimization jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried optimization job.', - 'type' => 'object', - 'properties' => [ - 'ComputeUnit' => [ - 'description' => 'The computing resources used by the optimization job.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'CreatedTime' => [ - 'description' => 'The time when the optimization job was created.'."\n", - 'type' => 'string', - 'example' => '2022-01-23T02:18Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the optimization job was modified.'."\n", - 'type' => 'string', - 'example' => '2022-09-30T00:15Z', - ], - 'TaskDesc' => [ - 'description' => 'The description of the optimization job.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'TaskDuration' => [ - 'description' => 'The execution duration of the optimization job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'TaskId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'sj-hz******', - ], - 'TaskMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'TaskStatus' => [ - 'description' => 'The execution status. Valid values:'."\n" - ."\n" - .'1. NEW'."\n" - .'2. RUNNING'."\n" - .'3. SUCCESS'."\n" - .'4. STOPPED'."\n" - .'5. FAILED'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'StrategyType' => [ - 'description' => 'The type of the lifecycle management policy.'."\n", - 'type' => 'string', - 'example' => 'StrategyValue', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-*******', - ], - ], - 'example' => '-', - ], - 'example' => '-', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], ], + 'example' => '', ], ], ], - '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' => 'ListApsOptimizationTasks', - ], - 'ListApsOptimizationStrategy' => [ - 'summary' => 'Queries a list of lake storage optimization policies for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.CatalogAlreadyExist', 'errorMessage' => 'The catalog already exists.', 'description' => 'Catalog already exists'], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ['errorCode' => 'MDS.SemanticViewAlreadyExist', 'errorMessage' => 'The semantic view already exists.', 'description' => 'Semantic view already exists'], + ['errorCode' => 'MDS.SemanticViewNotExist', 'errorMessage' => 'This semantic view does not exist.', 'description' => 'This semantic view does not exist'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + [ + ['errorCode' => 'MDS.InstanceNotExist', 'errorMessage' => 'ADB instance does not exist.', 'description' => 'ADB instance does not exist'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modifies the name of a semantic view.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ReplaceSemanticView' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '200834', - 'abilityTreeNodes' => [ - 'FEATUREadsNQ1ZDK', - ], + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsTYGUV3'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL cluster.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1u8c0mgfg58****', 'title' => ''], ], [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-*******', - ], + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the schema.', 'type' => 'string', 'required' => true, 'example' => 'adb_demo', 'title' => ''], ], - ], - 'responses' => [ + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the semantic view.', 'type' => 'string', 'required' => true, 'example' => 'sales_sv', 'title' => ''], + ], + [ + 'name' => 'Definition', + 'in' => 'query', + 'schema' => ['description' => 'The definition of the semantic view.', 'type' => 'string', 'required' => true, 'example' => 'YAML 内容', 'title' => ''], + ], + ], + 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultData', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried polices.'."\n", - 'type' => 'object', - 'properties' => [ - 'StrategyDesc' => [ - 'description' => 'The description of the lifecycle management policy.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'StrategyName' => [ - 'description' => 'The name of the lifecycle management policy.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'StrategyType' => [ - 'description' => 'The type of the lifecycle management policy. Only StrategyValue is returned.'."\n", - 'type' => 'string', - 'example' => 'StrategyValue', - ], - 'Status' => [ - 'description' => 'The status of the lifecycle management policy. Valid values:'."\n" - ."\n" - .'1. on: enabled.'."\n" - .'2. off: disabled.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-23xxxx', - ], - ], - 'example' => '-', - ], - 'example' => '-', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], ], + 'title' => '', + 'description' => 'The response object.', + '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' => 'ListApsOptimizationStrategy', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeAPSADBInstances' => [ - 'summary' => 'Queries a list of AnalyticDB for MySQL clusters for AnalyticDB Pipeline Service (APS) federated analytics.', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MDS.CatalogAlreadyExist', 'errorMessage' => 'The catalog already exists.', 'description' => 'Catalog already exists'], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ['errorCode' => 'MDS.SemanticViewNotExist', 'errorMessage' => 'This semantic view does not exist.', 'description' => 'This semantic view does not exist'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + [ + ['errorCode' => 'MDS.InstanceNotExist', 'errorMessage' => 'ADB instance does not exist.', 'description' => 'ADB instance does not exist'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ReplaceSemanticView', + 'summary' => 'Updates the definition of a semantic view.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ResetAccountPassword' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '204210', - 'abilityTreeNodes' => [ - 'FEATUREadsH8FO36', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130691', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '30', - ], + 'schema' => ['description' => 'The name of the database account.'."\n" + ."\n" + .'> You can call the [DescribeAccounts](~~612430~~) operation to query the information about database accounts of an AnalyticDB for MySQL cluster, including database account names.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_accout', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the database account.'."\n" + ."\n" + .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n" + .'* The password must be 8 to 32 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Test_accout1', 'title' => ''], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the database account.'."\n" + ."\n" + .'* The description cannot start with `http://` or `https://`.'."\n" + .'* The description must be 2 to 256 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AccDesc', 'title' => ''], + ], + [ + 'name' => 'Engine', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID.'."\n", + 'description' => 'The database engine of the cluster. Valid values:'."\n" + ."\n" + .'* **AnalyticDB** (default): the AnalyticDB for MySQL engine.'."\n" + .'* **Clickhouse**: the wide table engine.'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Clickhouse', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'Items' => [ - 'description' => 'The queried clusters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried cluster.', - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", - 'type' => 'string', - 'example' => 'am-bp1********', - ], - 'DBClusterDescription' => [ - 'description' => 'The description of the cluster.'."\n", - 'type' => 'string', - 'example' => 'adb_test', - ], - 'ZoneId' => [ - 'description' => 'The zone ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'ComputeResource' => [ - 'description' => 'The specifications of the reserved computing resources.'."\n", - 'type' => 'string', - 'example' => '16ACU', - ], - 'StorageResource' => [ - 'description' => 'The specifications of the reserved storage resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24ACU', - ], - 'ReservedACU' => [ - 'description' => 'The amount of remaining reserved computing resources that are available in the cluster.'."\n", - 'type' => 'string', - 'example' => '24ACU', - ], - 'DBClusterStatus' => [ - 'description' => 'The status of the cluster.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - ], - ], - 'example' => '-', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInput', - 'errorMessage' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => 'The AccountPassword parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['errorCode' => 'ACS.Sql.CannotConnect', 'errorMessage' => 'Cannot connect instance which type is %s.', 'description' => 'Cannot connect to a child instance of the given type.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'ResetAccountPassword', + 'summary' => 'Resets the password of a database account for an AnalyticDB for MySQL cluster.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2024-06-13T13:53:52.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2023-03-31T07:03:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:52:03.000Z', 'description' => 'OpenAPI offline'], ], - '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' => 'DescribeAPSADBInstances', - 'description' => 'You can call this operation to query the performance data of a cluster over a time range based on performance metrics. The collection granularity is 30 seconds. This operation allows you to query information about slow queries, such as the SQL query duration, number of scanned rows, and amount of scanned data.'."\n", - ], - 'ModifyApsSlsADBJob' => [ - 'summary' => 'Modifies an AnalyticDB Pipeline Service (APS) job from Simple Log Service (SLS) to an AnalyticDB for MySQL Data Warehouse Edition cluster.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ResetAccountPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', + ], + 'RevokeOperatorPermission' => [ + 'summary' => 'Revokes permissions from the service account of an AnalyticDB for MySQL cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '209632', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - ], + 'abilityTreeCode' => '214578', + 'abilityTreeNodes' => ['FEATUREadsF4WPVU'], ], 'parameters' => [ - [ - 'name' => 'WorkloadId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'aps-******', - ], - ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-*******', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amv-bp1mfe9qmsw1dzyg', 'title' => ''], ], - [ - 'name' => 'StartingOffsets', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The start offset.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'end_cursor', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'RelatedTaskNotFinish', 'errorMessage' => 'The related task does not finish.', 'description' => 'The related task has not finished.'], + ], + ], + 'title' => 'RevokeOperatorPermission', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeOperatorPermission'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Columns', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about columns.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about columns.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_name', - ], - 'MapName' => [ - 'description' => 'The name of the mapping.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'map_name', - ], - 'Type' => [ - 'description' => 'The data type of the column.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', - ], - 'MapType' => [ - 'description' => 'The type of the mapping.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', - ], - ], - 'required' => false, - 'example' => '-', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:RevokeOperatorPermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], - 'required' => false, - 'example' => '-', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + ], + 'RunMaterializedViewRecommend' => [ + 'summary' => 'Runs an automated recommendation task for Materialized Views.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'WorkloadName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workload.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-name', - ], - ], - [ - 'name' => 'DbName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dbName', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'DirtyDataProcessPattern', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The dirty data processing mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'STOP', - ], - ], - [ - 'name' => 'ExactlyOnce', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the consistency check.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsTYGUV3'], + ], + 'parameters' => [ [ - 'name' => 'UnixTimestampConvert', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The timestamp conversion.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The Region ID of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'UserName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user-name', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of an Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + .'The ID of a Data Lakehouse Edition cluster.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1u8c0mgfg58****', 'title' => ''], ], [ - 'name' => 'Password', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The password of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_123', - ], + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the recommendation task. To run tasks in a batch, separate their names with a comma.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'task1'], ], ], 'responses' => [ @@ -39886,64 +30891,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'example' => '-', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1AD222E9-E606-4A42-BF6D-8A444291****'], ], - 'description' => 'The response parameters.', + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - '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' => 'ModifyApsSlsADBJob', - ], - 'DescribeApsMigrationWorkloads' => [ - 'summary' => 'Queries the workloads of AnalyticDB Pipeline Service (APS) migration jobs.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RunMaterializedViewRecommend', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunMaterializedViewRecommend'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:RunMaterializedViewRecommend', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A444291****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'SearchSemanticViews' => [ + 'summary' => 'Searches for semantic views.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -39953,412 +30937,198 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads8FGISX'], ], 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '30', - ], - ], [ 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-*******', - ], - ], - [ - 'name' => 'WorkloadName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workload.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'OssLocation', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Object Storage Service (OSS) URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://******', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL cluster.', 'type' => 'string', 'required' => true, 'example' => 'am-bp*****', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The start of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-06-20T16:00:00Z', - ], + 'name' => 'QueryText', + 'in' => 'query', + 'schema' => ['description' => 'The search query.', 'type' => 'string', 'required' => false, 'example' => '销售额', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-07-20T16:00:00Z', - ], + 'name' => 'TopK', + 'in' => 'query', + 'schema' => ['description' => 'The number of the most relevant semantic views to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'default' => '3', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-57F0-9F06-******', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MigrationWorkloads' => [ - 'description' => 'The queried migration workloads.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Data' => [ 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ModifyTime' => [ - 'description' => 'The time when the migration job was modified.'."\n", - 'type' => 'string', - 'example' => '2021-06-21T02:15:16Z', - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2021-06-21T02:15:16Z', - ], - 'Id' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'State' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => 'COMPLETED', - ], - 'OssLocation' => [ - 'description' => 'The OSS URL.'."\n", - 'type' => 'string', - 'example' => 'oss://******', - ], - 'TargetType' => [ - 'description' => 'The destination type.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'WorkloadSubType' => [ - 'description' => 'The sub-type of the workload.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Name' => [ - 'description' => 'The name of the workload.'."\n", - 'type' => 'string', - 'example' => 'TEST-001', - ], - 'AcuCount' => [ - 'description' => 'The number of AnalyticDB compute units (ACUs).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-', - ], - 'MaxRT' => [ - 'description' => 'The maximum response time.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'FailedMsg' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => '-', - ], - ], - 'description' => 'The queried migration workloads.', - ], + 'items' => ['description' => 'A semantic view object.', 'example' => '-', '$ref' => '#/components/schemas/SemanticViewModel', 'title' => ''], + 'title' => '', + 'description' => 'A list of semantic view objects.', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInput', - 'errorMessage' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'MDS.CatalogAlreadyExist', 'errorMessage' => 'The catalog already exists.', 'description' => 'Catalog already exists'], + ['errorCode' => 'MDS.IllegalArgument', 'errorMessage' => 'Invalid argument.', 'description' => 'An invalid parameter is used.'], + ['errorCode' => 'MDS.InvalidPrivilege', 'errorMessage' => 'No permissions.', 'description' => 'You are not authorized to perform this operation.'], + ['errorCode' => 'MDS.MetaSchemaAlreadyExist', 'errorMessage' => 'The database already exists.', 'description' => 'The specified database already exists.'], + ['errorCode' => 'MDS.MetaSchemaNotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The specified database does not exist.'], + ['errorCode' => 'MDS.MetaTableAlreadyExist', 'errorMessage' => 'The table already exists.', 'description' => 'The specified table already exists.'], + ['errorCode' => 'MDS.MetaTableNotExist', 'errorMessage' => 'The table is not found.', 'description' => 'The specified table does not exist.'], + ['errorCode' => 'MDS.SemanticViewAlreadyExist', 'errorMessage' => 'The semantic view already exists.', 'description' => 'Semantic view already exists'], + ['errorCode' => 'MDS.SemanticViewNotExist', 'errorMessage' => 'This semantic view does not exist.', 'description' => 'This semantic view does not exist'], + ], + 403 => [ + ['errorCode' => 'MDS.RamAuthAccessDenied', 'errorMessage' => 'ram auth access denied.', 'description' => 'RAM authentication failed'], + ], + [ + ['errorCode' => 'MDS.InstanceNotExist', 'errorMessage' => 'ADB instance does not exist.', 'description' => 'ADB instance does not exist'], + ], + 500 => [ + ['errorCode' => 'MDS.InternalError', 'errorMessage' => 'An internal MDS error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'MDS.MetaVisitError', 'errorMessage' => 'Failed to access metadata.', 'description' => 'Failed to access the metadata.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'SearchSemanticViews', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'DescribeApsMigrationWorkloads', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": [\\n {\\n \\"ViewSchema\\": \\"sales_db\\",\\n \\"Definition\\": \\"name: revenue_analysis\\\\ndescription: \\\\\\"Semantic view for analyzing revenue across products and customers\\\\\\"\\\\n\\\\ntables:\\\\n - name: customers\\\\n description: \\\\\\"Customer information\\\\\\"\\\\n base_table:\\\\n schema: sales_db\\\\n table: customers\\\\n dimensions:\\\\n - name: customer_name\\\\n synonyms: [\\\\\\"client name\\\\\\", \\\\\\"customer\\\\\\"]\\\\n description: \\\\\\"Full name of the customer\\\\\\"\\\\n expr: c_name\\\\n data_type: VARCHAR\\\\n - name: customer_segment\\\\n synonyms: [\\\\\\"segment\\\\\\", \\\\\\"market segment\\\\\\"]\\\\n description: \\\\\\"Customer market segment\\\\\\"\\\\n expr: c_mktsegment\\\\n data_type: VARCHAR\\\\n is_enum: true\\\\n\\\\n - name: orders\\\\n description: \\\\\\"Order information\\\\\\"\\\\n base_table:\\\\n schema: sales_db\\\\n table: orders\\\\n dimensions:\\\\n - name: order_date\\\\n description: \\\\\\"Date when order was placed\\\\\\"\\\\n expr: o_orderdate\\\\n data_type: DATE\\\\n - name: order_year\\\\n description: \\\\\\"Year when order was placed\\\\\\"\\\\n expr: YEAR(o_orderdate)\\\\n data_type: NUMBER\\\\n facts:\\\\n - name: order_total\\\\n description: \\\\\\"Total order amount\\\\\\"\\\\n expr: o_totalprice\\\\n data_type: NUMBER\\\\n metrics:\\\\n - name: total_orders\\\\n description: \\\\\\"Total number of orders\\\\\\"\\\\n expr: COUNT(*)\\\\n - name: total_revenue\\\\n description: \\\\\\"Total revenue of orders\\\\\\"\\\\n expr: SUM(o_totalprice)\\\\n - name: average_order_value\\\\n description: \\\\\\"Average order value\\\\\\"\\\\n expr: AVG(o_totalprice)\\\\n\\\\nrelationships:\\\\n - name: orders_to_customers\\\\n left_table: orders\\\\n right_table: customers\\\\n relationship_columns:\\\\n - left_column: o_custkey\\\\n right_column: c_custkey\\\\n\\\\nmetrics:\\\\n - name: revenue_per_customer\\\\n description: \\\\\\"Average revenue per customer\\\\\\"\\\\n expr: orders.total_revenue / customers.customer_count\\\\n\\",\\n \\"ViewName\\": \\"revenue_analysis\\",\\n \\"Comment\\": \\"这是一个定义销售额相关指标的视图\\",\\n \\"Score\\": 0.81\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'DescribeApsHiveWorkload' => [ - 'summary' => 'Queries the information about an AnalyticDB Pipeline Service (APS) job from a Hive data source.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SetSparkAppLogRootPath' => [ + 'summary' => 'Modifies the Spark log configuration.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '170284', - 'abilityTreeNodes' => [ - 'FEATUREadsBIVU9O', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '156583', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-*******', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp169ea59k****', 'maxLength' => 64], ], [ - 'name' => 'WorkloadId', + 'name' => 'OssLogPath', 'in' => 'formData', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-******', - ], + 'schema' => ['description' => 'The path of Object Storage Service (OSS) logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://testBucketname/to/log', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'UseDefaultOss', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Specifies whether to use the default OSS log path.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '86F92D26-B774-5FA1-8E53-******', - ], - 'ApsWorkload' => [ - 'description' => 'The queried job.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380'], + 'Data' => [ + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-*******', - ], - 'WorkloadId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'aps-******', - ], - 'WorkloadName' => [ - 'description' => 'The name of the workload.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceGroup' => [ - 'description' => 'The resource group to which the SQL statement belongs.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'FullComputeUnit' => [ - 'description' => 'The number of AnalyticDB compute units (ACUs) required for migration.'."\n", - 'type' => 'string', - 'example' => '16', - ], - 'SyncAllowExpression' => [ - 'description' => 'The expression that manually matches the source database table whitelist.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'SyncDenyExpression' => [ - 'description' => 'Manually match the blacklist expressions for source database tables.'."\n", - 'type' => 'string', - 'example' => 'def', - ], - 'TargetType' => [ - 'description' => 'The destination type.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'OssLocation' => [ - 'description' => 'The Object Storage Service (OSS) URL of the AnalyticDB for MySQL cluster data.'."\n", - 'type' => 'string', - 'example' => 'oss://******', - ], - 'ConflictStrategy' => [ - 'description' => 'The policy to handle tables with the same name in the destination cluster.'."\n", - 'type' => 'string', - 'example' => 'Intercept', - ], - 'AdvancedConfig' => [ - 'description' => 'The advanced configurations.'."\n", - 'type' => 'string', - 'example' => 'test.adv.config=value', - ], - 'DatasourceId' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'DatasourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'sls-******', - ], - 'Parallelism' => [ - 'description' => 'The number of tasks that are allowed in parallel.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'WorkloadTypeName' => [ - 'description' => 'The name of the workload.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'State' => [ - 'description' => 'The status of the workload.'."\n", - 'type' => 'string', - 'example' => 'COMPLETED', - ], - 'CreateTime' => [ - 'description' => 'The time when the workload was created.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'MetaStoreUri' => [ - 'description' => 'The URL of the Hive Metastore.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'Vswitch' => [ - 'description' => 'The name of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-******', - ], - 'EmrClusterId' => [ - 'description' => 'The ID of the E-MapReduce (EMR) cluster.'."\n", - 'type' => 'string', - 'example' => '-', - ], + 'IsLogPathExists' => ['title' => '', 'description' => 'Indicates whether a log path exists.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RecordedLogPath' => ['title' => '', 'description' => 'The recorded log path.'."\n", 'type' => 'string', 'example' => 'oss://testBucketname/to/log'], + 'ModifiedUid' => ['title' => '', 'description' => 'The modifier ID.'."\n", 'type' => 'string', 'example' => '11111111'], + 'ModifiedTimestamp' => ['title' => '', 'description' => 'The last modification time.'."\n", 'type' => 'string', 'example' => '1675236908'], + 'DefaultLogPath' => ['title' => '', 'description' => 'The default log path.'."\n", 'type' => 'string', 'example' => 'oss://testBucketname/to/log'], ], - 'example' => '-', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInput', - 'errorMessage' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%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.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s.', 'description' => 'The operand is in non-legal state %s.'], + ], + 404 => [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'SetSparkAppLogRootPath', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-09-04T08:10:53.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-06-28T01:10:27.000Z', 'description' => 'Error codes changed'], ], - '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' => 'DescribeApsHiveWorkload', - ], - 'CreateApsCopyWorkload' => [ - 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) replication job.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetSparkAppLogRootPath'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:SetSparkAppLogRootPath', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'StartApsJob' => [ + 'summary' => 'Starts an AnalyticDB Pipeline Service (APS) job.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -40368,83 +31138,109 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '186455', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsY28JLD', - ], + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '185195', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsY28JLD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'ApsJobId', 'in' => 'formData', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-******', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-bp1xxxxxxxx47', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ApsJobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'aps-******', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-******-9F06-******', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'ErrCode' => ['description' => 'The error code returned when the request fails.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message returned if the request failed.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, a success message is returned.****'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'StartApsJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartApsJob'], + ], + ], + 'ramActions' => [ [ - 'name' => 'WorkloadType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SLS_INGESTION_ADB', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:StartApsJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + ], + 'StartFormationCrawler' => [ + 'summary' => 'Manually triggers a metadata discovery task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DatasourceId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '137130', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], + ], + 'parameters' => [ + [ + 'name' => 'CrawlerTaskId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '247', 'title' => ''], ], [ - 'name' => 'DbName', + 'name' => 'CrawlerTaskName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dbName', - ], + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'test-crawler-dbname', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'DBClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'am-bp1pke2pcfavw****', 'title' => ''], ], [ - 'name' => 'WorkloadId', + 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-******', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query available region IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -40452,64 +31248,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'example' => '-', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '69', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1564657730', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], - 'description' => 'The response parameters.', + 'description' => '', + 'title' => '', + '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' => 'CreateApsCopyWorkload', - ], - 'DescribeApsDatasource' => [ - 'summary' => 'Queries the information about an AnalyticDB Pipeline Service (APS) data source.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ['errorCode' => 'AlreadyRunning', 'errorMessage' => 'The crawler instance is already running.', 'description' => ''], + ['errorCode' => 'NotExists', 'errorMessage' => 'The formation task does not exist. ', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerStoreError', 'errorMessage' => 'A server storage error occurred. ', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Manually run a metadata discovery task', + 'description' => '### Operation description'."\n" + .'When you use a cloud-native data repository AnalyticDB for MySQL cluster and require Alibaba Cloud technical support, if the helpdesk needs to perform operations on your cluster during the support procedure, authorize the service account of the AnalyticDB for MySQL cluster so that the helpdesk can provide technical support through the service account. After the authorization expires, the permissions of the service account are automatically revoked.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": \\"69\\",\\n \\"TaskId\\": 1564657730,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'StartSparkReplSession' => [ + 'summary' => 'Starts a Spark session.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -40517,507 +31292,277 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '168878', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsY28JLD', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp1mfe9qm****', 'title' => ''], ], [ - 'name' => 'DBClusterId', + 'name' => 'ResourceGroupName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'am-*******', - ], + 'schema' => ['description' => 'The name of the job resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'DatasourceId', + 'name' => 'Config', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The configuration parameters that are used to start the Spark session, which are in the JSON format. For more information, see [Spark application configuration parameters](~~471203~~).'."\n", 'type' => 'string', 'required' => true, 'example' => '{ "spark.shuffle.timeout": ":0s" }', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-**D8-5***-A***-****587', - ], - 'ApsDatasource' => [ - 'description' => 'The queried APS data source.', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C1797FEA-B7D6-5ED6-A24B-2C8C5F4D7361'], + 'Data' => [ + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'DatasourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'kafka-2024***', - ], - 'CreateTime' => [ - 'description' => 'The time when the data source was created.'."\n", - 'type' => 'string', - 'example' => '2024-04-12T15:03:38Z', - ], - 'DatasourceType' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'example' => 'KAFKA', - ], - 'DatasourceDescription' => [ - 'description' => 'The description of the data source.'."\n", + 'SessionId' => ['description' => 'The ID of the session that executes the code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AttemptId' => ['description' => 'The attempt ID of the Spark application.'."\n", 'type' => 'string', 'example' => 's202301061000h****', 'title' => ''], + 'Error' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'session time out', 'title' => ''], + 'WebUiAddress' => ['description' => 'The URL of the web UI for the Spark application.'."\n", 'type' => 'string', 'example' => 'https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****', 'title' => ''], + 'State' => [ + 'description' => 'The status of the session. Valid values:'."\n" + ."\n" + .'* IDLE'."\n" + .'* BUSY'."\n" + .'* DEAD'."\n", 'type' => 'string', - 'example' => 'test', - ], - 'SlsInfo' => [ - 'description' => 'The Simple Log Service (SLS) project.'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceRegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Project' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'example' => '***', - ], - 'Store' => [ - 'description' => 'The name of the SLS Logstore.'."\n", - 'type' => 'string', - 'example' => '***', - ], - 'Across' => [ - 'description' => 'Indicates whether the data source is a cross-account resource. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'AcrossUid' => [ - 'description' => 'The cross-account UID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'AcrossRole' => [ - 'description' => 'The name of the cross-account role.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - 'example' => '-', - ], - 'KafkaInfo' => [ - 'description' => 'The information about the Kafka instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'KafkaClusterId' => [ - 'description' => 'The ID of the Kafka instance.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'KafkaTopic' => [ - 'description' => 'The topic of the Kafka instance.'."\n", - 'type' => 'string', - 'example' => '[{\'value\': \'hongxian_test\'}]', - ], - ], - 'example' => '-', - ], - 'HiveInfo' => [ - 'description' => 'The information about the Hive data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'MetaStoreUri' => [ - 'description' => 'The URL of the Hive Metastore.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'Vswitch' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-******', - ], - 'SecurityGroup' => [ - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'example' => 'sg-******', - ], - 'EmrClusterId' => [ - 'description' => 'The ID of the E-MapReduce (EMR) cluster.'."\n", - 'type' => 'string', - 'example' => '-', - ], - ], - 'example' => '-', - ], - 'RdsMysqlInfo' => [ - 'description' => 'The parameter is no longer supported.'."\n", - 'type' => 'object', - 'properties' => [ - 'UserName' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'RegionId' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'InstanceId' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'ConnectUrl' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'SecurityGroup' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - ], - 'example' => '-', - ], - 'PolarDBMysqlInfo' => [ - 'description' => 'The parameter is no longer supported.'."\n", - 'type' => 'object', - 'properties' => [ - 'UserName' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'RegionId' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'InstanceId' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'ConnectUrl' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'SecurityGroup' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'Across' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'boolean', - 'example' => '-', - ], - 'AcrossUid' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - 'AcrossRole' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'example' => '-', - ], - ], - 'example' => '-', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-******', - ], - 'DatabricksInfo' => [ - 'description' => 'The information about Databricks.'."\n", - 'type' => 'object', - 'properties' => [ - 'accessToken' => [ - 'description' => 'The token that is used to access Databricks.'."\n", - 'type' => 'string', - 'example' => '******', - ], - 'workspaceURL' => [ - 'description' => 'The URL of the workspace.'."\n", - 'type' => 'string', - 'example' => '-', - ], - ], - 'example' => '-', + 'enumValueTitles' => [], + 'example' => 'IDLE', + 'title' => '', ], + 'AliyunUid' => ['description' => 'The ID of the Alibaba Cloud account that owns the cluster.'."\n", 'type' => 'string', 'example' => '178157466******', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInput', - 'errorMessage' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'Spark.App.ExceedQuotaLimitation', 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', 'description' => ''], + ['errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', 'description' => 'The AppType type is illegal, please refer to using the document to specify the AppType suitable for your business.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ResourceNegativeError', 'errorMessage' => 'The requested resource MUST be positive: %s', 'description' => ''], + ['errorCode' => 'Spark.Config.InvalidAppFilePath', 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', 'description' => 'The main driver file address must be a valid OSS address. The current address is %s.'], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidDiskConfig', 'errorMessage' => 'The requested disk mount parameter is invalid: %s', 'description' => 'The disk mount configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidHostAliasConfig', 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', 'description' => 'The domain name mapping configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidLogOssPath', 'errorMessage' => 'The OSS address for log storage is illegal: %s', 'description' => 'The OSS address for storing logs is invalid.'], + ['errorCode' => 'Spark.Config.InvalidRoleArnFormat', 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', 'description' => 'The configured RoleARN format is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidTimeZone', 'errorMessage' => 'Unable to parse time zone configuration %s : %s', 'description' => 'The time zone configuration is incorrect.'], + ['errorCode' => 'Spark.Config.MainAppFileNotExists', 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', 'description' => 'The main driver file is missing. The file or sqls configuration must not be empty.'], + ['errorCode' => 'Spark.Config.OSSPathAccessError', 'errorMessage' => 'The configured OSS address %s cannot be accessed.', 'description' => 'The configured OSS path is inaccessible.'], + ['errorCode' => 'Spark.Config.OSSPathNotExists', 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', 'description' => 'The OSS path does not exist or the current user does not have permission to access it.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Config.SecurityGroupNotFound', 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.'], + ['errorCode' => 'Spark.Config.VswitchNotFound', 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured vSwitch cannot be found, or the current account has insufficient permissions. %s.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.BlankError', 'errorMessage' => 'Input sql can not be blank string.', 'description' => 'The submitted SQL statement cannot be empty.'], + ['errorCode' => 'Spark.SQL.MultipleSQLError', 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', 'description' => 'The submitted Spark SQL contains multiple executable SQL statements.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.App.NotFound', 'errorMessage' => 'The Spark application %s is not found.', 'description' => 'The specified Spark application was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], ], ], - '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' => 'DescribeApsDatasource', - ], - 'CreateAPSJob' => [ - 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) job.', - 'methods' => [ - 'get', - 'post', + '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' => 'StartSparkReplSession', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSparkReplSession'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:SubmitSparkApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#resourcegroup}'], + ], + ], + ], ], + ], + 'StartSparkSQLEngine' => [ + 'summary' => 'Starts the Spark SQL engine.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'readAndWrite', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '180008', - 'abilityTreeNodes' => [ - 'FEATUREadsH8FO36', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '152577', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'SourceEndpointInstanceID', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the source instance or cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pc-xxxxx', - ], - ], - [ - 'name' => 'SourceEndpointRegion', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID of the source instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'SourceEndpointUserName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database account of the source instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx', - ], - ], - [ - 'name' => 'SourceEndpointPassword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The password of the database account of the source instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], - ], - [ - 'name' => 'DestinationEndpointInstanceID', + 'name' => 'DBClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database account of the destination cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-xxxxx', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-abcd****', 'title' => ''], ], [ - 'name' => 'DestinationEndpointPassword', + 'name' => 'ResourceGroupName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The password of the database account of the destination cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'spark-rg-name', 'title' => ''], ], [ - 'name' => 'DestinationEndpointUserName', + 'name' => 'MinExecutor', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database account of the destination cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], + 'schema' => ['description' => 'The minimum number of executors that are required to execute SQL statements. Valid values: 0 to 2000. A value of 0 indicates that no executors are permanent if no SQL statements are executed. If this value exceeds the total number of executors that are supported by the resource group, the Spark SQL engine fails to be started. The value must be less than the value of MaxExecutor.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '0', 'title' => ''], ], [ - 'name' => 'DbList', + 'name' => 'MaxExecutor', 'in' => 'formData', - 'schema' => [ - 'description' => 'The objects to be synchronized.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"EntireInstance":true}', - ], + 'schema' => ['description' => 'The maximum number of executors that are required to execute SQL statements. Valid values: 1 to 2000. If this value exceeds the total number of executes that are supported by the resource group, the Spark SQL engine fails to be started.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ApsJobName', + 'name' => 'Jars', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the synchronization job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-xxxxx', - ], + 'schema' => ['description' => 'The Object Storage Service (OSS) paths of third-party JAR packages that are required to start the Spark SQL engine. Separate multiple OSS paths with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://testBuckname/test.jar,oss://testBuckname/test2.jar', 'title' => ''], ], [ - 'name' => 'PartitionList', + 'name' => 'SlotNum', 'in' => 'formData', - 'schema' => [ - 'description' => 'The partitions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The maximum number of slots that are required to maintain Spark sessions for executing SQL statements. Valid values: 1 to 500.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'default' => '50', 'title' => ''], ], [ - 'name' => 'TargetTableMode', + 'name' => 'Config', 'in' => 'formData', - 'schema' => [ - 'description' => 'The mode of the destination table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The configuration that is required to start the Spark SQL engine. Specify this value in the JSON format. For more information, see [Conf configuration parameters](~~471203~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "spark.shuffle.timeout": ":0s" }', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ApsJobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'aps-bj1xxxxxx', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D1B8ED33-5E9B-512D-B188-1579ED6xxx', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppId' => ['description' => 'The ID of the Spark job.'."\n", 'type' => 'string', 'example' => 's202301xxxx', 'title' => ''], + 'State' => ['description' => 'The state of the Spark SQL engine. Valid values:'."\n" + ."\n" + .'* SUBMITTED'."\n" + .'* STARTING'."\n" + .'* RUNNING'."\n" + .'* FAILED'."\n", 'type' => 'string', 'example' => 'SUBMITTED', 'title' => ''], + 'AppName' => ['description' => 'The name of the Spark application.'."\n", 'type' => 'string', 'example' => 'SQLEngine1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'adb::2021-12-01::DescribeApsJobDetail', - 'callbackInterval' => 6000, - 'maxCallbackTimes' => 100, + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.App.ExceedQuotaLimitation', 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', 'description' => ''], + ['errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', 'description' => 'The AppType type is illegal, please refer to using the document to specify the AppType suitable for your business.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ResourceNegativeError', 'errorMessage' => 'The requested resource MUST be positive: %s', 'description' => ''], + ['errorCode' => 'Spark.Config.InvalidAppFilePath', 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', 'description' => 'The main driver file address must be a valid OSS address. The current address is %s.'], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidDiskConfig', 'errorMessage' => 'The requested disk mount parameter is invalid: %s', 'description' => 'The disk mount configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidHostAliasConfig', 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', 'description' => 'The domain name mapping configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidLogOssPath', 'errorMessage' => 'The OSS address for log storage is illegal: %s', 'description' => 'The OSS address for storing logs is invalid.'], + ['errorCode' => 'Spark.Config.InvalidRoleArnFormat', 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', 'description' => 'The configured RoleARN format is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidTimeZone', 'errorMessage' => 'Unable to parse time zone configuration %s : %s', 'description' => 'The time zone configuration is incorrect.'], + ['errorCode' => 'Spark.Config.MainAppFileNotExists', 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', 'description' => 'The main driver file is missing. The file or sqls configuration must not be empty.'], + ['errorCode' => 'Spark.Config.OSSPathAccessError', 'errorMessage' => 'The configured OSS address %s cannot be accessed.', 'description' => 'The configured OSS path is inaccessible.'], + ['errorCode' => 'Spark.Config.OSSPathNotExists', 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', 'description' => 'The OSS path does not exist or the current user does not have permission to access it.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Config.SecurityGroupNotFound', 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.'], + ['errorCode' => 'Spark.Config.VswitchNotFound', 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured vSwitch cannot be found, or the current account has insufficient permissions. %s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.App.NotFound', 'errorMessage' => 'The Spark application %s is not found.', 'description' => 'The specified Spark application was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], ], - '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' => 'CreateAPSJob', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'StartApsJob' => [ - 'summary' => 'Starts an AnalyticDB Pipeline Service (APS) job.', - 'methods' => [ - 'post', + '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' => 'StartSparkSQLEngine', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-07-27T02:58:13.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-06-28T01:10:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSparkSQLEngine'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:StartSparkEngine', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopFormationCrawler' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41027,34 +31572,29 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeCode' => '185195', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsY28JLD', - ], + 'abilityTreeCode' => '138506', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~143074~~) operation to query available region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ApsJobId', + 'name' => 'CrawlerTaskName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-******', - ], + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'example' => 'test-crawler-dbname', 'title' => ''], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1xxxxxxxx47', 'title' => ''], + ], + [ + 'name' => 'CrawlerTaskId', + 'in' => 'formData', + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21', 'title' => ''], ], ], 'responses' => [ @@ -41062,73 +31602,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ApsJobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'aps-******', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrCode' => [ - 'description' => 'The error code returned when the request fails.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ErrMessage' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the successfully created task.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], - 'description' => 'The response parameters.', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'StartApsJob', - ], - 'SuspendApsJob' => [ - 'summary' => 'Suspends an AnalyticDB Pipeline Service (APS) job.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid. ', 'description' => ''], + ['errorCode' => 'NotExists', 'errorMessage' => 'The formation task does not exist. ', 'description' => ''], + ['errorCode' => 'NotRunning', 'errorMessage' => 'The instance is not running.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerStoreError', 'errorMessage' => 'A server storage error occurred.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Stop a running metadata discovery task', + 'summary' => 'Stops a metadata discovery task that is currently running.', + 'description' => 'Stops only the currently running task without canceling subsequent cron-scheduled executions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]', + ], + 'SubmitResultExportJob' => [ + 'summary' => 'Submits an SQL query and exports a result set.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41137,340 +31647,379 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183067', - 'abilityTreeNodes' => [ - 'FEATUREadsY28JLD', - 'FEATUREads1II0UT', - ], + 'abilityTreeCode' => '219535', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ApsJobId', + 'name' => 'DBClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-bj1xxxxxx', - ], + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.', 'type' => 'string', 'required' => true, 'example' => 'amv-bp10a0ng21t5****', 'title' => ''], + ], + [ + 'name' => 'Engine', + 'in' => 'formData', + 'schema' => ['description' => 'The engine that is used to run the result set export job. Set the value to XIHE.'."\n", 'type' => 'string', 'required' => false, 'example' => 'XIHE', 'title' => ''], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the resource group that runs the result set export job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user_default', 'title' => ''], + ], + [ + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tpch_oss', 'title' => ''], + ], + [ + 'name' => 'SQL', + 'in' => 'formData', + 'schema' => ['description' => 'The SQL statement that is used in the result set export job. You can specify only SELECT statements. If you specify other SQL statements, the request fails.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SELECT * FROM `fotor_com_datastore_resource`.`fotor_ai_create_task` where `date` = \'2023-05-13\' LIMIT 10;', 'title' => ''], + ], + [ + 'name' => 'ExportType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the result set export job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SLS', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ApsJobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'aps-bj1xxxxxx', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrCode' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'ErrMessage' => [ - 'description' => 'The error code returned when the request fails.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, an **OK** message is returned.'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => 'InvalidInput'."\n", 'title' => ''], + 'Data' => ['description' => 'The ID of the result set export job.'."\n", 'type' => 'string', 'example' => 'export_202405131927121980210080040****'."\n", 'title' => ''], ], - 'description' => 'The response parameters.', + 'example' => '', ], ], ], - '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' => 'SuspendApsJob', - ], - 'ModifyApsJob' => [ - 'summary' => 'Modifies an AnalyticDB Pipeline Service (APS) job.', - 'methods' => [ - 'get', - 'post', + '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' => 'SubmitResultExportJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitResultExportJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:SubmitResultExportJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SubmitSparkApp' => [ + 'summary' => 'Submits a Spark application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '183077', - 'abilityTreeNodes' => [ - 'FEATUREadsH8FO36', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '118686', + 'abilityTreeNodes' => ['FEATUREadsCQJTKP'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the application. The value can be up to 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestApp'], ], [ - 'name' => 'ApsJobId', + 'name' => 'AppType', 'in' => 'formData', 'schema' => [ - 'description' => 'The job ID.'."\n", + 'title' => '', + 'description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* **SQL**'."\n" + .'* **STREAMING**'."\n" + .'* **BATCH** (default)'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'aps-bj1xxxxxx', + 'required' => false, + 'example' => 'SQL', + 'default' => 'BATCH', + 'enum' => [], ], ], [ - 'name' => 'DbList', + 'name' => 'Data', 'in' => 'formData', - 'schema' => [ - 'description' => 'The objects to be synchronized.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"EntireInstance":true}', - ], + 'schema' => ['title' => '', 'description' => 'The data of the application template.'."\n" + ."\n" + .'> For information about the application template configuration, see [Spark application configuration guide](~~452402~~).'."\n", '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' => 'PartitionList', + 'name' => 'AgentSource', 'in' => 'formData', 'schema' => [ - 'description' => 'The partitions.'."\n", + 'title' => '', + 'description' => 'The type of the client. The value can be up to 64 characters in length.'."\n", 'type' => 'string', 'required' => false, - 'example' => '{}', + 'example' => 'CONSOLE', + 'default' => 'SDK', + 'enum' => [], ], ], + [ + 'name' => 'AgentVersion', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The version of the client. The value can be up to 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.091'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-bp11q28kvl688****', 'maxLength' => 64], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the job resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~612410~~) operation to query the name of a resource group within a cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'adb', 'maxLength' => 64], + ], + [ + 'name' => 'TemplateFileId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the application template.'."\n" + ."\n" + .'> You can call the [GetSparkTemplateFullTree](~~456205~~) operation to query the application template ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '15'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The status code. A value of 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ApsJobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'aps-bj1xxxxxx', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'ErrMessage' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'The status code. A value of 200 indicates that the request is successful.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput'."\n", - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppId' => ['title' => '', 'description' => 'The application ID.'."\n", 'type' => 'string', 'example' => 's202204132018hzprec1ac61a000****'], + 'AppName' => ['title' => '', 'description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'TestApp'], + 'Message' => ['title' => '', 'description' => 'The alert message returned for the operation, such as task execution failure or insufficient resources. If no alert occurs, null is returned.'."\n", 'type' => 'string', 'example' => 'Insufficient resources.'], + 'State' => ['title' => '', 'description' => 'The execution state of the application. Valid values:'."\n" + ."\n" + .'* **SUBMITTED**'."\n" + .'* **STARTING**'."\n" + .'* **RUNNING**'."\n" + .'* **FAILING**'."\n" + .'* **FAILED**'."\n" + .'* **KILLING**'."\n" + .'* **KILLED**'."\n" + .'* **SUCCEEDING**'."\n" + .'* **COMPLETED**'."\n" + .'* **FATAL**'."\n" + .'* **UNKNOWN**'."\n", 'type' => 'string', 'example' => 'SUBMITTED'], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.App.ExceedQuotaLimitation', 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', 'description' => ''], + ['errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', 'description' => 'The AppType type is illegal, please refer to using the document to specify the AppType suitable for your business.'], + ['errorCode' => 'Spark.App.InvalidResourceSpec', 'errorMessage' => 'The requested resource type is not supported:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ParameterConflict', 'errorMessage' => 'Conflicting parameters submitted:\\n %s', 'description' => ''], + ['errorCode' => 'Spark.App.ResourceNegativeError', 'errorMessage' => 'The requested resource MUST be positive: %s', 'description' => ''], + ['errorCode' => 'Spark.Config.InvalidAppFilePath', 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', 'description' => 'The main driver file address must be a valid OSS address. The current address is %s.'], + ['errorCode' => 'Spark.Config.invalidConnectors', 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidDiskConfig', 'errorMessage' => 'The requested disk mount parameter is invalid: %s', 'description' => 'The disk mount configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidHostAliasConfig', 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', 'description' => 'The domain name mapping configuration is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidLogOssPath', 'errorMessage' => 'The OSS address for log storage is illegal: %s', 'description' => 'The OSS address for storing logs is invalid.'], + ['errorCode' => 'Spark.Config.InvalidRoleArnFormat', 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', 'description' => 'The configured RoleARN format is incorrect.'], + ['errorCode' => 'Spark.Config.InvalidTimeZone', 'errorMessage' => 'Unable to parse time zone configuration %s : %s', 'description' => 'The time zone configuration is incorrect.'], + ['errorCode' => 'Spark.Config.MainAppFileNotExists', 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', 'description' => 'The main driver file is missing. The file or sqls configuration must not be empty.'], + ['errorCode' => 'Spark.Config.OSSPathAccessError', 'errorMessage' => 'The configured OSS address %s cannot be accessed.', 'description' => 'The configured OSS path is inaccessible.'], + ['errorCode' => 'Spark.Config.OSSPathNotExists', 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', 'description' => 'The OSS path does not exist or the current user does not have permission to access it.'], + ['errorCode' => 'Spark.Config.RoleArnVerifyFailed', 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'description' => 'The RoleARN parameter validation failed.'], + ['errorCode' => 'Spark.Config.SecurityGroupNotFound', 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.'], + ['errorCode' => 'Spark.Config.VswitchNotFound', 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', 'description' => 'The configured vSwitch cannot be found, or the current account has insufficient permissions. %s.'], + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['errorCode' => 'Spark.SQL.BlankError', 'errorMessage' => 'Input sql can not be blank string.', 'description' => 'The submitted SQL statement cannot be empty.'], + ['errorCode' => 'Spark.SQL.MultipleSQLError', 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', 'description' => 'The submitted Spark SQL contains multiple executable SQL statements.'], + ['errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['errorCode' => 'Spark.SQL.ParserError', 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ['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.', 'description' => 'Please make sure your current RAM user (ram_user_id %s) has been granted the system policy \'AliyunADBDeveloperAccess\'. And then follow the section \'Perform authorization within an Alibaba Cloud account". This will automatically initialize the system role named \'aliyunadbsparkprocessingdatarole\' in your cloud account. More details: https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.App.ContentNotFound', 'errorMessage' => 'The requested content %s of the Spark application is not found.', 'description' => 'The submission content of the specified Spark job was not found.'], + ['errorCode' => 'Spark.App.NotFound', 'errorMessage' => 'The Spark application %s is not found.', 'description' => 'The specified Spark application was not found.'], + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], + ], + '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' => 'SubmitSparkApp', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-05-27T07:29:50.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-06-11T03:28:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-27T02:58:13.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ['createdAt' => '2023-06-28T01:10:40.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'ModifyApsJob', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DeleteApsJob' => [ - 'summary' => 'Deletes an AnalyticDB Pipeline Service (APS) job.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSparkApp'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:SubmitSparkApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'SparkApplication', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], + ], + ], + ], ], + ], + 'SubmitSparkLogAnalyzeTask' => [ + 'summary' => 'Submits a Spark log analysis task and queries the analysis results.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeCode' => '183073', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsY28JLD', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ApsJobId', + 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-*****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the Spark application.'."\n", 'type' => 'string', 'required' => true, 'example' => 's202301121553hzd9c6f7xxxx'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ApsJobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'aps-*****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****-****-5D14-AC9F-*********', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrCode' => [ - 'description' => 'The error code returned when the request fails.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'ErrMessage' => [ - 'description' => 'The error code returned when the request fails.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1DF5AF5B-C803-1861-A0FF-63666A557709'], + 'Data' => ['description' => 'The information about the Spark log analysis task.'."\n", '$ref' => '#/components/schemas/SparkAnalyzeLogTask', 'title' => '', 'example' => ''], ], - 'description' => 'The response parameters.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['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.', 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task 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.', 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ], + 404 => [ + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.AnalyzeTask.NotFound', 'errorMessage' => 'The requested analysis task %s is not found.', 'description' => 'The log analysis task you requested to view does not exist. %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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], ], - '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' => 'DeleteApsJob', - 'description' => '* Deleting backup sets is an asynchronous operation and may require 10 to 20 minutes to complete.'."\n" - .'* You can delete up to 100 backup sets at a time. If you want to delete more than 100 backup sets, call this operation twice.'."\n" - .'* To ensure data security, the system forcibly retains one valid backup set. If you want to delete the last backup set, the system prohibits your operation.'."\n", - ], - 'CreateApsDatasoure' => [ - 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) data source.', - 'methods' => [ - 'get', - 'post', + '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: cpu is exceeded limits 12/10\\",\\n \\"AppErrorAdvice\\": \\"Please increase cpu quota for your resource group\\"\\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' => 'SubmitSparkLogAnalyzeTask', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-06-28T01:10:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSparkLogAnalyzeTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:SubmitSparkLogAnalyzeTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'SuspendApsJob' => [ + 'summary' => 'Suspends an AnalyticDB Pipeline Service (APS) job.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41482,424 +32031,320 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '168860', - 'abilityTreeNodes' => [ - 'FEATUREadsBIVU9O', - 'FEATUREadsY28JLD', - 'FEATUREads1II0UT', - ], + 'abilityTreeCode' => '183067', + 'abilityTreeNodes' => ['FEATUREadsY28JLD', 'FEATUREads1II0UT'], ], 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-xxxxx', - ], - ], [ 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DatasourceType', + 'name' => 'ApsJobId', 'in' => 'formData', + 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aps-bj1xxxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'KAFKA', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ApsJobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'aps-bj1xxxxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-******-9F06-******', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrCode' => ['description' => 'The HTTP status code or the error code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'ErrMessage' => ['description' => 'The error code returned when the request fails.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'SuspendApsJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendApsJob'], + ], + ], + 'ramActions' => [ [ - 'name' => 'DatasourceName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sls-******', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:SuspendApsJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UnbindAccount' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DatasourceDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Mode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALI_CLOUD_INSTANCE', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-wz99d9nh5****', 'title' => ''], ], [ - 'name' => 'SlsInfo', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database account.'."\n" + ."\n" + .'> You can call the [DescribeAccounts](~~612430~~) operation to query the information about database accounts of an AnalyticDB for MySQL cluster, including database account names.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_accout', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The information about the source Simple Log Service (SLS) instance or cluster.'."\n", + 'title' => '', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'SourceRegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - 'Project' => [ - 'description' => 'The SLS project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-project', - ], - 'Store' => [ - 'description' => 'The name of the SLS Logstore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-store', - ], - 'Across' => [ - 'description' => 'Specifies whether the data source is a cross-account resource.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'AcrossUid' => [ - 'description' => 'The cross-account UID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx', - ], - 'AcrossRole' => [ - 'description' => 'The name of the cross-account role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'yyy', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '93E85E5C-C805-5837-8713-05B69A504EE5'], ], - 'required' => false, - 'example' => '-', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The AccountName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ], + ], + 'title' => 'UnbindAccount', + 'summary' => 'Disassociates a standard account of an AnalyticDB for MySQL cluster from a Resource Access Management (RAM) user.', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-03-31T07:03:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-11T16:51:57.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindAccount'], + ], + ], + 'ramActions' => [ [ - 'name' => 'KafkaInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the source Apache Kafka instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'KafkaClusterId' => [ - 'description' => 'The ID of the Apache Kafka instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], - 'KafkaTopic' => [ - 'description' => 'The topic of the Apache Kafka instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:UnbindAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - 'required' => false, - 'example' => '-', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93E85E5C-C805-5837-8713-05B69A504EE5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 93E85E5C-C805-5837-8713-05B69A504EE5\\n","errorExample":""}]', + ], + 'UnbindDBResourceGroupWithUser' => [ + 'summary' => 'Disassociates a database account from a resource group of an AnalyticDB for MySQL cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREadsYXZ2UA'], + ], + 'parameters' => [ [ - 'name' => 'HiveInfo', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'am-bp1ub9grke1****', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'GroupUser', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The information about the Hive data source.'."\n", + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'MetaStoreUri' => [ - 'description' => 'The URL of the Hive Metastore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], - 'Vswitch' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1*****k', - ], - 'SecurityGroup' => [ - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sg-uf*******h', - ], - 'ClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], - 'HostConfig' => [ - 'description' => 'The configuration of the host.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], ], - 'required' => false, - 'example' => '-', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidPoolName.Malformed', 'errorMessage' => 'The specified parameter PoolName is not valid.', 'description' => 'The PoolName parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidPoolUser.Malformed', 'errorMessage' => 'The specified parameter PoolUser is not valid.', 'description' => 'The PoolUser parameter is invalid. Check the parameter.'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ], + ], + 'title' => 'UnbindDBResourceGroupWithUser', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindDBResourceGroupWithUser'], + ], + ], + 'ramActions' => [ [ - 'name' => 'RdsMysqlInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the source ApsaraDB RDS for MySQL instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rm-xxxxxxx', - ], - 'UserName' => [ - 'description' => 'The name of the database account of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], - 'Password' => [ - 'description' => 'The password of the database account of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], - 'ConnectUrl' => [ - 'description' => 'The URL used to connect to the read-only instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], - 'SecurityGroup' => [ - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sg-******', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:UnbindDBResourceGroupWithUser', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - 'required' => false, - 'example' => '-', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + ], + 'UpdateApsWebhook' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PolarDBMysqlInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the source PolarDB for MySQL cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pc-bp*********', - ], - 'UserName' => [ - 'description' => 'The username used to access the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-user-name', - ], - 'Password' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], - 'ConnectUrl' => [ - 'description' => 'The URL used to connect to the custom ApsaraDB RDS for MySQL instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****', - ], - 'SecurityGroup' => [ - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sg-******', - ], - 'Across' => [ - 'description' => 'Specifies whether the data source is a cross-account resource. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'AcrossUid' => [ - 'description' => 'The cross-account UID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456789*', - ], - 'AcrossRole' => [ - 'description' => 'The name of the cross-account role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-role', - ], - ], - 'required' => false, - 'example' => '-', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREads1II0UT', 'FEATUREadsBIVU9O', 'FEATUREadsY28JLD'], + ], + 'parameters' => [ [ - 'name' => 'PolarDBXInfo', + 'name' => 'DBClusterId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the source PolarDB-X instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - ], - 'required' => false, - 'example' => '-', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'exampleDBClusterId', 'title' => ''], ], [ - 'name' => 'DatabricksInfo', + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'exampleRegionId', 'title' => ''], + ], + [ + 'name' => 'Webhook', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The information about the Databricks data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'AccessToken' => [ - 'description' => 'The token that is used to access Databricks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], - 'WorkspaceURL' => [ - 'description' => 'The URL of the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxx', + 'description' => 'The webhook array.', + 'type' => 'array', + 'items' => [ + 'description' => 'The webhook array.', + 'type' => 'object', + 'properties' => [ + 'WebhookId' => ['description' => 'Webhook ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '**355****', 'title' => ''], + 'Url' => ['description' => 'The request URL.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/webhook', 'title' => ''], + 'Key' => ['description' => 'The signing key.', 'type' => 'string', 'required' => false, 'example' => 'ABC**', 'title' => ''], + 'WebhookType' => ['description' => 'The notification method. Valid values:'."\n" + ."\n" + .'- dingtalk: DingTalk.'."\n" + .'- lark: Lark.', 'type' => 'string', 'required' => false, 'example' => 'dingtalk', 'title' => ''], + 'Name' => ['description' => 'The webhook name.', 'type' => 'string', 'required' => false, 'example' => 'exampleWebhookName', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => '-', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The information about the cluster resource usage.'."\n", - 'type' => 'string', - 'example' => '69', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65D2***-45C1-5C18-**********', - ], - 'Success' => [ - 'description' => 'Indicates whether the dry run succeeds. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-7xxxxx', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'exampleRequestId'], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Operation succeeded', 'title' => ''], + 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'amv-bp11q28kvl688****', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => 'The response parameters.', + 'example' => '', ], ], ], - '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' => 'CreateApsDatasoure', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'ModifyApsDatasoure' => [ - 'summary' => 'Modifies an AnalyticDB Pipeline Service (APS) data source.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update webhook configuration', + 'summary' => 'Updates the webhook configuration of a specified database cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApsWebhook'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:UpdateApsWebhook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"exampleRequestId\\",\\n \\"Data\\": \\"-\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Operation succeeded\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateFormationCrawler' => [ + 'summary' => 'Updates the information of a metadata discovery task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41909,230 +32354,222 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsY28JLD', - ], + 'abilityTreeCode' => '138505', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-*******', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the regions and zones supported by AnalyticDB for MySQL, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'CrawlerInfo', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The JSON string that contains the complete configuration of the crawler. This is the most important parameter. For more information about the internal JSON structure, see the CrawlerInfo structure definition section.', 'type' => 'string', 'required' => true, 'example' => '{"sourceType":"OSSWAREHOUSE","dbName":"sales_db","sourceInfo":{"ossSourceInfo":{"sourceMode":"WAREHOUSE","ossLocations":"oss://test-bucket/***/***/","inclusions":[],"exclusions":[]}},"classifiers":"[]","frequency":{"type":"run_on_demand","cron":""},"configuration":"","schemaChangePolicy":{"updateRule":"ONLY_ADD_COLUMN","deleteRule":"IGNORE"}}', 'title' => ''], ], [ - 'name' => 'DatasourceId', + 'name' => 'DBClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1r053byu48p****', 'title' => ''], ], [ - 'name' => 'DatasourceName', + 'name' => 'CrawlerTaskId', 'in' => 'formData', + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '21', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sls-******', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request is processed successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The additional information about the call result. Valid values:'."\n" + ."\n" + .'- If the request is successful, OK is returned.'."\n" + .'- If the request fails, a specific error code is returned.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid. ', 'description' => ''], + ['errorCode' => 'NotExists', 'errorMessage' => 'The formation task does not exist. ', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerStoreError', 'errorMessage' => 'A server storage error occurred.', 'description' => ''], + ], + ], + 'title' => 'Update metadata discovery task information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\",\\n \\"TaskId\\": 15\\n}","type":"json"}]', + ], + 'UpdateFormationCrawlerScheduleState' => [ + 'summary' => 'Pauses or resumes the periodic scheduling of metadata discovery.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DatasourceDescription', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '138507', + 'abilityTreeNodes' => ['FEATUREadsCORDM7'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The region ID.'."\n" + .'>You can call the [DescribeRegions](~~143074~~) operation to query the region ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SlsInfo', + 'name' => 'CrawlerTaskName', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about Simple Log Service (SLS).'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceRegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - 'Across' => [ - 'description' => 'Specifies whether to use a cross-account resource as the data source. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'AcrossUid' => [ - 'description' => 'The cross-account UID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], - 'AcrossRole' => [ - 'description' => 'The name of the cross-account role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-role', - ], - ], - 'required' => false, - 'example' => '-', - ], + 'schema' => ['description' => 'The name of the crawler task.', 'type' => 'string', 'required' => true, 'example' => 'test-crawler-dbname', 'title' => ''], ], [ - 'name' => 'KafkaInfo', + 'name' => 'DBClusterId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the Kafka instance.', - 'type' => 'object', - 'properties' => [ - 'KafkaClusterId' => [ - 'description' => 'The ID of the Kafka instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'KafkaTopic' => [ - 'description' => 'The topic of the Kafka instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-topic', - ], - ], - 'required' => false, - 'example' => '-', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'am-bp1565u55p32****', 'title' => ''], ], [ - 'name' => 'LakehouseId', + 'name' => 'ScheduleState', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['description' => 'The scheduling state. Valid values:'."\n" + ."\n" + .'- NORMAL: resume.'."\n" + ."\n" + .'- DISABLED: pause.', 'type' => 'string', 'required' => true, 'example' => 'DISABLED', 'title' => ''], + ], + [ + 'name' => 'CrawlerTaskId', + 'in' => 'formData', + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '247', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The lakehouse ID.'."\n", 'type' => 'object', 'properties' => [ - 'Vswitch' => [ - 'description' => 'The name of the vSwitch.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-******', - ], - 'SecurityGroup' => [ - 'description' => 'The name of the security group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sg-******', - ], - 'VpcId' => [ - 'description' => 'The virtual private cloud (VPC) ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-******', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '642F3512-C628-5D0C-8815-F6670CEA00D4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message. OK is returned if the call was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], - 'required' => false, - 'example' => '123', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInput', 'errorMessage' => 'The specified parameter is invalid. ', 'description' => ''], + ['errorCode' => 'NotExists', 'errorMessage' => 'The formation task does not exist. ', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerStoreError', 'errorMessage' => 'A server storage error occurred.', 'description' => ''], + ], + ], + 'title' => 'Pause or resume metadata discovery periodic scheduling', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"642F3512-C628-5D0C-8815-F6670CEA00D4\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'UpdateLakeStorage' => [ + 'summary' => 'Updates a lake storage.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RdsMysqlInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'object', - 'properties' => [ - 'UserName' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'Password' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'RegionId' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'ConnectUrl' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - ], - 'required' => false, - 'example' => '-', - ], + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '216927', + 'abilityTreeNodes' => ['FEATUREadsQO9FPM'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], ], [ - 'name' => 'PolarDBMysqlInfo', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The description of the lake storage.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'LakeStorageId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The unique identifier of the lake storage.'."\n", 'type' => 'string', 'required' => false, 'example' => '-'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL cluster that is associated with the lake storage.', 'type' => 'string', 'required' => false, 'example' => 'amv-*******'], + ], + [ + 'name' => 'Permissions', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'object', - 'properties' => [ - 'UserName' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'Password' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'RegionId' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'ConnectUrl' => [ - 'description' => 'The parameter is no longer supported.', - 'type' => 'string', - 'required' => false, - 'example' => '-', + 'title' => '', + 'description' => 'The permissions on the lake storage.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The permissions.'."\n", + 'type' => 'object', + 'properties' => [ + 'Read' => ['title' => '', 'description' => 'The read permissions.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'Write' => ['title' => '', 'description' => 'The write permissions.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'Account' => ['title' => '', 'description' => 'The account ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'pattern' => '^\\d+$', 'default' => ''], + 'Type' => [ + 'title' => '', + 'description' => 'The account type.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'SUB', + 'enum' => ['Service', 'User'], + ], ], + 'required' => false, + 'example' => '-', ], 'required' => false, 'example' => '-', @@ -42142,71 +32579,100 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A3EB3BCD-D974-52D4-B75C-BB06505916CB', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '******-3EEC-******-9F06-******'], 'Data' => [ 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => '150', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'string', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput'."\n", - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', + 'type' => 'object', + 'properties' => [ + 'LakeStorageId' => ['title' => '', 'description' => 'The unique identifier of the lake storage.'."\n", 'type' => 'string', 'example' => '-'], + 'Description' => ['title' => '', 'description' => 'The description of the lake storage.'."\n", 'type' => 'string', 'example' => 'test'], + 'DBClusterId' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL cluster that is associated with the lake storage.', 'type' => 'string', 'example' => 'amv-23xxxx'], + 'FileSize' => ['title' => '', 'description' => 'The total storage size.'."\n", 'type' => 'string', 'example' => '142'], + 'RowCount' => ['title' => '', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '>=', 'pattern' => '', 'default' => ''], + 'TableCount' => ['title' => '', 'description' => 'The number of tables.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1234', 'pattern' => '', 'default' => ''], + 'PartitionCount' => ['description' => 'The number of partitions.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'CreatorUid' => ['title' => '', 'description' => 'The creator UID.'."\n", 'type' => 'string', 'example' => '123456'], + 'OwnerUid' => ['title' => '', 'description' => 'The owner UID.'."\n", 'type' => 'string', 'example' => '123456'], + 'OperatorUid' => ['title' => '', 'description' => 'The operator UID.'."\n", 'type' => 'string', 'example' => '123456'], + 'Permissions' => [ + 'title' => '', + 'description' => 'The permissions on the lake storage.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The permissions.'."\n", + 'type' => 'object', + 'properties' => [ + 'Read' => ['title' => '', 'description' => 'The read permissions.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Write' => ['title' => '', 'description' => 'The write permissions.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'Account' => ['title' => '', 'description' => 'The account ID.'."\n", 'type' => 'string', 'example' => 'test', 'pattern' => '^\\d+$', 'default' => ''], + 'Type' => [ + 'title' => '', + 'description' => 'The account type.'."\n", + 'type' => 'string', + 'example' => 'SUB', + 'enum' => ['CUSTOMER', 'SUB', 'STS'], + ], + ], + 'example' => '-', + ], + 'example' => '-', + 'maxItems' => 20, + 'minItems' => 0, + ], + 'CreateTime' => ['title' => '', 'description' => 'The time when the lake storage was created.'."\n", 'type' => 'string', 'example' => '2023-05-15T07:24:58Z'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the lake storage was last updated.'."\n", 'type' => 'string', 'example' => '2024-07-01T09:22:17Z'], + 'RegionId' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + 'example' => '-', + 'title' => '', ], + 'HttpStatusCode' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request is successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Valid values:'."\n" + ."\n" + .'* If the request was successful, an OK message is returned.'."\n" + .'* If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'ModifyApsDatasoure', - 'description' => '### [](#)'."\n" - ."\n" - .'* You can call this operation only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition that have 32 cores or more.'."\n" - .'* You cannot modify the number of nodes for the USER_DEFAULT resource group.'."\n", - ], - 'ModifyApsWorkloadName' => [ - 'summary' => 'Modifies the AnalyticDB Pipeline Service (APS) workload name.', - 'methods' => [ - 'get', - 'post', + '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' => 'UpdateLakeStorage', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLakeStorage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:UpdateLakeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateSparkTemplateFile' => [ + 'summary' => 'Updates a Spark application template.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -42216,4284 +32682,4673 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '170156', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsY28JLD', - ], + 'abilityTreeCode' => '123242', + 'abilityTreeNodes' => ['FEATUREadsUF9CN9'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'amv-pz5vp4585l466****', 'maxLength' => 64], ], [ - 'name' => 'DBClusterId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-*******', - ], + 'schema' => ['title' => '', 'description' => 'The application template ID.'."\n" + ."\n" + .'> You can call the [GetSparkTemplateFullTree](~~456205~~) operation to query the application template ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '718056'], ], [ - 'name' => 'WorkloadId', + 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-******', - ], + 'schema' => ['title' => '', 'description' => 'The template data to be updated.'."\n" + ."\n" + .'> If you do not specify this parameter, the application template is not updated. For information about how to configure a Spark application template, see [Configure a Spark application](~~452402~~).'."\n", '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' => 'WorkloadName', + 'name' => 'ResourceGroupName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workload.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sls-2024***93014', - ], + 'schema' => ['title' => '', 'description' => 'The name of the job resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adb'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The status code. A value of 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C3A9594F-1D40-4472-A96C-8FB8AA20D38C'], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput'."\n", - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', + 'description' => 'The update result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Succeeded' => ['title' => '', 'description' => 'Indicates whether the application template is updated.'."\n" + ."\n" + .'* **True**'."\n" + .'* **False**'."\n", 'type' => 'boolean', 'example' => 'True'], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => 'The response parameters.', + 'example' => '', ], ], ], - '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' => 'ModifyApsWorkloadName', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeApsDatasources' => [ - 'summary' => 'Queries a list of AnalyticDB Pipeline Service (APS) data sources.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Spark.InvalidParameter', 'errorMessage' => 'Invalid parameter value: %s', 'description' => 'Incorrect input parameter:%s.'], + ['errorCode' => 'Spark.TemplateFile.BadFileType', 'errorMessage' => 'The requested template %s is not a file.', 'description' => 'The specified template file ID is not of the file type.'], + ['errorCode' => 'Spark.InvalidState', 'errorMessage' => 'The object of the operation is in an invalid state: %s', 'description' => 'The operation object is invalid.'], + ['errorCode' => 'Spark.Log.IllegalPath', 'errorMessage' => 'Invalid job log URI: %s.', 'description' => 'The Spark log path is invalid.'], + ['errorCode' => 'Spark.Log.InvalidState', 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['errorCode' => 'Spark.Oss.InternalError', 'errorMessage' => 'An OSS internal error occurred: %s', 'description' => 'OSS internal error. The request failed.'], + ['errorCode' => 'Spark.RoleArn.Invalid', 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ], + 403 => [ + ['errorCode' => 'Spark.Forbidden', 'errorMessage' => 'No permissions to access the resources: %s', 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ], + [ + ['errorCode' => 'Spark.ObjectNotFound', 'errorMessage' => 'The object is not found. More information: %s', 'description' => 'The target object does not exist. Associated information: %s.'], + ['errorCode' => 'Spark.TemplateFile.FileNotFound', 'errorMessage' => 'The template file %s is not found.', 'description' => 'Failed to find the specified template file.'], + ['errorCode' => 'Spark.TemplateFile.TemplateNotFound', 'errorMessage' => 'The template %s is not found.', 'description' => 'The template file was not found.'], + ['errorCode' => 'Spark.Log.PodLogNotFound', 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', 'description' => 'Unable to find log [%s] for corresponding pod via podName.'], + ], + 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', 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ], + ], + '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' => 'UpdateSparkTemplateFile', + 'description' => '* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n" + ."\n" + .'> If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.'."\n", + 'changeSet' => [ + ['createdAt' => '2023-06-28T01:10:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSparkTemplateFile'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:UpdateSparkTemplateFile', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'SparkTemplate', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/template/{#TemplateId}'], + ], + ], + ], ], + ], + 'UpgradeKernelVersion' => [ + 'summary' => 'Updates the minor version of an AnalyticDB for MySQL cluster.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsY28JLD', - 'FEATUREadsCORDM7', - ], + 'abilityTreeNodes' => ['FEATUREadsQEKELU'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL Data Warehouse Edition clusters within a region, including cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'am-uf6g8w25jacm7****', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '30', - ], + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => 'The minor version to which you want to update.'."\n" + ."\n" + .'> You can call the **DescribeKernelVersion** operation to query the supported minor versions.'."\n", 'type' => 'string', 'required' => false, 'example' => '3.1.9', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-******', - ], - ], - [ - 'name' => 'DatasourceType', - 'in' => 'formData', + 'name' => 'SwitchMode', + 'in' => 'query', 'schema' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', + 'description' => 'The time when to perform the update. Valid values:'."\n" + ."\n" + .'* **0** (default): immediately performs the update.'."\n" + .'* **1**: performs the update during the maintenance window.'."\n" + ."\n" + .'> You can call the [ModifyDBClusterMaintainTime](~~612236~~) operation to modify the maintenance window of an AnalyticDB for MySQL cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'SLS', + 'example' => '0', + 'enum' => ['0', '1'], + 'title' => '', ], ], - [ - 'name' => 'DatasourceName', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A444FFFFFF'], + ], + 'example' => '', ], ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-01-01', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpgradeKernelVersion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeKernelVersion'], ], + ], + 'ramActions' => [ [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-01-30', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:UpgradeKernelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-5213-******-B608-******', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ApsDatasources' => [ - 'description' => 'The queried APS data sources.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DatasourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CreateTime' => [ - 'description' => 'The time when the data source was created.'."\n", - 'type' => 'string', - 'example' => '2024-01-10 14:44:33', - ], - 'DatasourceType' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'example' => 'SLS', - ], - 'DatasourceDescription' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DatasourceId' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'HasJob' => [ - 'description' => 'Indicates whether a job is using the data source.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - 'example' => '-', - 'description' => 'The queried APS data source.', - ], - 'example' => '-', - ], - ], - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A444FFFFFF\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-chengdu.aliyuncs.com', 'endpoint' => 'adb.cn-chengdu.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'adb.cn-wulanchabu.aliyuncs.com', 'vpc' => 'adb-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-beijing.aliyuncs.com', 'endpoint' => 'adb.cn-beijing.aliyuncs.com', 'vpc' => 'adb-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-qingdao.aliyuncs.com', 'endpoint' => 'adb.cn-qingdao.aliyuncs.com', 'vpc' => 'adb-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-shanghai.aliyuncs.com', 'endpoint' => 'adb.cn-shanghai.aliyuncs.com', 'vpc' => 'adb-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-hongkong.aliyuncs.com', 'endpoint' => 'adb.cn-hongkong.aliyuncs.com', 'vpc' => 'adb-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'adb.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'adb-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-shenzhen.aliyuncs.com', 'endpoint' => 'adb.cn-shenzhen.aliyuncs.com', 'vpc' => 'adb-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.ap-northeast-2.aliyuncs.com', 'endpoint' => 'adb.ap-northeast-2.aliyuncs.com', 'vpc' => 'adb-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.ap-northeast-1.aliyuncs.com', 'endpoint' => 'adb.ap-northeast-1.aliyuncs.com', 'vpc' => 'adb-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-guangzhou.aliyuncs.com', 'endpoint' => 'adb.cn-guangzhou.aliyuncs.com', 'vpc' => 'adb-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.ap-southeast-1.aliyuncs.com', 'endpoint' => 'adb.ap-southeast-1.aliyuncs.com', 'vpc' => 'adb-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.ap-southeast-2.aliyuncs.com', 'endpoint' => 'adb.ap-southeast-2.aliyuncs.com', 'vpc' => 'adb-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.ap-southeast-3.aliyuncs.com', 'endpoint' => 'adb.ap-southeast-3.aliyuncs.com', 'vpc' => 'adb-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.cn-huhehaote.aliyuncs.com', 'endpoint' => 'adb.cn-huhehaote.aliyuncs.com', 'vpc' => 'adb-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.ap-southeast-5.aliyuncs.com', 'endpoint' => 'adb.ap-southeast-5.aliyuncs.com', 'vpc' => 'adb-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.ap-southeast-6.aliyuncs.com', 'endpoint' => 'adb.ap-southeast-6.aliyuncs.com', 'vpc' => 'adb-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.ap-southeast-7.aliyuncs.com', 'endpoint' => 'adb.ap-southeast-7.aliyuncs.com', 'vpc' => 'adb-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'adb.aliyuncs.com', 'endpoint' => 'adb.aliyuncs.com', 'vpc' => 'adb-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'adb.us-east-1.aliyuncs.com', 'endpoint' => 'adb.us-east-1.aliyuncs.com', 'vpc' => 'adb-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'adb.eu-west-1.aliyuncs.com', 'endpoint' => 'adb.eu-west-1.aliyuncs.com', 'vpc' => 'adb-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'adb.us-west-1.aliyuncs.com', 'endpoint' => 'adb.us-west-1.aliyuncs.com', 'vpc' => 'adb-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'adb.eu-central-1.aliyuncs.com', 'endpoint' => 'adb.eu-central-1.aliyuncs.com', 'vpc' => 'adb-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'adb.na-south-1.aliyuncs.com', 'endpoint' => 'adb.na-south-1.aliyuncs.com', 'vpc' => 'adb-vpc.na-south-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'adb.me-central-1.aliyuncs.com', 'endpoint' => 'adb.me-central-1.aliyuncs.com', 'vpc' => 'adb-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'adb.ap-south-1.aliyuncs.com', 'endpoint' => 'adb.ap-south-1.aliyuncs.com', 'vpc' => 'adb-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'adb.aliyuncs.com', 'endpoint' => 'adb.aliyuncs.com', 'vpc' => 'adb-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'adb.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'adb.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'adb-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'adb.aliyuncs.com', 'endpoint' => 'adb.aliyuncs.com', 'vpc' => 'adb-vpc.cn-beijing-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'adb.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'adb.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'adb-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'adb.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'adb.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'adb-vpc.cn-north-2-gov-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessDenied', 'message' => 'Unauthorized access.', 'http_code' => 400, 'description' => 'Unauthorized access.'], + ['code' => 'AccountLimitExceeded', 'message' => 'The maximum number of accounts is exceeded.', 'http_code' => 400, 'description' => 'The maximum number of accounts has been reached.'], + ['code' => 'ACS.Account.NotExist', 'message' => 'The account is not found.', 'http_code' => 400, 'description' => 'The specified RAM user does not exist.'], + ['code' => 'ACS.Account.UserHasBind', 'message' => 'The user has been associated with another database account %s.', 'http_code' => 400, 'description' => 'The RAM user is associated with another database account.'], + ['code' => 'ACS.AssumeRoleError', 'message' => 'The AliyunAdbFullAccess permission is required for the RAM role to manage clusters.', 'http_code' => 400, 'description' => 'The RAM user does not have the AliyunAdbFullAccess permission.'], + ['code' => 'ACS.Clickhouse.ClickhouseEngineNotAllowed', 'message' => 'ClickHouse engine not allowed.', 'http_code' => 400, 'description' => 'clickhouse engine not allowed'."\n"], + ['code' => 'ACS.Clickhouse.ClickhouseEngineNotAllowed', 'message' => 'Clickhouse engine not allowed cause %s.', 'http_code' => 400, 'description' => 'Clickhouse engine not allowed'], + ['code' => 'ACS.Cluster.ElasticPlanJobsExists', 'message' => 'Operation failed. Ongoing elastic plan jobs exist.', 'http_code' => 400, 'description' => 'Failed to perform this operation because a storage scaling plan job is running.'], + ['code' => 'ACS.Cluster.InvalidState', 'message' => 'The state of the cluster does not support this operation.', 'http_code' => 400, 'description' => 'The status of the cluster does not support the current operation.'], + ['code' => 'ACS.Cluster.InvalidWorkerState', 'message' => 'The state of the worker does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported due to the current state of the storage node.'], + ['code' => 'ACS.Connection.CannotCreate', 'message' => 'Instance type %s cannot create connection.', 'http_code' => 400, 'description' => 'The child instance type does not support creating a connection'], + ['code' => 'ACS.DescribeDBClusterAttributeFailed', 'message' => 'DescribeDBClusterAttributeFailed.', 'http_code' => 400, 'description' => 'Corresponding instance not found'], + ['code' => 'ACS.ElasticPlan.AutoWorkerPlanExists', 'message' => 'Failed to enable the elastic plan. The instance already has an active elastic plan.', 'http_code' => 400, 'description' => 'Failed to enable the storage scaling plan because the cluster has another storage scaling plan enabled.'], + ['code' => 'ACS.ElasticPlan.InvalidEndTime', 'message' => 'The end time should be later than current time.', 'http_code' => 400, 'description' => 'The end time of scheduled scaling must be later than the current time.'], + ['code' => 'ACS.ElasticPlan.InvalidStartTime', 'message' => 'Invalid start time.', 'http_code' => 400, 'description' => 'The start time of the elastic plan is invalid.'], + ['code' => 'ACS.ElasticPlan.InvalidStartTimeInterval', 'message' => 'The start time of this elastic plan is too closed to another one.', 'http_code' => 400, 'description' => 'The effective time of the scaling plan is close to that of another scaling plan.'], + ['code' => 'ACS.ElasticPlan.InvalidTargetSize', 'message' => 'Invalid target size.', 'http_code' => 400, 'description' => 'The target specification is invalid.'], + ['code' => 'ACS.ElasticPlan.InvalidTodayPlan', 'message' => '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.', 'http_code' => 400, 'description' => 'Failed to enable the elastic plan. The elastic scaling operation cannot be triggered at the configured time today. Make sure that the configured time is later than the earliest available time (current time plus %s minutes for resource preparation).'], + ['code' => 'ACS.ElasticPlan.NameAlreadyExists', 'message' => 'The name already exists.', 'http_code' => 400, 'description' => 'A scaling plan with the same name exists.'], + ['code' => 'ACS.ElasticPlan.NotFound', 'message' => 'The elastic plan is not found.', 'http_code' => 404, 'description' => 'The elastic plan is not found'], + ['code' => 'ACS.ElasticPlan.WorkerNotFound', 'message' => 'Worker not found.', 'http_code' => 400, 'description' => 'The cluster cannot have storage scaling plans configured because it does not have reserved storage resources.'], + ['code' => 'ACS.ElasticPlan.WorkerPlanExists', 'message' => 'Failed to enable the elastic plan. At least one active elastic plan already exists.', 'http_code' => 400, 'description' => 'Failed to enable the storage scaling plan because another storage scaling plan has been enabled.'], + ['code' => 'ACS.Instance.InvalidState', 'message' => 'The state of the instance does not support this operation.', 'http_code' => 400, 'description' => 'The status of the child instance does not support the current operation'], + ['code' => 'ACS.InvalidParameter.%s', 'message' => 'Parameter %s is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], + ['code' => 'ACS.OperationFailed', 'message' => 'The specific operation is failed.', 'http_code' => 400, 'description' => 'ADB Cloud Service Service Error'], + ['code' => 'ACS.Parameter.Malformed', 'message' => 'The following required parameters are not specified: %s', 'http_code' => 400, 'description' => 'You must specify the required parameters.'], + ['code' => 'ACS.Privilege.ModifyFailed', 'message' => 'Failed to modify the account privilege. Make sure that bound account have sufficient database privileges.', 'http_code' => 400, 'description' => 'Failed to modify the database account permissions. Check whether the database account that is associated with the RAM user has sufficient database permissions.'], + ['code' => 'ACS.ResourceGroup.ElasticPlanExists', 'message' => 'This resource group does not support this operation. Elastic plans that have been enabled already exist.', 'http_code' => 400, 'description' => 'This operation is not supported for the current resource group because a scaling plan has been enabled.'], + ['code' => 'ACS.ResourceGroup.InvalidResourceGroupState', 'message' => 'The state of this resource group does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported due to the current state of the resource group.'], + ['code' => 'ACS.ResourceGroup.OngoingJobExist', 'message' => 'Resource group has ongoing job like %s.', 'http_code' => 400, 'description' => 'Running jobs exist for resource group'], + ['code' => 'ACS.ResourceGroup.OngoingJobExists', 'message' => 'Resource group has ongoing job(s).', 'http_code' => 400, 'description' => 'The resource group has jobs in progress.'], + ['code' => 'ACS.SecurityIPsExceedLimit', 'message' => 'Provided security IPs exceed limit.', 'http_code' => 400, 'description' => 'The number of IP addresses exceeds the upper limit.'], + ['code' => 'ACS.ServerError', 'message' => 'ADB Cloud Service failed to process your request.', 'http_code' => 403, 'description' => 'An internal service error occurred.'], + ['code' => 'ACS.Sql.CannotConnect', 'message' => 'Cannot connect instance which type is %s.', 'http_code' => 400, 'description' => 'Cannot connect to a child instance of the given type.'], + ['code' => 'ACS.UnsupportedAvailableZone', 'message' => 'The specified available zone is not supported.', 'http_code' => 400, 'description' => 'The specified zone is not supported.'], + ['code' => 'ACS.User.DatabaseAccountHasBind', 'message' => 'The database account has been bound to %s.', 'http_code' => 400, 'description' => 'The database account is associated with a RAM user.'], + ['code' => 'ACS.User.NotBindDatabaseAccount', 'message' => 'The user has not been associated with a database account.', 'http_code' => 400, 'description' => 'The user is not associated with the database account.'], + ['code' => 'AcsServerTimeOut', 'message' => 'The request has failed due to Adb Cloud Service time out.', 'http_code' => 408, 'description' => 'The backend service timed out. Please try again later.'], + ['code' => 'ADB.InnerDescribeClusters', 'message' => 'Failed to query clusters by inner api.', 'http_code' => 400, 'description' => 'Query'], + ['code' => 'ADBClassNotSupport', 'message' => 'The specified instance type does not support this operation.', 'http_code' => 400, 'description' => 'The specified instance type does not support this operation.'], + ['code' => 'ADBConsoleAPIError', 'message' => 'Instance console api query return failed.', 'http_code' => 503, 'description' => 'The instance console API operation failed.'], + ['code' => 'ADBConsoleAPITimeout', 'message' => 'Instance console api query timeout.', 'http_code' => 503, 'description' => 'The instance console API operation timed out.'], + ['code' => 'ADBVersionNotSupport', 'message' => 'ADB version not support. pls upgrade the cluster version first.', 'http_code' => 400, 'description' => 'The current ADB kernel version is not supported. Upgrade the kernel version first.'], + ['code' => 'AnalyticDBKernelError', 'message' => 'Failed to invoke AnalyticDB kernel.', 'http_code' => 400, 'description' => 'An engine error occurred.'], + ['code' => 'ApiVersionForbidden', 'message' => 'The version parameter is not correct.', 'http_code' => 400, 'description' => 'The specified Version parameter is invalid.'], + ['code' => 'APS.Forbidden', 'message' => 'No permissions to access the resources: %s .', 'http_code' => 403, 'description' => 'Insufficient permission to deny access to the associated resource. The information you are currently requesting access to is:%s.'], + ['code' => 'ClickHouseEngineNotAllowed', 'message' => 'ClickHouse engine not allowed cause %s.', 'http_code' => 400, 'description' => 'clickhouse engine not allowed'], + ['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'The module you purchased is invalid.', 'http_code' => 400, 'description' => 'The module you purchased is not legal. Please purchase again'], + ['code' => 'ConfigSyncJob.Duplicate', 'message' => 'There is another sync job configuring, please retry it later.', 'http_code' => 400, 'description' => 'A synchronization task is in progress. Try again later.'], + ['code' => 'ConfigSyncJobDuplicate', 'message' => 'There is another sync job configuring, please retry it later.', 'http_code' => 400, 'description' => 'There is already another synchronization task being configured, please wait and try again.'], + ['code' => 'Console.ConnectClusterFailed', 'message' => 'Failed to connect to the database instance through the JDBC protocol.', 'http_code' => 400, 'description' => 'Failed to connect to the database instance through the JDBC protocol'], + ['code' => 'Console.ExecuteSubmitFailed', 'message' => 'Failed to submit SQL execution task.', 'http_code' => 400, 'description' => 'Failed to submit the SQL execution task.'], + ['code' => 'Console.InternalServerError', 'message' => 'Internal Server Error.', 'http_code' => 500, 'description' => 'System internal error'], + ['code' => 'Console.MissingTraceId', 'message' => 'The trace id in the message is missing, please contact the administrator.', 'http_code' => 400, 'description' => 'The TRACE ID is missing from the message. Contact the administrator.'], + ['code' => 'Console.NotFound', 'message' => 'The resource is not found.', 'http_code' => 404, 'description' => 'Resource does not exist'], + ['code' => 'Console.ParamsUnavailable', 'message' => 'The params are invalid.', 'http_code' => 400, 'description' => 'Illegal input parameter'], + ['code' => 'Console.SendMessageFailed', 'message' => 'Failed to send websocket message to client.', 'http_code' => 400, 'description' => 'Failed to send a message to the WebSocket client.'], + ['code' => 'Console.SessionExpired', 'message' => 'User identity authentication failed, traceId and login ticket does not match, please login again.', 'http_code' => 400, 'description' => 'User authentication failed. The traceId does not match the logon session ticket. Log on again.'], + ['code' => 'Console.SessionExpired', 'message' => 'User’s login credentials have expired, please login again.', 'http_code' => 400, 'description' => 'User authentication failed. The traceId does not match the logon session ticket. Log on again.'], + ['code' => 'Console.UnknownMessage', 'message' => 'This type of message is not supported, only allow `Heartbeat`, `ExecuteSQL`, `CancelExecuteSQL`', 'http_code' => 400, 'description' => 'This message type is not supported. Only `Heartbeat`, `ExecuteSQL`, and `CancelExecuteSQL` are allowed.'], + ['code' => 'CREATE_PROCESS_DEFINITION_ERROR', 'message' => 'Failed to create process definition.', 'http_code' => 400, 'description' => 'Failed to create process definition.'], + ['code' => 'CrossUser.CheckFailed', 'message' => 'The input UID and role is not authorized.', 'http_code' => 403, 'description' => 'cross-account authentication failed. check whether the entered uid and role are correct, and whether the role trusts the adb service account'], + ['code' => 'DBNodeGroupCount', 'message' => 'The specified parameter "DBNodeGroupCount" is not valid.', 'http_code' => 400, 'description' => 'Illegal entry DBNodeGroupCount'], + ['code' => 'DeleteBackupError', 'message' => 'At least one backup set must be retained.', 'http_code' => 401, 'description' => 'At least one backup set must be retained.'], + ['code' => 'ElasticIOResourceCannotChange', 'message' => 'ElasticIOResource can not change.', 'http_code' => 400, 'description' => 'Elastic IO resources cannot be changed'], + ['code' => 'ElasticIOResourceInvalid', 'message' => 'ElasticIOResource Number is not valid, the range is %s to %s.', 'http_code' => 400, 'description' => 'The number of ElasticIOResource is incorrect, and the correct range is 1-200'], + ['code' => 'ElasticPlanParameterError', 'message' => 'The specified elastic plan parameter is invalid.', 'http_code' => 400, 'description' => 'The specified elastic plan parameter is invalid.'], + ['code' => 'Forbidden', 'message' => 'This operation is not allowed.', 'http_code' => 403, 'description' => 'This operation is prohibited.'], + ['code' => 'Forbidden', 'message' => 'You do not have the authority to operate.', 'http_code' => 401, 'description' => 'You have no permission to initiate the request.'], + ['code' => 'IncorrectDBInstanceLockMode', 'message' => 'The specified instance lock mode does not support this operation.', 'http_code' => 400, 'description' => 'The specified instance lock mode does not support this operation.'], + ['code' => 'IncorrectDBInstanceState', 'message' => 'The specified instance state does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported while the instance is in the current state.'], + ['code' => 'IncorrectModuleVersion', 'message' => 'The specified module version does not support this operation.', 'http_code' => 400, 'description' => 'The specified module version does not support this operation.'], + ['code' => 'IncorrectTaskStatus', 'message' => 'Status of certain task does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported when the task is in the current state. Confirm that the task status is valid.'], + ['code' => 'InsufficientResourceCapacity', 'message' => 'Insufficient resources.', 'http_code' => 400, 'description' => 'Insufficient resources.'], + ['code' => 'InternalError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => 'An internal error occurred. Please try again later.'], + ['code' => 'InternalFailure', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => 'An internal error has occurred. Please try again later.'], + ['code' => 'InternalServerError', 'message' => 'Internal Server Error', 'http_code' => 500, 'description' => 'An internal server error occurred. Please try again later.'], + ['code' => 'InvalidAccountDescription.Malformed', 'message' => 'The specified parameter AccountDescription is not valid.', 'http_code' => 400, 'description' => 'The AccountDescription parameter is invalid. Check the parameter.'], + ['code' => 'InvalidAccountName.Malformed', 'message' => 'The specified parameter AccountName is not valid.', 'http_code' => 400, 'description' => 'The AccountName parameter is invalid. Check the parameter.'], + ['code' => 'InvalidAccountPassword.Malformed', 'message' => 'The specified parameter AccountPassword is not valid.', 'http_code' => 400, 'description' => 'The AccountPassword parameter is invalid. Check the parameter.'], + ['code' => 'InvalidAccountType.Malformed', 'message' => 'The specified parameter AccountType is not valid.', 'http_code' => 400, 'description' => 'The AccountType parameter is invalid. Check the parameter.'], + ['code' => 'InvalidAction', 'message' => 'Specified action is not valid.', 'http_code' => 400, 'description' => 'The specified Action parameter is invalid.'], + ['code' => 'InvalidApi.NotFound', 'message' => 'Request was denied due to user flow control.', 'http_code' => 400, 'description' => 'The request is throttled.'], + ['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter BackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => 'The BackupRetentionPeriod parameter is invalid. Check the parameter.'], + ['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter "BackupRetentionPeriod" should be within [7-%s] days.', 'http_code' => 400, 'description' => '%s'], + ['code' => 'InvalidConnectionString.Malformed', 'message' => 'The specified parameter "ConnectionString" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter "ConnectionString" is not valid.'], + ['code' => 'InvalidConnectionString.UnSupported', 'message' => 'The specified parameter "ConnectionString" Only support vpc address.', 'http_code' => 400, 'description' => 'Parameter ConnectString only supports VPC addresses'], + ['code' => 'InvalidConnectionStringPrefix.Malformed', 'message' => 'The specified connection string is invalid.', 'http_code' => 400, 'description' => 'The specified connection string is invalid.'], + ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['code' => 'InvalidDBClusterDescription.Malformed', 'message' => 'The specified parameter DBClusterDescription is not valid.', 'http_code' => 400, 'description' => 'The DBClusterDescription parameter is invalid. Check the parameter.'], + ['code' => 'InvalidDBClusterId.Malformed', 'message' => 'The specified parameter DBClusterId is not valid.', 'http_code' => 400, 'description' => 'The DBClusterId parameter is invalid. Check the parameter.'], + ['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 400, 'description' => 'The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.'], + ['code' => 'InvalidDBClusterIPArrayName.Malformed', 'message' => 'The specified parameter DBClusterIPArrayName is not valid.', 'http_code' => 400, 'description' => 'The DBClusterIPArrayName parameter is invalid. Check the parameter.'], + ['code' => 'InvalidDBInstanceGroupCount', 'message' => 'Specified DB instance Group Count is not valid.', 'http_code' => 400, 'description' => 'Incorrect number of nodes specified'], + ['code' => 'InvalidElasticPlanType.Malformed', 'message' => 'The specified parameter "ElasticPlanType" is not valid.', 'http_code' => 400, 'description' => 'ElasticPlanType error'], + ['code' => 'InvalidElasticPlanWorkerSpec.Malformed', 'message' => 'The specified parameter "ElasticPlanWorkerSpec" is not valid.', 'http_code' => 400, 'description' => 'Illegal parameter ElasticPlanWorkerSpec'], + ['code' => 'InvalidInput', 'message' => 'Invalid input.', 'http_code' => 400, 'description' => 'The OpenAPI input parameter is invalid.'], + ['code' => 'InvalidInstanceCrossBackupEnabled.Malformed', 'message' => 'The specified parameter "BackupEnabled" is not valid.', 'http_code' => 400, 'description' => 'Parameter BackupEnabled does not exist or is illegal'], + ['code' => 'InvalidMaintainTime.Malformed', 'message' => 'The specified parameter MaintainTime is not valid.', 'http_code' => 400, 'description' => 'The MaintainTime parameter is invalid. Check the parameter.'], + ['code' => 'InvalidMaxComputeResource.Malformed', 'message' => 'The specified parameter MaxComputeResource is not valid.', 'http_code' => 400, 'description' => 'The MaxComputeResource parameter is invalid. Check the parameter.'], + ['code' => 'InvalidMinComputeResource.Malformed', 'message' => 'The specified parameter MinComputeResource is not valid.', 'http_code' => 400, 'description' => 'The MinComputeResource parameter is invalid. Check the parameter.'], + ['code' => 'InvalidOperation', 'message' => 'The specified parameter "Operation" is not valid, please choose one of Buy, Modify or Migrate.', 'http_code' => 400, 'description' => 'The entry Operation is illegal. Only Buy, Modify or Migrate are supported.'], + ['code' => 'InvalidParameter.ComputeResource', 'message' => 'The specified parameter "ComputeResource" is not valid.', 'http_code' => 400, 'description' => 'Illegal entry ComputeResource'], + ['code' => 'InvalidParameter.DBNodeClass', 'message' => 'The specified parameter "DBNodeClass" is not valid.', 'http_code' => 400, 'description' => 'Illegal entry DBNodeClass'], + ['code' => 'InvalidParameter.DBNodeGroupCount', 'message' => 'The specified parameter "DBNodeGroupCount" is not valid.', 'http_code' => 400, 'description' => 'Incorrect DBNodeGroupCount parameters'], + ['code' => 'InvalidParameter.Name', 'message' => 'The specified parameter Name is not valid.', 'http_code' => 400, 'description' => 'The Name parameter is missing or invalid.'], + ['code' => 'InvalidParameter.Resource', 'message' => 'The specified parameter Resource is not valid.', 'http_code' => 400, 'description' => 'The Resource parameter is invalid. Check the parameter.'], + ['code' => 'InvalidPayType.Malformed', 'message' => 'The specified parameter "PayType" is not changed.', 'http_code' => 400, 'description' => 'The payment type has not been modified.'], + ['code' => 'InvalidPoolName.Malformed', 'message' => 'The specified parameter PoolName is not valid.', 'http_code' => 400, 'description' => 'The PoolName parameter is invalid. Check the parameter.'], + ['code' => 'InvalidPoolType.Malformed', 'message' => 'The specified parameter PoolType is not valid.', 'http_code' => 400, 'description' => 'The PoolType parameter is invalid. Check the parameter.'], + ['code' => 'InvalidPoolUser.Malformed', 'message' => 'The specified parameter PoolUser is not valid.', 'http_code' => 400, 'description' => 'The PoolUser parameter is invalid. Check the parameter.'], + ['code' => 'InvalidPreferredBackupPeriod.Malformed', 'message' => 'The specified parameter PreferredBackupPeriod is not valid.', 'http_code' => 400, 'description' => 'PreferredBackupPeriod'], + ['code' => 'InvalidPreferredBackupTime.Malformed', 'message' => 'The specified parameter PreferredBackupTime is not valid.', 'http_code' => 400, 'description' => 'The PreferredBackupTime parameter is invalid. Check the parameter.'], + ['code' => 'InvalidRemoteBackupRegion.Malformed', 'message' => 'The specified parameter "RemoteBackupRegion" is not valid.', 'http_code' => 400, 'description' => 'Parameter "RemoteBackupRegion" does not exist or is illegal'], + ['code' => 'InvalidSecurityIPList.Duplicate', 'message' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'http_code' => 400, 'description' => 'The specified IP address is duplicate. Specify a valid IP address.'], + ['code' => 'InvalidSecurityIPList.Malformed', 'message' => 'The specified SecurityIPList is incorrectly formatted.', 'http_code' => 400, 'description' => 'The specified security group parameter is invalid.'], + ['code' => 'InvalidStartTime.Malformed', 'message' => 'The specified StartTime is invalid.', 'http_code' => 400, 'description' => 'The specified StarTime parameter is invalid.'], + ['code' => 'InvalidTagValue.Malformed', 'message' => 'The specified parameter Tag.n.Value is invalid.', 'http_code' => 400, 'description' => 'The specified Tag.n.Value parameter is invalid.'], + ['code' => 'InvalidUser.NotFound', 'message' => 'Specified user does not exist.', 'http_code' => 400, 'description' => 'The requested user does not exist in the system'], + ['code' => 'InvalidViewName.Malformed', 'message' => 'The specified parameter "ViewName" is not valid.', 'http_code' => 400, 'description' => 'The input ViewName is missing.'], + ['code' => 'InvalidVPC.NotFound', 'message' => 'VPC or VSwitch is not valid.', 'http_code' => 404, 'description' => 'VPC or VSwitch does not exist'], + ['code' => 'InvalidWorkerGroupNumber', 'message' => 'Invalid worker group number, because %s.', 'http_code' => 401, 'description' => 'The number of elastic IO resources is incorrect.'], + ['code' => 'InvokeSLSException', 'message' => 'Failed to invoke Log Service.', 'http_code' => 400, 'description' => 'An error occurred while calling the Log Service API.'], + ['code' => 'InvokeSLSException', 'message' => 'An exception occured while invoke SLS Service.Failed to invoke Log Service.', 'http_code' => 400, 'description' => 'Exception while calling SLS service, call failed'], + ['code' => 'MDS.IllegalArgument', 'message' => 'Invalid argument.', 'http_code' => 400, 'description' => 'An invalid parameter is used.'], + ['code' => 'MDS.InternalError', 'message' => 'An internal MDS error occurred.', 'http_code' => 500, 'description' => 'An internal error occurred.'], + ['code' => 'MDS.InvalidPrivilege', 'message' => 'No permissions.', 'http_code' => 400, 'description' => 'You are not authorized to perform this operation.'], + ['code' => 'MDS.MetaSchemaAlreadyExist', 'message' => 'The database already exists.', 'http_code' => 400, 'description' => 'The specified database already exists.'], + ['code' => 'MDS.MetaSchemaNotExist', 'message' => 'The database does not exist.', 'http_code' => 400, 'description' => 'The specified database does not exist.'], + ['code' => 'MDS.MetaTableAlreadyExist', 'message' => 'The table already exists.', 'http_code' => 400, 'description' => 'The specified table already exists.'], + ['code' => 'MDS.MetaTableNotExist', 'message' => 'The table is not found.', 'http_code' => 400, 'description' => 'The specified table does not exist.'], + ['code' => 'MDS.MetaVisitError', 'message' => 'Failed to access metadata.', 'http_code' => 500, 'description' => 'Failed to access the metadata.'], + ['code' => 'MDS.RamAuthAccessDenied', 'message' => 'ram auth access denied.', 'http_code' => 403, 'description' => 'RAM authentication failed'], + ['code' => 'MissingEcuType', 'message' => 'EcuType is mandatory for this action.', 'http_code' => 400, 'description' => 'You must specify the EcuType parameter.'], + ['code' => 'MissingParameter.PageSize', 'message' => 'The PageSize parameter is required.', 'http_code' => 400, 'description' => 'The PageSize parameter is not specified.'], + ['code' => 'MissingProjectName', 'message' => 'ProjectName is required.', 'http_code' => 400, 'description' => 'You must specify the ProjectName parameter.'], + ['code' => 'NotInInstanceCrossBackupWhitelist', 'message' => 'Not allow to enable instance cross backup cause dbClusterId not in whitelist.', 'http_code' => 403, 'description' => 'The cross-region backup policy of this instance is not allowed to be adjusted. Please contact ADB-M technical support to add the cluster to whitelist.'], + ['code' => 'OperationDenied.DBClusterPayType', 'message' => 'The specified instance pay type does not support this operation.', 'http_code' => 400, 'description' => 'The specified instance billing method does not support this operation.'], + ['code' => 'OperationDenied.DBClusterStatus', 'message' => 'The operation is not permitted due to cluster status.', 'http_code' => 403, 'description' => 'This operation is prohibited due to the current state of the cluster.'], + ['code' => 'OperationDenied.InvalidSourceDBCluster', 'message' => 'The operation is not permitted due to pc-wz9li839to71d2659 not synchronizing with this ADB cluster', 'http_code' => 400, 'description' => 'The specified source cluster ID is invalid. Check the cluster ID.'], + ['code' => 'OperationDenied.OrderProcessing', 'message' => 'User already has an order which is processing.', 'http_code' => 403, 'description' => 'User already has an order in process'], + ['code' => 'OperationDenied.OrderType', 'message' => 'The operation is not permitted due to the order type.', 'http_code' => 400, 'description' => 'Incorrect order type'], + ['code' => 'OperationDenied.ParallelOperateNodeStorage', 'message' => 'Nodes and storage resources cannot be changed at the same time.', 'http_code' => 400, 'description' => 'You cannot modify nodes and store resources at the same time.'], + ['code' => 'OperationDenied.RegionZoneNotSupport', 'message' => 'The specified region or zone does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported in the specified region or zone.'], + ['code' => 'PerformanceViewNotFound', 'message' => 'Performance view not found.', 'http_code' => 404, 'description' => 'Specified monitoring view name not found'], + ['code' => 'ProcessInstanceNotCompleted', 'message' => 'Process instance not completed', 'http_code' => 400, 'description' => 'This operation cannot be performed because the workflow instance is not completed.'], + ['code' => 'ProcessInstanceNotFailed', 'message' => 'Process instance not failed', 'http_code' => 400, 'description' => 'This operation cannot be performed because the workflow instance does not fail.'], + ['code' => 'ProcessInstanceNotRunning', 'message' => 'Process instance not running', 'http_code' => 400, 'description' => 'This operation cannot be performed because the workflow instance is not running.'], + ['code' => 'ProcessInstanceNotSuspended', 'message' => 'Process instance not suspended', 'http_code' => 400, 'description' => 'This operation cannot be performed because the workflow instance is not suspended.'], + ['code' => 'RelatedTaskNotFinish', 'message' => 'The related task does not finish.', 'http_code' => 400, 'description' => 'The related task has not finished.'], + ['code' => 'RemoteBackupRestoreToTimeError', 'message' => 'Remote backup restore to time is not allowed. The remote backup is not activated.', 'http_code' => 400, 'description' => 'The instance cross backup is not enabled, thus remote backup recovery is not available.'], + ['code' => 'RequiredParam.NotFound', 'message' => 'Required parameters are not specified.', 'http_code' => 400, 'description' => 'Required parameters are missing. Specify the required parameters and try again.'], + ['code' => 'SecurityIPList.Duplicate', 'message' => 'The specified IP address is duplicate.', 'http_code' => 400, 'description' => 'The specified IP address is duplicate.'], + ['code' => 'ServiceUnavailable', 'message' => 'An error occurred while processing your request.', 'http_code' => 503, 'description' => 'The system is unavailable. Please try again later.'], + ['code' => 'Spark.AnalyzeTask.AppStateNotAccepted', 'message' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'http_code' => 400, 'description' => 'Only Spark applications in a terminated state can be analyzed. The specified application does not meet this condition.'], + ['code' => 'Spark.AnalyzeTask.FailedToKill', 'message' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', 'http_code' => 400, 'description' => 'Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task and try again.'], + ['code' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', 'message' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', 'http_code' => 400, 'description' => 'You can perform log analysis only on Spark jobs that are in the terminated state.'], + ['code' => 'Spark.AnalyzeTask.NotFound', 'message' => 'The requested analysis task %s is not found.', 'http_code' => 404, 'description' => 'The log analysis task you requested to view does not exist. %s.'], + ['code' => 'Spark.App.ContentNotFound', 'message' => 'The requested content %s of the Spark application is not found.', 'http_code' => 404, 'description' => 'The submission content of the specified Spark job was not found.'], + ['code' => 'Spark.App.ExceedQuotaLimitation', 'message' => 'The Spark application resource request exceeds the quota limitation: %s.', 'http_code' => 400, 'description' => 'The Spark application resource request exceeds the quota limit: %s.'], + ['code' => 'Spark.App.InvalidAppTypeWhenSubmit', 'message' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', 'http_code' => 400, 'description' => 'The AppType type is illegal, please refer to using the document to specify the AppType suitable for your business.'], + ['code' => 'Spark.App.InvalidResourceSpec', 'message' => 'The requested resource type is not supported: %s.', 'http_code' => 400, 'description' => 'The requested resource model is not supported.'], + ['code' => 'Spark.App.KillNotAcceptable', 'message' => 'Can\'t kill the application %s in %s state.', 'http_code' => 406, 'description' => 'A Spark application in a non-deletable state cannot be deleted.'], + ['code' => 'Spark.App.KillOperationFailed', 'message' => 'Failed to kill the application %s, please retry in a few seconds.', 'http_code' => 400, 'description' => 'Failed to kill the Spark application. Try again later.'], + ['code' => 'Spark.App.NotFound', 'message' => 'The Spark application %s is not found.', 'http_code' => 404, 'description' => 'The specified Spark application was not found.'], + ['code' => 'Spark.App.ParameterConflict', 'message' => 'Conflicting parameters submitted: %s.', 'http_code' => 406, 'description' => 'There is a conflict in the configuration parameter for submitting a Spark job:'], + ['code' => 'Spark.App.ResourceNegativeError', 'message' => 'The requested resource MUST be positive: %s.', 'http_code' => 400, 'description' => 'The requested Spark resource amount must be a positive integer: %s.'], + ['code' => 'Spark.Config.InvalidAppFilePath', 'message' => 'The main driver file MUST be a valid OSS path. Current is %s.', 'http_code' => 400, 'description' => 'The main driver file address must be a valid OSS address. The current address is %s.'], + ['code' => 'Spark.Config.invalidConnectors', 'message' => 'The spark.adb.connectors configuration is invalid: %s', 'http_code' => 400, 'description' => 'The spark.adb.connectors configuration is incorrect.'], + ['code' => 'Spark.Config.InvalidDiskConfig', 'message' => 'The requested disk mount parameter is invalid: %s', 'http_code' => 400, 'description' => 'The disk mount configuration is incorrect.'], + ['code' => 'Spark.Config.InvalidDiskConfig', 'message' => 'The requested disk mount parameter is invalid: %s.', 'http_code' => 400, 'description' => 'The disk mount configuration is incorrect. The error message for related configuration parameters is %s.'], + ['code' => 'Spark.Config.InvalidHostAliasConfig', 'message' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', 'http_code' => 400, 'description' => 'The domain name mapping configuration is incorrect.'], + ['code' => 'Spark.Config.InvalidHostAliasConfig', 'message' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local.', 'http_code' => 400, 'description' => 'Domain name mapping configuration error.'], + ['code' => 'Spark.Config.InvalidLogOssPath', 'message' => 'The OSS address for log storage is illegal: %s', 'http_code' => 400, 'description' => 'The OSS address for storing logs is invalid.'], + ['code' => 'Spark.Config.InvalidRoleArnFormat', 'message' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', 'http_code' => 400, 'description' => 'The configured RoleARN format is incorrect.'], + ['code' => 'Spark.Config.InvalidRoleArnFormat', 'message' => 'Configure RoleARN %s invalid format.', 'http_code' => 400, 'description' => 'The configured RoleARN %s is in the wrong format.'], + ['code' => 'Spark.Config.InvalidTimeZone', 'message' => 'Unable to parse time zone configuration %s : %s', 'http_code' => 400, 'description' => 'The time zone configuration is incorrect.'], + ['code' => 'Spark.Config.InvalidTimeZone', 'message' => 'Unable to parse time zone configuration %s, %s.', 'http_code' => 400, 'description' => 'Time zone configuration error, error message:%s.'], + ['code' => 'Spark.Config.LogOssPathNotExists', 'message' => 'Spark app log path %s is not exists.', 'http_code' => 400, 'description' => 'The Spark log address %s does not exist.'], + ['code' => 'Spark.Config.MainAppFileNotExists', 'message' => 'The main driver file is missing, [file] or [sqls] must be configured.', 'http_code' => 400, 'description' => 'The main driver file is missing. The file or sqls configuration must not be empty.'], + ['code' => 'Spark.Config.OSSPathAccessError', 'message' => 'The configured OSS address %s cannot be accessed.', 'http_code' => 400, 'description' => 'The configured OSS path is inaccessible.'], + ['code' => 'Spark.Config.OSSPathNotExists', 'message' => 'The OSS address %s requested does not exist or the permissions are insufficient.', 'http_code' => 400, 'description' => 'The OSS path does not exist or the current user does not have permission to access it.'], + ['code' => 'Spark.Config.RoleArnVerifyFailed', 'message' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', 'http_code' => 400, 'description' => 'The RoleARN parameter validation failed.'], + ['code' => 'Spark.Config.SecurityGroupNotFound', 'message' => 'The security group in the configuration does not exist or cannot be accessed. %s.', 'http_code' => 400, 'description' => 'The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.'], + ['code' => 'Spark.Config.VswitchNotFound', 'message' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', 'http_code' => 400, 'description' => 'The configured vSwitch cannot be found, or the current account has insufficient permissions. %s.'], + ['code' => 'Spark.Forbidden', 'message' => 'No permissions to access the resources: %s', 'http_code' => 403, 'description' => 'Insufficient permissions to access the related resources. Information that you want to access: %s.'], + ['code' => 'Spark.GetNotebookKernelStateFailed', 'message' => 'Failed to obtain the status of the notebook kernel.', 'http_code' => 400, 'description' => 'Failed to query the notebook kernel state.'], + ['code' => 'Spark.GetSparkStatementResultFailed', 'message' => 'Get spark statement execution results failed: %s.', 'http_code' => 400, 'description' => 'Failed to get Spark code execution result:'], + ['code' => 'Spark.InvalidParameter', 'message' => 'Invalid parameter value: %s', 'http_code' => 400, 'description' => 'Incorrect input parameter:%s.'], + ['code' => 'Spark.InvalidParameter', 'message' => 'Spark parameter is not valid, please check error info: %s.', 'http_code' => 400, 'description' => 'Spark parameter error, error message: %s.'], + ['code' => 'Spark.InvalidState', 'message' => 'The object of the operation is in an invalid state: %s', 'http_code' => 400, 'description' => 'The operation object is invalid.'], + ['code' => 'Spark.InvalidState', 'message' => 'The object of the operation is in an invalid state: %s.', 'http_code' => 400, 'description' => 'The operand is in non-legal state %s.'], + ['code' => 'Spark.Log.IllegalPath', 'message' => 'Invalid job log URI: %s.', 'http_code' => 400, 'description' => 'The Spark log path is invalid.'], + ['code' => 'Spark.Log.InvalidState', 'message' => 'Failed to obtain the logs of the Spark job %s in the %s state.', 'http_code' => 400, 'description' => 'The logs of the specified Spark job cannot be retrieved.'], + ['code' => 'Spark.Log.PodLogNotFound', 'message' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', 'http_code' => 404, 'description' => 'Unable to find log [%s] for corresponding pod via podName.'], + ['code' => 'Spark.NotebookNamingDuplicate', 'message' => 'The name of the notebook is duplicated, please change the name', 'http_code' => 400, 'description' => 'The notebook name is duplicate. Rename the notebook.'], + ['code' => 'Spark.NotebookNotFound', 'message' => 'The notebook is not found', 'http_code' => 400, 'description' => 'The notebook does not exist. Contact the administrator.'], + ['code' => 'Spark.NotebookParagraphMissingProgramCode', 'message' => 'The notebook paragraph program code is missing', 'http_code' => 400, 'description' => 'Execution code is missing from the notebook paragraph.'], + ['code' => 'Spark.NotebookParagraphNotFound', 'message' => 'The notebook paragraph is not found', 'http_code' => 400, 'description' => 'The notebook paragraph does not exist. Contact the administrator.'], + ['code' => 'Spark.NotebookParagraphNotRunning', 'message' => 'The notebook paragraph has not been running', 'http_code' => 400, 'description' => 'The notebook paragraph is not running. Execute the statement first.'], + ['code' => 'Spark.ObjectNotFound', 'message' => 'The object is not found. More information: %s', 'http_code' => 404, 'description' => 'The target object does not exist. Associated information: %s.'], + ['code' => 'Spark.Oss.InternalError', 'message' => 'An OSS internal error occurred: %s', 'http_code' => 400, 'description' => 'OSS internal error. The request failed.'], + ['code' => 'Spark.Resources.LoadFileFromClasspathFailed', 'message' => 'Can\'t load the content from file: %s', 'http_code' => 500, 'description' => 'Failed to load the resource file.'], + ['code' => 'Spark.RoleArn.Invalid', 'message' => '%s is not found, or the RAM role has not been authorized.', 'http_code' => 400, 'description' => 'Make sure that your current RAM user (ram_user_id %s) has been granted the system policy "AliyunADBDeveloperAccess". Then follow the "Perform authorization within the Alibaba Cloud account" section. This automatically initializes the system role named "aliyunadbsparkprocessingdatarole" in your cloud account. For more information, visit https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role.'], + ['code' => 'Spark.RoleARN.invalid', 'message' => '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.', 'http_code' => 400, 'description' => 'Please make sure your current RAM user (ram_user_id %s) has been granted the system policy \'AliyunADBDeveloperAccess\'. And then follow the section \'Perform authorization within an Alibaba Cloud account". This will automatically initialize the system role named \'aliyunadbsparkprocessingdatarole\' in your cloud account. More details: https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/user-guide/create-the-aliyunadbsparkprocessingdatarole-role-for-a-ram-user-and-grant-permissions-to-the-role'], + ['code' => 'Spark.ServerError', 'message' => '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', 'http_code' => 500, 'description' => 'An error occurred on the Spark control component system. Submit a ticket or contact technical support.'], + ['code' => 'Spark.SQL.BlankError', 'message' => 'Input sql can not be blank string.', 'http_code' => 400, 'description' => 'The submitted SQL statement cannot be empty.'], + ['code' => 'Spark.SQL.MultipleSQLError', 'message' => 'Element in field [sqls] can not contain more than one sql statement: %s.', 'http_code' => 400, 'description' => 'The submitted Spark SQL contains multiple executable SQL statements.'], + ['code' => 'Spark.SQL.NotFoundExecutableSQLError', 'message' => 'No executable statements are submitted. Please check the input SQL.', 'http_code' => 400, 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['code' => 'Spark.SQL.NotFoundExecutableSQLError', 'message' => 'The execution part is not included in the current submitted SQL, please check the input SQL.', 'http_code' => 400, 'description' => 'The SQL information in the Spark job does not contain executable statements.'], + ['code' => 'Spark.SQL.ParserError', 'message' => 'Failed to parse the SQL %s. Error message: %s.', 'http_code' => 400, 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ['code' => 'Spark.SQL.ParserError', 'message' => 'Submit spark app failed when parser SQL %s. Error message: %s.', 'http_code' => 400, 'description' => 'The SQL in the Spark job information cannot be parsed.'], + ['code' => 'Spark.TemplateFile.BadFileType', 'message' => 'The requested template %s is not a file.', 'http_code' => 400, 'description' => 'The specified template file ID is not of the file type.'], + ['code' => 'Spark.TemplateFile.FileNotFound', 'message' => 'The template file %s is not found.', 'http_code' => 404, 'description' => 'Failed to find the specified template file.'], + ['code' => 'Spark.TemplateFile.TemplateNotFound', 'message' => 'The template %s is not found.', 'http_code' => 404, 'description' => 'The template file was not found.'], + ['code' => 'StartTimeBeforeNow', 'message' => 'The start time should not be earlier than the current time.', 'http_code' => 400, 'description' => 'The start time must not be earlier than the current time. Specify the start time again.'], + ['code' => 'SwitchTimeAfterDeadline', 'message' => 'The switch time should be earlier than deadline.', 'http_code' => 400, 'description' => 'The switchover time must be earlier than the end time. Specify the switchover time again.'], + ['code' => 'SystemError', 'message' => 'Internal system exception: templateName cannot be empty.', 'http_code' => 400, 'description' => 'An internal system error has occurred'], + ['code' => 'TaskModifyError', 'message' => 'Part of the tasks cannot be modified.', 'http_code' => 400, 'description' => 'Part of the tasks cannot be modified. Confirm your task information first.'], + ['code' => 'Throttling.Api', 'message' => 'The request was denied due to API throttling.', 'http_code' => 403, 'description' => 'The request was limited due to throttling.'], + ['code' => 'Unauthorized', 'message' => 'Denied by sts or ram', 'http_code' => 400, 'description' => 'The access is not authorized.'], + ['code' => 'UserAndPoolAlreadyBind', 'message' => 'The specified user already binds the resource pool.', 'http_code' => 400, 'description' => 'The specified user has already bound the resource pool.'], + ['code' => 'UserNotInElasticPlanWhitelist', 'message' => 'Not allow to create worker elastic plan.', 'http_code' => 400, 'description' => 'Creating a storage elastic plan is not allowed.'], + ['code' => 'MDS.CatalogAlreadyExist', 'message' => 'The catalog already exists.', 'http_code' => 400, 'description' => 'Catalog already exists'], + ['code' => 'MDS.SemanticViewNotExist', 'message' => 'This semantic view does not exist.', 'http_code' => 400, 'description' => 'This semantic view does not exist'], + ['code' => 'MDS.SemanticViewAreadyExist', 'message' => 'This semantic view already exists.', 'http_code' => 400, 'description' => 'This semantic view already exists'], + ['code' => 'MDS.SemanticViewAlreadyExist', 'message' => 'The semantic view already exists.', 'http_code' => 400, 'description' => 'Semantic view already exists'], + ['code' => 'MDS.InstanceNotExist', 'message' => 'ADB instance does not exist.', 'http_code' => 404, 'description' => 'ADB instance does not exist'], + ['code' => 'MDS.RamUserAlreadyBound', 'message' => 'RAM user already bound to another user.', 'http_code' => 400, 'description' => 'The Ram user has been bound to another account.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDownloadRecords'], + ], + 'createdAt' => '2025-12-19T09:34:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateApsKafkaHudiJob'], + ], + 'createdAt' => '2025-12-03T12:35:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBResourceGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBResourceGroup'], + ], + 'createdAt' => '2025-12-02T15:07:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAuditLogRecords'], + ], + 'createdAt' => '2025-10-27T07:49:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBResourceGroup'], + ], + 'createdAt' => '2025-10-17T13:49:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDiagnosisRecords'], + ['description' => 'Response parameters changed', 'api' => 'DescribePatternPerformance'], + ], + 'createdAt' => '2024-10-21T12:16:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribePerformanceViewAttribute'], + ], + 'createdAt' => '2024-10-16T02:07:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBResourceGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBResourceGroup'], + ], + 'createdAt' => '2024-10-15T17:29:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2024-10-14T14:44:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], + ], + 'createdAt' => '2024-10-12T14:49:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ModifyBackupPolicy'], + ], + 'createdAt' => '2024-10-12T03:26:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyBackupPolicy'], + ], + 'createdAt' => '2024-10-12T01:59:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBResourceGroup'], + ], + 'createdAt' => '2024-09-29T06:39:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeClusterAccessWhiteList'], + ], + 'createdAt' => '2024-09-26T08:36:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], + ], + 'createdAt' => '2024-09-24T09:25:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDBCluster'], + ], + 'createdAt' => '2024-09-18T13:35:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'SetSparkAppLogRootPath'], + ], + 'createdAt' => '2024-09-02T02:38:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDiagnosisRecords'], + ], + 'createdAt' => '2024-08-30T11:11:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetTableObjects'], + ], + 'createdAt' => '2024-08-20T09:29:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyAuditLogConfig'], + ], + 'createdAt' => '2024-08-20T07:40:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBResourceGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBResourceGroup'], + ], + 'createdAt' => '2024-08-13T16:11:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLPatterns'], + ], + 'createdAt' => '2024-08-06T07:59:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeRegions'], + ], + 'createdAt' => '2024-07-24T07:15:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetTable'], + ], + 'createdAt' => '2024-07-04T08:31:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeJobResourceUsage'], + ], + 'createdAt' => '2024-06-30T06:27:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateAccount'], + ], + 'createdAt' => '2024-06-13T14:53:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'AllocateClusterPublicConnection'], + ['description' => 'Request parameters changed', 'api' => 'DeleteAccount'], + ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'DescribeAccounts'], + ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'DescribeClusterNetInfo'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'ModifyAccountDescription'], + ['description' => 'Request parameters changed', 'api' => 'ReleaseClusterPublicConnection'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'ResetAccountPassword'], + ], + 'createdAt' => '2024-06-13T13:51:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitSparkApp'], + ], + 'createdAt' => '2024-05-29T02:44:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], + ], + 'createdAt' => '2024-05-28T02:57:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2024-05-23T06:29:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeApsActionLogs'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterHealthStatus'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDownloadRecords'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLPatterns'], + ], + 'createdAt' => '2024-05-14T08:32:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOssSubDirectory'], + ], + 'createdAt' => '2024-05-10T06:02:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBClusters'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBCluster'], + ], + 'createdAt' => '2024-05-09T02:23:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2024-05-08T07:37:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ExistRunningSQLEngine'], + ], + 'createdAt' => '2024-05-06T03:07:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeApsResourceGroups'], + ], + 'createdAt' => '2024-04-10T07:29:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ModifyAccountPrivileges'], + ], + 'createdAt' => '2024-04-09T11:05:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBResourceGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBResourceGroup'], + ], + 'createdAt' => '2024-03-25T02:10:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBResourceGroup'], + ], + 'createdAt' => '2024-03-01T08:17:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBResourceGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeClusterResourceDetail'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBResourceGroup'], + ], + 'createdAt' => '2024-01-26T02:34:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeApsActionLogs'], + ], + 'createdAt' => '2024-01-24T03:42:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetSparkAppAttemptLog'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetSparkAppLog'], + ], + 'createdAt' => '2024-01-18T10:52:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDiagnosisSQLInfo'], + ], + 'createdAt' => '2024-01-05T06:00:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetTable'], + ], + 'createdAt' => '2023-12-21T06:37:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBResourceGroup'], + ], + 'createdAt' => '2023-12-19T08:51:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeEnabledPrivileges'], + ], + 'createdAt' => '2023-12-18T14:02:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteElasticPlan'], + ['description' => 'Response parameters changed', 'api' => 'DescribeElasticPlanAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeElasticPlanJobs'], + ['description' => 'Response parameters changed', 'api' => 'DescribeElasticPlanSpecifications'], + ['description' => 'Response parameters changed', 'api' => 'DisableElasticPlan'], + ['description' => 'Response parameters changed', 'api' => 'ModifyElasticPlan'], + ], + 'createdAt' => '2023-12-12T10:09:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAuditLogRecords'], + ['description' => 'Request parameters changed', 'api' => 'DescribePatternPerformance'], + ['description' => 'Request parameters changed', 'api' => 'DescribeSQLPatterns'], + ], + 'createdAt' => '2023-12-08T02:33:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeAccountAllPrivileges'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'DescribeAccountPrivilegeObjects'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'DescribeAccountPrivileges'], + ['description' => 'Request parameters changed', 'api' => 'DescribeEnabledPrivileges'], + ], + 'createdAt' => '2023-12-06T02:33:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetSparkAppInfo'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetSparkAppLog'], + ['description' => 'Request parameters changed', 'api' => 'GetSparkAppMetrics'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetSparkAppState'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetSparkAppWebUiAddress'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'KillSparkApp'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSparkAppAttempts'], + ['description' => 'Request parameters changed', 'api' => 'PreloadSparkAppMetrics'], + ], + 'createdAt' => '2023-11-23T05:56:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeUserQuota'], + ], + 'createdAt' => '2023-11-06T09:35:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeAdbMySqlColumns'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAdbMySqlTables'], + ], + 'createdAt' => '2023-11-02T03:45:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetDatabaseObjects'], + ['description' => 'Request parameters changed', 'api' => 'GetTableColumns'], + ['description' => 'Request parameters changed', 'api' => 'GetTableDDL'], + ['description' => 'Request parameters changed', 'api' => 'GetTableObjects'], + ['description' => 'Request parameters changed', 'api' => 'GetViewDDL'], + ['description' => 'Request parameters changed', 'api' => 'GetViewObjects'], + ], + 'createdAt' => '2023-10-25T05:35:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeElasticPlanAttribute'], + ], + 'createdAt' => '2023-10-23T02:55:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2023-09-26T07:36:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBResourceGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBResourceGroup'], + ], + 'createdAt' => '2023-09-25T10:08:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBClusterPerformance'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDiagnosisDimensions'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDiagnosisRecords'], + ['description' => 'Request parameters changed', 'api' => 'DescribeSqlPattern'], + ['description' => 'Request parameters changed', 'api' => 'DescribeTableAccessCount'], + ['description' => 'Request parameters changed', 'api' => 'DownloadDiagnosisRecords'], + ], + 'createdAt' => '2023-09-13T12:07:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetSparkAppAttemptLog'], + ], + 'createdAt' => '2023-09-01T08:22:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], + ], + 'createdAt' => '2023-08-28T06:20:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAllDataSource'], + ['description' => 'Request parameters changed', 'api' => 'DescribeColumns'], + ['description' => 'Request parameters changed', 'api' => 'DescribeTables'], + ], + 'createdAt' => '2023-08-25T03:36:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBClusters'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBCluster'], + ], + 'createdAt' => '2023-07-27T11:22:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetSparkAppAttemptLog'], + ['description' => 'Error codes changed', 'api' => 'GetSparkConfigLogPath'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetSparkLogAnalyzeTask'], + ['description' => 'Error codes changed', 'api' => 'GetSparkTemplateFolderTree'], + ['description' => 'Error codes changed', 'api' => 'GetSparkTemplateFullTree'], + ['description' => 'Error codes changed', 'api' => 'KillSparkLogAnalyzeTask'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'ListSparkLogAnalyzeTasks'], + ['description' => 'Error codes changed', 'api' => 'ListSparkTemplateFileIds'], + ], + 'createdAt' => '2023-07-27T05:10:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'StartSparkSQLEngine'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'SubmitSparkApp'], + ], + 'createdAt' => '2023-07-27T01:59:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateElasticPlan'], + ['description' => 'Error codes changed', 'api' => 'EnableElasticPlan'], + ], + 'createdAt' => '2023-06-30T02:18:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeApsActionLogs'], + ], + 'createdAt' => '2023-06-21T09:28:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDBCluster'], + ], + 'createdAt' => '2023-06-21T03:39:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateSparkTemplate'], + ['description' => 'Error codes changed', 'api' => 'DeleteSparkTemplate'], + ['description' => 'Error codes changed', 'api' => 'DeleteSparkTemplateFile'], + ['description' => 'Error codes changed', 'api' => 'GetSparkAppInfo'], + ['description' => 'Error codes changed', 'api' => 'GetSparkAppLog'], + ['description' => 'Error codes changed', 'api' => 'GetSparkAppMetrics'], + ['description' => 'Error codes changed', 'api' => 'GetSparkAppState'], + ['description' => 'Error codes changed', 'api' => 'GetSparkAppWebUiAddress'], + ['description' => 'Error codes changed', 'api' => 'GetSparkDefinitions'], + ['description' => 'Error codes changed', 'api' => 'GetSparkSQLEngineState'], + ], + 'createdAt' => '2023-06-19T09:40:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeSQLPatterns'], + ], + 'createdAt' => '2023-06-08T06:16:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribePatternPerformance'], + ], + 'createdAt' => '2023-06-08T03:15:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BindAccount'], + ['description' => 'Error codes changed', 'api' => 'DeleteDBResourceGroup'], + ], + 'createdAt' => '2023-06-07T15:59:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeElasticPlans'], + ], + 'createdAt' => '2023-06-02T01:37:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeApsResourceGroups'], + ], + 'createdAt' => '2023-05-09T09:42:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDBCluster'], + ], + 'createdAt' => '2023-05-08T16:27:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BindAccount'], + ['description' => 'Error codes changed', 'api' => 'DescribeAccountAllPrivileges'], + ['description' => 'Error codes changed', 'api' => 'DescribeAccountPrivilegeObjects'], + ['description' => 'Error codes changed', 'api' => 'DescribeAccountPrivileges'], + ['description' => 'Error codes changed', 'api' => 'DescribeEnabledPrivileges'], + ['description' => 'Error codes changed', 'api' => 'ModifyAccountPrivileges'], + ], + 'createdAt' => '2023-04-20T14:38:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateElasticPlan'], + ], + 'createdAt' => '2023-04-14T08:50:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateDBResourceGroup'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'CreateElasticPlan'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'DeleteDBCluster'], + ['description' => 'Error codes changed', 'api' => 'DeleteDBResourceGroup'], + ['description' => 'Error codes changed', 'api' => 'DeleteElasticPlan'], + ['description' => 'Error codes changed', 'api' => 'DescribeElasticPlanAttribute'], + ['description' => 'Error codes changed', 'api' => 'DescribeElasticPlanJobs'], + ['description' => 'Error codes changed', 'api' => 'DescribeElasticPlans'], + ['description' => 'Error codes changed', 'api' => 'DescribeElasticPlanSpecifications'], + ['description' => 'Error codes changed', 'api' => 'DisableElasticPlan'], + ], + 'createdAt' => '2023-04-13T06:37:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AllocateClusterPublicConnection'], + ['description' => 'Error codes changed', 'api' => 'BindAccount'], + ['description' => 'Error codes changed', 'api' => 'CreateAccount'], + ['description' => 'Error codes changed', 'api' => 'CreateDBResourceGroup'], + ['description' => 'Error codes changed', 'api' => 'DeleteAccount'], + ['description' => 'Error codes changed', 'api' => 'DeleteDBResourceGroup'], + ['description' => 'Error codes changed', 'api' => 'DescribeAccounts'], + ['description' => 'Error codes changed', 'api' => 'DescribeClusterAccessWhiteList'], + ['description' => 'Error codes changed', 'api' => 'DescribeDBResourceGroup'], + ['description' => 'Error codes changed', 'api' => 'ModifyAccountDescription'], + ], + 'createdAt' => '2023-03-31T07:03:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeApsActionLogs'], + ], + 'createdAt' => '2023-03-30T02:43:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeAccountAllPrivileges'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeAccountPrivilegeObjects'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeAccountPrivileges'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeEnabledPrivileges'], + ['description' => 'Request parameters changed', 'api' => 'ModifyAccountPrivileges'], + ], + 'createdAt' => '2023-03-24T06:24:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetDatabaseObjects'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetTable'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetTableColumns'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetTableDDL'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetTableObjects'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetViewDDL'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetViewObjects'], + ], + 'createdAt' => '2023-03-22T02:15:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDiagnosisSQLInfo'], + ], + 'createdAt' => '2023-01-03T03:57:06.000Z', + 'description' => '修复stage信息中的operatorCost映射', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDiagnosisSQLInfo'], + ], + 'createdAt' => '2022-12-15T11:36:50.000Z', + 'description' => '查询诊断信息提供stage统计信息', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteDBCluster'], + ], + 'createdAt' => '2022-11-16T06:07:19.000Z', + 'description' => '修正deleteDBCluster返回参数', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeBackupPolicy'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeBackups'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyBackupPolicy'], + ], + 'createdAt' => '2022-11-16T06:03:56.000Z', + 'description' => '支持备份策略', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListAuthorizedUsers'], + ['description' => 'Request parameters changed', 'api' => 'ListUnauthorizedUsers'], + ], + 'createdAt' => '2022-11-15T04:31:59.000Z', + 'description' => '不发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], + ], + 'createdAt' => '2022-11-07T06:20:54.000Z', + 'description' => '修改PayType参数为必填', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDBCluster'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBClusters'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBCluster'], + ], + 'createdAt' => '2022-11-03T03:02:21.000Z', + 'description' => '调整参数正确性', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeApsActionLogs'], + ], + 'createdAt' => '2022-11-01T17:22:54.000Z', + 'description' => '增加任务日志API', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2022-09-27T12:01:23.000Z', + 'description' => '提供默认engineVersion', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeRegions'], + ], + 'createdAt' => '2022-09-27T11:59:58.000Z', + 'description' => 'adb5.0 feature', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'StartProcessInstance'], + ], + 'createdAt' => '2022-09-22T09:27:02.000Z', + 'description' => 'none', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'StartCheckProcessDefinition'], + ['description' => 'Request parameters changed', 'api' => 'StartCheckProcessDefinition'], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidInput', - 'errorMessage' => 'The specified parameter is invalid.', - ], - ], + 'createdAt' => '2022-09-16T07:56:56.000Z', + 'description' => '非公开', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CancelAsyncSqlByJobId'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeAsyncResultsByJobId'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSparkCodeLog'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSparkCodeOutput'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSparkCodeWebUi'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ExecuteAsyncSql'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-09-06T02:43:16.000Z', + 'description' => '没有sdk', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBClusterPerformance'], ], - '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' => 'DescribeApsDatasources', + 'createdAt' => '2022-09-01T08:51:18.000Z', + 'description' => '内测接口', ], - 'CreateApsHiveJob' => [ - 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) job from a Hive data source.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBClusterHealthStatus'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-09-01T03:16:56.000Z', + 'description' => '内侧接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSqlEditorHistory'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-08-25T11:38:01.000Z', + 'description' => 'a', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ExecuteSyncSql'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '170254', - 'abilityTreeNodes' => [ - 'FEATUREadsBIVU9O', - ], + 'createdAt' => '2022-08-24T08:10:34.000Z', + 'description' => '不需要', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeSqlEditorHistory'], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'WorkloadName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workload.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xxx-20240224100253', - ], - ], - [ - 'name' => 'ResourceGroup', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user_default', + 'createdAt' => '2022-08-16T03:04:39.000Z', + 'description' => '不需要', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CancelAsyncSqlByJobId'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeAsyncResultsByJobId'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeAsyncResultsDownloadUrlByJobId'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSqlEditorHistory'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSqlEditorHistoryDimensions'], + ['description' => 'OpenAPI offline', 'api' => 'ExecuteAsyncSql'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ExecuteSyncSql'], + ], + 'createdAt' => '2022-08-10T06:38:28.000Z', + 'description' => '不输出SDK', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeApsResourceGroups'], + ], + 'createdAt' => '2022-08-08T07:29:14.000Z', + 'description' => 'APS API 首次发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDiagnosisSQLInfo'], + ], + 'createdAt' => '2022-07-26T03:56:16.000Z', + 'description' => 'rchost设置为非必选', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDiagnosisSQLInfo'], + ], + 'createdAt' => '2022-07-26T03:53:29.000Z', + 'description' => '查询提交时间和状态非必选', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListSparkAppAttempts'], + ['description' => 'Request parameters changed', 'api' => 'ListSparkApps'], + ], + 'createdAt' => '2022-07-19T03:29:03.000Z', + 'description' => '将Spark的Filter和DeleteLog参数可见性配置为私有, 当前 ADB Spark无真实线上用户, 预期不会影响任何用户使用.', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOssSubDirectory'], + ['description' => 'OpenAPI offline', 'api' => 'GetLakehouseValidResourceGroups'], + ], + 'createdAt' => '2022-06-22T08:55:31.000Z', + 'description' => 'lakehose api 发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeAuditLogConfig'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeAuditLogRecords'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBClusterForecast'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDiagnosisDimensions'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDiagnosisSQLInfo'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDownloadRecords'], + ['description' => 'OpenAPI offline', 'api' => 'DescribePatternPerformance'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSqlPattern'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSQLPatternAttribute'], + ], + 'createdAt' => '2022-06-22T04:05:55.000Z', + 'description' => '内测暂不对外发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AllocateClusterPublicConnection'], + ['description' => 'OpenAPI offline', 'api' => 'BindAccount'], + ['description' => 'OpenAPI offline', 'api' => 'CheckBindRamUser'], + ['description' => 'OpenAPI offline', 'api' => 'CreateAccount'], + ['description' => 'OpenAPI offline', 'api' => 'CreateDBCluster'], + ['description' => 'OpenAPI offline', 'api' => 'CreateDBResourceGroup'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteAccount'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteDBCluster'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteDBResourceGroup'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeAccounts'], + ], + 'createdAt' => '2022-06-11T16:53:04.000Z', + 'description' => '新增5.0OpenApi接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBClusterPerformance'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDiagnosisRecords'], + ], + 'createdAt' => '2022-03-22T08:52:04.000Z', + 'description' => '内测发布', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePerformanceView'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSparkReplStatement'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDownloadRecords'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkReplSession'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountAllPrivileges'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteSparkReplStatement'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsProgress'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunMaterializedViewRecommend'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeKernelVersion'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResourceGroupSpec'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackups'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisSQLInfo'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableAdviceService'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePerformanceView'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppWebUiAddress'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlTables'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApsWebhook'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCompactionServiceSwitch'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTableStatistics'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteElasticPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KillSparkSQLEngine'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClusterAccessWhiteList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSparkTemplateFile'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticPlanSpecifications'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLakeCacheSize'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAuditLogRecords'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsKafkaHudiJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterResourceGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchApplyAdviceByIdList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePatternPerformance'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KillSparkLogAnalyzeTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBResourceGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClickhouseEngine'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsJobs'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsActionLogs'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterSpaceSummary'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountPrivileges'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableElasticPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterMaintainTime'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkSQLDiagnosisList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DownloadDiagnosisRecords'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsHiveWorkload'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackups'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEssdCacheConfig'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LoadSampleDataSet'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSparkApp'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkAuditLogRecords'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApsJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSparkTemplate'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachUserENI'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeOperatorPermission'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeControllerDetection'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeViewJobs'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppMetrics'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAuditLogConfig'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindAccount'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlIndexes'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePerformanceViews'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkAppDiagnosisInfo'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLakeStorages'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePerformanceViewAttribute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableObjects'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantOperatorPermission'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAllDataSource'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMvRecommendTasks'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStorageResourceUsage'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBCluster'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTablePartitionDiagnose'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DownloadInstanceCACertificate'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsDatasources'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticPlanAttribute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAPSADBInstances'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppInfo'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInclinedNodes'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAutoRenewalAttribute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterPerformance'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAutoRenewalAttribute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyAdviceById'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMaterializedViewRecommend'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindDBResourceGroupWithUser'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkApps'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAbnormalPatternDetection'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResultExportJobHistory'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsMigrationWorkloads'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckBindRamUser'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsResourceGroups'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBResourceGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOssSubDirectory'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateElasticPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlColumns'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdviceServiceEnabled'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SuspendApsJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLakeStorage'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsHiveJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterAttribute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOversizeNonPartitionTableInfos'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSparkSQLEngine'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusters'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisDimensions'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasks'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsSlsADBJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KillSparkApp'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSampleDataSet'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApsDatasoure'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLWebSocketDomain'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySqlTemplatePosition'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KillProcess'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkWarehouseBatchSQL'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountPrivilegeObjects'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExcessivePrimaryKeys'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlPattern'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkSQLDiagnosisAttribute'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComputeResourceUsage'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMvRecommendSubTasks'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartApsJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApsWebhook'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTableAccessCount'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApsSlsADBJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPerformanceView'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkAppAttempts'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreloadSparkAppMetrics'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfigureResultExport'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetViewObjects'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkTemplateFileContent'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkTemplateFullTree'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterNetInfo'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApsWorkloadName'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLakeStorage'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountPrivileges'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkAppType'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWorkerDetection'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBCluster'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterResourceDetail'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsDatasoure'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUserEniVswitchOptions'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOperatorPermission'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApsJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppState'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeJobResourceUsage'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSparkLogAnalyzeTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterStatus'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExistRunningSQLEngine'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTable'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMaterializedViewRecommend'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyLakeCacheSize'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppLog'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBCluster'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsDatasource'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkLogAnalyzeTasks'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppliedAdvices'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasksStat'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindAccount'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkConfigLogPath'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLakeStorage'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetViewDDL'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBResourceGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsWebhook'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApsCopyWorkload'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnabledPrivileges'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApsJobDetail'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableAdvices'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSchemas'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkWarehouseBatchSQL'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterDescription'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumns'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteSparkWarehouseBatchSQL'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSparkTemplateFile'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMVRecommendResults'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLakeStorage'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserQuota'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCompactionServiceSwitch'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSparkReplSession'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableAdviceService'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachUserENI'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkCodeLog'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableDDL'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkLogAnalyzeTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEssdCacheConfig'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterSSL'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlTableMeta'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBClusterHealthStatus'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSparkTemplateFileIds'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMaterializedView'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkAppAttemptLog'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExecutorDetection'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetADBSparkNecessaryRAMPermissions'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkCodeOutput'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApsDatasoure'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterAccessWhiteList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitResultExportJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterResourceUsage'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyElasticPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableElasticPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLPatterns'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAPSJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResultExportConfig'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterVip'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSparkWarehouseBatchSQL'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseClusterPublicConnection'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkTemplateFolderTree'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticPlanJobs'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterSSL'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTables'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSparkTemplate'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBadSqlDetection'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkReplStatement'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInclinedTables'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeKernelVersion'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticPlans'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindDBResourceGroupWithUser'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBResourceGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabaseObjects'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableColumns'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMaterializedViewRecommend'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisRecords'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCreateTableSQL'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccounts'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAdbMySqlSchemas'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSparkCodeWebUi'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetSparkAppLogRootPath'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTableDetail'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSparkSQLEngineState'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocateClusterPublicConnection'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApsWebhook'], + ], + ], + 'ram' => [ + 'productCode' => 'ADB', + 'productName' => 'AnalyticDB for MySQL', + 'ramCodes' => ['adb'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [ + [ + 'name' => 'adb:DiskEncryption', + 'schema' => [ + 'type' => 'String', + 'description' => 'Whether to enable cloud disk encryption', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'adb:EnableSSL', + 'schema' => [ + 'type' => 'String', + 'description' => 'Whether to enable SSL encryption link', + 'enums' => ['true', 'false'], + ], + ], + ], + 'ramActions' => [ + [ + 'apiName' => 'ExecuteSparkWarehouseBatchSQL', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:ExecuteSparkWarehouseBatchSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FullComputeUnit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of AnalyticDB compute units (ACUs) required for data migration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '16', + ], + [ + 'apiName' => 'ReleaseClusterPublicConnection', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:ReleaseClusterPublicConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DatasourceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '40', + ], + [ + 'apiName' => 'UpdateApsWebhook', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:UpdateApsWebhook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SyncAllowExpression', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The expression that allows objects to be synchronized.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', + ], + [ + 'apiName' => 'SetSparkAppLogRootPath', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:SetSparkAppLogRootPath', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'SyncDenyExpression', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The expression that denies objects to be synchronized.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', + ], + [ + 'apiName' => 'DescribeDBClusterSSL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'TargetType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The destination type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', + ], + [ + 'apiName' => 'GetTableObjects', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getTableObjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'OssLocation', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the destination data lakehouse in an Object Storage Service (OSS) bucket.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://test-test*/*0516/', + ], + [ + 'apiName' => 'DescribeExecutorDetection', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeExecutorDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'ConflictStrategy', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The policy to handle tables with the same name in the destination cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Intercept: reports error and aborts.'."\n" - .'Ignore: ignores and continues migrating the relevant tables.'."\n" - .'Skip: skips related tables and only migrates other tables.', + ], + [ + 'apiName' => 'DescribeSparkCodeOutput', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkCodeOutput', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AdvancedConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The advanced configurations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', + ], + [ + 'apiName' => 'CreateApsHiveJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsHiveJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'Parallelism', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of tasks that are allowed in parallel.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8', + ], + [ + 'apiName' => 'CreateElasticPlan', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2895BB82-B2C1-408E-AA73-DB8D59******', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - ], + [ + 'apiName' => 'DescribeTableStatistics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeTableStatistics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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' => 'CreateApsHiveJob', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeApsProgress' => [ - 'summary' => 'Queries the progress of an AnalyticDB Pipeline Service (APS) job.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeDBClusters', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListApsWebhook', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '171313', - 'abilityTreeNodes' => [ - 'FEATUREadsH8FO36', + 'ramAction' => [ + 'action' => 'adb:ListApsWebhook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-******', + [ + 'apiName' => 'DeletePerformanceView', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeletePerformanceView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'WorkloadId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-******', + ], + [ + 'apiName' => 'CreateApsDatasoure', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsDatasoure', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'CheckBindRamUser', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:CheckBindRamUser', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'TotalTableCount' => [ - 'description' => 'The total number of tables to be migrated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SuccessTableCount' => [ - 'description' => 'The total number of migrated tables returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SuccessPercentage' => [ - 'description' => 'The success rate.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'ApsHiveProgress' => [ - 'description' => 'The migration progress.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DbName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'TbName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Progress' => [ - 'description' => 'The migration progress.'."\n", - 'type' => 'string', - 'example' => '95', - ], - 'Speed' => [ - 'description' => 'The migration speed.'."\n", - 'type' => 'string', - 'example' => '2', - ], - ], - 'example' => '-', - 'description' => '', - ], - 'example' => '-', - ], - ], - 'description' => '', + [ + 'apiName' => 'DescribeInclinedTables', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeInclinedTables', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidInput', - 'errorMessage' => 'The specified parameter is invalid.', + [ + 'apiName' => 'ModifyLakeCacheSize', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:ModifyLakeCacheSize', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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' => 'DescribeApsProgress', - ], - 'DeleteApsDatasoure' => [ - 'summary' => 'Deletes an AnalyticDB Pipeline Service (APS) data source.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'RevokeOperatorPermission', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:RevokeOperatorPermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UnbindAccount', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:UnbindAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreatePerformanceView', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreatePerformanceView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '168866', - 'abilityTreeNodes' => [ - 'FEATUREadsQO9FPM', + [ + 'apiName' => 'ModifyPerformanceView', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyPerformanceView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-******', + [ + 'apiName' => 'DescribeInclinedNodes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeInclinedNodes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'ModifyClickhouseEngine', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyClickhouseEngine', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DatasourceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + ], + [ + 'apiName' => 'DownloadInstanceCACertificate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DownloadInstanceCACertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FAE98A4F-****-****-BF6D-67EEAC9C39DE', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => '7', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **True**'."\n" - .'* **False**'."\n", - 'type' => 'string', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - ], + [ + 'apiName' => 'SubmitSparkLogAnalyzeTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:SubmitSparkLogAnalyzeTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribePerformanceViews', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribePerformanceViews', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - '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' => 'DeleteApsDatasoure', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'DescribeApsJobs' => [ - 'summary' => 'Queries a list of AnalyticDB Pipeline Service (APS) jobs.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeApsJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeApsJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeElasticPlanJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeElasticPlanJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribePerformanceViewAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribePerformanceViewAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeSparkCodeLog', + 'description' => '', 'operationType' => 'list', - 'abilityTreeCode' => '180030', - 'abilityTreeNodes' => [ - 'FEATUREadsH8FO36', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkCodeLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', + [ + 'apiName' => 'DisableElasticPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DisableElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '30', + ], + [ + 'apiName' => 'ModifyMaterializedView', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyMaterializedView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + ], + [ + 'apiName' => 'DeleteLakeStorage', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteLakeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CreateTimeStart', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-03-23T01:10Z', + ], + [ + 'apiName' => 'ModifyApsDatasoure', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyApsDatasoure', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'CreateTimeEnd', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-23T01:10Z', + ], + [ + 'apiName' => 'ExecuteSparkReplStatement', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:ExecuteSparkReplStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}'], ], ], - [ - 'name' => 'ApsJobName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the APS job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aps-xxxxx', + ], + [ + 'apiName' => 'CreateOssSubDirectory', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateOssSubDirectory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeElasticPlans', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeElasticPlans', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeApsResourceGroups', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsResourceGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-7F9D-5DBD-993E-******', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'APSJobs' => [ - 'description' => 'The queried APS jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried APS job.', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the APS job.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'ApsJobName' => [ - 'description' => 'The name of the APS job.'."\n", - 'type' => 'string', - 'example' => 'data-sync-******', - ], - 'DestinationInstanceID' => [ - 'description' => 'The destination cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-*******', - ], - 'SourceInstanceID' => [ - 'description' => 'The ID of the source instance or cluster.'."\n", - 'type' => 'string', - 'example' => 'pc-******', - ], - 'Delay' => [ - 'description' => 'The synchronization latency.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CreateTime' => [ - 'description' => 'The time when the APS job was created.'."\n", - 'type' => 'string', - 'example' => '2022-06-28 15:00:04', - ], - 'Projress' => [ - 'description' => 'The progress.'."\n", - 'type' => 'string', - 'example' => '30: The progress is 30%.', - ], - 'ApsJobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'aps-******', - ], - 'SubStatus' => [ - 'description' => 'The status of the task.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'ErrMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - ], - 'example' => '-', - ], - 'example' => '-', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'The status code. A value of 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'ok', - ], - ], + [ + 'apiName' => 'DescribeApsProgress', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsProgress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidInput', - 'errorMessage' => 'The specified parameter is invalid.', + [ + 'apiName' => 'DescribeAutoRenewalAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAutoRenewalAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeLakeCacheSize', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeLakeCacheSize', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - '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' => 'DescribeApsJobs', - ], - 'DescribeApsActionLogs' => [ - 'summary' => 'Queries the logs of a real-time data ingestion job for an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeDBClusterSpaceSummary', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterSpaceSummary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeApsJobDetail', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsJobDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateSparkTemplate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateSparkTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '154388', - 'abilityTreeNodes' => [ - 'FEATUREads1II0UT', - 'FEATUREadsY28JLD', + [ + 'apiName' => 'ModifyDBResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp1r053byu48p****', + [ + 'apiName' => 'CancelSparkReplStatement', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CancelSparkReplStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}/{#sparkStatmentId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~454314~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'DescribeAppliedAdvices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAppliedAdvices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the logs to be queried. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mmZ** format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-02-11T08:30:00Z', + ], + [ + 'apiName' => 'ModifyAutoRenewalAttribute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyAutoRenewalAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the logs to be queried. Specify the time in the ISO 8601 standard in the **yyyy-MM-ddTHH:mmZ** format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time. The maximum time range that can be specified is 30 days.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-02-11T09:30:00Z', + ], + [ + 'apiName' => 'GrantOperatorPermission', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:GrantOperatorPermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], - [ - 'name' => 'WorkloadId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the real-time data ingestion job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aps-hz109vpvt4fg8528d****', + ], + [ + 'apiName' => 'CreateApsCopyWorkload', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsCopyWorkload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that you want to use for fuzzy match in the query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table_test', + ], + [ + 'apiName' => 'DescribeBadSqlDetection', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeBadSqlDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'Stage', - 'in' => 'query', - 'schema' => [ - 'description' => 'The phase during which the logs to be queried were generated. Valid values:'."\n" - ."\n" - .'* **StructureMigrate**: schema migration.'."\n" - .'* **FullDataSync**: full data synchronization.'."\n" - .'* **IncrementalSync**: incremental data synchronization.'."\n" - ."\n" - .'> If you do not specify this parameter, logs of all the phases are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FullDataSync', + ], + [ + 'apiName' => 'DescribeDiagnosisRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'State', - 'in' => 'query', - 'schema' => [ - 'description' => 'The types of the logs. Separate multiple log types with commas (,). Valid values:'."\n" - ."\n" - .'* **INFO**'."\n" - .'* **WARN**'."\n" - .'* **ERROR**'."\n" - ."\n" - .'> If you do not specify this parameter, logs of all types are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'INFO,WARN,ERROR', + ], + [ + 'apiName' => 'DescribeCompactionServiceSwitch', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DescribeCompactionServiceSwitch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '30', - 'default' => '10', + ], + [ + 'apiName' => 'DescribeDiagnosisDimensions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDiagnosisDimensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', + ], + [ + 'apiName' => 'ModifyDBClusterDescription', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5EDBA27-AF3E-5966-9503-FD1557E19167', - ], - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-bp1r053byu48p****', - ], - 'WorkloadId' => [ - 'description' => 'The ID of the real-time data ingestion job.'."\n", - 'type' => 'string', - 'example' => 'aps-hz109vpvt4fg8528d****', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ActionLogs' => [ - 'description' => 'The queried logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'description' => 'The time when the log was generated. The time follows the ISO 8601 standard in the **yyyy-MM-ddTHH:mm:ssZ** format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-02-01T05:46:30Z', - ], - 'Stage' => [ - 'description' => 'The phase during which the log was generated. Valid values:'."\n" - ."\n" - .'* **StructureMigrate**: schema migration.'."\n" - .'* **FullDataSync**: full data synchronization.'."\n" - .'* **IncrementalSync**: incremental data synchronization.'."\n", - 'type' => 'string', - 'example' => 'FullDataSync', - ], - 'State' => [ - 'description' => 'The type of the log. Multiple log types are separated by commas (,). Valid values:'."\n" - ."\n" - .'* **INFO**'."\n" - .'* **WARN**'."\n" - .'* **ERROR**'."\n", - 'type' => 'string', - 'example' => 'INFO,WARN,ERROR', - ], - 'Context' => [ - 'description' => 'The content of the log.'."\n", - 'type' => 'string', - 'example' => 'DDL migration job finished', - ], - ], - ], - ], - 'AccessDeniedDetail' => [ - 'description' => 'The information about the request denial.'."\n", - '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" - .'}', - ], - ], - 'description' => '', + [ + 'apiName' => 'DescribeAbnormalPatternDetection', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAbnormalPatternDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBResourceGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + [ + 'apiName' => 'ModifyApsWorkloadName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyApsWorkloadName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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' => 'DescribeApsActionLogs', - 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" - .'* Regional public endpoint: `adb..aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" - .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc..aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", - ], - 'UpdateLakeStorage' => [ - 'summary' => 'Updates a lake storage.', - 'methods' => [ - 'post', + [ + 'apiName' => 'DescribeAdbMySqlIndexes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlIndexes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DescribeApsActionLogs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsActionLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeElasticPlanAttribute', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeElasticPlanAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ModifyDBClusterSSL', + 'description' => '', 'operationType' => 'update', - 'abilityTreeCode' => '216927', - 'abilityTreeNodes' => [ - 'FEATUREadsQO9FPM', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen', + [ + 'apiName' => 'CheckSampleDataSet', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:CheckSampleDataSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '湖存储描述', - 'description' => 'The description of the lake storage.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'UnbindDBResourceGroupWithUser', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:UnbindDBResourceGroupWithUser', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'LakeStorageId', - 'in' => 'formData', - 'schema' => [ - 'title' => '湖存储唯一标识', - 'description' => 'The unique identifier of the lake storage.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', + ], + [ + 'apiName' => 'ModifyDBClusterVip', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterVip', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'ADB实例ID', - 'description' => 'The ID of the AnalyticDB for MySQL cluster that is associated with the lake storage.', - 'type' => 'string', - 'required' => false, - 'example' => 'amv-*******', + ], + [ + 'apiName' => 'DescribeEssdCacheConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DescribeEssdCacheConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'Permissions', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '湖存储权限', - 'description' => 'The permissions on the lake storage.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '权限项', - 'description' => 'The permissions.'."\n", - 'type' => 'object', - 'properties' => [ - 'Read' => [ - 'title' => '读权限', - 'description' => 'The read permissions.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'Write' => [ - 'title' => '写权限', - 'description' => 'The write permissions.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'Account' => [ - 'title' => '账户ID', - 'description' => 'The account ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - 'pattern' => '^\\d+$', - 'default' => '', - ], - 'Type' => [ - 'title' => '账户类型', - 'description' => 'The account type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SUB', - 'enum' => [ - 'Service', - 'User', - ], - ], - ], - 'required' => false, - 'example' => '-', - ], - 'required' => false, - 'example' => '-', + ], + [ + 'apiName' => 'RunMaterializedViewRecommend', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:RunMaterializedViewRecommend', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'LakeStorageId' => [ - 'title' => '湖存储唯一标识', - 'description' => 'The unique identifier of the lake storage.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'Description' => [ - 'title' => '湖存储描述', - 'description' => 'The description of the lake storage.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DBClusterId' => [ - 'title' => 'ADB实例ID', - 'description' => 'The ID of the AnalyticDB for MySQL cluster that is associated with the lake storage.', - 'type' => 'string', - 'example' => 'amv-23xxxx', - ], - 'FileSize' => [ - 'title' => '总存储量', - 'description' => 'The total storage size.'."\n", - 'type' => 'string', - 'example' => '142', - ], - 'RowCount' => [ - 'title' => '总数据行数', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '>=', - 'pattern' => '', - 'default' => '', - ], - 'TableCount' => [ - 'title' => '库表数量', - 'description' => 'The number of tables.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1234', - 'pattern' => '', - 'default' => '', - ], - 'PartitionCount' => [ - 'description' => 'The number of partitions.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'CreatorUid' => [ - 'title' => '创建者UID', - 'description' => 'The creator UID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'OwnerUid' => [ - 'title' => '拥有者UID', - 'description' => 'The owner UID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'OperatorUid' => [ - 'title' => '操作者UID', - 'description' => 'The operator UID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'Permissions' => [ - 'title' => '湖存储权限', - 'description' => 'The permissions on the lake storage.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '权限项', - 'description' => 'The permissions.'."\n", - 'type' => 'object', - 'properties' => [ - 'Read' => [ - 'title' => '读权限', - 'description' => 'The read permissions.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Write' => [ - 'title' => '写权限', - 'description' => 'The write permissions.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Account' => [ - 'title' => '账户ID', - 'description' => 'The account ID.'."\n", - 'type' => 'string', - 'example' => 'test', - 'pattern' => '^\\d+$', - 'default' => '', - ], - 'Type' => [ - 'title' => '账户类型', - 'description' => 'The account type.'."\n", - 'type' => 'string', - 'example' => 'SUB', - 'enum' => [ - 'CUSTOMER', - 'SUB', - 'STS', - ], - ], - ], - 'example' => '-', - ], - 'example' => '-', - 'maxItems' => 20, - 'minItems' => 0, - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the lake storage was created.'."\n", - 'type' => 'string', - 'example' => '2023-05-15T07:24:58Z', - ], - 'UpdateTime' => [ - 'title' => '更新时间', - 'description' => 'The time when the lake storage was last updated.'."\n", - 'type' => 'string', - 'example' => '2024-07-01T09:22:17Z', - ], - 'RegionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - 'example' => '-', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code. A value of 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code. A value of 200 indicates that the request is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, an OK message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - ], + [ + 'apiName' => 'DescribeClusterResourceUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeClusterResourceUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DeleteBackups', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteBackups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - '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' => 'UpdateLakeStorage', - ], - 'ListLakeStorages' => [ - 'summary' => 'Queries a list of lake storages.', - 'methods' => [ - 'get', + [ + 'apiName' => 'CreateApsKafkaHudiJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsKafkaHudiJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ModifyElasticPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateDBResourceGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '216928', - 'abilityTreeNodes' => [ - 'FEATUREadsQO9FPM', + [ + 'apiName' => 'ModifyAccountPrivileges', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyAccountPrivileges', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - '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' => 'The filter parameters that you want to use to query lake storages. Specify multiple parameters in an AND relationship. For example, if you want to query lake storage whose names are in the range of i-a123, or i-b123, and in the Stopped state, set this parameter to \\&Filter. 1.Name=InstanceName\\&Filter. 1.Value.1=i-a123\\&Filter.1.Value.2=i-b123\\&Filter.2.Name=Status\\&Filter. 2.Value=Stopped.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', + ], + [ + 'apiName' => 'GetSparkTemplateFolderTree', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkTemplateFolderTree', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果的最大个数。', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeResultExportConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeResultExportConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + ], + [ + 'apiName' => 'GetSparkReplStatement', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:GetSparkReplStatement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}/{#sparkStatmentId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-*******', + ], + [ + 'apiName' => 'BindDBResourceGroupWithUser', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:BindDBResourceGroupWithUser', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****-964D-****-9D31-****', - ], - 'TotalCount' => [ - 'title' => '总记录数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'title' => '当总结果个数大于MaxResults时，用于翻页的token。', - 'description' => 'The token that is used for paging when the number of results is greater than the value of MaxResults.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Items' => [ - 'title' => '数组，返回示例目录。', - 'description' => 'The queried lake storages.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'LakeStorageItemType', - 'description' => 'LakeStorageItemType'."\n", - 'type' => 'object', - 'properties' => [ - 'OwnerUid' => [ - 'title' => '拥有者UID', - 'description' => 'The queried lake storage.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'DBClusterId' => [ - 'title' => 'ADB实例ID', - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-*******', - ], - 'TotalRows' => [ - 'title' => '总数据行数', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - 'pattern' => '', - 'default' => '', - ], - 'OperatorUid' => [ - 'title' => '操作者UID', - 'description' => 'The operator UID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'Permissions' => [ - 'title' => '湖存储权限', - 'description' => 'The permissions on the lake storage.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '权限项', - 'description' => 'The permissions.'."\n", - 'type' => 'object', - 'properties' => [ - 'Read' => [ - 'title' => '读权限', - 'description' => 'The read permissions.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Write' => [ - 'title' => '写权限', - 'description' => 'The write permissions.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Account' => [ - 'title' => '账户ID', - 'description' => 'The database account ID.'."\n", - 'type' => 'string', - 'example' => '-', - 'pattern' => '^\\d+$', - 'default' => '', - ], - 'Type' => [ - 'title' => '账户类型', - 'description' => 'The type of the database account.'."\n", - 'type' => 'string', - 'example' => '-', - 'enum' => [ - 'CUSTOMER', - 'SUB', - 'STS', - ], - ], - ], - 'example' => '-', - ], - 'example' => '-', - ], - 'TableCount' => [ - 'title' => '库表数量', - 'description' => 'The number of tables.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'pattern' => '', - 'default' => '', - ], - 'Description' => [ - 'title' => '湖存储描述', - 'description' => 'The description of the lake storage.'."\n", - 'type' => 'string', - 'example' => 'Create a role to run ROS StackGroups.', - ], - 'LakeStorageId' => [ - 'title' => '湖存储唯一标识', - 'description' => 'The unique identifier of the lake storage.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the lake storage was created.'."\n", - 'type' => 'string', - 'example' => '2021-04-01T09:50:18Z', - ], - 'TotalStorage' => [ - 'title' => '总存储量', - 'description' => 'The total storage size.'."\n", - 'type' => 'string', - 'example' => '111333', - ], - 'CreatorUid' => [ - 'title' => '创建者UID', - 'description' => 'The creator UID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'UpdateTime' => [ - 'title' => '更新时间', - 'description' => 'The time when the lake storage was last updated.'."\n", - 'type' => 'string', - 'example' => '2024-03-15T02:24:32', - ], - 'RegionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'FileSize' => [ - 'description' => 'The size of data files.'."\n", - 'type' => 'string', - 'example' => '651', - ], - ], - 'example' => '-', - ], - 'example' => '-', - ], - 'Success' => [ - 'description' => 'Indicates whether the dry run succeeds. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - ], + [ + 'apiName' => 'EnableAdviceService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:EnableAdviceService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeAuditLogRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAuditLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - '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' => 'ListLakeStorages', - ], - 'GetLakeStorage' => [ - 'summary' => 'Queries a lake storage.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ApplyAdviceById', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ApplyAdviceById', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ModifyUserEniVswitchOptions', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyUserEniVswitchOptions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetSparkLogAnalyzeTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkLogAnalyzeTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/task/{#SparkTaskId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeDBClusterAttribute', + 'description' => '', 'operationType' => 'get', - 'abilityTreeCode' => '216924', - 'abilityTreeNodes' => [ - 'FEATUREadsQO9FPM', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'EnableElasticPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:EnableElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'LakeStorageId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例 ID。', - 'description' => 'The lake storage ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', + ], + [ + 'apiName' => 'DescribeTablePartitionDiagnose', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeTablePartitionDiagnose', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-*******', + ], + [ + 'apiName' => 'DescribeWorkerDetection', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeWorkerDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******-3EEC-******-9F06-******', - ], - 'Data' => [ - 'description' => 'The queried lake storage.'."\n", - 'type' => 'object', - 'properties' => [ - 'LakeStorageId' => [ - 'title' => '湖存储唯一标识', - 'description' => 'The unique identifier of the lake storage.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'Description' => [ - 'title' => '湖存储描述', - 'description' => 'The description of the lake storage.'."\n", - 'type' => 'string', - 'example' => 'a test db', - ], - 'DBClusterId' => [ - 'title' => 'ADB实例ID', - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-*******', - ], - 'FileSize' => [ - 'title' => '总存储量', - 'description' => 'The total storage size.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'RowCount' => [ - 'title' => '总数据行数', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-', - 'pattern' => '', - 'default' => '', - ], - 'TableCount' => [ - 'title' => '库表数量', - 'description' => 'The number of the tables.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-', - 'pattern' => '', - 'default' => '', - ], - 'PartitionCount' => [ - 'description' => 'The number of partitions.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'CreatorUid' => [ - 'title' => '创建者UID', - 'description' => 'The creator UID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'OwnerUid' => [ - 'title' => '拥有者UID', - 'description' => 'The owner UID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'OperatorUid' => [ - 'title' => '操作者UID', - 'description' => 'The operator UID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'Permissions' => [ - 'title' => '湖存储权限', - 'description' => 'The permissions on the lake storage.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '权限项', - 'description' => 'The permissions.'."\n", - 'type' => 'object', - 'properties' => [ - 'Read' => [ - 'title' => '读权限', - 'description' => 'The read permissions.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Write' => [ - 'title' => '写权限', - 'description' => 'The write permissions.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Account' => [ - 'title' => '账户ID', - 'description' => 'The account ID.'."\n", - 'type' => 'string', - 'example' => 'test', - 'pattern' => '^\\d+$', - 'default' => '', - ], - 'Type' => [ - 'title' => '账户类型', - 'description' => 'The account type.'."\n", - 'type' => 'string', - 'example' => '-', - 'enum' => [ - 'CUSTOMER', - 'SUB', - 'STS', - ], - ], - ], - 'example' => '-', - ], - 'example' => '-', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the lake storage was created.'."\n", - 'type' => 'string', - 'example' => '2023-05-15T07:24:58Z', - ], - 'UpdateTime' => [ - 'title' => '更新时间', - 'description' => 'The time when the lake storage was last updated.'."\n", - 'type' => 'string', - 'example' => '2024-10-14T02:28:41Z', - ], - 'RegionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - 'example' => '-', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - ], + [ + 'apiName' => 'ModifyDBClusterMaintainTime', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterMaintainTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeAdbMySqlSchemas', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlSchemas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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' => 'GetLakeStorage', - ], - 'CreateLakeStorage' => [ - 'summary' => 'Creates a lake storage.', - 'methods' => [ - 'post', + [ + 'apiName' => 'DescribeSchemas', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:describeAllDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DescribeSQLPatterns', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSQLPatterns', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeSparkSQLDiagnosisAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkSQLDiagnosisAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeSparkAppDiagnosisInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkAppDiagnosisInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '216925', - 'abilityTreeNodes' => [ - 'FEATUREadsQO9FPM', + [ + 'apiName' => 'ModifyAuditLogConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyAuditLogConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'GetSparkAppMetrics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppMetrics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'SparkApplication', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], ], ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '湖存储描述', - 'description' => 'The description of the lake storage.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'GetTableDDL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getTableDDL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'ADB实例ID', - 'description' => 'The ID of the AnalyticDB for MySQL cluster with which you want to associate the lake storage.', - 'type' => 'string', - 'required' => false, - 'example' => 'amv-******', + ], + [ + 'apiName' => 'ModifyEssdCacheConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyEssdCacheConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'Permissions', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '湖存储权限', - 'description' => 'The permissions that you want to grant on the lake storage to the Alibaba Cloud account besides the permissions that are automatically granted to the Resource Access Management (RAM) user or the Alibaba Cloud account.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '权限项', - 'description' => 'The permissions.'."\n", - 'type' => 'object', - 'properties' => [ - 'Read' => [ - 'title' => '读权限', - 'description' => 'The read permissions.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => '-', - ], - 'Write' => [ - 'title' => '写权限', - 'description' => 'The write permissions.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => '-', - ], - 'Account' => [ - 'title' => '账户ID', - 'description' => 'The account ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - 'pattern' => '^\\d+$', - 'default' => '', - ], - 'Type' => [ - 'title' => '账户类型', - 'description' => 'The account type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - 'enum' => [ - 'CUSTOMER', - 'SUB', - 'STS', - ], - ], - ], - 'required' => false, - ], - 'required' => false, - 'example' => '-', + ], + [ + 'apiName' => 'GetSparkSQLEngineState', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetActiveSparkSession', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], ], ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" - .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', - 'type' => 'string', - 'required' => false, - 'example' => '******', + ], + [ + 'apiName' => 'DescribeBackups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID'."\n", - 'type' => 'string', - 'example' => '******', - ], - 'Message' => [ - 'title' => '若创建接口为异步实现，则需返回明确的JobId。', - 'description' => 'The returned message. If the operation is asynchronously implemented, the job ID is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code or the error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Data' => [ - 'description' => 'The usage details of cluster resources.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'DescribeProcessList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeProcessList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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.', + [ + 'apiName' => 'GetCreateTableSQL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetCreateTableSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateDBCluster', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateDBCluster', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'adb:DiskEncryption', 'validationType' => 'always'], + ['conditionKey' => 'adb:EnableSSL', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'CreateLakeStorage', - ], - 'DeleteLakeStorage' => [ - 'summary' => 'Deletes a lake storage.', - 'methods' => [ - 'post', + [ + 'apiName' => 'UpgradeKernelVersion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:UpgradeKernelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'LoadSampleDataSet', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:LoadSampleDataSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeClusterNetInfo', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeClusterNetInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '216926', - 'abilityTreeNodes' => [ - 'FEATUREadsQO9FPM', + [ + 'apiName' => 'DescribeTables', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:describeAllDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + [ + 'apiName' => 'DescribeHistoryTasks', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeHistoryTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'LakeStorageId', - 'in' => 'formData', - 'schema' => [ - 'title' => '实例 ID。', - 'description' => 'The ID of the lake storage.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '-', + ], + [ + 'apiName' => 'DescribeElasticPlanSpecifications', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeElasticPlanSpecifications', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp*********', + ], + [ + 'apiName' => 'DescribeViewJobs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeViewJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2******-B2C1-408E-AA73-DB8D59******', - ], - 'Message' => [ - 'title' => '若创建接口为异步实现，则需返回明确的JobId。', - 'description' => 'The returned message. If the operation is asynchronously implemented, the job ID is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the delete operation was successful.'."\n", - 'type' => 'string', - 'example' => 'True', - ], - ], + [ + 'apiName' => 'DeleteApsWebhook', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteApsWebhook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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.', + [ + 'apiName' => 'SubmitResultExportJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:SubmitResultExportJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateAPSJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateAPSJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - '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' => 'DeleteLakeStorage', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - 'ModifyLakeCacheSize' => [ - 'summary' => 'Modifies the lake cache size of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeClusterAccessWhiteList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeClusterAccessWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetSparkConfigLogPath', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkConfigLogPath', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeAccountAllPrivileges', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAccountAllPrivileges', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeSparkSQLDiagnosisList', + 'description' => '', 'operationType' => 'get', - 'abilityTreeCode' => '214852', - 'abilityTreeNodes' => [ - 'FEATUREadsCQJTKP', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkSQLDiagnosisList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp10yt0gva71ei7d', + [ + 'apiName' => 'AttachUserENI', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:AttachUserENI', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'EnableLakeCache', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the lake cache feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', + ], + [ + 'apiName' => 'GetViewDDL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getViewDDL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'Capacity', - 'in' => 'query', - 'schema' => [ - 'description' => 'The lake cache size that you want to set. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', + ], + [ + 'apiName' => 'ListSparkApps', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkApps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'PlainResponse', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '494486CE-6F49-574E-B304-29127EA12E36', - ], - 'Code' => [ - 'description' => 'The status code. The value 200 indicates that the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Instances' => [ - 'description' => 'The clusters that share the lake cache space.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-bp10yt0gva71ei7d', - ], - ], - 'Capacity' => [ - 'description' => 'The size of the lake cache space. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'DataSize' => [ - 'description' => 'The size of the data that occupies the lake cache space. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - ], + [ + 'apiName' => 'CreateMaterializedViewRecommend', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateMaterializedViewRecommend', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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' => 'ModifyLakeCacheSize', - ], - 'DescribeLakeCacheSize' => [ - 'summary' => 'Queries the lake cache size of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetSparkWarehouseBatchSQL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkWarehouseBatchSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeEnabledPrivileges', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeEnabledPrivileges', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '214834', - 'abilityTreeNodes' => [ - 'FEATUREadsCQJTKP', + [ + 'apiName' => 'DescribeApsHiveWorkload', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsHiveWorkload', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp10b6646l07akdt', + [ + 'apiName' => 'DescribeSparkAuditLogRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkAuditLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'PlainResponse', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Code' => [ - 'description' => 'The status code. The value 200 indicates that the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-bp10b6646l07akdt'."\n", - ], - 'EnableLakeCache' => [ - 'description' => 'Indicates whether the lake cache feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Instances' => [ - 'description' => 'The clusters that share the lake cache space.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'amv-bp10b6646l07akdt'."\n", - ], - ], - 'Capacity' => [ - 'description' => 'The size of the lake cache space. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'DataSize' => [ - 'description' => 'The size of the data that occupies the lake cache space. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - ], + [ + 'apiName' => 'ConfigureResultExport', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:ConfigureResultExport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => 'DescribeLakeCacheSize', - ], - 'DescribeCompactionServiceSwitch' => [ - 'summary' => 'Queries whether the remote build feature is enabled in the query acceleration configuration of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeApsDatasources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsDatasources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeColumns', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:describeAllDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetTable', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getTable', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', + [ + 'apiName' => 'DeleteMaterializedViewRecommend', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteMaterializedViewRecommend', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp149vz49b36t****', + [ + 'apiName' => 'DescribeExcessivePrimaryKeys', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeExcessivePrimaryKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D761DA51-12F8-5457-AAA9-F52B9F436D2D', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'EnableCompactionService' => [ - 'description' => 'Indicates whether the remote build feature is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'GetSparkTemplateFullTree', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkTemplateFullTree', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + [ + 'apiName' => 'DescribeSqlPattern', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSqlPattern', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + [ + 'apiName' => 'ModifyApsSlsADBJob', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyApsSlsADBJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - [ - 'errorCode' => 'InvalidMaintainTime.Malformed', - 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + [ + 'apiName' => 'StartSparkSQLEngine', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:StartSparkEngine', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D761DA51-12F8-5457-AAA9-F52B9F436D2D\\",\\n \\"Data\\": {\\n \\"EnableCompactionService\\": true\\n }\\n}","type":"json"}]', - 'title' => 'DescribeCompactionServiceSwitch', - ], - 'ModifyEssdCacheConfig' => [ - 'summary' => 'Modifies the disk cache size in the query acceleration configuration of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'BindAccount', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:BindAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'AccountLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ModifyAccountDescription', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyAccountDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeResourceGroupSpec', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeResourceGroupSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ModifyDBClusterResourceGroup', + 'description' => '', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBClusterResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp10yt0gva71ei7d', + [ + 'apiName' => 'DescribeDownloadRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDownloadRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'EnableEssdCache', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the disk cache feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', + ], + [ + 'apiName' => 'DescribeSQLWebSocketDomain', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeSQLWebSocketDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EssdCacheSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The disk cache size. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '500', + ], + [ + 'apiName' => 'GetSparkAppLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '115F9CCA-EF2E-5F91-AB60-4961D52FEAB4', - ], - ], - 'description' => '', + [ + 'apiName' => 'DescribeUserQuota', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeUserQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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.', + [ + 'apiName' => 'DetachUserENI', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DetachUserENI', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"115F9CCA-EF2E-5F91-AB60-4961D52FEAB4\\"\\n}","type":"json"}]', - 'title' => 'ModifyEssdCacheConfig', - ], - 'DescribeEssdCacheConfig' => [ - 'summary' => 'Queries the disk cache size in the query acceleration configuration of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteDBResourceGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteDBResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeAccountPrivileges', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAccountPrivileges', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ModifyBackupPolicy', + 'description' => '', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', + 'ramAction' => [ + 'action' => 'adb:ModifyBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-uf685u1o987hj6rn', + [ + 'apiName' => 'CreateBackup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateBackup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'EnableEssdCache' => [ - 'description' => 'Specifies whether to enable the disk cache feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - ], - 'EssdCacheSize' => [ - 'description' => 'The disk cache size. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - ], - ], - ], - 'description' => 'The response parameters.', + [ + 'apiName' => 'StartApsJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:StartApsJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + [ + 'apiName' => 'DescribeStorageResourceUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeStorageResourceUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + [ + 'apiName' => 'DescribeJobResourceUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeJobResourceUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - [ - 'errorCode' => 'InvalidMaintainTime.Malformed', - 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + [ + 'apiName' => 'CreateLakeStorage', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:CreateLakeStorageBucket', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"Data\\": {\\n \\"EnableEssdCache\\": true,\\n \\"EssdCacheSize\\": 500\\n }\\n}","type":"json"}]', - 'title' => 'DescribeEssdCacheConfig', - ], - 'ModifyCompactionServiceSwitch' => [ - 'summary' => 'Modifies the status of the remote build feature in the query acceleration configuration of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeComputeResourceUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeComputeResourceUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeKernelVersion', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeKernelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeAdbMySqlTableMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlTableMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', + [ + 'apiName' => 'GetSparkAppAttemptLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppAttemptLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'amv-bp14t95lun0w****', + [ + 'apiName' => 'DescribeDiagnosisSQLInfo', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDiagnosisSQLInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'EnableCompactionService', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the remote build feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', + ], + [ + 'apiName' => 'ModifyClusterAccessWhiteList', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyClusterAccessWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '21ABF219-10E0-571B-94B8-9C9AE5022BF8', - ], - ], - 'description' => '', + [ + 'apiName' => 'ModifyDBCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyDBCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + [ + 'apiName' => 'DescribeAvailableAdvices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAvailableAdvices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + [ + 'apiName' => 'GetDatabaseObjects', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getDatabaseObjectsByFilter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], - [ - 'errorCode' => 'InvalidMaintainTime.Malformed', - 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + [ + 'apiName' => 'KillSparkApp', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:KillSparkApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21ABF219-10E0-571B-94B8-9C9AE5022BF8\\"\\n}","type":"json"}]', - 'title' => 'ModifyCompactionServiceSwitch', - ], - 'SubmitResultExportJob' => [ - 'summary' => 'Submits an SQL query and exports a result set.', - 'methods' => [ - 'post', + [ + 'apiName' => 'DeleteDBCluster', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteDBCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ModifyMaterializedViewRecommend', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyMaterializedViewRecommend', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeTableAccessCount', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeTableAccessCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '219535', - 'abilityTreeNodes' => [ - 'FEATUREadsCORDM7', + [ + 'apiName' => 'DescribeAccountPrivilegeObjects', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAccountPrivilegeObjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'AllocateClusterPublicConnection', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:AllocateClusterPublicConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.', - 'type' => 'string', - 'required' => true, - 'example' => 'amv-bp10a0ng21t5****', + ], + [ + 'apiName' => 'ExistRunningSQLEngine', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetActiveSparkSession', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], ], ], - [ - 'name' => 'Engine', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The engine that is used to run the result set export job. Set the value to XIHE.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'XIHE', + ], + [ + 'apiName' => 'DeleteAccount', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'ResourceGroup', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the resource group that runs the result set export job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user_default', + ], + [ + 'apiName' => 'GetSparkTemplateFileContent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkTemplateFileContent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'Schema', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tpch_oss', + ], + [ + 'apiName' => 'DescribeAccounts', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'SQL', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The SQL statement that is used in the result set export job. You can specify only SELECT statements. If you specify other SQL statements, the request fails.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SELECT * FROM `fotor_com_datastore_resource`.`fotor_ai_create_task` where `date` = \'2023-05-13\' LIMIT 10;', + ], + [ + 'apiName' => 'DescribeHistoryTasksStat', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DescribeHistoryTasksStat', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ExportType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the result set export job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SLS', + ], + [ + 'apiName' => 'DeleteApsJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DeleteApsJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultData', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, an **OK** message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput'."\n", - ], - 'Data' => [ - 'description' => 'The ID of the result set export job.'."\n", - 'type' => 'string', - 'example' => 'export_202405131927121980210080040****'."\n", - ], - ], + [ + 'apiName' => 'KillSparkSQLEngine', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:KillSparkEngine', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], ], ], ], - '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' => 'SubmitResultExportJob', - ], - 'ListResultExportJobHistory' => [ - 'summary' => 'Queries the execution records of result set export jobs of a Resource Access Management (RAM) user.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateLakeStorage', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:UpdateLakeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'KillSparkLogAnalyzeTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:KillSparkLogAnalyzeTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/task/{#SparkTaskId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '219537', - 'abilityTreeNodes' => [ - 'FEATUREadsCORDM7', + [ + 'apiName' => 'GetLakeStorage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetLakeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID of the cluster.'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DescribeAllDataSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:describeAllDataSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.', - 'type' => 'string', - 'required' => true, - 'example' => 'amv-7xv5ty5m9o4v****', + ], + [ + 'apiName' => 'DescribeOperatorPermission', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeOperatorPermission', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'ListSparkWarehouseBatchSQL', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkWarehouseBatchSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values:'."\n" - ."\n" - .'* **30** (default)'."\n" - .'* **50**'."\n" - .'* **100**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', + ], + [ + 'apiName' => 'DescribeAdviceServiceEnabled', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeAdviceServiceEnabled', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-01T12:01:00Z', + ], + [ + 'apiName' => 'ListLakeStorages', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListLakeStorages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-05-25T06:54:00Z', + ], + [ + 'apiName' => 'DescribeMvRecommendSubTasks', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeMvRecommendSubTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'Order', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The order in which to sort the SQL statements by field, which contains the `Field` and `Type` fields. Specify the order in the JSON format. Example: `[{"Field":"CreateTimee", "Type": "desc" }]`.'."\n" - ."\n" - .'* `Field` specifies the field that is used to sort the SQL statements. Valid values:'."\n" - ."\n" - .' * `CreateTime`: the time when the result set export job was created.'."\n" - .' * `Status`: the execution status.'."\n" - .' * `DatabaseUser`: the name of the database account.'."\n" - .' * `TimeCost`: the execution duration.'."\n" - .' * `ResourceGroup`: the name of the resource group.'."\n" - .' * `ExportRows`: the number of exported rows.'."\n" - .' * `Progress`: the export progress.'."\n" - ."\n" - .'* `Type` specifies the sorting order. Valid values (case-insensitive):'."\n" - ."\n" - .' * `Desc`: descending order.'."\n" - .' * `Asc`: ascending order.'."\n", - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => 'The field that is used to sort the SQL statements. Valid values:'."\n" - ."\n" - .'* CreateTime'."\n" - .'* DatabaseUser'."\n" - .'* TimeCost'."\n" - .'* ResourceGroup'."\n" - .'* Status'."\n" - .'* Progress'."\n" - .'* ExportRows'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DatabaseUser', - ], - 'Type' => [ - 'description' => 'The sorting order. Valid values (case-insensitive):'."\n" - ."\n" - .'* **Desc**: descending order.'."\n" - .'* **Asc**: ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Desc', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'GetSparkReplSession', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:GetSparkReplSession', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}/{#sessionid}'], ], ], - [ - 'name' => 'StatusList', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The execution status of result set export jobs. You can use this parameter to query the execution records of export jobs that are in a specific state.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Valid values:'."\n" - ."\n" - .'1. **SUBMITTED**'."\n" - .'2. **RUNNING**'."\n" - .'3. **SUCCEEDED**'."\n" - .'4. **FAILED**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'required' => false, + ], + [ + 'apiName' => 'DescribeControllerDetection', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeControllerDetection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'ResourceGroup', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the resource group that runs the result set export jobs. You can use this parameter to query the execution records of export jobs that are run in a specific resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user_default', + ], + [ + 'apiName' => 'DescribeAdbMySqlColumns', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlColumns', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DatabaseUser', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', + ], + [ + 'apiName' => 'GetSparkAppWebUiAddress', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppWebUiAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultData', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, an **OK** message is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Items' => [ - 'description' => 'The queried result set export jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried result set export job.'."\n", - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", - 'type' => 'string', - 'example' => 'amv-7xv5ty5m9o4v****', - ], - 'AliUid' => [ - 'description' => 'The RAM user ID.'."\n", - 'type' => 'string', - 'example' => '120010511678****', - ], - 'Sql' => [ - 'description' => 'The SQL statement that is used in the result set export job.'."\n", - 'type' => 'string', - 'example' => 'SELECT * FROM `ADB_SampleData_TPCH`.`supplier` LIMIT 20', - ], - 'CreateTime' => [ - 'description' => 'The time when the result set export job was created. The time follows the ISO 8601 standard in the *yyyy-mm-ddThh:mm:ssZ* format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-04-01T09:50:18Z', - ], - 'StartTime' => [ - 'description' => 'The start time of the result set export job. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-07-03T04:00:00Z', - ], - 'EndTime' => [ - 'description' => 'The end time of the result set export job. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time.'."\n", - 'type' => 'string', - 'example' => '2023-06-15T02:13:00Z', - ], - 'DatabaseUser' => [ - 'description' => 'The name of the database account that is associated with the RAM user.'."\n", - 'type' => 'string', - 'example' => 'ram_user', - ], - 'TimeCost' => [ - 'description' => 'The amount of time consumed to export execution records. Unit: milliseconds.'."\n" - ."\n" - .'> The value is the duration between the time when the result set export job starts and the time when the result set export job ends.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '560', - ], - 'ExportJobId' => [ - 'description' => 'The unique identifier of the result set export job.'."\n", - 'type' => 'string', - 'example' => 'export_2024051319271219802100800401300****'."\n", - ], - 'ResourceGroup' => [ - 'description' => 'The name of the resource group that runs the result set export job.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'description' => 'The execution status of the result set export job. Valid values:'."\n" - ."\n" - .'1. **SUBMITTED**'."\n" - .'2. **RUNNING**'."\n" - .'3. **SUCCEEDED**'."\n" - .'4. **FAILED**'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ExportPath' => [ - 'description' => 'The complete URL of the path to store the exported result set.'."\n", - 'type' => 'string', - 'example' => 'oss://testBucketName/export_test/result_export/2024/05/13/202405131528400210090110690315154****/result.csv', - ], - 'Progress' => [ - 'description' => 'The progress of the result set export job. Unit: %. Valid values: 0 to 100.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'ProcessId' => [ - 'description' => 'The query ID that can be used for diagnostics.'."\n" - ."\n" - .'> You can call the [DescribeDiagnosisSQLInfo](~~612337~~) operation to query the execution information about a query.', - 'type' => 'string', - 'example' => '202306121421111720161451770345339****', - ], - 'ExportRows' => [ - 'description' => 'The number of exported rows. This parameter is returned only when the request was successful.'."\n", - 'type' => 'string', - 'example' => '10000', - ], - 'Message' => [ - 'description' => 'The returned message. This parameter is returned only when the request failed.'."\n", - 'type' => 'string', - 'example' => 'Failed to execute SQL', - ], - 'Engine' => [ - 'description' => 'The engine that is used to execute the result set export job. Only XIHE is returned.'."\n", - 'type' => 'string', - 'example' => 'XIHE', - ], - 'Schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'lake_db', - ], - 'ExportType' => [ - 'description' => 'The type of the result set export job.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'IsExpired' => [ - 'description' => 'Indicates whether the result set export job has expired. Valid values:'."\n" - ."\n" - .'* **false**'."\n" - .'* **true**'."\n", - 'type' => 'boolean', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '174', - ], - ], + [ + 'apiName' => 'DeleteApsDatasoure', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DeleteApsDatasoure', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ModifyApsJob', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyApsJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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' => 'ListResultExportJobHistory', - ], - 'DescribeSQLWebSocketDomain' => [ - 'summary' => 'Queries the WebSocket domain name of an AnalyticDB for MySQL cluster.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'BatchApplyAdviceByIdList', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:BatchApplyAdviceByIdList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeMvRecommendTasks', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeMvRecommendTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeDBClusterPerformance', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeAdbMySqlTables', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeAdbMySqlTables', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeApsDatasource', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeApsDatasource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + [ + 'apiName' => 'ListResultExportJobHistory', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListResultExportJobHistory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeTableDetail', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '180261', - 'abilityTreeNodes' => [ - 'FEATUREads8FGISX', + 'ramAction' => [ + 'action' => 'adb:DescribeTableDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID'."\n" - ."\n" - .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ListSparkLogAnalyzeTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkLogAnalyzeTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amv-bp1lw6g669zpi660', + ], + [ + 'apiName' => 'StartSparkReplSession', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:SubmitSparkApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#resourcegroup}'], ], ], - [ - 'name' => 'Module', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'DeleteSparkTemplateFile', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteSparkTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/template/{#TemplateId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request was successful, a success message is returned.****'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E03F0806-A67B-5B24-8562-9589F20DEEB5', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'adb-ws-beijing.console.aliyun.com/query', - ], - ], - 'description' => '', + [ + 'apiName' => 'GetViewObjects', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getViewObjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'SuspendApsJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:SuspendApsJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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' => 'DescribeSQLWebSocketDomain', - ], - 'ConfigureResultExport' => [ - 'summary' => 'Configures the export destination (SLS or OSS) at the instance level. The configuration is unique per instance and follows the "configure once, use multiple times" principle.', - 'methods' => [ - 'post', + [ + 'apiName' => 'CancelSparkWarehouseBatchSQL', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:CancelSparkWarehouseBatchSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateApsSlsADBJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsSlsADBJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteSparkTemplate', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteSparkTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/template/{#TemplateId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateAccount', + 'description' => '', 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '254776', - 'abilityTreeNodes' => [ - 'FEATUREadsCORDM7', + 'ramAction' => [ + 'action' => 'adb:CreateAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the region where the instance resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shenzhen', + [ + 'apiName' => 'UpdateSparkTemplateFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:UpdateSparkTemplateFile', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'SparkTemplate', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/template/{#TemplateId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-wz9509beptiz****', + ], + [ + 'apiName' => 'DescribeDBClusterHealthStatus', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeDBClusterHealthStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'ExportType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The export type. Valid values:'."\n" - ."\n" - .'* SLS: Specifies that the export destination is SLS.'."\n" - .'* OSS: Specifies that the export destination is OSS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SLS', + ], + [ + 'apiName' => 'PreloadSparkAppMetrics', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:PreloadSparkAppMetrics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'SparkApplication', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], ], ], - [ - 'name' => 'SlsInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The SLS configuration details if the destination is of the SLS type.'."\n", - 'type' => 'object', - 'properties' => [ - 'SlsProject' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-project', - ], - 'ResourceGroup' => [ - 'description' => 'The name of the resource group that runs the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aps', - ], - 'LogstoreTtl' => [ - 'description' => 'The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day, maximum: 30 days. Values outside this range will result in an error.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'DescribeAPSADBInstances', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:DescribeAPSADBInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'OssInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The OSS configuration details if the destination is of the OSS type.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExportBasePath' => [ - 'description' => 'The OSS path where the result sets are stored.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://testBucketName/data_result', - ], - 'ResourceGroup' => [ - 'description' => 'The name of the resource group that runs the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aps', - ], - 'ResultFileTtl' => [ - 'description' => 'The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days. Values outside this range will result in an error.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'ResetAccountPassword', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ResetAccountPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultData', - 'description' => 'ResultData\\'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* **true**: Succeeded.'."\n" - .'* **false**: Failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code. A value of 200 indicates that the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* OK is returned if the request is normal.'."\n" - .'* The specific error code is returned if the request is abnormal,'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'The backend error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The path where the result sets are stored.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExportType' => [ - 'description' => 'The export type. Valid values:'."\n" - ."\n" - .'* SLS: Indicates that the export destination is SLS.'."\n" - .'* OSS: Indicates that the export destination is OSS.'."\n", - 'type' => 'string', - 'example' => 'SLS', - ], - 'SlsInfo' => [ - 'description' => 'The SLS configuration if the destination is of the SLS type.'."\n", - 'type' => 'object', - 'properties' => [ - 'SlsProject' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'example' => 'test-project', - ], - 'ResourceGroup' => [ - 'description' => 'The name of the resource group that runs the job.'."\n", - 'type' => 'string', - 'example' => 'aps', - ], - 'LogstoreTtl' => [ - 'description' => 'The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day. Maximum value: 30 days.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'OssInfo' => [ - 'description' => 'The OSS configuration if the destination is of the OSS type.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExportBasePath' => [ - 'description' => 'The OSS path where the result sets are stored.'."\n", - 'type' => 'string', - 'example' => 'oss://testBucketName/data_result', - ], - 'ResourceGroup' => [ - 'description' => 'The name of the resource group that runs the job.'."\n", - 'type' => 'string', - 'example' => 'aps', - ], - 'ResultFileTtl' => [ - 'description' => 'The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeSparkCodeWebUi', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkCodeWebUi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSparkAppInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], + ], + ], + [ + 'apiName' => 'GetSparkAppState', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetSparkAppState', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ], + ], + ], + [ + 'apiName' => 'ListSparkTemplateFileIds', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkTemplateFileIds', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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' => 'ConfigureResultExport', - ], - 'DescribeResultExportConfig' => [ - 'summary' => 'Queries the user-configured result set export settings.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateApsWebhook', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'adb:CreateApsWebhook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListSparkAppAttempts', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:ListSparkAppAttempts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ModifySqlTemplatePosition', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '254784', - 'abilityTreeNodes' => [ - 'FEATUREadsCORDM7', + 'ramAction' => [ + 'action' => 'adb:ModifySqlTemplatePosition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shenzhen', + [ + 'apiName' => 'DescribeApsMigrationWorkloads', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeApsMigrationWorkloads', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n" - ."\n" - .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-8vbf80pjcz*****', + ], + [ + 'apiName' => 'SubmitSparkApp', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:SubmitSparkApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'SparkApplication', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], ], ], - [ - 'name' => 'ExportType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The export type. Valid values:'."\n" - ."\n" - .'* SLS: Indicates that the export destination is SLS.'."\n" - .'* OSS: Indicates that the export destination is OSS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SLS', + ], + [ + 'apiName' => 'DescribeOversizeNonPartitionTableInfos', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeOversizeNonPartitionTableInfos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultData', - 'description' => 'ResultData\\'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values: Valid values:'."\n" - ."\n" - .'* **True: Succeeded.**'."\n" - .'* **False: Failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP response status code. A value of 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* The request succeeded, and the server returns **OK**.'."\n" - .'* The request failed, and the server returns an error message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'API status or POP error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidInput', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExportType' => [ - 'description' => 'The export type. Valid values:'."\n" - ."\n" - .'* SLS: Indicates that the export destination is SLS.'."\n" - .'* OSS: Indicates that the export destination is OSS.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'SlsInfo' => [ - 'description' => 'The configured SLS export settings, returned when the export destination is SLS.'."\n", - 'type' => 'object', - 'properties' => [ - 'SlsProject' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'example' => 'test-project', - ], - 'ResourceGroup' => [ - 'description' => 'The name of the resource group that runs the export SQL.'."\n", - 'type' => 'string', - 'example' => 'aps', - ], - 'LogstoreTtl' => [ - 'description' => 'The expiration period (in days) for the temporary Logstore automatically created during result set export. The Logstore is automatically deleted after expiration. The returned value is between 1 and 30 days (inclusive).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'OssInfo' => [ - 'description' => 'The configured OSS export settings, returned when the export destination is OSS.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExportBasePath' => [ - 'description' => 'The path of the OSS bucket to which the result sets are exported.'."\n", - 'type' => 'string', - 'example' => 'oss://testBucketName/data_result'."\n", - ], - 'ResourceGroup' => [ - 'description' => 'The name of the resource group that runs the export SQL.'."\n", - 'type' => 'string', - 'example' => 'aps', - ], - 'ResultFileTtl' => [ - 'description' => 'The expiration period (in days) for the OSS file. The returned value is between 1 and 30 days (inclusive).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeMVRecommendResults', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeMVRecommendResults', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DeleteElasticPlan', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'adb:DeleteElasticPlan', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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' => 'DescribeResultExportConfig', - ], - 'ModifySqlTemplatePosition' => [ - 'summary' => 'Modifies the directory location of SQL templates.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'DisableAdviceService', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:DisableAdviceService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeSparkAppType', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeSparkAppType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifyCompactionServiceSwitch', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'adb:ModifyCompactionServiceSwitch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeClusterResourceDetail', + 'description' => '', 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'ramAction' => [ + 'action' => 'adb:DescribeClusterResourceDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'amv-uf6wjk5xxxxxxxxxx', + ], + [ + 'apiName' => 'DescribePatternPerformance', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:DescribePatternPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => '分组Id', - 'description' => 'The template ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '210208', + ], + [ + 'apiName' => 'KillProcess', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'adb:KillProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'TargetTemplateGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '参数模板Id', - 'description' => 'The ID of the template group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + ], + [ + 'apiName' => 'DownloadDiagnosisRecords', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'adb:DownloadDiagnosisRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => 'The returned message. Valid values:'."\n" - ."\n" - .'* If the request is successful, a **SUCCESS** message is returned.'."\n" - .'* If the request is abnormal, the detailed error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5DC10091-348D-12B1-906D-AB49D658012E', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**: Succeeded.'."\n" - .'* **false**: Failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', + [ + 'apiName' => 'GetADBSparkNecessaryRAMPermissions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:GetADBSparkNecessaryRAMPermissions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeBackupPolicy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:DescribeBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5DC10091-348D-12B1-906D-AB49D658012E\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ModifySqlTemplatePosition', - 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", - ], - ], - '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', + [ + 'apiName' => 'GetTableColumns', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'adb:getTableColumns', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ADB', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourceGroupName/{#ResrouceGroupName}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ['validationType' => 'always', 'resourceType' => 'DBCluster', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:DBClusterLakeVersion/DBClusterLakeVersionId'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:DBClusterLakeVersion/*'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}/{#sparkStatmentId}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#Region}:{#AccountId}:dbcluster/{#DBClusterId}'], + ['validationType' => 'always', 'resourceType' => 'LakeAccount', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/account/{#AccountName}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/task/{#SparkTaskId}'], + ['validationType' => 'always', 'resourceType' => 'SparkApplication', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourceGroupName/{#ResrouceGroupName}/query/{#QueryId}'], + ['validationType' => 'always', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:adb:*:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], + ['validationType' => 'always', 'resourceType' => 'AccountLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbClusterId}/resourcegroup/{#resourceGroupName}/sparkapp/{#sparkAppId}/{#sessionid}'], + ['validationType' => 'always', 'resourceType' => 'DBClusterLakeVersion', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/template/{#TemplateId}'], + ['validationType' => 'always', 'resourceType' => 'SparkTemplate', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/template/{#TemplateId}'], + ['validationType' => 'always', 'resourceType' => 'SparkApplication', 'arn' => 'acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}'], ], ], ]; -- cgit v1.2.3