diff options
Diffstat (limited to 'data/en_us/adb/2021-12-01/api-docs.php')
| -rw-r--r-- | data/en_us/adb/2021-12-01/api-docs.php | 46499 |
1 files changed, 46499 insertions, 0 deletions
diff --git a/data/en_us/adb/2021-12-01/api-docs.php b/data/en_us/adb/2021-12-01/api-docs.php new file mode 100644 index 0000000..c976ee2 --- /dev/null +++ b/data/en_us/adb/2021-12-01/api-docs.php @@ -0,0 +1,46499 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'adb', + 'version' => '2021-12-01', + ], + 'directories' => [ + [ + 'id' => 181281, + 'title' => 'Region management', + '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', + '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', + ], + ], + [ + 'id' => 181295, + 'title' => 'Log management', + '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', + 'type' => 'directory', + 'children' => [ + 'DescribeAccounts', + 'CreateAccount', + 'DeleteAccount', + 'ModifyAccountDescription', + 'ResetAccountPassword', + 'CheckBindRamUser', + 'BindAccount', + 'UnbindAccount', + 'ModifyAccountPrivileges', + 'DescribeAccountPrivileges', + 'DescribeEnabledPrivileges', + 'DescribeAccountAllPrivileges', + 'DescribeAccountPrivilegeObjects', + 'DescribeOperatorPermission', + 'RevokeOperatorPermission', + 'GrantOperatorPermission', + ], + ], + [ + 'id' => 196277, + 'title' => 'Backup management', + 'type' => 'directory', + 'children' => [ + 'DescribeBackupPolicy', + 'ModifyBackupPolicy', + 'DescribeBackups', + 'CreateBackup', + 'DeleteBackups', + ], + ], + [ + 'id' => 181298, + 'title' => 'Monitoring management', + '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', + 'type' => 'directory', + 'children' => [ + 'DescribeViewJobs', + 'DescribeTableDetail', + 'GetCreateTableSQL', + 'DescribeTableStatistics', + 'DescribeAdbMySqlTableMeta', + 'DescribeAdbMySqlIndexes', + 'DescribeMvRecommendSubTasks', + 'DescribeMVRecommendResults', + 'DescribeMvRecommendTasks', + 'CreateMaterializedViewRecommend', + 'ModifyMaterializedView', + 'ModifyMaterializedViewRecommend', + 'DeleteMaterializedViewRecommend', + 'DescribeInclinedTables', + 'DescribeAdbMySqlColumns', + 'DescribeAdbMySqlTables', + 'DescribeAdbMySqlSchemas', + 'DescribeTableAccessCount', + 'GetViewDDL', + 'GetViewObjects', + 'GetDatabaseObjects', + 'GetTable', + 'GetTableColumns', + 'GetTableDDL', + 'GetTableObjects', + 'CheckSampleDataSet', + 'DescribeSchemas', + 'DescribeAllDataSource', + 'DescribeTables', + 'DescribeColumns', + 'LoadSampleDataSet', + ], + ], + [ + 'id' => 181302, + 'title' => 'SQL diagnostics', + 'type' => 'directory', + 'children' => [ + 'GetADBSparkNecessaryRAMPermissions', + 'KillProcess', + 'DescribeAdviceServiceEnabled', + 'DescribeSparkSQLDiagnosisList', + 'DescribeSparkSQLDiagnosisAttribute', + 'DescribeOversizeNonPartitionTableInfos', + 'DescribeTablePartitionDiagnose', + 'DescribeSparkAppDiagnosisInfo', + 'EnableAdviceService', + 'DescribeAppliedAdvices', + 'DisableAdviceService', + 'BatchApplyAdviceByIdList', + 'ApplyAdviceById', + 'DescribeAvailableAdvices', + 'DescribeDiagnosisSQLInfo', + 'DescribeDiagnosisDimensions', + 'DownloadDiagnosisRecords', + 'DescribeDiagnosisRecords', + 'DescribeDownloadRecords', + 'DescribeSqlPattern', + 'DescribeSQLPatterns', + 'DescribePatternPerformance', + ], + ], + [ + 'id' => 190405, + 'title' => 'Storage analysis', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterSpaceSummary', + 'DescribeExcessivePrimaryKeys', + ], + ], + [ + 'id' => 181303, + 'title' => 'O\\&M management', + 'type' => 'directory', + 'children' => [ + 'ModifyDBClusterMaintainTime', + 'ModifyDBClusterResourceGroup', + 'ListTagResources', + 'DescribeAutoRenewalAttribute', + 'ModifyAutoRenewalAttribute', + ], + ], + [ + 'id' => 186177, + 'title' => 'APS management', + 'type' => 'directory', + 'children' => [ + 'DescribeApsResourceGroups', + 'DescribeApsJobDetail', + 'CreateApsWebhook', + 'DeleteApsWebhook', + 'UpdateApsWebhook', + 'ListApsWebhook', + 'CreateApsKafkaHudiJob', + 'ListApsLifecycleStrategy', + 'GetApsManagedDatabases', + 'CreateApsSlsADBJob', + 'ListApsOptimizationTasks', + 'ListApsOptimizationStrategy', + 'DescribeAPSADBInstances', + 'ModifyApsSlsADBJob', + 'DescribeApsMigrationWorkloads', + 'DescribeApsHiveWorkload', + 'CreateApsCopyWorkload', + 'DescribeApsDatasource', + 'CreateAPSJob', + 'StartApsJob', + 'SuspendApsJob', + 'ModifyApsJob', + 'DeleteApsJob', + 'CreateApsDatasoure', + 'ModifyApsDatasoure', + 'ModifyApsWorkloadName', + 'DescribeApsDatasources', + 'CreateApsHiveJob', + 'DescribeApsProgress', + 'DeleteApsDatasoure', + 'DescribeApsJobs', + 'DescribeApsActionLogs', + ], + ], + [ + 'id' => 361662, + 'title' => 'Lake storage', + 'type' => 'directory', + 'children' => [ + 'UpdateLakeStorage', + 'ListLakeStorages', + 'GetLakeStorage', + 'CreateLakeStorage', + 'DeleteLakeStorage', + 'ModifyLakeCacheSize', + 'DescribeLakeCacheSize', + ], + ], + [ + 'id' => 199647, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'DescribeCompactionServiceSwitch', + 'ModifyEssdCacheConfig', + 'DescribeEssdCacheConfig', + 'ModifyCompactionServiceSwitch', + 'SubmitResultExportJob', + 'ListResultExportJobHistory', + 'DescribeSQLWebSocketDomain', + 'ConfigureResultExport', + 'DescribeResultExportConfig', + 'ModifySqlTemplatePosition', + ], + ], + ], + 'components' => [ + 'schemas' => [ + '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', + ], + ], + ], + 'CstoreIndexModel' => [ + 'title' => 'A short description of struct', + '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', + ], + 'IndexColumns' => [ + 'title' => 'indexColumns', + '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', + ], + 'ColumnOrds' => [ + 'title' => 'columnOrds', + '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', + ], + 'Options' => [ + 'title' => 'options', + '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', + ], + ], + ], + 'DatabaseSummaryModel' => [ + 'title' => '', + 'description' => 'The summary of the database.'."\n", + 'visibility' => 'public', + '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', + ], + ], + ], + 'Detail' => [ + 'title' => 'A short description of struct', + '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://<bucket-name>/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', + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + 'open_struct_MvBaseTableDetailModel' => [ + 'description' => '', + 'visibility' => 'Public', + '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', + ], + ], + ], + 'open_struct_MvDetailModel' => [ + 'description' => 'Materialized view summary data.'."\n", + 'visibility' => 'Public', + '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', + ], + 'BaseTableInfos' => [ + 'description' => '', + 'visibility' => 'Public', + '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', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'baseTableNames', + ], + 'TableEngine' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'XUANWU', + 'backendName' => 'tableEngine', + ], + 'BaseTableNames' => [ + 'description' => 'All direct parent base tables of the current materialized view.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The database name and table name of the base table.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the database or table.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 't1', + 'extendType' => 'true', + ], + 'extendType' => 'true', + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + 'Name' => [ + 'description' => 'The materialized view name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'demo_mv', + 'backendName' => 'name', + ], + ], + ], + 'SerDeInfoModel' => [ + 'title' => 'A short description of struct', + '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', + ], + 'Parameters' => [ + 'title' => 'parameters', + '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', + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + 'SparkAttemptInfo' => [ + 'title' => 'A short description of struct', + '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', + ], + ], + ], + 'SparkBatchSQL' => [ + 'title' => 'A short description of struct', + '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', + ], + 'QueryState' => [ + 'title' => '', + 'description' => 'The execution status of the query. Valid values:'."\n" + ."\n" + .'* FAILED'."\n" + .'* RUNNING'."\n" + .'* CANCELED'."\n" + .'* PENDING'."\n" + .'* SUBMITTED'."\n" + .'* FINISHED'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RUNNING', + 'backendName' => 'queryState', + ], + 'QuerySubmissionTime' => [ + 'title' => '', + 'description' => 'The submission timestamp of the query.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723521767000', + 'backendName' => 'querySubmissionTime', + ], + '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' => [ + 'title' => '', + 'description' => 'The execution status of the SQL statement. Valid values:'."\n" + ."\n" + .'* FAILED'."\n" + .'* RUNNING'."\n" + .'* 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', + ], + ], + ], + 'StorageDescriptorModel' => [ + 'title' => 'A short description of struct', + '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', + ], + 'Parameters' => [ + 'title' => 'parameters', + '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', + ], + ], + ], + 'TableDetailModel' => [ + 'title' => '', + 'description' => 'The queried table.'."\n", + 'visibility' => 'public', + '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', + ], + 'Columns' => [ + 'title' => '', + 'description' => 'The columns in the table.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The column in the table.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ColDetailModel', + ], + 'backendName' => 'columns', + ], + 'Catalog' => [ + 'title' => '', + 'description' => 'The external data source.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss', + 'backendName' => 'catalog', + ], + ], + ], + 'TableModel' => [ + 'title' => 'A short description of struct', + 'description' => 'The queried table.'."\n", + 'visibility' => 'public', + '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', + ], + 'PartitionKeys' => [ + 'title' => 'partitionKeys', + 'description' => 'The partition key.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The partition column.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/FieldSchemaModel', + ], + 'backendName' => 'partitionKeys', + ], + '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', + ], + 'Cols' => [ + 'title' => 'cols', + 'description' => 'The columns in the table.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The column in the table.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/FieldSchemaModel', + ], + 'backendName' => 'cols', + ], + 'DistributeColumns' => [ + 'title' => 'distributeColumns', + 'description' => 'The distribution columns.'."\n", + 'visibility' => 'public', + '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', + ], + 'RouteColumns' => [ + 'title' => 'routeColumns', + 'description' => 'The route columns.'."\n", + 'visibility' => 'public', + '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', + ], + 'Indexes' => [ + 'title' => 'indexes', + 'description' => 'The index.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The index column.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/CstoreIndexModel', + ], + 'backendName' => 'indexes', + ], + ], + ], + 'TableSummaryModel' => [ + 'title' => '', + 'description' => 'The summary of the table or view.'."\n", + 'visibility' => 'public', + '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', + ], + ], + ], + ], + ], + 'apis' => [ + 'DescribeRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '154593', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"adb.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"VpcEnabled\\": true,\\n \\"LocalName\\": \\"Hangzhou Zone H\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>421794A3-72A5-5D27-9E8B-A75A4C503E17</RequestId>\\n <Regions>\\n <RegionEndpoint>adb.aliyuncs.com</RegionEndpoint>\\n <LocalName>China (Hangzhou)</LocalName>\\n <RegionId>cn-hangzhou</RegionId>\\n <Zones>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <VpcEnabled>true</VpcEnabled>\\n <LocalName>Hangzhou Zone H</LocalName>\\n </Zones>\\n </Regions>\\n</DescribeRegionsResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130697', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => 'DBClusterIds', + '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****', + ], + ], + [ + 'name' => 'DBClusterDescription', + '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', + ], + ], + [ + 'name' => 'DBClusterStatus', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + '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, + '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, + 'example' => '1', + 'default' => '1', + ], + ], + [ + '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****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + '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, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ProductVersion', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'BasicVersion', + 'enum' => [ + 'EnterpriseVersion', + 'BasicVersion', + ], + ], + ], + [ + 'name' => 'DBClusterVersion', + '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', + 'required' => false, + 'example' => '5.0', + 'default' => '5.0', + 'enum' => [ + 'All', + '3.0', + '5.0', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"A5EDBA27-AF3E-5966-9503-FD1557E19167\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2022-04-01T09:50:18Z\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"Mode\\": \\"flexible\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageResource\\": \\"24ACU\\",\\n \\"DBClusterId\\": \\"amv-bp163885f8q21****\\",\\n \\"ConnectionString\\": \\"amv-bp163885f8q21****.ads.aliyuncs.com\\",\\n \\"DBClusterType\\": \\"Common\\",\\n \\"CommodityCode\\": \\"ads_pre\\",\\n \\"ExpireTime\\": \\"2022-07-01T09:50:18Z\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"VPCId\\": \\"vpc-bp13h7uzhulpuxvnp****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ComputeResource\\": \\"16ACU\\",\\n \\"VSwitchId\\": \\"vsw-bp1syh8vvw8yech7n****\\",\\n \\"DBVersion\\": \\"5.0\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"ReservedACU\\": \\"32ACU\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"Category\\": \\"MIXED_STORAGE\\",\\n \\"InnerPort\\": \\"3306\\",\\n \\"VPCCloudInstanceId\\": \\"am-bp163885f8q21****-controller\\",\\n \\"InnerIp\\": \\"10.1.xx.xx\\",\\n \\"DtsJobId\\": \\"dtsb1578j90XXXX\\",\\n \\"ElasticIOResource\\": 2,\\n \\"RdsInstanceId\\": \\"rm-bp11q28kvl688****\\",\\n \\"ExecutorCount\\": \\"1\\",\\n \\"DBNodeClass\\": \\"E8\\",\\n \\"DiskType\\": \\"cloud_essd\\",\\n \\"DBNodeStorage\\": 300,\\n \\"DBNodeCount\\": 2,\\n \\"TaskInfo\\": {\\n \\"Name\\": \\"analyticDBFlexibleScaleOut\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Progress\\": \\"10%\\",\\n \\"StepList\\": {\\n \\"StepList\\": [\\n {\\n \\"StepName\\": \\"ApplyResource\\",\\n \\"StepDesc\\": \\"Apply resource\\",\\n \\"StepStatus\\": \\"SUCCEED\\",\\n \\"StepProgress\\": \\"50%\\",\\n \\"StartTime\\": \\"2024-03-10T09:28:34Z\\",\\n \\"EndTime\\": \\"2024-03-10T10:28:34Z\\"\\n }\\n ]\\n }\\n },\\n \\"ProductForm\\": \\"IntegrationForm\\",\\n \\"ProductVersion\\": \\"EnterpriseVersion\\",\\n \\"ReservedNodeSize\\": \\"8ACU\\",\\n \\"ReservedNodeCount\\": 1,\\n \\"AINodeSpec\\": \\"\\",\\n \\"AINodeNumber\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClustersResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>A5EDBA27-AF3E-5966-9503-FD1557E19167</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <Expired>false</Expired>\\n <CreateTime>2022-04-01T09:50:18Z</CreateTime>\\n <PayType>Prepaid</PayType>\\n <Mode>flexible</Mode>\\n <Port>3306</Port>\\n <LockMode>Unlock</LockMode>\\n <StorageResource>24ACU</StorageResource>\\n <DBClusterId>amv-bp163885f8q21****</DBClusterId>\\n <ConnectionString>amv-bp163885f8q21****.ads.aliyuncs.com</ConnectionString>\\n <DBClusterType>Common</DBClusterType>\\n <CommodityCode>ads_pre</CommodityCode>\\n <ExpireTime>2022-07-01T09:50:18Z</ExpireTime>\\n <LockReason>instance_expired</LockReason>\\n <VPCId>vpc-bp13h7uzhulpuxvnp****</VPCId>\\n <RegionId>cn-hangzhou</RegionId>\\n <ComputeResource>16ACU</ComputeResource>\\n <VSwitchId>vsw-bp1syh8vvw8yech7n****</VSwitchId>\\n <DBVersion>5.0</DBVersion>\\n <DBClusterStatus>Running</DBClusterStatus>\\n <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>\\n <DBClusterNetworkType>VPC</DBClusterNetworkType>\\n <DBClusterDescription>adb_test</DBClusterDescription>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <Engine>AnalyticDB</Engine>\\n <ReservedACU>32ACU</ReservedACU>\\n </Items>\\n</DescribeDBClustersResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusters', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + 'CreateDBCluster' => [ + 'summary' => 'Creates an AnalyticDB for MySQL Data Lakehouse Edition cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '130062', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'ZoneId', + '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', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the cluster. Set the value to **5.0**.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5.0', + ], + ], + [ + 'name' => 'DBClusterNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the cluster. Set the value to **VPC**.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'DBClusterDescription', + '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', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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", + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual private cloud (VPC) ID of the cluster.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-bp1at5ze0t5u3xtqn****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID of the cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-bp1aadw9k19x6cis9****', + ], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + '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****', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + [ + 'name' => 'ReservedNodeSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of reserved resource nodes. Unit: ACUs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8ACU', + 'default' => '8ACU', + ], + ], + [ + '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' => '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' => 'DiskEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable disk encryption.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CloneSourceRegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'SecondaryVSwitchId', + '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****', + ], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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****', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"ResourceGroupId\\": \\"rg-4690g37929****\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\",\\n \\"OrderId\\": \\"202353278****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDBClusterResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <ResourceGroupId>rg-4690g37929****</ResourceGroupId>\\n <DBClusterId>amv-bp1r053byu48p****</DBClusterId>\\n <OrderId>202353278****</OrderId>\\n</CreateDBClusterResponse>","errorExample":""}]', + 'title' => 'CreateDBCluster', + 'description' => 'CreateDBCluster', + ], + 'ModifyDBCluster' => [ + 'summary' => 'Changes the configurations of an AnalyticDB for MySQL Data Lakehouse Edition cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '132381', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'ProductForm', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'LegacyForm', + 'default' => 'LegacyForm', + 'enum' => [ + 'IntegrationForm', + 'LegacyForm', + ], + ], + ], + [ + 'name' => 'ReservedNodeSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'LegacyForm', + ], + ], + [ + 'name' => 'ReservedNodeCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '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****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Cluster.InvalidWorkerState', + 'errorMessage' => 'The state of the worker does not support this operation.', + ], + [ + 'errorCode' => 'ACS.Cluster.ElasticPlanJobsExists', + 'errorMessage' => 'Operation failed. Ongoing elastic plan jobs exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D6BF3E2-41D8-57F6-9A62-A13A70377952\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\",\\n \\"OrderId\\": \\"2035629****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterResponse>\\n <RequestId>0D6BF3E2-41D8-57F6-9A62-A13A70377952</RequestId>\\n <DBClusterId>amv-bp1r053byu48p****</DBClusterId>\\n <OrderId>2035629****</OrderId>\\n</ModifyDBClusterResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + '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****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Cluster.InvalidWorkerState', + 'errorMessage' => 'The state of the worker does not support this operation.', + ], + [ + 'errorCode' => 'ACS.Cluster.ElasticPlanJobsExists', + 'errorMessage' => 'Operation failed. Ongoing elastic plan jobs exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBClusterResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <DBClusterId>amv-bp1r053byu48p****</DBClusterId>\\n</DeleteDBClusterResponse>","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", + ], + 'DescribeDBClusterAttribute' => [ + 'summary' => 'Queries the information about an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130313', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + 'Items' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\",\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"CreationTime\\": \\"2022-07-01T09:50:18Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"MaintainTime\\": \\"04:00Z-05:00Z\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"Mode\\": \\"flexible\\",\\n \\"Port\\": 3306,\\n \\"LockMode\\": \\"ManualLock\\",\\n \\"EngineVersion\\": \\"3.1.16\\",\\n \\"StorageResource\\": \\"24ACU\\",\\n \\"DBClusterId\\": \\"amv-wz9509beptiz****\\",\\n \\"ConnectionString\\": \\"amv-wz9509beptiz****.ads.aliyuncs.com\\",\\n \\"DBClusterType\\": \\"Common\\",\\n \\"CommodityCode\\": \\"ads_pre\\",\\n \\"ExpireTime\\": \\"2022-10-01T09:50:18Z\\",\\n \\"LockReason\\": \\"instance_expire\\",\\n \\"VPCId\\": \\"vpc-bp13h7uzhulpu****\\",\\n \\"ComputeResource\\": \\"16ACU\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchId\\": \\"vsw-uf629gydd54ld****\\",\\n \\"DBVersion\\": \\"5.0\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"UserENIStatus\\": false,\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"ReservedACU\\": \\"24ACU\\",\\n \\"ComputeResourceTotal\\": \\"48ACU\\",\\n \\"StorageResourceTotal\\": \\"24ACU\\",\\n \\"SupportedFeatures\\": {\\n \\"key\\": \\"预留参数，不涉及。\\"\\n },\\n \\"ProductForm\\": \\"预留参数，不涉及。\\",\\n \\"ReservedNodeSize\\": \\"预留参数，不涉及。\\",\\n \\"ReservedNodeCount\\": 0,\\n \\"ClickhouseEngineEnabled\\": true,\\n \\"AINodeNumber\\": 0,\\n \\"ProductVersion\\": \\"BasicVersion\\",\\n \\"KmsId\\": \\"e1935511-cf88-1123-a0f8-1be8d251****\\",\\n \\"TaskInfo\\": {\\n \\"Name\\": \\"ScaleUpDBCluster\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Progress\\": \\"10\\",\\n \\"StepList\\": {\\n \\"StepList\\": [\\n {\\n \\"StepName\\": \\"PrepareResources\\",\\n \\"StepDesc\\": \\"Prepare resources\\",\\n \\"StepStatus\\": \\"RUNNING\\",\\n \\"StepProgress\\": \\"50\\",\\n \\"StartTime\\": \\"2024-03-10T09:28:34Z\\",\\n \\"EndTime\\": \\"2024-03-10T10:28:34Z\\"\\n }\\n ]\\n }\\n },\\n \\"UserENIVpcId\\": \\"vpc-rj9hnedlfm645uj******\\",\\n \\"UserENIVSwitchOptions\\": \\"vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******\\",\\n \\"UserENIZoneOptions\\": \\"cn-hangzhou-k,cn-hangzhou-h\\",\\n \\"SecondaryZoneId\\": \\"\\",\\n \\"SecondaryVSwitchId\\": \\"\\",\\n \\"DiskEncryption\\": true,\\n \\"ClickhouseEngineCacheSize\\": 100,\\n \\"AINodeSpec\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterAttributeResponse>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n <Items>\\n <CreationTime>2022-07-01T09:50:18Z</CreationTime>\\n <Expired>false</Expired>\\n <MaintainTime>04:00Z-05:00Z</MaintainTime>\\n <PayType>Prepaid</PayType>\\n <Mode>flexible</Mode>\\n <Port>3306</Port>\\n <LockMode>ManualLock</LockMode>\\n <EngineVersion>3.1.16</EngineVersion>\\n <StorageResource>24ACU</StorageResource>\\n <DBClusterId>amv-wz9509beptiz****</DBClusterId>\\n <ConnectionString>amv-wz9509beptiz****.ads.aliyuncs.com</ConnectionString>\\n <DBClusterType>Common</DBClusterType>\\n <CommodityCode>ads_pre</CommodityCode>\\n <ExpireTime>2022-10-01T09:50:18Z</ExpireTime>\\n <LockReason>instance_expire</LockReason>\\n <VPCId>vpc-bp13h7uzhulpu****</VPCId>\\n <ComputeResource>16ACU</ComputeResource>\\n <RegionId>cn-hangzhou</RegionId>\\n <VSwitchId>vsw-uf629gydd54ld****</VSwitchId>\\n <DBVersion>5.0</DBVersion>\\n <DBClusterStatus>Running</DBClusterStatus>\\n <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>\\n <DBClusterNetworkType>VPC</DBClusterNetworkType>\\n <DBClusterDescription>adb_test</DBClusterDescription>\\n <UserENIStatus>false</UserENIStatus>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <Engine>AnalyticDB</Engine>\\n <ReservedACU>24ACU</ReservedACU>\\n <ComputeResourceTotal>48ACU</ComputeResourceTotal>\\n <StorageResourceTotal>24ACU</StorageResourceTotal>\\n </Items>\\n</DescribeDBClusterAttributeResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254101', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"KernelVersion\\": \\"3.1.8\\",\\n \\"ExpireDate\\": \\"2025-01-12T16:00:00Z\\",\\n \\"AvailableKernelVersions\\": [\\n {\\n \\"KernelVersion\\": \\"3.1.9\\",\\n \\"ReleaseDate\\": \\"2024-07-17T16:00:00Z\\\\n\\",\\n \\"ExpireDate\\": \\"2025-07-17T16:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeKernelVersion', + ], + 'UpgradeKernelVersion' => [ + 'summary' => 'Updates the minor version of an AnalyticDB for MySQL cluster.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + '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', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + '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.', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A444FFFFFF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A444FFFFFF\\"\\n}","type":"json"}]', + 'title' => 'UpgradeKernelVersion', + ], + 'DescribeDBClusterStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '133754', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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 (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + 'name' => 'DBClusterDescription', + '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' => true, + 'docRequired' => true, + 'example' => 'adb_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterDescription.Malformed', + 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterDescriptionResponse>\\n <RequestId>17F57FEE-EA4F-4337-8D2E-9C23CAA63D74</RequestId>\\n</ModifyDBClusterDescriptionResponse>","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', + ], + ], + '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****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"370D09FD-442A-5225-AAD3-7362CAE39177\\",\\n \\"Items\\": {\\n \\"IPArray\\": [\\n {\\n \\"DBClusterIPArrayAttribute\\": \\"hidden\\",\\n \\"SecurityIPList\\": \\"127.0.xx.xx\\",\\n \\"DBClusterIPArrayName\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterAccessWhiteListResponse>\\n <RequestId>370D09FD-442A-5225-AAD3-7362CAE39177</RequestId>\\n <Items>\\n <DBClusterIPArrayAttribute>hidden</DBClusterIPArrayAttribute>\\n <SecurityIPList>127.0.xx.xx</SecurityIPList>\\n <DBClusterIPArrayName>test</DBClusterIPArrayName>\\n </Items>\\n</DescribeClusterAccessWhiteListResponse>","errorExample":""}]', + 'title' => 'DescribeClusterAccessWhiteList', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + 'ModifyClusterAccessWhiteList' => [ + 'summary' => 'Modifies the IP address whitelist 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', + '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-bp11q28kvl688****', + ], + ], + [ + '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' => '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' => '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' => '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', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityIPList.Duplicate', + 'errorMessage' => 'The specified IP address is duplicate.', + ], + [ + 'errorCode' => 'InvalidDBClusterIPArrayName.Malformed', + 'errorMessage' => 'The specified parameter DBClusterIPArrayName is not valid.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Malformed', + 'errorMessage' => 'The specified SecurityIPList is incorrectly formatted.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 1564657730,\\n \\"RequestId\\": \\"370D09FD-442A-5225-AAD3-7362CAE39177\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyClusterAccessWhiteListResponse>\\n <TaskId>1564657730</TaskId>\\n <RequestId>370D09FD-442A-5225-AAD3-7362CAE39177</RequestId>\\n <DBClusterId>amv-bp11q28kvl688****</DBClusterId>\\n</ModifyClusterAccessWhiteListResponse>","errorExample":""}]', + 'title' => 'ModifyClusterAccessWhiteList', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see Endpoints.'."\n", + ], + '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' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '208236', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the wide table engine feature. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'CacheSize', + 'in' => 'query', + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D761DA51-12F8-5457-AAA9-F52B9F436D2D\\"\\n}","type":"json"}]', + 'title' => 'ModifyClickhouseEngine', + ], + 'DescribeResourceGroupSpec' => [ + 'summary' => 'Queries the information about resource group specifications.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235394', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-8vbo40tl1dxxxxxx', + ], + ], + [ + 'name' => 'ResourceGroupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ai', + ], + ], + [ + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolType.Malformed', + 'errorMessage' => 'The specified parameter PoolType is not valid.', + ], + ], + 408 => [ + [ + 'errorCode' => 'AcsServerTimeOut', + 'errorMessage' => 'The request has failed due to Adb Cloud Service time out.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10226189-4391-5B10-97AF-5CA5XXXXXXX\\",\\n \\"Specs\\": [\\n {\\n \\"Name\\": \\"xlarge\\",\\n \\"AllocateUnits\\": [\\n \\"1\\"\\n ],\\n \\"MaxQuantity\\": 8,\\n \\"Type\\": \\"GPU\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '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' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136449', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + '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' => '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' => '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' => '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' => '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' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A'."\n", + ], + ], + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'N/A'."\n", + ], + ], + [ + 'name' => 'MaxClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'N/A'."\n", + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A'."\n", + ], + ], + [ + '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' => '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' => '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' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SparkWarehouse', + ], + ], + [ + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + ], + [ + 'name' => 'AutoStopInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5m', + ], + ], + [ + 'name' => 'SpecName', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'MinGpuQuantity', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'MaxGpuQuantity', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'TargetResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'RayConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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, + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolType.Malformed', + 'errorMessage' => 'The specified parameter PoolType is not valid.', + ], + [ + 'errorCode' => 'InvalidMinComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MinComputeResource is not valid.', + ], + [ + 'errorCode' => 'InvalidMaxComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MaxComputeResource is not valid.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', + 'errorMessage' => 'The state of this resource group does not support this operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD5\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDBResourceGroupResponse>\\n <RequestId>A94B6C02-7BD4-5D67-9776-3AC8317E8DD5</RequestId>\\n</CreateDBResourceGroupResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136430', + '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****', + ], + ], + [ + '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' => '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' => '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', + ], + ], + ], + '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', + ], + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolType.Malformed', + 'errorMessage' => 'The specified parameter PoolType is not valid.', + ], + [ + 'errorCode' => 'InvalidMinComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MinComputeResource is not valid.', + ], + [ + 'errorCode' => 'InvalidMaxComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MaxComputeResource is not valid.', + ], + ], + 408 => [ + [ + 'errorCode' => 'AcsServerTimeOut', + 'errorMessage' => 'The request has failed due to Adb Cloud Service time out.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD3\\",\\n \\"GroupsInfo\\": [\\n {\\n \\"GroupType\\": \\"Job\\",\\n \\"GroupName\\": \\"test1\\",\\n \\"MinComputeResource\\": \\"0ACU\\",\\n \\"MaxComputeResource\\": \\"512ACU\\",\\n \\"ClusterSizeResource\\": \\"预留参数，不涉及\\",\\n \\"MinClusterCount\\": 0,\\n \\"MaxClusterCount\\": 0,\\n \\"RunningClusterCount\\": 0,\\n \\"ClusterMode\\": \\"预留参数，不涉及\\",\\n \\"ElasticMinComputeResource\\": \\"16ACU\\",\\n \\"EnableSpot\\": \\"True\\",\\n \\"GroupUsers\\": \\"testb,testc\\",\\n \\"CreateTime\\": \\"2022-08-29T03:34:30Z\\",\\n \\"UpdateTime\\": \\"2022-08-31T03:34:30Z\\",\\n \\"Status\\": \\"ok\\",\\n \\"Rules\\": [\\n {\\n \\"GroupName\\": \\"user_default\\",\\n \\"QueryTime\\": \\"180000\\",\\n \\"TargetGroupName\\": \\"job\\"\\n }\\n ],\\n \\"Engine\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"AutoStopInterval\\": \\"\\",\\n \\"SpecName\\": \\"\\",\\n \\"TargetResourceGroupName\\": \\"\\",\\n \\"MinGpuQuantity\\": 0,\\n \\"MaxGpuQuantity\\": 0,\\n \\"RayConfig\\": {\\n \\"EnableUserEni\\": true,\\n \\"HeadSpecType\\": \\"\\",\\n \\"HeadSpec\\": \\"\\",\\n \\"HeadAllocateUnit\\": \\"\\",\\n \\"HeadDiskCapacity\\": \\"\\",\\n \\"Category\\": \\"\\",\\n \\"WorkerGroups\\": [\\n {\\n \\"GroupName\\": \\"g01\\",\\n \\"AllocateUnit\\": \\"1\\",\\n \\"MaxWorkerQuantity\\": 1,\\n \\"MinWorkerQuantity\\": 1,\\n \\"WorkerDiskCapacity\\": \\"100G\\",\\n \\"WorkerSpecName\\": \\"large\\",\\n \\"WorkerSpecType\\": \\"CPU\\"\\n }\\n ],\\n \\"RayClusterAddress\\": \\"http://ray-cluster-address.example.com\\",\\n \\"RayDashboardAddress\\": \\"http://ray-dashboard-address.example.com\\",\\n \\"RayGrafanaAddress\\": \\"http://ray-grafana-address.example.com\\",\\n \\"AppConfig\\": {\\n \\"AppName\\": \\"app01\\",\\n \\"AppType\\": \\"IsaacLab\\",\\n \\"ImageSelector\\": {\\n \\"Image\\": \\"lab2.10.0-ray2.43.0\\",\\n \\"InferenceEngine\\": \\"vLLM\\",\\n \\"LlmModel\\": \\"Deepseek-R1\\"\\n }\\n },\\n \\"StorageMounts\\": [\\n {\\n \\"StorageId\\": 1,\\n \\"MountPath\\": \\"/mnt/data01\\"\\n }\\n ]\\n },\\n \\"GpuElasticPlan\\": {\\n \\"Enabled\\": true,\\n \\"Rules\\": [\\n {\\n \\"StartCronExpression\\": \\"\\",\\n \\"EndCronExpression\\": \\"\\"\\n }\\n ]\\n },\\n \\"EngineParams\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBResourceGroupResponse>\\n <RequestId>A94B6C02-7BD4-5D67-9776-3AC8317E8DD3</RequestId>\\n <GroupsInfo>\\n <GroupType>Job</GroupType>\\n <GroupName>test1</GroupName>\\n <MinComputeResource>0ACU</MinComputeResource>\\n <MaxComputeResource>512ACU</MaxComputeResource>\\n <ClusterSizeResource>预留参数，不涉及</ClusterSizeResource>\\n <ClusterMode>预留参数，不涉及</ClusterMode>\\n <ElasticMinComputeResource>16ACU</ElasticMinComputeResource>\\n <EnableSpot>True</EnableSpot>\\n <GroupUsers>testb,testc</GroupUsers>\\n <CreateTime>2022-08-29T03:34:30Z</CreateTime>\\n <UpdateTime>2022-08-31T03:34:30Z</UpdateTime>\\n <Status>ok</Status>\\n <Rules/>\\n </GroupsInfo>\\n</DescribeDBResourceGroupResponse>","errorExample":""}]', + 'title' => 'DescribeDBResourceGroup', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136445', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + '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****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + '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', + ], + ], + [ + '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' => [], + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'MaxComputeResource', + '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', + ], + ], + [ + 'name' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A'."\n", + ], + ], + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'N/A'."\n", + ], + ], + [ + 'name' => 'MaxClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'N/A'."\n", + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A'."\n", + ], + ], + [ + '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' => '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' => 'Rules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The job resubmission rules.'."\n", + '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", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + ], + [ + 'name' => 'AutoStopInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5m', + ], + ], + [ + 'name' => 'SpecName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MinGpuQuantity', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'MaxGpuQuantity', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'TargetResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'starting', + ], + ], + [ + 'name' => 'RayConfig', + 'in' => 'query', + 'style' => 'json', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolType.Malformed', + 'errorMessage' => 'The specified parameter PoolType is not valid.', + ], + [ + 'errorCode' => 'InvalidMinComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MinComputeResource is not valid.', + ], + [ + 'errorCode' => 'InvalidMaxComputeResource.Malformed', + 'errorMessage' => 'The specified parameter MaxComputeResource is not valid.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.ElasticPlanExists', + 'errorMessage' => 'This resource group does not support this operation. Elastic plans that have been enabled already exist.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', + 'errorMessage' => 'The state of this resource group does not support this operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"805F14E1-0186-520E-A6D5-30188D94E8DA\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBResourceGroupResponse>\\n <RequestId>805F14E1-0186-520E-A6D5-30188D94E8DA</RequestId>\\n</ModifyDBResourceGroupResponse>","errorExample":""}]', + 'title' => 'ModifyDBResourceGroup', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + 'DeleteDBResourceGroup' => [ + 'summary' => 'Deletes a resource group from an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136447', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPoolName.Malformed', + 'errorMessage' => 'The specified parameter PoolName is not valid.', + ], + [ + 'errorCode' => 'InvalidPoolUser.Malformed', + 'errorMessage' => 'The specified parameter PoolUser is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.ElasticPlanExists', + 'errorMessage' => 'This resource group does not support this operation. Elastic plans that have been enabled already exist.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.InvalidResourceGroupState', + 'errorMessage' => 'The state of this resource group does not support this operation.', + ], + [ + 'errorCode' => 'ACS.ResourceGroup.OngoingJobExists', + 'errorMessage' => 'Resource group has ongoing job(s).', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD3\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBResourceGroupResponse>\\n <RequestId>A94B6C02-7BD4-5D67-9776-3AC8317E8DD3</RequestId>\\n</DeleteDBResourceGroupResponse>","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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test'."\n", + ], + ], + [ + '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", + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => '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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'GroupUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + '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' => '2023-02-04T03:45: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' => true, + 'example' => '2023-02-05T03:45:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<DescribeElasticPlanAttributeResponse>', + '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-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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0322C7FB-4584-5D2A-BF7F-F9036E940C35\\",\\n \\"ElasticACU\\": \\"512 ACU\\",\\n \\"ResourceGroupCount\\": \\"10\\",\\n \\"ReserverdCompteACU\\": \\"48 ACU\\",\\n \\"ReserverdStorageACU\\": \\"24 ACU\\"\\n}","type":"json"}]', + 'title' => 'DescribeUserQuota', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + 'CreateElasticPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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' => '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' => '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', + ], + ], + [ + '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' => '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidEndTime', + 'errorMessage' => 'The end time should be later than current time.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.WorkerNotFound', + 'errorMessage' => 'Worker not found.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.AutoWorkerPlanExists', + 'errorMessage' => 'Failed to enable the elastic plan. The instance already has an active elastic plan.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.WorkerPlanExists', + 'errorMessage' => 'Failed to enable the elastic plan. At least one active elastic plan already exists.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidStartTimeInterval', + 'errorMessage' => 'The start time of this elastic plan is too closed to another one.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidTodayPlan', + 'errorMessage' => 'Failed to enable this elastic plan. Today\'s schedule time is missed and you should prepare at least %s minutes for us to prepare resource.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidTargetSize', + 'errorMessage' => 'Invalid target size.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidStartTime', + 'errorMessage' => 'Invalid start time.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateElasticPlanResponse>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n</CreateElasticPlanResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginationResponse<List<DescribeElasticPlansResponse>>', + 'description' => 'PaginationResponse\\<List>'."\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', + ], + ], + ], + ], + ], + '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":"<DescribeElasticPlansResponse>\\n <TotalCount>15</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <ElasticPlans>\\n <ElasticPlanName>test</ElasticPlanName>\\n <Type>EXECUTOR</Type>\\n <Enabled>true</Enabled>\\n <ResourceGroupName>test</ResourceGroupName>\\n <TargetSize>32ACU</TargetSize>\\n <NextScheduleTime>2022-01-01T12:01:00Z</NextScheduleTime>\\n <AutoScale>false</AutoScale>\\n </ElasticPlans>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n</DescribeElasticPlansResponse>","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", + ], + 'ModifyElasticPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + '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' => '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' => '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' => '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', + ], + ], + [ + '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****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyElasticPlanResponse>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n</ModifyElasticPlanResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + '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' => '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****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.ElasticPlan.AutoWorkerPlanExists', + 'errorMessage' => 'Failed to enable the elastic plan. The instance already has an active elastic plan.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.WorkerPlanExists', + 'errorMessage' => 'Failed to enable the elastic plan. At least one active elastic plan already exists.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidStartTimeInterval', + 'errorMessage' => 'The start time of this elastic plan is too closed to another one.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidEndTime', + 'errorMessage' => 'The end time should be later than current time.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidTodayPlan', + 'errorMessage' => 'Failed to enable this elastic plan. Today\'s schedule time is missed and you should prepare at least %s minutes for us to prepare resource.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidTargetSize', + 'errorMessage' => 'Invalid target size.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.InvalidStartTime', + 'errorMessage' => 'Invalid start time.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableElasticPlanResponse>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n</EnableElasticPlanResponse>","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", + ], + 'DisableElasticPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + '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' => '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse', + 'description' => 'BaseResponse'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableElasticPlanResponse>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n</DisableElasticPlanResponse>","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", + ], + 'DeleteElasticPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + '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' => '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****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteElasticPlanResponse>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n</DeleteElasticPlanResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + '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', + ], + ], + [ + 'name' => 'ResourceGroupName', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginationResponse<List<DescribeElasticPlanJobsResponse>>', + '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' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A5C433C2-001F-58E3-99F5-3274C14DF8BD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 15,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Jobs\\": [\\n {\\n \\"ElasticPlanName\\": \\"test\\",\\n \\"Status\\": \\"SUCCESSFUL\\",\\n \\"Type\\": \\"EXECUTOR\\",\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"StartTime\\": \\"2022-01-01T11:01:00Z\\",\\n \\"EndTime\\": \\"2022-01-01T12:01:00Z\\",\\n \\"TargetSize\\": \\"32ACU\\",\\n \\"TotalAcu\\": \\"32ACU\\",\\n \\"ReserveAcu\\": \\"16ACU\\",\\n \\"ElasticAcu\\": \\"16ACU\\",\\n \\"InstanceSize\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeElasticPlanJobsResponse>\\n <TotalCount>15</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <Jobs>\\n <ElasticPlanName>test</ElasticPlanName>\\n <Status>SUCCESSFUL</Status>\\n <Type>EXECUTOR</Type>\\n <ResourceGroupName>test</ResourceGroupName>\\n <StartTime>2022-01-01T11:01:00Z</StartTime>\\n <EndTime>2022-01-01T12:01:00Z</EndTime>\\n <TargetSize>32ACU</TargetSize>\\n <TotalAcu>32ACU</TotalAcu>\\n <ReserveAcu>16ACU</ReserveAcu>\\n <ElasticAcu>16ACU</ElasticAcu>\\n <InstanceSize>1</InstanceSize>\\n </Jobs>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n</DescribeElasticPlanJobsResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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' => '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<DescribeElasticPlanAttributeResponse>', + 'description' => 'The response parameters.'."\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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.ElasticPlan.NotFound', + 'errorMessage' => 'The elastic plan is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ElasticPlan\\": {\\n \\"ElasticPlanName\\": \\"test\\",\\n \\"Type\\": \\"EXECUTOR\\",\\n \\"Enabled\\": true,\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"TargetSize\\": \\"32ACU\\",\\n \\"StartTime\\": \\"2022-01-01T12:01:00Z\\",\\n \\"EndTime\\": \\"2025-01-01T12:01:00Z\\",\\n \\"CronExpression\\": \\"0 20 14 * * ?\\",\\n \\"AutoScale\\": false\\n },\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeElasticPlanAttributeResponse>\\n <ElasticPlan>\\n <ElasticPlanName>test</ElasticPlanName>\\n <Type>EXECUTOR</Type>\\n <Enabled>true</Enabled>\\n <ResourceGroupName>test</ResourceGroupName>\\n <TargetSize>32ACU</TargetSize>\\n <StartTime>2022-01-01T12:01:00Z</StartTime>\\n <EndTime>2025-01-01T12:01:00Z</EndTime>\\n <CronExpression>0 20 14 * * ?</CronExpression>\\n <AutoScale>false</AutoScale>\\n </ElasticPlan>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n</DescribeElasticPlanAttributeResponse>","errorExample":""}]', + '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", + ], + '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' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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' => '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' => '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginationResponse<List<String>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"Specifications\\": [\\n \\"16ACU\\"\\n ],\\n \\"RequestId\\": \\"A5C433C2-001F-58E3-99F5-3274C14DF8BD\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeElasticPlanSpecificationsResponse>\\n <TotalCount>10</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>5</PageSize>\\n <Specifications>16ACU</Specifications>\\n <RequestId>A5C433C2-001F-58E3-99F5-3274C14DF8BD</RequestId>\\n</DescribeElasticPlanSpecificationsResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132363', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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' => '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" + .'> '."\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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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' => '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' => 'OrderType', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username that is used to execute the SQL statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + '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"}]', + ], + ], + [ + '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, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + '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' => 'ProxyUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"6974\\",\\n \\"PageSize\\": \\"10\\",\\n \\"RequestId\\": \\"8A564B7F-8C00-43C0-8EC5-919FBB70573\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"amv-t4nj8619bz2w3****\\",\\n \\"Items\\": [\\n {\\n \\"HostAddress\\": \\"100.104.XX.XX:43908\\",\\n \\"Succeed\\": \\"true\\",\\n \\"SQLText\\": \\"SELECT * FROM adb_hdfs_import_source\\",\\n \\"TotalTime\\": \\"216\\",\\n \\"ConnId\\": \\"14356****\\",\\n \\"DBName\\": \\"adb_demo\\",\\n \\"SQLType\\": \\"SELECT\\",\\n \\"ExecuteTime\\": \\"2022-08-12 10:10:00\\",\\n \\"ExecuteTimestamp\\": 0,\\n \\"ProcessID\\": \\"202106081752021720161662490345362390\\",\\n \\"User\\": \\"test\\",\\n \\"HasDiagnosticInfo\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAuditLogRecordsResponse>\\n <TotalCount>6974</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>8A564B7F-8C00-43C0-8EC5-919FBB70573</RequestId>\\n <PageNumber>1</PageNumber>\\n <DBClusterId>amv-t4nj8619bz2w3****</DBClusterId>\\n <Items>\\n <HostAddress>100.104.XX.XX:43908</HostAddress>\\n <Succeed>true</Succeed>\\n <SQLText>SELECT * FROM adb_hdfs_import_source</SQLText>\\n <TotalTime>216</TotalTime>\\n <ConnId>14356****</ConnId>\\n <DBName>adb_demo</DBName>\\n <SQLType>SELECT</SQLType>\\n <ExecuteTime>2022-08-12 10:10:00</ExecuteTime>\\n <ProcessID>202106081752021720161662490345362390</ProcessID>\\n <User>test</User>\\n </Items>\\n</DescribeAuditLogRecordsResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132366', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CDC59E56-BD07-56CA-A05F-B7907DE5C862\\",\\n \\"UpdateSucceed\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyAuditLogConfigResponse>\\n <RequestId>CDC59E56-BD07-56CA-A05F-B7907DE5C862</RequestId>\\n <UpdateSucceed>true</UpdateSucceed>\\n</ModifyAuditLogConfigResponse>","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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235459', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username that is used to execute SQL statements.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + [ + '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\\"}]', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProxyUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + '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' => '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' => 'StatementId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fbd22066-1c03-xxxx-aa16-6ae28288****', + ], + ], + [ + 'name' => 'TotalTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The duration of the SQL statement. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3000', + ], + ], + [ + 'name' => 'SQLText', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword in the SQL statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_table_name', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '999f2439-6b10-xxxx-a5d3-daf3b35c****', + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'StatementSource', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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" + .'}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"100\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"2D5867CF-423F-559F-BBB1-199A289E****\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"amv-bp1j7******78j8i\\",\\n \\"Items\\": [\\n {\\n \\"SQLText\\": \\"SELECT * FROM adb_hdfs_import_source\\",\\n \\"TotalTime\\": 40000,\\n \\"ExecuteTime\\": \\"2022-01-23T16:05:08Z\\",\\n \\"User\\": \\"test_user\\",\\n \\"StatementId\\": \\"fbd22066-1c03-xxxx-aa16-6ae28288****\\",\\n \\"Status\\": \\"finish\\",\\n \\"ResourceGroupName\\": \\"test_job\\",\\n \\"AppId\\": \\"s202411061011hzc5d6476000****\\",\\n \\"InnerQueryId\\": \\"1\\",\\n \\"IsDiagnosable\\": true,\\n \\"ClientIp\\": \\"192.168.XX.XX\\",\\n \\"ProcessId\\": \\"999f2439-6b10-xxxx-a5d3-daf3b35c****\\",\\n \\"StatementSource\\": \\"SQL_EDITOR\\",\\n \\"ErrorMsg\\": \\"notFoundIp\\",\\n \\"ErrorTrace\\": \\"notFoundIpException\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '133667', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + 'name' => 'Engine', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClusterNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"69A29B65-CD0C-52B1-BE42-8B454569747F\\",\\n \\"Items\\": {\\n \\"Address\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-bp1syh8vvw8yec****\\",\\n \\"ConnectionString\\": \\"amv-wz9dqvn0o7****.ads.aliyuncs.com\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-8vbhucmd5b****\\",\\n \\"IPAddress\\": \\"192.168.xx.xx\\",\\n \\"ConnectionStringPrefix\\": \\"amv-wz9dqvn0o7****\\",\\n \\"Ports\\": {\\n \\"ports\\": [\\n {\\n \\"Port\\": \\"3306\\",\\n \\"Protocol\\": \\"mysql\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterNetInfoResponse>\\n <ClusterNetworkType>VPC</ClusterNetworkType>\\n <RequestId>69A29B65-CD0C-52B1-BE42-8B454569747F</RequestId>\\n <Items>\\n <VSwitchId>vsw-bp1syh8vvw8yec****</VSwitchId>\\n <ConnectionString>amv-wz9dqvn0o7****.ads.aliyuncs.com</ConnectionString>\\n <NetType>VPC</NetType>\\n <Port>3306</Port>\\n <VPCId>vpc-8vbhucmd5b****</VPCId>\\n <IPAddress>192.168.xx.xx</IPAddress>\\n <ConnectionStringPrefix>amv-wz9dqvn0o7****</ConnectionStringPrefix>\\n </Items>\\n</DescribeClusterNetInfoResponse>","errorExample":""}]', + 'title' => 'DescribeClusterNetInfo', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + 'AllocateClusterPublicConnection' => [ + 'summary' => 'Applies for a public endpoint for an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131191', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1z5d2q71is2****', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + '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', + ], + ], + [ + 'name' => 'Engine', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '868EF07F-D0B2-5043-B092-0C14CD00B65A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidConnectionStringPrefix.Malformed', + 'errorMessage' => 'The specified connection string is invalid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"868EF07F-D0B2-5043-B092-0C14CD00B65A\\"\\n}","errorExample":""},{"type":"xml","example":"<AllocateClusterPublicConnectionResponse>\\n <RequestId>868EF07F-D0B2-5043-B092-0C14CD00B65A</RequestId>\\n</AllocateClusterPublicConnectionResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131192', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'Engine', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A94B6C02-7BD4-5D67-9776-3AC8317E8DD5', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B6C02-7BD4-5D67-9776-3AC8317E8DD5\\"\\n}","errorExample":""},{"type":"xml","example":"<ReleaseClusterPublicConnectionResponse>\\n <RequestId>A94B6C02-7BD4-5D67-9776-3AC8317E8DD5</RequestId>\\n</ReleaseClusterPublicConnectionResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsPOF80W', + ], + ], + '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 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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => 'AttachUserENI', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + 'DetachUserENI' => [ + 'summary' => '解绑用户弹性网卡', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsPOF80W', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads3N2V5J', + ], + ], + 'parameters' => [ + [ + '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', + ], + ], + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + '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", + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ModifyUserEniVswitchOptions', + ], + 'ModifyDBClusterVip' => [ + 'summary' => 'Changes the virtual IP address (VIP) that is used to connect to an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212368', + 'abilityTreeNodes' => [ + 'FEATUREads3N2V5J', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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*****', + ], + ], + [ + '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****', + ], + ], + [ + '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****', + ], + ], + [ + 'name' => 'ConnectString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amv-2ze8mbuai974s4y2500000169.ads.aliyuncs.com', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Cluster.InvalidState', + 'errorMessage' => 'The state of the cluster does not support this operation.', + ], + [ + 'errorCode' => 'InvalidConnectionString.Malformed', + 'errorMessage' => 'The specified parameter "ConnectionString" is not valid.', + ], + [ + 'errorCode' => 'InvalidConnectionString.UnSupported', + 'errorMessage' => 'The specified parameter "ConnectionString" Only support vpc address.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'ACS.UnsupportedAvailableZone', + 'errorMessage' => 'The specified available zone is not supported.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ACS.ServerError', + 'errorMessage' => 'ADB Cloud Service failed to process your request.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-****-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBClusterVip', + ], + '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' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-************', + ], + ], + [ + 'name' => 'EnableSSL', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The unique ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBClusterSSL', + ], + 'DescribeDBClusterSSL' => [ + 'summary' => 'Queries the SSL configurations of a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220651', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"348303D8-6F42-5141-9B00-A6EECA1E37B6\\",\\n \\"ExpireTime\\": \\"2022-10-11T08:16:43Z\\",\\n \\"ConnectionString\\": \\"amv-*********.ads.aliyuncs.com\\",\\n \\"SSLEnabled\\": true\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208235', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9842849v6****', + ], + ], + [ + 'name' => 'Engine', + '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', + ], + ], + [ + '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-hangzhou', + ], + ], + ], + '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' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF', + ], + 'DownloadUrl' => [ + 'description' => 'The OSS URL of the downloaded certificate.'."\n", + 'type' => 'string', + 'example' => 'https://***/ca.crt', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"DownloadUrl\\": \\"https://***/ca.crt\\"\\n}","type":"json"}]', + 'title' => 'DownloadInstanceCACertificate', + ], + 'DescribeAccounts' => [ + 'summary' => 'Queries the database accounts 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', + 'abilityTreeCode' => '131026', + '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****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Engine', + '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', + ], + ], + ], + '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' => '9CCFAAB4-97B7-5800-B9F2-685EB596E3EF', + ], + 'AccountList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBAccount' => [ + 'description' => 'The queried database accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried database account.'."\n", + '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', + ], + 'RamUserList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RamUserList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.Sql.CannotConnect', + 'errorMessage' => 'Cannot connect instance which type is %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"AccountList\\": {\\n \\"DBAccount\\": [\\n {\\n \\"AccountName\\": \\"test_accout\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountDescription\\": \\"测试数据库账号\\",\\n \\"RamUsers\\": \\"1958134230****\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"Engine\\": \\"Clickhouse\\",\\n \\"RamUserList\\": {\\n \\"RamUserList\\": [\\n \\"\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccountsResponse>\\n <RequestId>9CCFAAB4-97B7-5800-B9F2-685EB596E3EF</RequestId>\\n <AccountList>\\n <AccountName>test_accout</AccountName>\\n <AccountStatus>Available</AccountStatus>\\n <AccountDescription>测试数据库账号</AccountDescription>\\n <RamUsers>1958134230****</RamUsers>\\n <AccountType>Normal</AccountType>\\n </AccountList>\\n</DescribeAccountsResponse>","errorExample":""}]', + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130688', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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" + .'* 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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + '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', + ], + ], + [ + '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', + ], + ], + ], + [ + 'name' => 'Engine', + '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', + ], + ], + [ + 'name' => 'RamUserList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter AccountPassword is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'The specified parameter AccountDescription is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountType.Malformed', + 'errorMessage' => 'The specified parameter AccountType is not valid.', + ], + [ + 'errorCode' => 'ACS.Sql.CannotConnect', + 'errorMessage' => 'Cannot connect instance which type is %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccountResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</CreateAccountResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130690', + '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****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Engine', + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAccountResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</DeleteAccountResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130693', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + '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' => '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' => 'testacc', + ], + ], + [ + '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' => true, + 'example' => 'AccDesc', + ], + ], + [ + 'name' => 'Engine', + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'The specified parameter AccountDescription is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAccountDescriptionResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</ModifyAccountDescriptionResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130691', + '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****', + ], + ], + [ + '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', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Engine', + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter AccountPassword is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.Sql.CannotConnect', + 'errorMessage' => 'Cannot connect instance which type is %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetAccountPasswordResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</ResetAccountPasswordResponse>","errorExample":""}]', + 'title' => 'ResetAccountPassword', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + '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' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => 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](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amv-wz9842849v6****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FB9DCA3-DA56-5B43-A9A0-68E3D0E6AA84\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<CheckBindRamUserResponse>\\n <RequestId>2FB9DCA3-DA56-5B43-A9A0-68E3D0E6AA84</RequestId>\\n <Result>true</Result>\\n</CheckBindRamUserResponse>","errorExample":""}]', + 'title' => 'CheckBindRamUser', + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz99d9nh532****', + ], + ], + [ + 'name' => 'RamUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the RAM user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1444832459****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The standard account of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'RamUserList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + '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' => 'DFF27323-3868-5F8A-917D-5D1D06B6BC0D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.Account.NotExist', + 'errorMessage' => 'The account is not found.', + ], + [ + 'errorCode' => 'ACS.Account.UserHasBind', + 'errorMessage' => 'The user has been associated with another database account %s.', + ], + [ + 'errorCode' => 'ACS.User.DatabaseAccountHasBind', + 'errorMessage' => 'The database account has been bound to %s.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DFF27323-3868-5F8A-917D-5D1D06B6BC0D\\"\\n}","errorExample":""},{"type":"xml","example":"<BindAccountResponse>\\n <RequestId>DFF27323-3868-5F8A-917D-5D1D06B6BC0D</RequestId>\\n</BindAccountResponse>","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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + '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****', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93E85E5C-C805-5837-8713-05B69A504EE5\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbindAccountResponse>\\n <RequestId>93E85E5C-C805-5837-8713-05B69A504EE5</RequestId>\\n</UnbindAccountResponse>","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' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '159109', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + '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 (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1k5p066e1a****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'account1', + ], + ], + [ + 'name' => 'AccountPrivileges', + '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, + ], + ], + ], + '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' => '9DD88DE7-824F-1082-AA57-575AFC6517A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Privilege.ModifyFailed', + 'errorMessage' => 'Failed to modify the account privilege. Make sure that bound account have sufficient database privileges.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.Parameter.Malformed', + 'errorMessage' => 'The following required parameters are not specified: %s', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.User.NotBindDatabaseAccount', + 'errorMessage' => 'The user has not been associated with a database account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DD88DE7-824F-1082-AA57-575AFC6517A8\\"\\n}","type":"json"}]', + 'title' => 'ModifyAccountPrivileges', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + 'DescribeAccountPrivileges' => [ + 'summary' => 'Queries the permissions of a database account on a specified permission level.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '159083', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + '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 (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp1k5p066e1a****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'account1', + ], + ], + [ + 'name' => 'PrivilegeType', + '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', + ], + ], + [ + 'name' => 'DatabasePrivilegeObject', + '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', + ], + ], + [ + 'name' => 'TablePrivilegeObject', + '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', + ], + ], + [ + 'name' => 'PageNumber', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ColumnPrivilegeObject', + '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', + ], + ], + ], + '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", + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Account.NotExist', + 'errorMessage' => 'The account is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.User.NotBindDatabaseAccount', + 'errorMessage' => 'The user has not been associated with a database account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA32480A-E3E5-1BE7-BA98-724551DC04C8\\",\\n \\"Data\\": [\\n {\\n \\"PrivilegeType\\": \\"Column\\",\\n \\"PrivilegeObject\\": {\\n \\"Database\\": \\"db1\\",\\n \\"Table\\": \\"tabl1\\",\\n \\"Column\\": \\"column1\\",\\n \\"Description\\": \\"a test column\\"\\n },\\n \\"Privileges\\": [\\n \\"insert,select\\"\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccountPrivilegesResponse>\\n <RequestId>DA32480A-E3E5-1BE7-BA98-724551DC04C8</RequestId>\\n <Data>\\n <PrivilegeType>Column</PrivilegeType>\\n <PrivilegeObject>\\n <Database>db1</Database>\\n <Table>tabl1</Table>\\n <Column>column1</Column>\\n <Description>a test column</Description>\\n </PrivilegeObject>\\n <Privileges>insert,select</Privileges>\\n </Data>\\n <TotalCount>100</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n</DescribeAccountPrivilegesResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '159129', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + '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 (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp14t95lun0w****', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'Description' => [ + 'description' => 'The description of the permission level.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + '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, + ], + ], + 'required' => true, + ], + 'required' => false, + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"246F42E0-A475-15FF-96D2-8DC47FC2F289\\",\\n \\"Data\\": [\\n {\\n \\"Scope\\": \\"Global\\",\\n \\"Description\\": \\"全局权限\\",\\n \\"Privileges\\": [\\n {\\n \\"Key\\": \\"select\\",\\n \\"Description\\": \\"查询数据\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeEnabledPrivilegesResponse>\\n <RequestId>246F42E0-A475-15FF-96D2-8DC47FC2F289</RequestId>\\n <Data>\\n <Scope>Global</Scope>\\n <Description>全局</Description>\\n <Privileges>\\n <Key>select</Key>\\n <Description>查询</Description>\\n </Privileges>\\n </Data>\\n</DescribeEnabledPrivilegesResponse>","errorExample":""}]', + 'title' => 'DescribeEnabledPrivileges', + ], + 'DescribeAccountAllPrivileges' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '162785', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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 (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp14t95lun0w****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'account1', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse', + 'description' => 'BaseResponse', + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Account.NotExist', + 'errorMessage' => 'The account is not found.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.User.NotBindDatabaseAccount', + 'errorMessage' => 'The user has not been associated with a database account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3BB185E9-BB54-1727-B876-13243E4C0EB5\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"PrivilegeType\\": \\"Global\\",\\n \\"PrivilegeObject\\": {\\n \\"Database\\": \\"tdb1\\",\\n \\"Table\\": \\"table1\\",\\n \\"Column\\": \\"id\\",\\n \\"Description\\": \\"id of table\\"\\n },\\n \\"Privileges\\": [\\n \\"select\\"\\n ]\\n }\\n ],\\n \\"Marker\\": \\"0573e74fd1ccb01739993a691e876074db6e1b6ad79f54115f0e98528432ba6a523cfec5780ade5189299cc3396f6ff7\\",\\n \\"Truncated\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccountAllPrivilegesResponse>\\n <RequestId>3BB185E9-BB54-1727-B876-13243E4C0EB5</RequestId>\\n <Data>\\n <Result>\\n <PrivilegeType>Global</PrivilegeType>\\n <PrivilegeObject/>\\n </Result>\\n <Marker>0573e74fd1ccb01739993a691e876074db6e1b6ad79f54115f0e98528432ba6a523cfec5780ade5189299cc3396f6ff7</Marker>\\n <Truncated>true</Truncated>\\n </Data>\\n</DescribeAccountAllPrivilegesResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '160215', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 20.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ColumnPrivilegeObject', + 'in' => 'query', + 'schema' => [ + 'description' => 'The column name that is used to filter columns.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'col1', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ACS.Account.NotExist', + 'errorMessage' => 'The account is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'ACS.InvalidParameter.%s', + 'errorMessage' => 'Parameter %s is invalid.', + ], + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'ACS.User.NotBindDatabaseAccount', + 'errorMessage' => 'The user has not been associated with a database account.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34B2AD29-682F-1C14-B3AA-9EF1A96084B8\\",\\n \\"Data\\": [\\n {\\n \\"Database\\": \\"tdb1\\",\\n \\"Table\\": \\"table1\\",\\n \\"Column\\": \\"column1\\",\\n \\"Description\\": \\"a test db\\"\\n }\\n ],\\n \\"TotalCount\\": 23,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccountPrivilegeObjectsResponse>\\n <RequestId>34B2AD29-682F-1C14-B3AA-9EF1A96084B8</RequestId>\\n <Data>\\n <Database>tdb1</Database>\\n <Table>table1</Table>\\n <Column>column1</Column>\\n <Description>a test db</Description>\\n </Data>\\n <TotalCount>23</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n</DescribeAccountPrivilegeObjectsResponse>","errorExample":""}]', + 'title' => 'DescribeAccountPrivilegeObjects', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + 'DescribeOperatorPermission' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '214554', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214578', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1mfe9qmsw1dzyg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RelatedTaskNotFinish', + 'errorMessage' => 'The related task does not finish.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => 'RevokeOperatorPermission', + ], + 'GrantOperatorPermission' => [ + 'summary' => 'Grants permissions to the service account 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' => '214575', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1565u55p32****', + ], + ], + [ + '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A438072A-E2E7-5509-9A3F-66293512A820', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RelatedTaskNotFinish', + 'errorMessage' => 'The related task does not finish.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A438072A-E2E7-5509-9A3F-66293512A820\\"\\n}","type":"json"}]', + 'title' => 'GrantOperatorPermission', + ], + 'DescribeBackupPolicy' => [ + 'summary' => '查看集群备份设置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Wednesday,Saturday\\",\\n \\"LogBackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"EnableBackupLog\\": \\"true\\",\\n \\"BackupRetentionPeriod\\": 7\\n}","type":"json"}]', + 'title' => 'DescribeBackupPolicy', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).', + ], + 'ModifyBackupPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '155194', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupTime.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupPeriod.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter "BackupRetentionPeriod" should be within [7-%s] days.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => '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", + ], + 'DescribeBackups' => [ + 'summary' => '查询实例备份集', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155193', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup set ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1679758862', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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' => 'Remote', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"300\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"CE17270B-F8F8-5A31-9DB4-DADDFDAD7940\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"FreeBackupSize\\": 0,\\n \\"TotalBackupSize\\": 64953700,\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2022-06-01T16:00Z\\",\\n \\"BackupSize\\": 2167808,\\n \\"BackupEndTime\\": \\"2022-06-02T16:00Z\\",\\n \\"BackupExpiredTime\\": \\"2022-07-02T16:00Z\\\\n\\",\\n \\"BackupId\\": \\"32732****\\",\\n \\"BackupMethod\\": \\"Snapshot\\",\\n \\"BackupRegion\\": \\"cn-hangzhou\\",\\n \\"ParentBackupId\\": \\"32733****\\",\\n \\"BackupStatus\\": \\"Finished\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '246050', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-wz9or2xawpnc****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + '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' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '421794A3-72A5-5D27-9E8B-A75A4C50****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C50****\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '246050', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'BackupIds', + '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', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '771C5FAA-530F-52F7-B84D-EBAD4561D590', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771C5FAA-530F-52F7-B84D-EBAD4561D590\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254755', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The region ID'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type. The value is fixed to Instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + ], + ], + [ + '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', + ], + ], + [ + '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-********', + ], + ], + [ + '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****', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae****', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + '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', + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"E51713A3-BB45-5616-AB15-170B704F8F01\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"TaskId\\": \\"t-83br18hloy3faf****\\",\\n \\"CurrentStepName\\": \\"exec_task\\",\\n \\"StartTime\\": \\"2022-02-03T11:31:03Z\\",\\n \\"EndTime\\": \\"2022-02-03T12:06:17Z\\",\\n \\"TaskType\\": \\"autotest_dispatch_cases\\",\\n \\"RemainTime\\": 1000,\\n \\"Progress\\": 79,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceType\\": \\"Instance\\",\\n \\"InstanceId\\": \\"amv-********\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"DbType\\": \\"analyticdb\\",\\n \\"Product\\": \\"ads\\",\\n \\"TaskDetail\\": \\"{\\\\\\\\\\\\\\"callerUid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}\\",\\n \\"ActionInfo\\": \\"{\\\\\\\\\\\\\\"steps\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"action_info\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Waiting\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"modifySwitchTime\\\\\\\\\\\\\\"]},\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec_task\\\\\\\\\\\\\\"}]}\\",\\n \\"Uid\\": \\"141345906006****\\",\\n \\"CallerSource\\": \\"141345906006****\\",\\n \\"CallerUid\\": \\"User\\",\\n \\"ReasonCode\\": \\"test\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"test\\",\\n \\"AuthPrincipalDisplayName\\": \\"test\\",\\n \\"AuthPrincipalOwnerId\\": \\"141345906006****\\",\\n \\"AuthPrincipalType\\": \\"test\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFmy+hZZsvoWTQ2NTJFQUFBLUIyNjktMzk5NS05MEZCLUMxMzgwNDUwMDA2Ng==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"ControlPolicy\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeHistoryTasks', + 'description' => 'Only supports viewing tasks within the last 30 days.'."\n", + ], + 'DescribeHistoryTasksStat' => [ + 'summary' => 'Queries task statistics.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254776', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The ID of the region where the instance resides.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amv-********', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1564657730', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'Query start time.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-05-08T07:04:17Z', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmy*****', + ], + ], + ], + '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', + ], + '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', + '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', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Scheduled\\",\\n \\"TotalCount\\": 20\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"test\\",\\n \\"AuthPrincipalDisplayName\\": \\"test\\",\\n \\"AuthPrincipalOwnerId\\": \\"141345906006****\\",\\n \\"AuthPrincipalType\\": \\"test\\",\\n \\"EncodedDiagnosticMessage\\": \\"test\\\\n\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"ControlPolicy\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeHistoryTasksStat', + ], + 'DescribeExecutorDetection' => [ + 'summary' => 'Queries the diagnostic results of the compute layer.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194344', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + '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", + ], + ], + ], + 'description' => 'The detection result items of operator metric aggregation.'."\n", + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"566\\",\\n \\"RequestId\\": \\"9DFF5F54-162B-5860-80A5-411FF550B347\\",\\n \\"DBClusterId\\": \\"am-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"指标检测\\",\\n \\"Results\\": {\\n \\"OperatorDetails\\": [\\n {\\n \\"MetricName\\": \\"PeakMemory\\",\\n \\"SearchResults\\": [\\n {\\n \\"ProcessId\\": \\"2024080110010002102500023803151627972\\",\\n \\"StageId\\": \\"Stage[3]\\",\\n \\"OperatorName\\": \\"Join\\",\\n \\"PeakMemory\\": 234,\\n \\"OperatorCost\\": 123,\\n \\"InputRows\\": 123,\\n \\"OutputRows\\": 2345,\\n \\"InputSize\\": 345,\\n \\"OutputSize\\": 234,\\n \\"OperatorInfo\\": \\"Group By字段：uid\\"\\n }\\n ]\\n }\\n ],\\n \\"OperatorAgg\\": [\\n {\\n \\"MetricName\\": \\"OperatorCost\\",\\n \\"SearchResults\\": [\\n {\\n \\"OperatorName\\": \\"Window\\",\\n \\"MaxValue\\": 2345,\\n \\"TotalValue\\": 345,\\n \\"AvgValue\\": 234,\\n \\"OperatorCount\\": 3\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"检测到Aggregation算子消耗内存资源较多\\\\n\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeExecutorDetection', + ], + 'DescribeWorkerDetection' => [ + 'summary' => 'Queries the diagnostic results of the storage layer.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194345', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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', + ], + ], + [ + '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' => '2021-11-18T00: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:mmZ* format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-04-25T02:04Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language. Valid values:'."\n" + ."\n" + .'* **zh** (default): simplified Chinese.'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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", + 'type' => 'object', + 'properties' => [ + 'SkewedTables' => [ + 'description' => 'The detection result items of skewed tables.'."\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", + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"20\\",\\n \\"RequestId\\": \\"E5B37B61-E6C9-5FE0-9374-45BAA548AEF6\\",\\n \\"DBClusterId\\": \\"am-xxxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"指标检测\\",\\n \\"Results\\": {\\n \\"SkewedTables\\": [\\n {\\n \\"SchemaName\\": \\"platfunc\\",\\n \\"TableName\\": \\"sls_log_cheat_action\\",\\n \\"DDL\\": \\"create table test(id varchar)\\",\\n \\"PartitionCount\\": 2,\\n \\"TotalDataSize\\": 2345,\\n \\"TotalRowCount\\": 34,\\n \\"TotalPkSize\\": 234,\\n \\"TotalRemoteDataSize\\": 234,\\n \\"TotalLocalDataSize\\": \\"2345\\",\\n \\"ShardSkewedRows\\": \\"1234\\"\\n }\\n ],\\n \\"PartitionedTables\\": [\\n {\\n \\"SchemaName\\": \\"nxg\\",\\n \\"TableName\\": \\"zhw_place_order\\",\\n \\"DDL\\": \\"create table test(id varchar)\\",\\n \\"PartitionCount\\": \\"234\\",\\n \\"PartitionIds\\": \\"[2024,2025]\\",\\n \\"TotalDataSize\\": 1234\\n }\\n ],\\n \\"TopAccessTables\\": [\\n {\\n \\"MetricName\\": \\"峰值内存检测\\",\\n \\"SearchResults\\": [\\n {\\n \\"TableName\\": \\"tiberias_2copt_origin_order_goods_info\\",\\n \\"MaxScanCost\\": 345,\\n \\"AvgScanCost\\": 234,\\n \\"MaxScanSize\\": 2345,\\n \\"AvgScanSize\\": 234,\\n \\"AccessCount\\": 1111\\n }\\n ]\\n }\\n ],\\n \\"OperatorDetails\\": [\\n {\\n \\"MetricName\\": \\"PeakMemory\\",\\n \\"SearchResults\\": [\\n {\\n \\"ProcessId\\": \\"2024041909301402103302422803151411141\\",\\n \\"StageId\\": \\"Stage[2]\\",\\n \\"OperatorName\\": \\"TableScan\\",\\n \\"PeakMemory\\": 23,\\n \\"OperatorCost\\": 23,\\n \\"InputRows\\": 123,\\n \\"OutputRows\\": 123,\\n \\"InputSize\\": 123,\\n \\"OutputSize\\": 123,\\n \\"OperatorInfo\\": \\"Group By字段：id\\"\\n }\\n ]\\n }\\n ],\\n \\"OperatorAgg\\": [\\n {\\n \\"MetricName\\": \\"峰值内存\\",\\n \\"SearchResults\\": [\\n {\\n \\"OperatorName\\": \\"Aggregation\\",\\n \\"MaxValue\\": 444,\\n \\"TotalValue\\": 123,\\n \\"AvgValue\\": 2234,\\n \\"OperatorCount\\": 1234\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"检测到多个表存在主键过多的问题\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeWorkerDetection', + ], + 'DescribeControllerDetection' => [ + 'summary' => 'Queries the diagnostic results of the access layer.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194343', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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', + ], + ], + [ + '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 30 days.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2024-06-23T02:21Z', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"10\\",\\n \\"RequestId\\": \\"257FAE29-ED5F-586C-94E4-43BD1392F238\\",\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Message\\": \\"检测到接入节点CPU增高\\",\\n \\"Name\\": \\"CPU增高检测\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeControllerDetection', + ], + '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' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194347', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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', + ], + ], + [ + '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-01-23T02:18Z', + ], + ], + [ + 'name' => 'EndTime', + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + '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.', + ], + ], + ], + ], + '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" + .'}', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"50\\",\\n \\"RequestId\\": \\"584CFCAE-E3C8-5BBB-B46C-724E77A830A7\\",\\n \\"DBClusterId\\": \\"amv-xxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"Cost\\",\\n \\"Results\\": [\\n {\\n \\"Cost\\": 709,\\n \\"PeakMemory\\": 234,\\n \\"OperatorCost\\": 2345,\\n \\"ScanSize\\": 2342,\\n \\"OutputDataSize\\": 235433,\\n \\"ProcessId\\": \\"202410161002191720161451770345363xxxx\\",\\n \\"TotalStages\\": 5,\\n \\"DiagnosisResults\\": [\\n {\\n \\"Code\\": \\"查询返回客户端的数据量较大\\",\\n \\"Detail\\": \\"当前SQL返回到客户端的数据量较大，考虑导入到OSS\\",\\n \\"StageId\\": \\"Stage[67]\\",\\n \\"OperatorId\\": \\"TableScan[234]\\"\\n }\\n ],\\n \\"SQL\\": \\"SELECT * FROM device WHERE product_key = \'h66zXfxet2X\' AND name = \'device@zntbtfptv5_9237117\'\\",\\n \\"StartTime\\": \\"2024-09-06T02:11:00Z\\",\\n \\"PatternId\\": \\"3467484070025860498\\"\\n }\\n ],\\n \\"Status\\": \\"WARNING\\",\\n \\"Message\\": \\"检测到存在峰值内存教导的SQL\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescribeBadSqlDetection', + ], + 'DescribeAbnormalPatternDetection' => [ + 'summary' => 'Queries abnormal SQL patterns within a time range.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194346', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-zhangjiakou', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"15\\",\\n \\"RequestId\\": \\"19B824E0-690D-5A78-9992-5398C2F43694\\",\\n \\"DBClusterId\\": \\"amv-xxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"Cost\\",\\n \\"Results\\": [\\n {\\n \\"PatternId\\": \\"2803084667741875187\\",\\n \\"SQLPattern\\": \\"SELECT `tsid`nFROM `prod_ods_marketing_engine_material`nWHERE `tsid` = ?nLIMIT ?\\",\\n \\"Detail\\": \\"检测到2个totalTime指标异常Pattern，可能导致CPU使用率增高，或者查询变慢，影响系统稳定性，请到监控页面使用一键诊断查看详情，并进行优化\\",\\n \\"RelatedMetrics\\": \\"最大查询耗时：1.43s\\\\n最大峰值内存：20.73MB\\\\n最大表读取数据量：10.12MB\\",\\n \\"User\\": \\"test\\",\\n \\"AccessIp\\": \\"172.16.133.168\\",\\n \\"Tables\\": \\"dw_student_exam.ods_school_queanal\\",\\n \\"QueryCount\\": 72,\\n \\"FailedCount\\": 7\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeAbnormalPatternDetection', + ], + 'DescribeInclinedNodes' => [ + 'summary' => 'Queries the disk usage of all storage nodes.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '217356', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C0BF6685-0519-543E-90F8-DB8949E4D5F2', + ], + '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', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0BF6685-0519-543E-90F8-DB8949E4D5F2\\",\\n \\"Items\\": [\\n {\\n \\"Node\\": \\"Node1\\",\\n \\"DiskUsageRatio\\": \\"90.5\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '151720', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CS' => [ + 'description' => 'The access nodes of the queried cluster.'."\n", + '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', + ], + ], + ], + 'Executor' => [ + 'description' => 'The compute node groups of the queried cluster.'."\n", + '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', + ], + ], + ], + 'Worker' => [ + 'description' => 'The storage node groups of the queried cluster.'."\n", + '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', + ], + ], + ], + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CS\\": {\\n \\"ActiveCount\\": 0,\\n \\"UnavailableCount\\": 1,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 1,\\n \\"Status\\": \\"UNAVAILABLE\\"\\n },\\n \\"Executor\\": {\\n \\"ActiveCount\\": 0,\\n \\"UnavailableCount\\": 1,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 1,\\n \\"Status\\": \\"UNAVAILABLE\\"\\n },\\n \\"Worker\\": {\\n \\"ActiveCount\\": 0,\\n \\"UnavailableCount\\": 1,\\n \\"RiskCount\\": 1,\\n \\"ExpectedCount\\": 1,\\n \\"Status\\": \\"UNAVAILABLE\\"\\n },\\n \\"InstanceStatus\\": \\"NORMAL\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CAV\\",\\n \\"AccessDeniedDetail\\": \\"\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131503', + 'abilityTreeNodes' => [ + 'FEATUREadsCVPI8C', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ResourcePools', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user_default', + ], + ], + ], + 'responses' => [ + 200 => [ + '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****', + ], + 'Performances' => [ + 'description' => 'The queried performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried performance metric.'."\n", + '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' => '%', + ], + 'Series' => [ + 'description' => 'The queried performance metric data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried performance metric data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => 'The values of the performance metric at different points in time.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-03-11T15:01Z\\",\\n \\"RequestId\\": \\"BD8C3096-8BC6-51DF-A4AB-BACD9DC10435\\",\\n \\"StartTime\\": \\"2022-03-10T23:56Z\\",\\n \\"DBClusterId\\": \\"amv-bp1hx5n1o8f61****\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_CPU_Usage_Percentage\\",\\n \\"Unit\\": \\"%\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n \\"[\\\\n [ \\\\n \\\\\\"2023-06-27T13:21:00+08:00\\\\\\",\\\\\\"0.1250\\\\\\" \\\\n ], \\\\n [ \\\\n \\\\\\"2022-03-11T10:00:42.739Z\\\\\\",\\\\\\"0.3125\\\\\\" \\\\n ]...\\\\n]\\"\\n ],\\n \\"Name\\": \\"AnalyticDB_Storage_CPU_Avg_Usage_Percentage\\",\\n \\"Tags\\": \\"\\\\n{instance_name: \\\\\\"am-***\\\\\\"}\\",\\n \\"TranslateKey\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterPerformanceResponse>\\n <EndTime>2022-03-11T15:01:00Z</EndTime>\\n <RequestId>BD8C3096-8BC6-51DF-A4AB-BACD9DC10435</RequestId>\\n <StartTime>2022-03-10T23:56:00Z</StartTime>\\n <DBClusterId>am-bp1hx5n1o8f61****</DBClusterId>\\n <Performances>\\n <Key>AnalyticDB_CPU</Key>\\n <Unit>%</Unit>\\n <Series>\\n <Values>[ \\"2022-03-11T03:00:12.72Z\\", \\"0.1250\\" ], [ \\"2022-03-11T10:00:42.739Z\\", \\"0.3125\\" ]</Values>\\n <Name>worker_avg_cpu_used</Name>\\n </Series>\\n </Performances>\\n</DescribeDBClusterPerformanceResponse>","errorExample":""}]', + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + '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-bp11q28kvl688****', + ], + ], + [ + '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', + ], + ], + [ + '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' => '2022-08-22T01:06:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<DescribeElasticPlanAttributeResponse>', + '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-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', + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + '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', + ], + '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" + ."\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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<DescribeElasticPlanAttributeResponse>', + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp10yt0gva71ei7d', + ], + ], + [ + '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-08-22T01:06:00Z'."\n", + ], + ], + [ + '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' => '2022-08-23T01:06:00Z'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<DescribeElasticPlanAttributeResponse>', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173228', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + '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' => '2023-02-04T03:45: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. The end time must be later than the start time.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2023-03-17T16:00:00Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<DescribeElasticPlanAttributeResponse>', + '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 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", + 'type' => 'array', + 'items' => [ + '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", + 'type' => 'object', + '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', + ], + 'SpotAcuNumber' => [ + 'description' => 'The number of spot ACUs.', + 'type' => 'number', + 'format' => 'float', + 'example' => '16ACU', + ], + 'SpotAcuPercentage' => [ + 'description' => 'The percent of spot ACUs.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + ], + ], + 'UseCachePool' => [ + 'type' => 'boolean', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"DBClusterId\\": \\"amv-clusterxxx\\",\\n \\"StartTime\\": \\"2023-05-22T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-05-23T16:00:00Z\\\\n\\",\\n \\"JobAcuUsage\\": [\\n {\\n \\"JobId\\": \\"1592\\",\\n \\"ResourceGroupName\\": \\"job_default\\",\\n \\"JobStartTime\\": \\"2023-05-22T16:00:00Z\\\\n\\",\\n \\"JobEndTime\\": \\"2023-05-23T16:00:00Z\\",\\n \\"AcuUsageDetail\\": {\\n \\"TotalAcuNumber\\": 0,\\n \\"ReservedAcuNumber\\": 0,\\n \\"ElasticAcuNumber\\": 0,\\n \\"SpotAcuNumber\\": 0,\\n \\"SpotAcuPercentage\\": 0.9\\n },\\n \\"UseCachePool\\": true\\n }\\n ],\\n \\"PageNumber\\": 0,\\n \\"PageSize\\": 0,\\n \\"TotalCount\\": 0\\n }\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220841', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8', + ], + 'Views' => [ + 'description' => 'the list of view.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ViewName' => [ + 'description' => 'The name of the view.'."\n", + 'type' => 'string', + 'example' => 'Basic', + ], + 'CreateTime' => [ + 'description' => 'The time when created.', + 'type' => 'string', + 'example' => '2024-06-18T07:06:53.000+00:00', + ], + 'UpdateTime' => [ + 'description' => 'The time when updated.', + 'type' => 'string', + 'example' => '2024-06-18T07:07:32.000+00:00', + ], + ], + ], + ], + '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" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8\\",\\n \\"Views\\": [\\n {\\n \\"ViewName\\": \\"自定义-1\\",\\n \\"CreateTime\\": \\"2024-06-18T07:06:53.000+00:00\\",\\n \\"UpdateTime\\": \\"2024-06-18T07:07:32.000+00:00\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescribePerformanceViews', + ], + 'CreatePerformanceView' => [ + 'summary' => 'Creates a custom monitoring view.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221254', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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-beijing', + ], + ], + [ + 'name' => 'ViewDetail', + '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, + ], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the view.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'viewname', + ], + ], + [ + 'name' => 'CreateFromViewType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the view.', + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + [ + 'name' => 'FillOriginViewKeys', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E031AABF-BD56-5966-A063-4283EF18DB45', + ], + 'CreateStatus' => [ + 'description' => 'The creation result. Valid values:'."\n" + ."\n" + .'* **SUCCESS**'."\n" + .'* **FAILED**'."\n", + 'type' => 'string', + '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" + .'}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"CreateStatus\\": \\"SUCCESS\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'CreatePerformanceView', + ], + 'ModifyPerformanceView' => [ + 'summary' => 'Modifies the information about a custom monitoring view.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220840', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the monitoring view.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Basic', + ], + ], + [ + 'name' => 'ViewDetail', + 'in' => 'query', + 'style' => 'json', + '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", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '', + '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, + ], + ], + ], + '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' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"ModifyStatus\\": \\"SUCCESS\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'ModifyPerformanceView', + ], + 'DescribePerformanceViewAttribute' => [ + 'summary' => 'Queries the information about a monitoring view.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220839', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the view.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Basic', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'PerformanceViewNotFound', + 'errorMessage' => 'Performance view not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"ViewName\\": \\"自定义-全部指标-2列-联动\\",\\n \\"CreateFromViewType\\": \\"Basic\\",\\n \\"ViewDetail\\": {\\n \\"ChartsPerLine\\": 2,\\n \\"ChartLinked\\": true,\\n \\"Categories\\": [\\n {\\n \\"Category\\": \\"Node\\",\\n \\"Keys\\": [\\n {\\n \\"KeyName\\": \\"AnalyticDB_CPU\\",\\n \\"Selected\\": true,\\n \\"GroupType\\": [\\n \\"\\"\\n ],\\n \\"Engine\\": [\\n \\"\\"\\n ],\\n \\"EnableAutoMc\\": true\\n }\\n ]\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\",\\n \\"DBClusterId\\": \\"amv-bp198m028ih55xxxx\\",\\n \\"FillOriginViewKeys\\": true\\n}","type":"json"}]', + 'title' => 'DescribePerformanceViewAttribute', + ], + 'DeletePerformanceView' => [ + 'summary' => 'Deletes a monitoring view.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221469', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the view.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'view_dwd_plan_double_term', + ], + ], + ], + 'responses' => [ + 200 => [ + '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" + .'}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'PerformanceViewNotFound', + 'errorMessage' => 'Performance view not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DeleteStatus\\": true,\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DeletePerformanceView', + ], + 'ExistRunningSQLEngine' => [ + 'summary' => 'Queries whether a running SQL engine exists.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '150789', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'example' => 'True', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA675D68-14A4-5D9C-8820-92537D9F447E\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'ExistRunningSQLEngine', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '235566', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Agency', + 'in' => 'formData', + 'schema' => [ + 'description' => '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' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + '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' => 'Schema', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + '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' => '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' => '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" + .'}', + ], + ], + ], + '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' => 'CBE843D8-964D-5EA3-9D31-822125611B6E', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'example' => 'true', + '$ref' => '#/components/schemas/SparkBatchSQL', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBE843D8-964D-5EA3-9D31-822125611B6E\\",\\n \\"Data\\": {\\n \\"QueryId\\": \\"amv-202401-xx\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"QueryStartTime\\": 1723521767000,\\n \\"QueryEndTime\\": 1723521767000,\\n \\"Schema\\": \\"default\\",\\n \\"Uid\\": 12222222,\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"ResourceGroupName\\": \\"spark_rg\\",\\n \\"Query\\": \\"query\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"amv-20240711-stmt\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"JSON格式执行结果集\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\"\\n }\\n}","type":"json"}]', + 'title' => 'ExecuteSparkWarehouseBatchSQL', + ], + 'CancelSparkWarehouseBatchSQL' => [ + 'summary' => 'Cancels the execution of a Spark SQL statement.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235570', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'QueryId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The query ID of the Spark SQL statement.', + 'type' => 'string', + 'required' => true, + 'example' => 'sq202501011001s****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'amv-uf6485635f***', + ], + ], + [ + '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', + ], + ], + ], + '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' => '771C5FAA-530F-52F7-B84D-EBAD45***', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'example' => '123', + '$ref' => '#/components/schemas/SparkBatchSQL', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771C5FAA-530F-52F7-B84D-EBAD45***\\",\\n \\"Data\\": {\\n \\"QueryId\\": \\"amv-202401-xx\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"QueryStartTime\\": 1723521767000,\\n \\"QueryEndTime\\": 1723521767000,\\n \\"Schema\\": \\"default\\",\\n \\"Uid\\": 12222222,\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"ResourceGroupName\\": \\"spark_rg\\",\\n \\"Query\\": \\"query\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"amv-20240711-stmt\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"JSON格式执行结果集\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\"\\n }\\n}","type":"json"}]', + 'title' => 'CancelSparkWarehouseBatchSQL', + ], + 'ListSparkWarehouseBatchSQL' => [ + 'summary' => 'Queries a list of Spark SQL statements.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236211', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'default' => '10', + ], + ], + ], + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"Total\\": 0,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Queries\\": [\\n {\\n \\"QueryId\\": \\"amv-202401-xx\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"QueryStartTime\\": 1723521767000,\\n \\"QueryEndTime\\": 1723521767000,\\n \\"Schema\\": \\"default\\",\\n \\"Uid\\": 12222222,\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"ResourceGroupName\\": \\"spark_rg\\",\\n \\"Query\\": \\"query\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"amv-20240711-stmt\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"JSON格式执行结果集\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListSparkWarehouseBatchSQL', + ], + 'GetSparkWarehouseBatchSQL' => [ + 'summary' => 'Queries the execution result of a Spark SQL statement.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235568', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'QueryId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The query ID of the Spark SQL statement.', + 'type' => 'string', + 'required' => true, + 'example' => 'sq2024123*****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amv-uf6485635f***', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3D44EDA0-A9DC-580D-9B5A-019370C075F4\\",\\n \\"Data\\": {\\n \\"QueryId\\": \\"amv-202401-xx\\",\\n \\"QueryState\\": \\"RUNNING\\",\\n \\"QuerySubmissionTime\\": 1723521767000,\\n \\"QueryStartTime\\": 1723521767000,\\n \\"QueryEndTime\\": 1723521767000,\\n \\"Schema\\": \\"default\\",\\n \\"Uid\\": 12222222,\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"ResourceGroupName\\": \\"spark_rg\\",\\n \\"Query\\": \\"query\\",\\n \\"Statements\\": [\\n {\\n \\"ResultUri\\": \\"oss://yourbucket/result.json\\",\\n \\"EndTime\\": 1723521767000,\\n \\"AppId\\": \\"s20240122jsdx****\\",\\n \\"StatementId\\": \\"amv-20240711-stmt\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"StartTime\\": 1723521767000,\\n \\"Error\\": \\"table is not found\\",\\n \\"Code\\": \\"SELECT 100\\",\\n \\"Result\\": \\"JSON格式执行结果集\\"\\n }\\n ],\\n \\"ErrMessage\\": \\"schema is not found\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetSparkWarehouseBatchSQL', + ], + 'StartSparkReplSession' => [ + 'summary' => 'Starts a Spark session.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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" }', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C1797FEA-B7D6-5ED6-A24B-2C8C5F4D7361', + ], + '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" + ."\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******', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1797FEA-B7D6-5ED6-A24B-2C8C5F4D7361\\",\\n \\"Data\\": {\\n \\"SessionId\\": 1,\\n \\"AttemptId\\": \\"s202301061000h****\\",\\n \\"Error\\": \\"session time out\\",\\n \\"WebUiAddress\\": \\"https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\",\\n \\"State\\": \\"IDLE\\",\\n \\"AliyunUid\\": \\"178157466******\\"\\n }\\n}","type":"json"}]', + 'title' => 'StartSparkReplSession', + ], + 'GetSparkReplStatement' => [ + 'summary' => 'Queries the execution result of a code block.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => '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', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the session that executes the code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + '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" + ."\n" + .'Valid values:'."\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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"StatementId\\": 123,\\n \\"Code\\": \\"print(1+1)\\",\\n \\"CodeType\\": \\"PYTHON\\",\\n \\"CodeState\\": \\"RUNNING\\",\\n \\"AliyunUid\\": 0,\\n \\"OutputType\\": \\"TEXT\\",\\n \\"Output\\": \\"{\\\\\\"text/plain\\\\\\": 2}\\",\\n \\"Columns\\": [\\n \\"col1\\"\\n ],\\n \\"Error\\": \\"stackoverflow error\\",\\n \\"StartTime\\": 1730968194000,\\n \\"EndTime\\": 1730968194000\\n }\\n}","type":"json"}]', + 'title' => 'GetSparkReplStatement', + ], + 'ExecuteSparkReplStatement' => [ + 'summary' => 'Executes part of the code in a Spark job.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => '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' => 'Code', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The code that you want to execute.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'print(1+1)', + ], + ], + [ + '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"StatementId\\": 123,\\n \\"Code\\": \\"print(1+1)\\",\\n \\"CodeType\\": \\"PYTHON\\",\\n \\"CodeState\\": \\"RUNNING\\",\\n \\"AliyunUid\\": 0,\\n \\"OutputType\\": \\"TEXT\\",\\n \\"Output\\": \\"{\\\\\\"text/plain\\\\\\": 2}\\",\\n \\"Columns\\": [\\n \\"col1\\"\\n ],\\n \\"Error\\": \\"StackOverflow Exception\\",\\n \\"StartTime\\": 1730968125000,\\n \\"EndTime\\": 1730968125000\\n }\\n}","type":"json"}]', + 'title' => 'ExecuteSparkReplStatement', + ], + 'CancelSparkReplStatement' => [ + 'summary' => 'Terminates part of the code in a Spark job.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => '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' => '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' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '456', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '190063530332****', + ], + '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', + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"StatementId\\": 123,\\n \\"Code\\": \\"print(1+1)\\",\\n \\"CodeType\\": \\"PYTHON\\",\\n \\"CodeState\\": \\"RUNNING\\",\\n \\"AliyunUid\\": 0,\\n \\"OutputType\\": \\"TEXT\\",\\n \\"Output\\": \\"{\\\\\\"text/plain\\\\\\": \\\\\\"2\\\\\\"}\\",\\n \\"Columns\\": [\\n \\"col1\\"\\n ],\\n \\"Error\\": \\"StackOverflow Exception：\\",\\n \\"StartTime\\": 1730968056000,\\n \\"EndTime\\": 1730968056000\\n }\\n}","type":"json"}]', + 'title' => 'CancelSparkReplStatement', + ], + 'GetSparkReplSession' => [ + 'summary' => 'Queries the status of a Spark session.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => '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' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the session that executes the code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4CE6DF97-AEA4-484F-906F-C407EE3770EB', + ], + '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', + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE3770EB\\",\\n \\"Data\\": {\\n \\"SessionId\\": 1,\\n \\"State\\": \\"IDEL\\",\\n \\"AttemptId\\": \\"s202301061000hz57d797b00002****\\",\\n \\"Error\\": \\"Session timed out\\",\\n \\"WebUiAddress\\": \\"https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\",\\n \\"AliyunUid\\": \\"178157466101****\\",\\n \\"Active\\": \\"true\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetSparkReplSession', + ], + 'DescribeSparkAppType' => [ + 'summary' => 'Queries the type of a Spark application.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189112', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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' => '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + ], + '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" + .'}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"596AF63B-8798-501E-BA06-CD2184D48A35\\",\\n \\"Type\\": \\"Batch\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescribeSparkAppType', + ], + 'PreloadSparkAppMetrics' => [ + 'summary' => 'Preloads metrics for a Spark application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '169119', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => 'The Spark application ID.'."\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](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp1mfe9qmsw1dzyg', + ], + ], + ], + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84489769-3065-5A28-A4CB-977CD426F1C3\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202212181815shaccb8be0000253\\",\\n \\"AttemptId\\": \\"s202301061000hz57d797b0000201-0001\\",\\n \\"Finished\\": true,\\n \\"EventLogPath\\": \\"oss://path/to/eventLog\\",\\n \\"ScanMetrics\\": {\\n \\"OutputRowsCount\\": 1000,\\n \\"TotalReadFileSizeInByte\\": 10000\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<PreloadSparkAppMetricsResponse>\\n <RequestId>84489769-3065-5A28-A4CB-977CD426F1C3</RequestId>\\n <Data>\\n <AppId>s202212181815shaccb8be0000253</AppId>\\n <AttemptId>s202301061000hz57d797b0000201-0001</AttemptId>\\n <Finished>true</Finished>\\n <EventLogPath>oss://path/to/eventLog</EventLogPath>\\n <ScanMetrics>\\n <OutputRowsCount>1000</OutputRowsCount>\\n <TotalReadFileSizeInByte>10000</TotalReadFileSizeInByte>\\n </ScanMetrics>\\n </Data>\\n</PreloadSparkAppMetricsResponse>","errorExample":""}]', + 'title' => 'PreloadSparkAppMetrics', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '169120', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + '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****', + ], + ], + ], + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.CancelNotebookStatementFailed', + 'errorMessage' => 'Failed to cancel the execution of notebook statements.', + ], + [ + 'errorCode' => 'Spark.CloseNotebookKernelFailed', + 'errorMessage' => 'Failed to disable the notebook kernel.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.ExecuteNotebookStatementFailed', + 'errorMessage' => 'Failed to execute notebook statements.', + ], + [ + 'errorCode' => 'Spark.GetNotebookKernelFailed', + 'errorMessage' => 'Failed to start the notebook kernel. Try again later.', + ], + [ + 'errorCode' => 'Spark.GetNotebookKernelStateFailed', + 'errorMessage' => 'Failed to obtain the status of the notebook kernel.', + ], + [ + 'errorCode' => 'Spark.GetNotebookStatementLogFailed', + 'errorMessage' => 'Failed to obtain notebook statement logs.', + ], + [ + 'errorCode' => 'Spark.GetNotebookStatementResultFailed', + 'errorMessage' => 'Failed to obtain notebook statement execution results.', + ], + [ + 'errorCode' => 'Spark.GetNotebookStatementUiFailed', + 'errorMessage' => 'Failed to obtain notebook statement UI.', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.NotebookKernelBusy', + 'errorMessage' => 'Too many jobs in the notebook kernel. Try again later.', + ], + [ + 'errorCode' => 'Spark.NotebookKernelExpired', + 'errorMessage' => 'The notebook kernel has expired. Restart the kernel.', + ], + [ + 'errorCode' => 'Spark.NotebookKernelInvalidStatus', + 'errorMessage' => 'The status of the notebook kernel is invalid.', + ], + [ + 'errorCode' => 'Spark.NotebookKernelNotStartup', + 'errorMessage' => 'The notebook kernel has not been started', + ], + [ + 'errorCode' => 'Spark.NotebookKernelStarting', + 'errorMessage' => 'The notebook kernel is starting. Try again later.', + ], + [ + 'errorCode' => 'Spark.NotebookNamingDuplicate', + 'errorMessage' => 'The name of the notebook is duplicated, please change the name', + ], + [ + 'errorCode' => 'Spark.NotebookNotFound', + 'errorMessage' => 'The notebook is not found', + ], + [ + 'errorCode' => 'Spark.NotebookParagraphMissingProgramCode', + 'errorMessage' => 'The notebook paragraph program code is missing', + ], + [ + 'errorCode' => 'Spark.NotebookParagraphNotFound', + 'errorMessage' => 'The notebook paragraph is not found', + ], + [ + 'errorCode' => 'Spark.NotebookParagraphNotRunning', + 'errorMessage' => 'The notebook paragraph has not been running', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + [ + 'errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', + 'errorMessage' => 'Can\'t load the content from file: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202302051515shfa865f8000****\\",\\n \\"AttemptId\\": \\"s202301061000hz57d797b0000201-****\\",\\n \\"Finished\\": true,\\n \\"EventLogPath\\": \\"oss://path/to/eventLog\\",\\n \\"ScanMetrics\\": {\\n \\"OutputRowsCount\\": 1000,\\n \\"TotalReadFileSizeInByte\\": 10000\\n }\\n }\\n}","type":"json"}]', + 'title' => '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.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'ListSparkLogAnalyzeTasks' => [ + 'summary' => 'Queries a list of Spark log analysis tasks.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群ID', + 'description' => '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', + ], + ], + [ + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1DF5AF5B-C803-1861-A0FF-63666A557709\\",\\n \\"Data\\": {\\n \\"TaskList\\": [\\n {\\n \\"TaskId\\": 10,\\n \\"UserId\\": 0,\\n \\"SubmittedTimeInMillis\\": 1672123543000,\\n \\"TerminatedTimeInMillis\\": 1672123543000,\\n \\"TaskState\\": \\"WAITING\\",\\n \\"Result\\": {\\n \\"AppErrorCode\\": \\"EXCEEDED_QUOTA\\",\\n \\"AppErrorLog\\": \\"exception: xxxx\\",\\n \\"AppErrorAdvice\\": \\"\\"\\n },\\n \\"StartedTimeInMillis\\": 1672123543000,\\n \\"RuleMatched\\": true,\\n \\"TaskErrMsg\\": \\"Driver log not found\\",\\n \\"DBClusterId\\": \\"amv-adbxxxxx\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSparkLogAnalyzeTasksResponse>\\n <RequestId>1DF5AF5B-C803-1861-A0FF-63666A557709</RequestId>\\n <Data>\\n <TaskList>\\n <TaskId>10</TaskId>\\n <SubmittedTimeInMillis>1672123543000</SubmittedTimeInMillis>\\n <TerminatedTimeInMillis>1672123543000</TerminatedTimeInMillis>\\n <TaskState>WAITING</TaskState>\\n <Result>\\n <AppErrorCode>EXCEEDED_QUOTA</AppErrorCode>\\n <AppErrorLog>exception: xxxx</AppErrorLog>\\n </Result>\\n <StartedTimeInMillis>1672123543000</StartedTimeInMillis>\\n <RuleMatched>true</RuleMatched>\\n <TaskErrMsg>Driver log not found</TaskErrMsg>\\n <DBClusterId>amv-adbxxxxx</DBClusterId>\\n </TaskList>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n <TotalCount>100</TotalCount>\\n </Data>\\n</ListSparkLogAnalyzeTasksResponse>","errorExample":""}]', + 'title' => 'ListSparkLogAnalyzeTasks', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'SubmitSparkLogAnalyzeTask' => [ + 'summary' => 'Submits a Spark log analysis task and queries the analysis results.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + '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 information about the Spark log analysis task.'."\n", + '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1DF5AF5B-C803-1861-A0FF-63666A557709\\",\\n \\"Data\\": {\\n \\"TaskId\\": 10,\\n \\"UserId\\": 0,\\n \\"SubmittedTimeInMillis\\": 1672123543000,\\n \\"TerminatedTimeInMillis\\": 1672123543000,\\n \\"TaskState\\": \\"WAITING\\",\\n \\"Result\\": {\\n \\"AppErrorCode\\": \\"EXCEEDED_QUOTA\\",\\n \\"AppErrorLog\\": \\"exception: xxxx\\",\\n \\"AppErrorAdvice\\": \\"\\"\\n },\\n \\"StartedTimeInMillis\\": 1672123543000,\\n \\"RuleMatched\\": true,\\n \\"TaskErrMsg\\": \\"Driver log not found\\",\\n \\"DBClusterId\\": \\"amv-adbxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitSparkLogAnalyzeTaskResponse>\\n <RequestId>xxx-xxx-xxxx</RequestId>\\n <Data>\\n <TaskId>10</TaskId>\\n <SubmittedTimeInMillis>1672123543000</SubmittedTimeInMillis>\\n <TerminatedTimeInMillis>1672123543000</TerminatedTimeInMillis>\\n <TaskState>WAITING</TaskState>\\n <Result>\\n <AppErrorCode>EXCEEDED_QUOTA</AppErrorCode>\\n <AppErrorLog>exception: xxxx</AppErrorLog>\\n </Result>\\n <StartedTimeInMillis>1672123543000</StartedTimeInMillis>\\n <RuleMatched>true</RuleMatched>\\n <TaskErrMsg>Driver log not found</TaskErrMsg>\\n </Data>\\n</SubmitSparkLogAnalyzeTaskResponse>","errorExample":""}]', + 'title' => 'SubmitSparkLogAnalyzeTask', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'KillSparkLogAnalyzeTask' => [ + 'summary' => 'Terminates a Spark log analysis task and queries the information about the analysis task.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark日志分析任务ID'."\n", + 'description' => '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', + '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 information about the Spark log analysis task.'."\n", + '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1DF5AF5B-C803-1861-A0FF-63666A557709\\",\\n \\"Data\\": {\\n \\"TaskId\\": 10,\\n \\"UserId\\": 0,\\n \\"SubmittedTimeInMillis\\": 1672123543000,\\n \\"TerminatedTimeInMillis\\": 1672123543000,\\n \\"TaskState\\": \\"WAITING\\",\\n \\"Result\\": {\\n \\"AppErrorCode\\": \\"EXCEEDED_QUOTA\\",\\n \\"AppErrorLog\\": \\"exception: xxxx\\",\\n \\"AppErrorAdvice\\": \\"\\"\\n },\\n \\"StartedTimeInMillis\\": 1672123543000,\\n \\"RuleMatched\\": true,\\n \\"TaskErrMsg\\": \\"Driver log not found\\",\\n \\"DBClusterId\\": \\"amv-adbxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<KillSparkLogAnalyzeTaskResponse>\\n <RequestId>1DF5AF5B-C803-1861-A0FF-63666A557709</RequestId>\\n <Data>\\n <TaskId>10</TaskId>\\n <SubmittedTimeInMillis>1672123543000</SubmittedTimeInMillis>\\n <TerminatedTimeInMillis>1672123543000</TerminatedTimeInMillis>\\n <TaskState>WAITING</TaskState>\\n <Result>\\n <AppErrorCode>EXCEEDED_QUOTA</AppErrorCode>\\n <AppErrorLog>exception: xxxx</AppErrorLog>\\n </Result>\\n <StartedTimeInMillis>1672123543000</StartedTimeInMillis>\\n <RuleMatched>true</RuleMatched>\\n <TaskErrMsg>Driver log not found</TaskErrMsg>\\n <DBClusterId>amv-adbxxxxx</DBClusterId>\\n </Data>\\n</KillSparkLogAnalyzeTaskResponse>","errorExample":""}]', + 'title' => 'KillSparkLogAnalyzeTask', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark日志分析任务ID'."\n", + 'description' => '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', + ], + ], + ], + '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 information about the Spark log analysis task.'."\n", + '$ref' => '#/components/schemas/SparkAnalyzeLogTask', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1DF5AF5B-C803-1861-A0FF-63666A557709\\",\\n \\"Data\\": {\\n \\"TaskId\\": 10,\\n \\"UserId\\": 0,\\n \\"SubmittedTimeInMillis\\": 1672123543000,\\n \\"TerminatedTimeInMillis\\": 1672123543000,\\n \\"TaskState\\": \\"WAITING\\",\\n \\"Result\\": {\\n \\"AppErrorCode\\": \\"EXCEEDED_QUOTA\\",\\n \\"AppErrorLog\\": \\"exception: xxxx\\",\\n \\"AppErrorAdvice\\": \\"\\"\\n },\\n \\"StartedTimeInMillis\\": 1672123543000,\\n \\"RuleMatched\\": true,\\n \\"TaskErrMsg\\": \\"Driver log not found\\",\\n \\"DBClusterId\\": \\"amv-adbxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSparkLogAnalyzeTaskResponse>\\n <RequestId>1DF5AF5B-C803-1861-A0FF-63666A557709</RequestId>\\n <Data>\\n <TaskId>10</TaskId>\\n <SubmittedTimeInMillis>1672123543000</SubmittedTimeInMillis>\\n <TerminatedTimeInMillis>1672123543000</TerminatedTimeInMillis>\\n <TaskState>WAITING</TaskState>\\n <Result>\\n <AppErrorCode>EXCEEDED_QUOTA</AppErrorCode>\\n <AppErrorLog>exception: xxxx</AppErrorLog>\\n </Result>\\n <StartedTimeInMillis>1672123543000</StartedTimeInMillis>\\n <RuleMatched>true</RuleMatched>\\n <TaskErrMsg>Driver log not found</TaskErrMsg>\\n <DBClusterId>amv-adbxxxxx</DBClusterId>\\n </Data>\\n</GetSparkLogAnalyzeTaskResponse>","errorExample":""}]', + 'title' => 'GetSparkLogAnalyzeTask', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '156583', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的id', + 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-dbclusterid', + 'maxLength' => 64, + ], + ], + [ + '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' => 'UseDefaultOss', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to use the default OSS log path.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + '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' => [ + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"IsLogPathExists\\": true,\\n \\"RecordedLogPath\\": \\"oss://testBucketname/to/log\\",\\n \\"ModifiedUid\\": \\"11111111\\",\\n \\"ModifiedTimestamp\\": \\"1675236908\\",\\n \\"DefaultLogPath\\": \\"oss://testBucketname/to/log\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SetSparkAppLogRootPathResponse>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <Data>\\n <IsLogPathExists>true</IsLogPathExists>\\n <RecordedLogPath>oss://path/to/log</RecordedLogPath>\\n <ModifiedUid>1111111</ModifiedUid>\\n <ModifiedTimestamp>1675236908</ModifiedTimestamp>\\n <DefaultLogPath>oss://path/to/log</DefaultLogPath>\\n </Data>\\n</SetSparkAppLogRootPathResponse>","errorExample":""}]', + 'title' => 'SetSparkAppLogRootPath', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '156541', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的id', + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-adsdxxxx', + 'maxLength' => 64, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1919-xxx-ssdfsdff\\",\\n \\"Data\\": {\\n \\"IsLogPathExists\\": true,\\n \\"RecordedLogPath\\": \\"oss://test/spark-logs/\\",\\n \\"ModifiedUid\\": \\"10130223128xxx\\",\\n \\"ModifiedTimestamp\\": \\"1675654361000\\",\\n \\"DefaultLogPath\\": \\"oss://aliyun-oa-adb-spark-****-oss-cn-hanghzou/spark-logs\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSparkConfigLogPathResponse>\\n <RequestId>1919-xxx-ssdfsdff</RequestId>\\n <Data>\\n <IsLogPathExists>true</IsLogPathExists>\\n <RecordedLogPath>oss://test/spark-logs/</RecordedLogPath>\\n <ModifiedUid>10130223128xxx</ModifiedUid>\\n <ModifiedTimestamp>1675654361000</ModifiedTimestamp>\\n <DefaultLogPath>oss://aliyun-oa-adb-spark-1111-oss-cn-hanghzou/spark-logs</DefaultLogPath>\\n </Data>\\n</GetSparkConfigLogPathResponse>","errorExample":""}]', + 'title' => 'GetSparkConfigLogPath', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'StartSparkSQLEngine' => [ + 'summary' => 'Starts the Spark SQL engine.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '152577', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-abcd****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'spark-rg-name', + ], + ], + [ + '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' => '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' => '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' => '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' => '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" }', + ], + ], + ], + '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" + ."\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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202301xxxx\\",\\n \\"State\\": \\"SUBMITTED\\",\\n \\"AppName\\": \\"SQLEngine1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<StartSparkSQLEngineResponse>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <Data>\\n <AppId>s202301xxxx</AppId>\\n <State>SUBMITTED</State>\\n <AppName>SQLEngine1</AppName>\\n </Data>\\n</StartSparkSQLEngineResponse>","errorExample":""}]', + 'title' => 'StartSparkSQLEngine', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152585', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-8vbn8pq537k8w****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'spark_test', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": true\\n}","errorExample":""},{"type":"xml","example":"<KillSparkSQLEngineResponse>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <Data>false</Data>\\n</KillSparkSQLEngineResponse>","errorExample":""}]', + 'title' => 'KillSparkSQLEngine', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'GetSparkSQLEngineState' => [ + 'summary' => 'Queries the state information about the Spark SQL engine.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152586', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-bp11q28kvl688****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the job resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_instance', + ], + ], + ], + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxx-xx\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202207151211hz0c****\\",\\n \\"MinExecutor\\": \\"1\\",\\n \\"MaxExecutor\\": \\"3\\",\\n \\"Jars\\": \\"oss://test-bucket/test.jar\\",\\n \\"SlotNum\\": \\"2\\",\\n \\"Config\\": \\"{\\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"}\\",\\n \\"State\\": \\"COMPLETED\\",\\n \\"SubmittedTimeInMillis\\": \\"1651213645000\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetSparkSQLEngineState', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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', + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Spark job.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '620', + ], + ], + ], + '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', + ], + '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}"', + ], + ], + 'description' => '', + ], + ], + ], + '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.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'DescribeSparkCodeLog' => [ + 'summary' => 'Queries the execution logs of Spark code.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '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](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf6o6m8p6x7v****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Spark job.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1248', + ], + ], + ], + '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', + ], + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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', + '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****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Spark job.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1248', + ], + ], + ], + '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', + ], + '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****', + ], + ], + 'description' => '', + ], + ], + ], + '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.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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****', + ], + ], + ], + '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' => '文件ID列表', + 'description' => 'The IDs of Spark template files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the Spark template file.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": [\\n 10\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSparkTemplateFileIdsResponse>\\n <Data>10</Data>\\n <Data>20</Data>\\n <Data>30</Data>\\n</ListSparkTemplateFileIdsResponse>","errorExample":""}]', + 'title' => 'ListSparkTemplateFileIds', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'GetSparkAppWebUiAddress' => [ + 'summary' => 'Queries the URL of the web UI for a Spark application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '119937', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => '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" + ."\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****', + ], + ], + ], + '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' => [ + 'title' => '', + 'description' => 'The returned data.'."\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=****', + ], + 'DBClusterId' => [ + 'title' => '数据库ID'."\n", + 'description' => 'The database ID.'."\n", + 'type' => 'string', + 'example' => 'amv-clusterxxx', + 'default' => 'DB_CLUSTER_ID', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202205201533hz1209892000****\\",\\n \\"ExpirationTimeInMillis\\": 1655801973000,\\n \\"WebUiAddress\\": \\"https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****\\",\\n \\"DBClusterId\\": \\"amv-clusterxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSparkAppWebUiAddressResponse>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <Data>\\n <AppId>s202205201533hz1209892000****</AppId>\\n <ExpirationTimeInMillis>1655801973000</ExpirationTimeInMillis>\\n <WebUiAddress>https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****</WebUiAddress>\\n </Data>\\n</GetSparkAppWebUiAddressResponse>","errorExample":""}]', + 'title' => 'GetSparkAppWebUiAddress', + 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" + .'* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + '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****', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amv-uf6o6m8p6x***', + ], + ], + ], + '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' => [ + '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" + ."\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", + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"AttemptInfoList\\": [\\n {\\n \\"AttemptId\\": \\"s202207151211hz0cb4200*****-0001\\",\\n \\"Priority\\": \\"NORMAL\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"Message\\": \\"WARN: Disk is full\\",\\n \\"Detail\\": {\\n \\"DurationInMillis\\": 100,\\n \\"LogRootPath\\": \\"oss://<bucket-name>/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":"<ListSparkAppAttemptsResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <Data>\\n <AttemptInfoList>\\n <AttemptId>s202207151211hz0cb4200*****-0001</AttemptId>\\n <State>RUNNING</State>\\n <Message>WARN: Disk is full</Message>\\n <Detail>\\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\\" } }</Data>\\n <EstimateExecutionCpuTimeInSeconds>100</EstimateExecutionCpuTimeInSeconds>\\n <LogRootPath>oss://<bucket-name>/logs/driver</LogRootPath>\\n <LastAttemptId>s202204291426hzpre60cfa*****-0003</LastAttemptId>\\n <WebUiAddress>https://sparkui.aliyuncs.com/token=xxx</WebUiAddress>\\n <SubmittedTimeInMillis>1651213645000</SubmittedTimeInMillis>\\n <StartedTimeInMillis>1651213645010</StartedTimeInMillis>\\n <LastUpdatedTimeInMillis>1651213645200</LastUpdatedTimeInMillis>\\n <TerminatedTimeInMillis>1651213645300</TerminatedTimeInMillis>\\n <DBClusterId>amv-bp11q28kv****</DBClusterId>\\n <ResourceGroupName>spark-rg</ResourceGroupName>\\n <DurationInMillis>100</DurationInMillis>\\n </Detail>\\n </AttemptInfoList>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>3</TotalCount>\\n </Data>\\n</ListSparkAppAttemptsResponse>","errorExample":""}]', + 'title' => 'ListSparkAppAttempts', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'CreateSparkTemplate' => [ + 'summary' => 'Creates a Spark application template.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '132061', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件所在数据库ID', + 'description' => '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' => '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' => 'AppType', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板文件内容的类型, 可选值有 BATCH, STREAMING, SQL, 默认为UNDEFINED', + 'description' => 'The application type. Valid values:'."\n" + ."\n" + .'* **SQL**'."\n" + .'* **STREAMING**'."\n" + .'* **BATCH**'."\n" + ."\n" + .'> You do not need to specify this parameter when Type is set to folder.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SQL', + 'default' => 'UNDEFINED', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"Succeeded\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateSparkTemplateResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <Data>\\n <Succeeded>true</Succeeded>\\n </Data>\\n</CreateSparkTemplateResponse>","errorExample":""}]', + 'title' => 'CreateSparkTemplate', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'DeleteSparkTemplate' => [ + 'summary' => 'Deletes Spark template files.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '132062', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '待删除模板文件的ID', + 'description' => '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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 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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', + 'errorMessage' => 'Can\'t load the content from file: %s', + ], + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"Succeeded\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteSparkTemplateResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <Data>\\n <Succeeded>true</Succeeded>\\n </Data>\\n</DeleteSparkTemplateResponse>","errorExample":""}]', + 'title' => 'DeleteSparkTemplate', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库的ID', + 'description' => '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', + '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" }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": \\"{ \\\\\\"Uid\\\\\\":195813423****, \\\\\\"Type\\\\\\":\\\\\\"FOLDER\\\\\\", \\\\\\"Parent\\\\\\":-1, \\\\\\"Children\\\\\\":[ { \\\\\\"LastModified\\\\\\":1647853173, \\\\\\"Uid\\\\\\":195813423****, \\\\\\"Type\\\\\\":\\\\\\"FOLDER\\\\\\", \\\\\\"Parent\\\\\\":0, \\\\\\"Id\\\\\\":157, \\\\\\"Name\\\\\\":\\\\\\"t\\\\\\" } ], \\\\\\"Id\\\\\\":725204, \\\\\\"Name\\\\\\":\\\\\\"root\\\\\\" }\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSparkTemplateFolderTreeResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\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\\" }</Data>\\n</GetSparkTemplateFolderTreeResponse>","errorExample":""}]', + 'title' => 'GetSparkTemplateFolderTree', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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, + ], + ], + ], + '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" + ."\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" }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": \\"{ \\\\\\"Uid\\\\\\": 10415777****, \\\\\\"Type\\\\\\": \\\\\\"FOLDER\\\\\\", \\\\\\"Parent\\\\\\": -1, \\\\\\"Children\\\\\\": [ { \\\\\\"LastModified\\\\\\": 1648544748, \\\\\\"Uid\\\\\\": 104157779****, \\\\\\"Type\\\\\\": \\\\\\"FILE\\\\\\", \\\\\\"Parent\\\\\\": 0, \\\\\\"Id\\\\\\": s202204132****, \\\\\\"AppType\\\\\\": \\\\\\"SQL\\\\\\", \\\\\\"Name\\\\\\": \\\\\\"f\\\\\\" }, { \\\\\\"LastModified\\\\\\": 1648544956, \\\\\\"Uid\\\\\\": 1041577795****, \\\\\\"Type\\\\\\": \\\\\\"FOLDER\\\\\\", \\\\\\"Parent\\\\\\": 0, \\\\\\"Id\\\\\\": 157, \\\\\\"Name\\\\\\": \\\\\\"f3333\\\\\\" } ], \\\\\\"Id\\\\\\": 725204, \\\\\\"Name\\\\\\": \\\\\\"root\\\\\\" }\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSparkTemplateFullTreeResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\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\\" }</Data>\\n</GetSparkTemplateFullTreeResponse>","errorExample":""}]', + 'title' => 'GetSparkTemplateFullTree', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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, + ], + ], + [ + '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', + ], + ], + ], + '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' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppType\\": \\"SQL\\",\\n \\"Content\\": \\"set spark.driver.resourceSpec=medium;set spark.executor.instances=2;set spark.executor.resourceSpec=medium;set spark.app.name=Spark SQL Test;\\",\\n \\"Id\\": 725204,\\n \\"Type\\": \\"file\\",\\n \\"ResourceGroupName\\": \\"test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSparkTemplateFileContentResponse>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <Data>\\n <AppType>SQL</AppType>\\n <Content>set spark.driver.resourceSpec=medium;set spark.executor.instances=2;set spark.executor.resourceSpec=medium;set spark.app.name=Spark SQL Test;</Content>\\n <Id>725204</Id>\\n <Type>file</Type>\\n <ResourceGroupName>test</ResourceGroupName>\\n </Data>\\n</GetSparkTemplateFileContentResponse>","errorExample":""}]', + 'title' => 'GetSparkTemplateFileContent', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '123242', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + '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' => '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' => 'Content', + 'in' => 'formData', + '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' => 'ResourceGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组的名称', + 'description' => 'The name of the job resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\",\\n \\"Data\\": {\\n \\"Succeeded\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateSparkTemplateFileResponse>\\n <RequestId>C3A9594F-1D40-4472-A96C-8FB8AA20D38C</RequestId>\\n <Data>\\n <Succeeded>true</Succeeded>\\n </Data>\\n</UpdateSparkTemplateFileResponse>","errorExample":""}]', + 'title' => 'UpdateSparkTemplateFile', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '123240', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + [ + 'errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', + 'errorMessage' => 'Can\'t load the content from file: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\",\\n \\"Data\\": {\\n \\"Succeeded\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteSparkTemplateFileResponse>\\n <RequestId>C3A9594F-1D40-4472-A96C-8FB8AA20D38C</RequestId>\\n <Data>\\n <Succeeded>true</Succeeded>\\n </Data>\\n</DeleteSparkTemplateFileResponse>","errorExample":""}]', + 'title' => 'DeleteSparkTemplateFile', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '读取日志的其实偏移量。', + 'description' => 'The log offset.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '一页的日志行数', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '500', + 'default' => '100000', + ], + ], + ], + 'responses' => [ + 200 => [ + '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 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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\",\\n \\"Data\\": {\\n \\"LogContent\\": \\"22/04/22 15:30:49 INFO Utils: Start the dump task because s202207151211hz****-0001 app end, the interval is 238141ms;22/04/22 15:30:49 INFO AbstractConnector: Stopped Spark@5e774d9d{HTTP/1.1, (http/1.1)}{0.0.0.0:4040}\\",\\n \\"Message\\": \\"WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/\\",\\n \\"DBClusterId\\": \\"amv-bp1bg858bo8c****\\",\\n \\"AppId\\": \\"s202204132018hzprec1ac61a000****\\",\\n \\"LogSize\\": 775946240\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSparkAppAttemptLogResponse>\\n <RequestId>C3A9594F-1D40-4472-A96C-8FB8AA20D38C</RequestId>\\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}</LogContent>\\n <Message>WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/</Message>\\n </Data>\\n</GetSparkAppAttemptLogResponse>","errorExample":""}]', + 'title' => 'GetSparkAppAttemptLog', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + ], + '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****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the job resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'test_instance', + ], + ], + [ + 'name' => 'PageNumber', + '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', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + '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', + ], + 'Data' => [ + 'description' => 'The data returned.', + '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.', + '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', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppInfoList\\": [\\n {\\n \\"AppId\\": \\"s202207151211hz0cb4*****\\",\\n \\"AppName\\": \\"Spark Test\\",\\n \\"Priority\\": \\"NORMAL\\",\\n \\"State\\": \\"FAILED\\",\\n \\"Message\\": \\"WARN: Disk is full\\",\\n \\"Detail\\": {\\n \\"DurationInMillis\\": 100,\\n \\"LogRootPath\\": \\"oss://<bucket-name>/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":"<ListSparkAppsResponse>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <Data>\\n <AppInfoList>\\n <AppId>s202207151211hz0cb4*****</AppId>\\n <AppName>Spark Test</AppName>\\n <State>FAILED</State>\\n <Message>WARN: Disk is full</Message>\\n <Detail>\\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\\" } }</Data>\\n <EstimateExecutionCpuTimeInSeconds>100</EstimateExecutionCpuTimeInSeconds>\\n <LogRootPath>oss://<bucket-name>/logs/driver</LogRootPath>\\n <LastAttemptId>s202204291426hzpre60cfa*****-0003</LastAttemptId>\\n <WebUiAddress>https://sparkui.aliyuncs.com/token=xxx</WebUiAddress>\\n <SubmittedTimeInMillis>1651213645000</SubmittedTimeInMillis>\\n <StartedTimeInMillis>1651213645010</StartedTimeInMillis>\\n <LastUpdatedTimeInMillis>1651213645200</LastUpdatedTimeInMillis>\\n <TerminatedTimeInMillis>1651213645300</TerminatedTimeInMillis>\\n <DBClusterId>amv-bp11q28kv****</DBClusterId>\\n <ResourceGroupName>spark-rg</ResourceGroupName>\\n <DurationInMillis>100</DurationInMillis>\\n </Detail>\\n </AppInfoList>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n </Data>\\n</ListSparkAppsResponse>","errorExample":""}]', + 'title' => 'ListSparkApps', + ], + 'GetSparkAppInfo' => [ + 'summary' => 'Queries the information about an Spark application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => '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 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****', + ], + ], + ], + '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 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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.BadFileType', + 'errorMessage' => 'The requested template %s is not a file.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + [ + 'errorCode' => 'Spark.Resources.LoadFileFromClasspathFailed', + 'errorMessage' => 'Can\'t load the content from file: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202207151211hz0cb4*****\\",\\n \\"AppName\\": \\"Spark Test\\",\\n \\"Priority\\": \\"NORMAL\\",\\n \\"State\\": \\"FAILED\\",\\n \\"Message\\": \\"WARN: Disk is full\\",\\n \\"Detail\\": {\\n \\"DurationInMillis\\": 100,\\n \\"LogRootPath\\": \\"oss://<bucket-name>/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":"<GetSparkAppInfoResponse>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <Data>\\n <AppId>s202207151211hz0cb4*****</AppId>\\n <AppName>Spark Test</AppName>\\n <State>FAILED</State>\\n <Message>WARN: Disk is full</Message>\\n <Detail>\\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\\" } }</Data>\\n <EstimateExecutionCpuTimeInSeconds>100</EstimateExecutionCpuTimeInSeconds>\\n <LogRootPath>oss://<bucket-name>/logs/driver</LogRootPath>\\n <LastAttemptId>s202204291426hzpre60cfa*****-0003</LastAttemptId>\\n <WebUiAddress>https://sparkui.aliyuncs.com/token=xxx</WebUiAddress>\\n <SubmittedTimeInMillis>1651213645000</SubmittedTimeInMillis>\\n <StartedTimeInMillis>1651213645010</StartedTimeInMillis>\\n <LastUpdatedTimeInMillis>1651213645200</LastUpdatedTimeInMillis>\\n <TerminatedTimeInMillis>1651213645300</TerminatedTimeInMillis>\\n <DBClusterId>amv-bp11q28kv****</DBClusterId>\\n <ResourceGroupName>spark-rg</ResourceGroupName>\\n <DurationInMillis>100</DurationInMillis>\\n </Detail>\\n </Data>\\n</GetSparkAppInfoResponse>","errorExample":""}]', + 'title' => 'GetSparkAppInfo', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'GetSparkAppState' => [ + 'summary' => 'Queries the status of a Spark application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'spark app的id', + 'description' => '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 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****', + ], + ], + ], + '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' => [ + '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" + ."\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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202204191546hzpread6a896000****\\",\\n \\"AppName\\": \\"test\\",\\n \\"Message\\": \\"Insufficient resources.\\",\\n \\"State\\": \\"COMPLETED\\",\\n \\"DBClusterId\\": \\"amv-bp1h405854m****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSparkAppStateResponse>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <Data>\\n <AppId>s202204191546hzpread6a896000****</AppId>\\n <AppName>test</AppName>\\n <Message>Insufficient resources.</Message>\\n <State>COMPLETED</State>\\n </Data>\\n</GetSparkAppStateResponse>","errorExample":""}]', + 'title' => 'GetSparkAppState', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '读取日志的偏移量。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + 'default' => '100000', + ], + ], + ], + 'responses' => [ + 200 => [ + '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 queried log.'."\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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.Oss.InternalError', + 'errorMessage' => 'An OSS internal error occurred: %s', + ], + [ + 'errorCode' => 'Spark.Log.IllegalPath', + 'errorMessage' => 'Invalid job log URI: %s.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.AppStateNotAccepted', + 'errorMessage' => 'Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.FailedToKill', + 'errorMessage' => 'Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again.', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp', + 'errorMessage' => 'Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Log.InvalidState', + 'errorMessage' => 'Failed to obtain the logs of the Spark job %s in the %s state.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Failed to parse the SQL %s. Error message: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.Log.PodLogNotFound', + 'errorMessage' => 'Can\'t find logs of the pod by podName[%s] in the namespace[%s].', + ], + [ + 'errorCode' => 'Spark.AnalyzeTask.NotFound', + 'errorMessage' => 'The requested analysis task %s is not found.', + ], + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + [ + 'errorCode' => 'Spark.TemplateFile.FileNotFound', + 'errorMessage' => 'The template file %s is not found.', + ], + [ + 'errorCode' => 'Spark.TemplateFile.TemplateNotFound', + 'errorMessage' => 'The template %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3A9594F-1D40-4472-A96C-8FB8AA20D38C\\",\\n \\"Data\\": {\\n \\"LogContent\\": \\"22/04/22 15:30:49 INFO Utils: Start the dump task because s202206061441hz22a35ab000****-0001 app end, the interval is 238141ms;22/04/22 15:30:49 INFO AbstractConnector: Stopped Spark@5e774d9d{HTTP/1.1, (http/1.1)}{0.0.0.0:4040}\\",\\n \\"Message\\": \\"WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/\\",\\n \\"DBClusterId\\": \\"amv-clusterxxx\\",\\n \\"LogSize\\": 3517972480\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSparkAppLogResponse>\\n <RequestId>C3A9594F-1D40-4472-A96C-8FB8AA20D38C</RequestId>\\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}</LogContent>\\n <Message>WARNING: log file maybe deleted, please check oss path: oss://TestBucketName/applog/</Message>\\n </Data>\\n</GetSparkAppLogResponse>","errorExample":""}]', + 'title' => 'GetSparkAppLog', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'SubmitSparkApp' => [ + 'summary' => 'Submits a Spark application.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '118686', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的名称', + 'description' => 'The name of the application. The value can be up to 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestApp', + ], + ], + [ + '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' => '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' => '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' => '数据库的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' => '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' => '模板文件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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.App.ExceedQuotaLimitation', + 'errorMessage' => 'The requested resource exceeds the maximum limit: %s', + ], + [ + 'errorCode' => 'Spark.App.InvalidAppTypeWhenSubmit', + 'errorMessage' => 'The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.', + ], + [ + 'errorCode' => 'Spark.App.InvalidResourceSpec', + 'errorMessage' => 'The requested resource type is not supported:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ParameterConflict', + 'errorMessage' => 'Conflicting parameters submitted:\\n %s', + ], + [ + 'errorCode' => 'Spark.App.ResourceNegativeError', + 'errorMessage' => 'The requested resource MUST be positive: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidAppFilePath', + 'errorMessage' => 'The main driver file MUST be a valid OSS path. Current is %s.', + ], + [ + 'errorCode' => 'Spark.Config.invalidConnectors', + 'errorMessage' => 'The spark.adb.connectors configuration is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidDiskConfig', + 'errorMessage' => 'The requested disk mount parameter is invalid: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidHostAliasConfig', + 'errorMessage' => 'The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local', + ], + [ + 'errorCode' => 'Spark.Config.InvalidLogOssPath', + 'errorMessage' => 'The OSS address for log storage is illegal: %s', + ], + [ + 'errorCode' => 'Spark.Config.InvalidRoleArnFormat', + 'errorMessage' => 'Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name', + ], + [ + 'errorCode' => 'Spark.Config.InvalidTimeZone', + 'errorMessage' => 'Unable to parse time zone configuration %s : %s', + ], + [ + 'errorCode' => 'Spark.Config.MainAppFileNotExists', + 'errorMessage' => 'The main driver file is missing, [file] or [sqls] must be configured.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathAccessError', + 'errorMessage' => 'The configured OSS address %s cannot be accessed.', + ], + [ + 'errorCode' => 'Spark.Config.OSSPathNotExists', + 'errorMessage' => 'The OSS address %s requested does not exist or the permissions are insufficient.', + ], + [ + 'errorCode' => 'Spark.Config.RoleArnVerifyFailed', + 'errorMessage' => 'RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s', + ], + [ + 'errorCode' => 'Spark.Config.SecurityGroupNotFound', + 'errorMessage' => 'The security group in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.Config.VswitchNotFound', + 'errorMessage' => 'The vswitch in the configuration does not exist or cannot be accessed. %s.', + ], + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.RoleArn.Invalid', + 'errorMessage' => '%s is not found, or the RAM role has not been authorized.', + ], + [ + 'errorCode' => 'Spark.SQL.BlankError', + 'errorMessage' => 'Input sql can not be blank string.', + ], + [ + 'errorCode' => 'Spark.SQL.MultipleSQLError', + 'errorMessage' => 'Element in field [sqls] can not contain more than one sql statement: %s.', + ], + [ + 'errorCode' => 'Spark.SQL.NotFoundExecutableSQLError', + 'errorMessage' => 'No executable statements are submitted. Please check the input SQL.', + ], + [ + 'errorCode' => 'Spark.SQL.ParserError', + 'errorMessage' => 'Submit spark app failed when parser SQL %s. Error message: %s.', + ], + [ + 'errorCode' => 'Spark.RoleARN.invalid', + 'errorMessage' => 'Current account fails to verify the permissions of the RAM system, please check the help information and configure the appropriate permissions for the current account.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Spark.Forbidden', + 'errorMessage' => 'No permissions to access the resources: %s', + ], + ], + [ + [ + 'errorCode' => 'Spark.App.ContentNotFound', + 'errorMessage' => 'The requested content %s of the Spark application is not found.', + ], + [ + 'errorCode' => 'Spark.App.NotFound', + 'errorMessage' => 'The Spark application %s is not found.', + ], + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202204132018hzprec1ac61a000****\\",\\n \\"AppName\\": \\"TestApp\\",\\n \\"Message\\": \\"Insufficient resources.\\",\\n \\"State\\": \\"SUBMITTED\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitSparkAppResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <Data>\\n <AppId>s202204132018hzprec1ac61a000****</AppId>\\n <AppName>TestApp</AppName>\\n <Message>Insufficient resources.</Message>\\n <State>SUBMITTED</State>\\n </Data>\\n</SubmitSparkAppResponse>","errorExample":""}]', + 'title' => 'SubmitSparkApp', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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", + ], + 'KillSparkApp' => [ + 'summary' => 'Terminates a Spark application.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Spark App的ID', + 'description' => '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 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****', + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Invalid parameter value: %s', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + [ + 'errorCode' => 'Spark.App.KillOperationFailed', + 'errorMessage' => 'Failed to kill the application %s, please retry in a few seconds.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Spark.ObjectNotFound', + 'errorMessage' => 'The object is not found. More information: %s', + ], + ], + 406 => [ + [ + 'errorCode' => 'Spark.App.KillNotAcceptable', + 'errorMessage' => 'Can\'t kill the application %s in %s state.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Spark.ServerError', + 'errorMessage' => 'The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69D0810B-F9F5-5F4C-A57F-DF36133B63C9\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"s202204132018hzprec1ac****\\",\\n \\"AppName\\": \\"test\\",\\n \\"Message\\": \\"[Advisor] Advisor feature is not available for instance: amv-bp11q28kvl688****\\",\\n \\"State\\": \\"KILLED\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<KillSparkAppResponse>\\n <RequestId>69D0810B-F9F5-5F4C-A57F-DF36133B63C9</RequestId>\\n <Data>\\n <AppId>s202204132018hzprec1ac****</AppId>\\n <AppName>test</AppName>\\n <Message>[Advisor] Advisor feature is not available for instance: amv-bp11q28kvl688****</Message>\\n <State>running</State>\\n <DBClusterId>amv-bp11q28kvl688****</DBClusterId>\\n </Data>\\n</KillSparkAppResponse>","errorExample":""}]', + 'title' => 'KillSparkApp', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '125729', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建的子目录的完整OSS路径'."\n", + 'description' => 'The OSS path where you want to create a subdirectory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://testBucketName/das_lakehouse', + ], + ], + [ + '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****', + ], + ], + ], + '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', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3A0DE2E0-A37B-5EE4-9136-C4C473714802\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"ClientCRC\\": 1,\\n \\"ETag\\": \\"1\\",\\n \\"RequestId\\": \\"3A0DE2E0-A37B-5EE4-9136-C4C473714802\\",\\n \\"ServerCRC\\": 1\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateOssSubDirectoryResponse>\\n <RequestId>3A0DE2E0-A37B-5EE4-9136-C4C473714802</RequestId>\\n <Message>Success</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <ClientCRC>1</ClientCRC>\\n <ETag>1</ETag>\\n <RequestId>3A0DE2E0-A37B-5EE4-9136-C4C473714802</RequestId>\\n <ServerCRC>1</ServerCRC>\\n </Data>\\n <Success>true</Success>\\n</CreateOssSubDirectoryResponse>","errorExample":""}]', + 'title' => 'CreateOssSubDirectory', + 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" + .'* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'DescribeViewJobs' => [ + 'summary' => 'Retrieves materialized view refresh tasks.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the view.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_mv', + ], + ], + [ + '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" + .'This parameter is empty by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MATERIALIZED_VIEW', + ], + ], + [ + 'name' => 'FilterOwner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The owner of the view.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + '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' => 'am-bp1ub9grke1****'."\n", + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + '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' => '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", + 'type' => 'object', + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'Refresh task details.'."\n", + '$ref' => '#/components/schemas/open_struct_RefreshJobModel', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A318054-6815-528A-AA94-8AC921******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 44,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 44,\\n \\"MvRefreshJobModels\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"RefreshModel\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"RefreshInterval\\": \\"\\",\\n \\"Processid\\": \\"\\",\\n \\"ScheduledStartTime\\": \\"\\",\\n \\"SchemaName\\": \\"\\",\\n \\"ResourceGroup\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeViewJobs', + ], + 'DescribeTableDetail' => [ + 'summary' => 'Queries the information about data distribution among shards of a table.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194789', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + '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' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'Items' => [ + 'description' => 'The queried data distribution.'."\n", + 'type' => 'object', + 'properties' => [ + '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', + ], + 'Id' => [ + 'description' => 'The shard ID. Only the numeric part of the shard name is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + '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' => '', + ], + ], + ], + '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', + ], + 'GetCreateTableSQL' => [ + 'summary' => 'Queries the table creation statement for tables.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212744', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2ze8mbuai974s4y2', + ], + ], + [ + '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', + ], + ], + ], + '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' => '109462AF-B5FA-3D5A-9377-B27E5B******', + ], + 'SQL' => [ + 'description' => 'The SQL statement.'."\n", + 'type' => 'string', + 'example' => 'create table ('."\n" + .' id varchar(32)'."\n" + .');', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"109462AF-B5FA-3D5A-9377-B27E5B******\\",\\n \\"SQL\\": \\"create table (\\\\n id varchar(32)\\\\n);\\"\\n}","type":"json"}]', + 'title' => 'GetCreateTableSQL', + ], + 'DescribeTableStatistics' => [ + 'summary' => 'Queries the table statistics of an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186727', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-****************', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + '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":"Desc"}]', + ], + ], + [ + '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-beijing', + ], + ], + [ + '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' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TableStatisticRecords' => [ + 'description' => 'The queried table statistics.'."\n", + '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', + ], + ], + ], + ], + ], + ], + 'SchemaNames' => [ + 'description' => 'The names of databases.'."\n", + 'type' => 'string', + 'example' => '[\'adb_platform\', \'adb_ai\', \'adb_data\']', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'DescribeAdbMySqlTableMeta' => [ + 'summary' => 'Queries the information about table metadata.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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', + ], + ], + [ + '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](~~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' => 'Schema', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'adb_demo', + ], + ], + [ + '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' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + '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" + ."\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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'DescribeMvRecommendSubTasks' => [ + 'summary' => '查看物化视图子任务', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the recommendation task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my_task_1', + ], + ], + [ + 'name' => 'SubtaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subtask ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'OrderBy', + '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\\"}', + ], + ], + [ + '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 per 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' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed system value (non-modifiable).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ActionInner', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed system value (non-modifiable).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 4,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 4,\\n \\"MvRecommendSubTaskModels\\": [\\n {\\n \\"SubQueriesCount\\": 0,\\n \\"Status\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"SubtaskId\\": 0,\\n \\"ScanQueriesCount\\": 0,\\n \\"MinRewriteQueryCount\\": 0,\\n \\"MinRewriteQueryPattern\\": 0,\\n \\"SlowQueryThreshold\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeMvRecommendSubTasks', + ], + 'DescribeMVRecommendResults' => [ + 'summary' => 'Retrieves the result of a recommendation task for a materialized view.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SubtaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subtask ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the recommendation task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'task_n1', + ], + ], + [ + 'name' => 'SubQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + '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 per 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' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed system value (non-modifiable).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ActionInner', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed system value (non-modifiable).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Type": "Desc","Field": "AcceleratedQueriesCount"}', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 20,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"MvRecommendResultModels\\": [\\n {\\n \\"BaseTables\\": [\\n {\\n \\"TableName\\": \\"\\",\\n \\"DataVolumn\\": \\"\\",\\n \\"EnableBinlog\\": true,\\n \\"SchemaName\\": \\"\\"\\n }\\n ],\\n \\"AcceleratedQueriesCount\\": 0,\\n \\"SupportIncrementalRefresh\\": true,\\n \\"SubqueryId\\": 0,\\n \\"SavedScanbytes\\": 0,\\n \\"Subquery\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeMVRecommendResults', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + 'DescribeMvRecommendTasks' => [ + 'summary' => '查看物化视图推荐任务', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed system value (non-modifiable).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ActionInner', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed system value (non-modifiable).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 4,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 4,\\n \\"MvRecommendTaskModels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"CreatedTime\\": \\"\\",\\n \\"LastRunAt\\": \\"\\",\\n \\"TaskName\\": \\"\\",\\n \\"ScanQueriesRange\\": 0,\\n \\"SchedulingSettings\\": \\"\\",\\n \\"MinRewriteQueryCount\\": 0,\\n \\"MinRewriteQueryPattern\\": 0,\\n \\"SlowQueryThreshold\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeMvRecommendTasks', + ], + 'CreateMaterializedViewRecommend' => [ + 'summary' => 'Creates a materialized view recommendation task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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***', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务名称', + 'description' => 'The name of the recommendation task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'task_n1', + ], + ], + [ + 'name' => 'SchedulingPolicy', + 'in' => 'query', + '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', + ], + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务的描述', + 'description' => 'The description of the recommendation task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'task desc', + ], + ], + [ + 'name' => 'SlowQueryThreshold', + 'in' => 'query', + 'schema' => [ + 'title' => '慢查询阈值', + 'description' => '慢查询阈值', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'MinRewriteQueryPattern', + 'in' => 'query', + 'schema' => [ + 'title' => '最小可加速的Pattern数量', + 'description' => '最小可加速的Pattern数量', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '5', + ], + ], + [ + 'name' => 'MinRewriteQueryCount', + 'in' => 'query', + 'schema' => [ + 'title' => 'Pattern匹配的最少慢查询个数', + 'description' => 'Pattern匹配的最少慢查询个数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => 'CreateMaterializedViewRecommend', + ], + 'ModifyMaterializedView' => [ + 'summary' => 'Modifies materialized views.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'title' => '物化视图名称', + 'description' => 'The name of the materialized view.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mv_1', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'title' => '物化视图所在DB名', + 'description' => 'The name of the database where the materialized view resides.'."\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', + ], + ], + [ + 'name' => 'LatencyTolerance', + 'in' => 'query', + 'schema' => [ + 'title' => '刷新延迟容忍度（分钟）', + 'description' => 'Refresh delay tolerance (in minutes).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + '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-uf6o*****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务名称', + 'description' => 'The name of the recommendation task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'task_n1', + ], + ], + [ + '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' => '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' => false, + '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', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务的描述', + 'description' => 'The description of the recommendation task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'task desc', + ], + ], + [ + 'name' => 'SlowQueryThreshold', + 'in' => 'query', + 'schema' => [ + 'title' => '慢查询阈值', + 'description' => '慢查询阈值', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'MinRewriteQueryPattern', + 'in' => 'query', + 'schema' => [ + 'title' => '最小可加速的Pattern数量', + 'description' => '最小可加速的Pattern数量', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '5', + ], + ], + [ + 'name' => 'MinRewriteQueryCount', + 'in' => 'query', + 'schema' => [ + 'title' => 'Pattern匹配的最少慢查询个数', + 'description' => 'Pattern匹配的最少慢查询个数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf66*****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'title' => '推荐任务名称', + 'description' => 'The name of the recommendation task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my_task_1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '7B081A85-0568-5E54-82EF-6958C4A3D4B4', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B081A85-0568-5E54-82EF-6958C4A3D4B4\\"\\n}","type":"json"}]', + 'title' => 'DeleteMaterializedViewRecommend', + ], + 'DescribeInclinedTables' => [ + 'summary' => 'Queries the information about skewed tables for an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186716', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + 'name' => 'TableType', + 'in' => 'query', + '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', + ], + ], + [ + '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" } ]', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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" + .'}', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"15\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Table\\": [\\n {\\n \\"Type\\": \\"Fact\\",\\n \\"Schema\\": \\"spark_test\\",\\n \\"Size\\": 200,\\n \\"Name\\": \\"admin_daily_own_statistic_record\\",\\n \\"IsIncline\\": true,\\n \\"TotalSize\\": 53687091200,\\n \\"SpaceRatio\\": 0.4,\\n \\"RowCount\\": 1000\\n }\\n ]\\n },\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"表倾斜\\",\\n \\"Message\\": \\"检测到有表存在shard倾斜\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNNING\\\\nCRITICAL\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescribeInclinedTables', + ], + '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' => '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', + ], + ], + [ + '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****', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + 'default' => 'INFORMATION_SCHEMA', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'default' => 'COLUMNS', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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":"<DescribeAdbMySqlColumnsResponse>\\n <Message>Success</Message>\\n <RequestId>A9F013CD-0222-595E-8157-445969B97F03</RequestId>\\n <Success>true</Success>\\n <Schema>adb_demo</Schema>\\n <TableName>test</TableName>\\n <ColumnCount>1</ColumnCount>\\n <Columns>\\n <Type>bigint</Type>\\n <Name>id</Name>\\n <Comment>test</Comment>\\n </Columns>\\n</DescribeAdbMySqlColumnsResponse>","errorExample":""}]', + 'title' => 'DescribeAdbMySqlColumns', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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', + ], + ], + [ + '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****', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + 'default' => 'INFORMATION_SCHEMA', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + '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":"<DescribeAdbMySqlTablesResponse>\\n <Message>Success</Message>\\n <RequestId>7A7D49E3-5585-5DF8-B62C-75C46B4991DC</RequestId>\\n <Success>true</Success>\\n <Schema>adb_demo</Schema>\\n <Tables>test</Tables>\\n</DescribeAdbMySqlTablesResponse>","errorExample":""}]', + 'title' => 'DescribeAdbMySqlTables', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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', + ], + ], + [ + '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + 'description' => '', + ], + ], + ], + '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":"<DescribeAdbMySqlSchemasResponse>\\n <Message>Success</Message>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <Success>true</Success>\\n <Schemas>adb_demo,adb_test,mysql</Schemas>\\n</DescribeAdbMySqlSchemasResponse>","errorExample":""}]', + 'title' => 'DescribeAdbMySqlSchemas', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + '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****', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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":"<DescribeTableAccessCountResponse>\\n <RequestId>6B7D627B-DA23-572D-AD71-256F64698B7D</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</TotalCount>\\n <Items>\\n <ReportDate>2022-09-26</ReportDate>\\n <TableSchema>tpch</TableSchema>\\n <AccessCount>6</AccessCount>\\n <TableName>CUSTOMER</TableName>\\n <InstanceName>amv-2ze627uzpkh8a8****</InstanceName>\\n </Items>\\n</DescribeTableAccessCountResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157089', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'ViewName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the view.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v_modbus', + ], + ], + [ + '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', + ], + ], + ], + '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`', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"SQL\\": \\"CREATE VIEW `test`.`test_view` AS SELECT\\\\n `id`\\\\n, `name`\\\\nFROM\\\\n `test_tbl_adb`\\"\\n}","errorExample":""},{"type":"xml","example":"<GetViewDDLResponse>\\n <RequestId>421794A3-72A5-5D27-9E8B-A75A4C503E17</RequestId>\\n <SQL>CREATE VIEW `test`.`test_view` AS SELECT\\n `id`\\n, `name`\\nFROM\\n `test_tbl_adb`</SQL>\\n</GetViewDDLResponse>","errorExample":""}]', + 'title' => 'GetViewDDL', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'GetViewObjects' => [ + 'summary' => 'Queries the information about views.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157080', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + '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"}', + ], + ], + [ + 'name' => 'FilterViewName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the view.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_filter', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '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', + 'default' => '30', + ], + ], + [ + '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' => 'FilterOwner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The owner of the view.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ShowMvBaseTable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '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', + ], + 'Data' => [ + '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' => '1', + ], + 'TableSummaryModels' => [ + 'description' => 'The queried views.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried view.'."\n", + '$ref' => '#/components/schemas/TableSummaryModel', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"TableSummaryModels\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"TableSize\\": 0,\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"SQL\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"MvDetailModel\\": {\\n \\"FirstRefreshTime\\": \\"\\",\\n \\"QueryRewriteEnabled\\": true,\\n \\"ExplicitHit\\": 0,\\n \\"IsInactive\\": true,\\n \\"RemoteSize\\": 0,\\n \\"LocalSize\\": 0,\\n \\"RefreshState\\": \\"\\",\\n \\"RefreshInterval\\": \\"\\",\\n \\"ImplicitHit\\": 0,\\n \\"UpdatedAt\\": \\"\\",\\n \\"ResourceGroup\\": \\"\\",\\n \\"BaseTableInfos\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"BaseTableIsMv\\": true,\\n \\"TableEngine\\": \\"\\"\\n }\\n ],\\n \\"TableEngine\\": \\"\\",\\n \\"BaseTableNames\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"EnableDelayAlert\\": 0,\\n \\"EnableFailureAlert\\": 0,\\n \\"LatencyTolerance\\": 0\\n },\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetViewObjectsResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</TotalCount>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</TotalCount>\\n <TableSummaryModels/>\\n </Data>\\n</GetViewObjectsResponse>","errorExample":""}]', + 'title' => 'GetViewObjects', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'GetDatabaseObjects' => [ + 'summary' => 'Queries the information about databases.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Data\\": {\\n \\"DatabaseSummaryModels\\": [\\n {\\n \\"Owner\\": \\"\\",\\n \\"SchemaName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\",\\n \\"DbType\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDatabaseObjectsResponse>\\n <RequestId>863D51B7-5321-41D8-A0B6-A088B0******</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</TotalCount>\\n <Data>\\n <DatabaseSummaryModels/>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</TotalCount>\\n </Data>\\n</GetDatabaseObjectsResponse>","errorExample":""}]', + 'title' => 'GetDatabaseObjects', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'GetTable' => [ + 'summary' => 'Queries the information about a table.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '160312', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"TblId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"MappedName\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"PkPosition\\": 0,\\n \\"IsPartitionKey\\": true,\\n \\"OrdinalPosition\\": 0,\\n \\"ColumnRawName\\": \\"\\",\\n \\"PhysicalColumnName\\": \\"\\",\\n \\"Nullable\\": true,\\n \\"AutoIncrement\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"Primarykey\\": true,\\n \\"DefaultValue\\": \\"\\",\\n \\"Tokenizer\\": \\"\\",\\n \\"Encode\\": \\"\\",\\n \\"Compression\\": \\"\\",\\n \\"Delimiter\\": \\"\\",\\n \\"ValueType\\": \\"\\",\\n \\"CompressFloatUseShort\\": true,\\n \\"OnUpdate\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Sd\\": {\\n \\"SdId\\": 0,\\n \\"Location\\": \\"\\",\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Compressed\\": true,\\n \\"NumBuckets\\": 0,\\n \\"SerDeInfo\\": {\\n \\"SerDeId\\": 0,\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"CreateTime\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"Comment\\": \\"\\",\\n \\"Cols\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"MappedName\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"PkPosition\\": 0,\\n \\"IsPartitionKey\\": true,\\n \\"OrdinalPosition\\": 0,\\n \\"ColumnRawName\\": \\"\\",\\n \\"PhysicalColumnName\\": \\"\\",\\n \\"Nullable\\": true,\\n \\"AutoIncrement\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"Primarykey\\": true,\\n \\"DefaultValue\\": \\"\\",\\n \\"Tokenizer\\": \\"\\",\\n \\"Encode\\": \\"\\",\\n \\"Compression\\": \\"\\",\\n \\"Delimiter\\": \\"\\",\\n \\"ValueType\\": \\"\\",\\n \\"CompressFloatUseShort\\": true,\\n \\"OnUpdate\\": \\"\\"\\n }\\n ],\\n \\"DistributeColumns\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"MappedName\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"PkPosition\\": 0,\\n \\"IsPartitionKey\\": true,\\n \\"OrdinalPosition\\": 0,\\n \\"ColumnRawName\\": \\"\\",\\n \\"PhysicalColumnName\\": \\"\\",\\n \\"Nullable\\": true,\\n \\"AutoIncrement\\": true,\\n \\"Precision\\": 0,\\n \\"Scale\\": 0,\\n \\"Primarykey\\": true,\\n \\"DefaultValue\\": \\"\\",\\n \\"Tokenizer\\": \\"\\",\\n \\"Encode\\": \\"\\",\\n \\"Compression\\": \\"\\",\\n \\"Delimiter\\": \\"\\",\\n \\"ValueType\\": \\"\\",\\n \\"CompressFloatUseShort\\": true,\\n \\"OnUpdate\\": \\"\\"\\n }\\n ],\\n \\"PhysicalTableName\\": \\"\\",\\n \\"PhysicalDatabaseName\\": \\"\\",\\n \\"DistributeType\\": \\"\\",\\n \\"PartitionType\\": \\"\\",\\n \\"PartitionColumn\\": \\"\\",\\n \\"PartitionCount\\": 0,\\n \\"PreviousVersion\\": 0,\\n \\"CurrentVersion\\": 0,\\n \\"UpdateTime\\": \\"\\",\\n \\"TableEngineName\\": \\"\\",\\n \\"IsAllIndex\\": true,\\n \\"BlockSize\\": 0,\\n \\"Compression\\": \\"\\",\\n \\"RawTableName\\": \\"\\",\\n \\"SubpartitionType\\": \\"\\",\\n \\"SubpartitionColumn\\": \\"\\",\\n \\"SubpartitionCount\\": 0,\\n \\"ArchiveType\\": \\"\\",\\n \\"MaxColumnId\\": 0,\\n \\"EnableDfs\\": true,\\n \\"StoragePolicy\\": \\"\\",\\n \\"HotPartitionCount\\": 0,\\n \\"IsFulltextDict\\": true,\\n \\"RtIndexAll\\": true,\\n \\"RouteColumns\\": [],\\n \\"RtEngineType\\": \\"\\",\\n \\"RtModeType\\": \\"\\",\\n \\"RouteType\\": \\"\\",\\n \\"DictEncode\\": true,\\n \\"BucketCount\\": 0,\\n \\"Bucket\\": 0,\\n \\"ViewSecurityMode\\": \\"\\",\\n \\"Indexes\\": [\\n {\\n \\"DatabaseName\\": \\"\\",\\n \\"PhysicalTableName\\": \\"\\",\\n \\"IndexName\\": \\"\\",\\n \\"IndexType\\": \\"\\",\\n \\"IndexColumns\\": [],\\n \\"ColumnOrds\\": [\\n \\"\\"\\n ],\\n \\"Options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\"\\n }\\n ],\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTableResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <Code>0</Code>\\n <Message>\\"\\"</Message>\\n <Success>true</Success>\\n <Table>\\n <PartitionKeys/>\\n <Sd>\\n <SerDeInfo/>\\n </Sd>\\n <Cols/>\\n <DistributeColumns/>\\n <RouteColumns/>\\n <RouteEffectiveColumn/>\\n <Indexes>\\n <IndexColumns/>\\n </Indexes>\\n </Table>\\n</GetTableResponse>","errorExample":""}]', + 'title' => 'GetTable', + ], + 'GetTableColumns' => [ + 'summary' => 'Queries the information about columns.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157085', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => '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', + ], + ], + ], + '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', + ], + 'Data' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 15,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 15,\\n \\"Table\\": {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"PartitionKey\\": true,\\n \\"Nullable\\": true,\\n \\"PrimaryKey\\": true,\\n \\"DistributeKey\\": true\\n }\\n ],\\n \\"Catalog\\": \\"\\",\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTableColumnsResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>15</TotalCount>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>15</TotalCount>\\n <Table>\\n <Columns/>\\n </Table>\\n </Data>\\n</GetTableColumnsResponse>","errorExample":""}]', + 'title' => 'GetTableColumns', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157088', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + '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" + .');', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0******\\",\\n \\"SQL\\": \\"create table (\\\\n id varchar(32)\\\\n);\\"\\n}","errorExample":""},{"type":"xml","example":"<GetTableDDLResponse>\\n <RequestId>863D51B7-5321-41D8-A0B6-A088B0******</RequestId>\\n <SQL>create table (\\n id varchar(32)\\n);</SQL>\\n</GetTableDDLResponse>","errorExample":""}]', + 'title' => 'GetTableDDL', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'GetTableObjects' => [ + 'summary' => 'Query the details of one or more tables.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157079', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + '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"}', + ], + ], + [ + 'name' => 'FilterTblName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_tbl', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1565u55p32****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'FilterOwner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The owner of the table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'FilterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the cluster resides.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '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', + ], + 'Data' => [ + 'description' => 'The data returned.'."\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" + ."\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', + ], + 'TableSummaryModels' => [ + 'description' => 'Details of the tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '$ref' => '#/components/schemas/TableSummaryModel', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"TableSummaryModels\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"TableSize\\": 0,\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"SQL\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"MvDetailModel\\": {\\n \\"FirstRefreshTime\\": \\"\\",\\n \\"QueryRewriteEnabled\\": true,\\n \\"ExplicitHit\\": 0,\\n \\"IsInactive\\": true,\\n \\"RemoteSize\\": 0,\\n \\"LocalSize\\": 0,\\n \\"RefreshState\\": \\"\\",\\n \\"RefreshInterval\\": \\"\\",\\n \\"ImplicitHit\\": 0,\\n \\"UpdatedAt\\": \\"\\",\\n \\"ResourceGroup\\": \\"\\",\\n \\"BaseTableInfos\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"BaseTableIsMv\\": true,\\n \\"TableEngine\\": \\"\\"\\n }\\n ],\\n \\"TableEngine\\": \\"\\",\\n \\"BaseTableNames\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"EnableDelayAlert\\": 0,\\n \\"EnableFailureAlert\\": 0,\\n \\"LatencyTolerance\\": 0\\n },\\n \\"CreatedBySource\\": \\"\\",\\n \\"CreatedByUser\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTableObjectsResponse>\\n <RequestId>863D51B7-5321-41D8-A0B6-A088B0******</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</TotalCount>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</TotalCount>\\n <TableSummaryModels/>\\n </Data>\\n</GetTableObjectsResponse>","errorExample":""}]', + 'title' => 'GetTableObjects', + ], + 'CheckSampleDataSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-wz9r8f67h4cqz41u', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"UNINITIALIZED\\",\\n \\"RequestId\\": \\"0CE655C3-C211-513D-A42F-D4AE2D1A867C\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190445', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', + ], + 'Items' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25B56BC7-4978-40B3-9E48-4B7067******\\",\\n \\"Items\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSchemas', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190495', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-bp1pke2pcfavw****', + ], + ], + [ + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"Tables\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"DBClusterId\\": \\"amv-bp1pke2pcfavw****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n },\\n \\"Columns\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"bigint\\",\\n \\"ColumnName\\": \\"id\\",\\n \\"TableName\\": \\"test\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"amv-bp1pke2pcfavw****\\",\\n \\"PrimaryKey\\": false,\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n },\\n \\"Schemas\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"amv-bp1pke2pcfavw****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAllDataSource', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'DescribeTables' => [ + 'summary' => 'Queries a list of tables in a database.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"DBClusterId\\": \\"amv-bp1xxxxxxxx47\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeTables', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'DescribeColumns' => [ + 'summary' => 'Queries a list of columns in a table.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + '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-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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MDS.IllegalArgument', + 'errorMessage' => 'Invalid argument.', + ], + [ + 'errorCode' => 'MDS.InvalidPrivilege', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaAlreadyExist', + 'errorMessage' => 'The database already exists.', + ], + [ + 'errorCode' => 'MDS.MetaSchemaNotExist', + 'errorMessage' => 'The database does not exist.', + ], + [ + 'errorCode' => 'MDS.MetaTableAlreadyExist', + 'errorMessage' => 'The table already exists.', + ], + [ + 'errorCode' => 'MDS.MetaTableNotExist', + 'errorMessage' => 'The table is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MDS.RamAuthAccessDenied', + 'errorMessage' => 'ram auth access denied.', + ], + ], + 500 => [ + [ + 'errorCode' => 'MDS.InternalError', + 'errorMessage' => 'An internal MDS error occurred.', + ], + [ + 'errorCode' => 'MDS.MetaVisitError', + 'errorMessage' => 'Failed to access metadata.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-XXX442913CEF\\",\\n \\"Items\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"bigint\\",\\n \\"ColumnName\\": \\"id\\",\\n \\"TableName\\": \\"test\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"amv-bp111m2cfrdl1****\\",\\n \\"PrimaryKey\\": false,\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeColumns', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'LoadSampleDataSet' => [ + 'summary' => 'Loads a built-in dataset.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA31BE84-ABE8-554A-A769-5F860C34EE10\\",\\n \\"DBClusterId\\": \\"amv-2ze0z517o1mg****\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsUF9CN9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '642F3512-C628-5D0C-8815-F6670C****', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + '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.', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Spark.InvalidParameter', + 'errorMessage' => 'Spark parameter is not valid, please check error info: %s.', + ], + [ + 'errorCode' => 'Spark.InvalidState', + 'errorMessage' => 'The object of the operation is in an invalid state: %s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"642F3512-C628-5D0C-8815-F6670C****\\",\\n \\"Data\\": {\\n \\"Passed\\": true,\\n \\"DeniedDetail\\": {\\n \\"ResourceOwnerId\\": \\"11685695632****\\",\\n \\"Action\\": \\"ListSparkApps\\",\\n \\"PrincipalType\\": \\"SubUser\\",\\n \\"ResourceAuthTargetInfo\\": \\"223345695632****\\\\n\\",\\n \\"PolicyType\\": \\"ControlPolicy\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\"\\n },\\n \\"Suggestion\\": \\"Grant the system RAM policy \'AliyunADBDeveloperAccess\' to current RAM user can quickly solve this issue.\\"\\n }\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189978', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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-hangzhou', + ], + ], + [ + 'name' => 'ProcessId', + '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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" + .'}', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'DescribeAdviceServiceEnabled' => [ + 'summary' => 'Queries whether the suggestion feature is enabled.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-2ze0vp0j6t3to****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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", + ], + 'DescribeSparkSQLDiagnosisList' => [ + 'summary' => 'Queries the diagnostic information about Spark SQL queries.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197113', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '20', + ], + ], + [ + '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\\"}]', + ], + ], + [ + 'name' => 'MinStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest start time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-28 22:00:00', + ], + ], + [ + 'name' => 'MaxStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest start time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-28 23:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => '{}', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1343,\\n \\"RequestId\\": \\"A91C9D07-7462-5F35-BB47-83629CE6CCAC\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"SQLDiagnosisList\\": [\\n {\\n \\"State\\": \\"COMPLETED\\",\\n \\"SQL\\": \\"select * from device where name = \'105506012112790031\'\\",\\n \\"AppId\\": \\"s202404291020bjd448ad40002122\\",\\n \\"StatementId\\": 1,\\n \\"InnerQueryId\\": 1,\\n \\"StartTime\\": \\"2024-11-20 09:09:00\\",\\n \\"ElapsedTime\\": 100,\\n \\"MaxExclusiveTime\\": 90,\\n \\"PeakMemory\\": 1024,\\n \\"ScanRowCount\\": 100\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]', + 'title' => 'DescribeSparkSQLDiagnosisList', + ], + 'DescribeSparkSQLDiagnosisAttribute' => [ + 'summary' => 'Queries the diagnostic information about a Spark SQL query.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197163', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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](~~612475~~) operation to query a list of Spark application IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 's202411071444hzdvk486d9d2001****', + ], + ], + [ + 'name' => 'InnerQueryId', + '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', + ], + ], + [ + 'name' => 'Language', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the Spark operator.'."\n", + '$ref' => '#/components/schemas/SparkOperatorInfo', + ], + ], + ], + ], + 'Root' => [ + 'description' => 'The Spark execution plan tree.'."\n", + '$ref' => '#/components/schemas/OperatorNode', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The information about the request denial.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"AppId\\": \\"s202411071444hzdvk486d9d2001****\\",\\n \\"InnerQueryId\\": 1,\\n \\"ElapsedTime\\": 100,\\n \\"DiagnosisInfos\\": [\\n {\\n \\"DiagnosisType\\": \\"APPLICATION\\",\\n \\"DiagnosisCode\\": \\"\\",\\n \\"DiagnosisCodeLabel\\": \\"\\",\\n \\"DiagnosisMsg\\": \\"\\"\\n }\\n ],\\n \\"OperatorListSortedByMetrics\\": {\\n \\"OperatorListSortedByMaxMemory\\": [\\n {\\n \\"OperatorName\\": \\"\\",\\n \\"MetricValue\\": 0\\n }\\n ],\\n \\"OperatorListSortedByExclusiveTime\\": [\\n {\\n \\"OperatorName\\": \\"\\",\\n \\"MetricValue\\": 0\\n }\\n ]\\n },\\n \\"Root\\": {\\n \\"nodeName\\": \\"\\",\\n \\"id\\": 0,\\n \\"nodeDepth\\": 0,\\n \\"parentId\\": 0,\\n \\"levelWidth\\": 0,\\n \\"nodeWidth\\": 0,\\n \\"stats\\": {\\n \\"parameters\\": \\"\\",\\n \\"bytes\\": 0,\\n \\"outputRows\\": 0,\\n \\"timeCost\\": 0,\\n \\"peakMemory\\": 0\\n },\\n \\"children\\": [\\n {\\n \\"nodeName\\": \\"\\",\\n \\"id\\": 0,\\n \\"nodeDepth\\": 0,\\n \\"parentId\\": 0,\\n \\"levelWidth\\": 0,\\n \\"nodeWidth\\": 0,\\n \\"stats\\": {\\n \\"parameters\\": \\"\\",\\n \\"bytes\\": 0,\\n \\"outputRows\\": 0,\\n \\"timeCost\\": 0,\\n \\"peakMemory\\": 0\\n },\\n \\"children\\": [\\n {\\n \\"nodeName\\": \\"\\",\\n \\"id\\": 0,\\n \\"nodeDepth\\": 0,\\n \\"parentId\\": 0,\\n \\"levelWidth\\": 0,\\n \\"nodeWidth\\": 0,\\n \\"stats\\": {\\n \\"parameters\\": \\"\\",\\n \\"bytes\\": 0,\\n \\"outputRows\\": 0,\\n \\"timeCost\\": 0,\\n \\"peakMemory\\": 0\\n },\\n \\"children\\": []\\n }\\n ]\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]', + 'title' => 'DescribeSparkSQLDiagnosisAttribute', + ], + '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' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217358', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'description' => 'The response parameter.', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp16t5ci7r74s****\\",\\n \\"Tables\\": [\\n {\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test\\",\\n \\"RowCount\\": 1222,\\n \\"IndexSize\\": 111,\\n \\"DataSize\\": 2921132457984,\\n \\"LocalDataSize\\": 1223,\\n \\"PrimaryKeySize\\": 123,\\n \\"RemoteDataSize\\": 122,\\n \\"SpaceRatio\\": 0.3\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"非分区表过大\\",\\n \\"Message\\": \\"检测到多个非分区表过大\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeOversizeNonPartitionTableInfos', + ], + 'DescribeTablePartitionDiagnose' => [ + 'summary' => 'Queries the information about partition diagnostics.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186721', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp171g24yvbxxxxx', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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" + .'}', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189113', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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' => 'PYTHON', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + '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" + .'}', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FB5AC339-91F6-5000-8E5A-F47065B01B87\\",\\n \\"AppId\\": \\"s202404141952sz6a1391200****\\",\\n \\"StartedTime\\": 1718329831000,\\n \\"DurationInMillis\\": 281063,\\n \\"State\\": \\"FINISHED\\",\\n \\"CpuUtilization\\": 100,\\n \\"PeakMemoryInByte\\": 4096000,\\n \\"ShuffleWriteInByte\\": 4096000,\\n \\"ShuffleReadInByte\\": 4096000,\\n \\"SpillInByte\\": 0,\\n \\"JVMGcCostInMillis\\": 81055,\\n \\"DiagnosisInfoList\\": [\\n {\\n \\"DiagnosisType\\": \\"APPLICATION\\",\\n \\"DiagnosisCode\\": \\"\\",\\n \\"DiagnosisCodeLabel\\": \\"\\",\\n \\"DiagnosisMsg\\": \\"\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescribeSparkAppDiagnosisInfo', + ], + 'EnableAdviceService' => [ + 'summary' => 'Enables the suggestion feature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + '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' => 'E1745C03-7CCE-55CF-932E-08121AAFA6AF', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193678', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\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' => 'StartTime', + 'in' => 'query', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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' => 'SchemaTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table in the **DatabaseName.TableName** format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tpch.lineitem', + ], + ], + [ + '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\\"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'title' => 'Items', + 'description' => 'The queried applied optimization suggestions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried applied optimization suggestion.'."\n", + '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" + .']', + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf67culrr26q2****', + ], + ], + [ + 'name' => 'RegionId', + '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****', + ], + ], + [ + 'name' => 'AdviceDate', + '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', + ], + ], + [ + 'name' => 'ApplyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'BuildImmediately', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '86F92D26-B774-5FA1-8E53-82CBEEEBB012', + 'title' => 'Id of the request', + ], + ], + 'description' => 'The response parameters.', + 'title' => 'Schema of Response', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"86F92D26-B774-5FA1-8E53-82CBEEEBB012\\"\\n}","type":"json"}]', + 'title' => 'BatchApplyAdviceByIdList', + ], + 'ApplyAdviceById' => [ + 'summary' => 'Applies an optimization suggestion.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193679', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\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' => 'AdviceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceId', + 'description' => 'The suggestion ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0baf1f52-53df-487f-8292-99a03716****', + ], + ], + [ + 'name' => 'AdviceDate', + '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' => '20221101', + ], + ], + [ + 'name' => 'ApplyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'BuildImmediately', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5DC10091-348D-12B1-906D-AB49D658012E', + 'title' => 'Id of the request', + ], + ], + 'description' => 'The response parameters.', + 'title' => 'Schema of Response', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193677', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp198m028ih55****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AdviceDate', + 'in' => 'query', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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' => 'SchemaTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table in the DatabaseName.TableName format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tpch.lineitem', + ], + ], + [ + '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" + .' * `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\\"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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" + .']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.PageSize', + 'errorMessage' => 'The PageSize parameter is required.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"AdviceId\\": \\"dcd04135-0925-4aed-a5a7-e7d92cb1****\\",\\n \\"AdviceDate\\": \\"20221124\\",\\n \\"AdviceType\\": \\"INDEX\\",\\n \\"SQL\\": \\"alter table `schema1`.`table1` drop key col1_1_idx\\",\\n \\"Reason\\": \\"15天未使用，历史使用统计概率小于1%\\",\\n \\"Benefit\\": \\"节省0.4 GB的存储空间。\\",\\n \\"TotalCount\\": 10192,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"IndexFields\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"96A55627-28E9-5E47-B8F6-D786BE551349\\",\\n \\"TotalCount\\": 10192,\\n \\"SchemaTableNames\\": [\\n \\"[\\\\n \\\\\\"tpch.lineitem\\\\\\",\\\\n \\\\\\"tpch.partsupp\\\\\\",\\\\n \\\\\\"tpch.orders\\\\\\"\\\\n]\\"\\n ]\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132343', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'ProcessStartTime', + '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', + ], + ], + [ + 'name' => 'ProcessState', + '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', + ], + ], + [ + '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, + 'docRequired' => true, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProcessRcHost', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DiagnosisSQLInfo\\": \\"{ \\\\\\"DiagnosisSQLInfo\\\\\\": { \\\\\\"hasSharedStage\\\\\\": false, \\\\\\"resourceGroup\\\\\\": \\\\\\"user_default\\\\\\", \\\\\\"cost\\\\\\": 274, \\\\\\"queuedTime\\\\\\": 0, \\\\\\"outputDataSize\\\\\\": 9, \\\\\\"scheduled\\\\\\": true, \\\\\\"query\\\\\\": \\\\\\"/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE \'PROMO%\' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate >= DATE \'1995-09-01\' AND l_shipdate < DATE \'1995-09-01\' + INTERVAL \'1\' MONTH\\\\\\", \\\\\\"outputRows\\\\\\": 1, \\\\\\"userName\\\\\\": \\\\\\"test_user\\\\\\", \\\\\\"parentId\\\\\\": 0, \\\\\\"maxOutputRows\\\\\\": 200000, \\\\\\"scanSize\\\\\\": 8247470, \\\\\\"peakMemory\\\\\\": 13188295, \\\\\\"startTime\\\\\\": 1626330527632, \\\\\\"state\\\\\\": \\\\\\"FINISHED\\\\\\", \\\\\\"endTime\\\\\\": 1626330527905, \\\\\\"writeTableRows\\\\\\": 0, \\\\\\"scanRows\\\\\\": 351966 } }\\",\\n \\"RequestId\\": \\"1\\",\\n \\"StageInfos\\": [\\n {\\n \\"InputRows\\": 2341,\\n \\"InputDataSize\\": 2341,\\n \\"OutputRows\\": 2341,\\n \\"OutputDataSize\\": 2341,\\n \\"PeakMemory\\": 2341,\\n \\"OperatorCost\\": 2341,\\n \\"StageId\\": \\"Stage[26]\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"Progress\\": 0.3,\\n \\"ExecutionType\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDiagnosisSQLInfoResponse>\\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 &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 } }</DiagnosisSQLInfo>\\n <RequestId>1</RequestId>\\n <StageInfos>\\n <InputRows>123</InputRows>\\n <InputDataSize>2341</InputDataSize>\\n <OutputRows>231</OutputRows>\\n <OutputDataSize>12344</OutputDataSize>\\n <PeakMemory>3421</PeakMemory>\\n <OperatorCost>2341</OperatorCost>\\n <StageId>Stage[26]</StageId>\\n <State>RUNNING</State>\\n <Progress>0.3</Progress>\\n </StageInfos>\\n</DescribeDiagnosisSQLInfoResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132346', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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' => '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' => '1625220213000', + ], + ], + [ + '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', + ], + ], + [ + '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"}', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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", + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClientIps\\": [\\n \\"106.11.xx.xx\\"\\n ],\\n \\"ResourceGroups\\": [\\n \\"user_defaul\\"\\n ],\\n \\"UserNames\\": [\\n \\"test_user\\"\\n ],\\n \\"Databases\\": [\\n \\"adb_demo\\"\\n ],\\n \\"RequestId\\": \\"DEA97C6B-D7A4-5E69-9EFC-D7F88737CED5\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDiagnosisDimensionsResponse>\\n <ClientIps>[\\"106.11.xx.xx\\",\\"106.11.xx.xx\\"]</ClientIps>\\n <ResourceGroups>user_defaul</ResourceGroups>\\n <UserNames>test_user</UserNames>\\n <Databases>adb_demo</Databases>\\n <RequestId>DEA97C6B-D7A4-5E69-9EFC-D7F88737CED5</RequestId>\\n</DescribeDiagnosisDimensionsResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132341', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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' => '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' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + '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"}', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query keyword of the SQL statements.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'select', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'MaxPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum peak memory of the SQL statements. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '88000000', + ], + ], + [ + 'name' => 'MinScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum scan size of the SQL statements. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1073741824', + ], + ], + [ + 'name' => 'MaxScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum scan size of the SQL statements. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '64424509440', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DownloadId\\": 25494,\\n \\"RequestId\\": \\"845774AC-5D43-53A2-AAB8-C73828E68508\\"\\n}","errorExample":""},{"type":"xml","example":"<DownloadDiagnosisRecordsResponse>\\n <DownloadId>25494</DownloadId>\\n <RequestId>845774AC-5D43-53A2-AAB8-C73828E68508</RequestId>\\n</DownloadDiagnosisRecordsResponse>","errorExample":""}]', + 'title' => 'DownloadDiagnosisRecords', + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '131519', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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' => '1632931200000', + ], + ], + [ + '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' => '1633017540000', + ], + ], + [ + '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' => '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"}', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query keyword of the SQL statements.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'select', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'MaxPeakMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum peak memory of the SQL statements. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '89000000', + ], + ], + [ + 'name' => 'MinScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum scan size of the SQL statements. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MaxScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum scan size of the SQL statements. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1024000000', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + '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', + 'required' => false, + 'example' => '[{"Field":"StartTime", "Type": "desc" }]', + ], + ], + [ + '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' => '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' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + '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' => 'PatternId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The SQL pattern ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5575924945138******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + '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 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132356', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + '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' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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":"<DescribeDownloadRecordsResponse>\\n <Records>\\n <Status>finished</Status>\\n <DownloadId>636890</DownloadId>\\n <ExceptionMsg>The query result is empty.</ExceptionMsg>\\n <Url>https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/amv-*********/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******\\"</Url>\\n <FileName>20210806094635-20210806095135</FileName>\\n </Records>\\n <RequestId>D761DA51-12F8-5457-AAA9-F52B9F436D2D</RequestId>\\n</DescribeDownloadRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeDownloadRecords', + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132339', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => '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' => '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' => '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', + ], + ], + [ + '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' => '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' => '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' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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":"<DescribeSqlPatternResponse>\\n <PageSize>30</PageSize>\\n <PageNumber>2</PageNumber>\\n <TotalCount>50</TotalCount>\\n <Items>\\n <AvgStageCount>2</AvgStageCount>\\n <MaxCpuTime>17</MaxCpuTime>\\n <AccessIP>100.104.xx.xx</AccessIP>\\n <AvgScanSize>244</AvgScanSize>\\n <MaxScanSize>1024</MaxScanSize>\\n <MaxPeakMemory>480096</MaxPeakMemory>\\n <AvgCpuTime>1.0625</AvgCpuTime>\\n <User>test_acc</User>\\n <AvgPeakMemory>240048</AvgPeakMemory>\\n <MaxStageCount>2</MaxStageCount>\\n <MaxTaskCount>2</MaxTaskCount>\\n <InstanceName>amv-bp1ej1nq9n6****</InstanceName>\\n <QueryCount>16</QueryCount>\\n <ReportDate>2022-08-30</ReportDate>\\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</Pattern>\\n <AvgTaskCount>2</AvgTaskCount>\\n </Items>\\n <RequestId>DB1F6C23-CBCA-5260-9366-BA7BB5EBF6F1</RequestId>\\n</DescribeSqlPatternResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132328', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => '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' => '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' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword that is used for the query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + '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"}]', + ], + ], + [ + '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' => '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' => '10', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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" + .'}', + ], + ], + ], + ], + ], + '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":"<DescribeSQLPatternsResponse>\\n <PageNumber>2</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>20</TotalCount>\\n <PatternDetails>\\n <SQLPattern>SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)</SQLPattern>\\n <PatternId>5575924945138******</PatternId>\\n <User>test</User>\\n <AccessIp>192.168.xx.xx</AccessIp>\\n <Tables>tpch.orders</Tables>\\n <PatternCreationTime>2022-09-06 05:06:00</PatternCreationTime>\\n <AverageQueryTime>4</AverageQueryTime>\\n <MaxQueryTime>2341</MaxQueryTime>\\n <AverageExecutionTime>234.78</AverageExecutionTime>\\n <MaxExecutionTime>2142</MaxExecutionTime>\\n <AveragePeakMemory>234.22</AveragePeakMemory>\\n <MaxPeakMemory>234149</MaxPeakMemory>\\n <AverageScanSize>234149.23</AverageScanSize>\\n <MaxScanSize>32212254</MaxScanSize>\\n <QueryCount>345</QueryCount>\\n <FailedCount>18</FailedCount>\\n <Blockable>true</Blockable>\\n </PatternDetails>\\n <RequestId>F3174013-5B7A-5A47-9FE0-6B5D397BD86B</RequestId>\\n</DescribeSQLPatternsResponse>","errorExample":""}]', + 'title' => 'DescribeSQLPatterns', + 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" + .'* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132321', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + '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" + .'> '."\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', + ], + ], + [ + 'name' => 'EndTime', + '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', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PatternId', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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":"<DescribePatternPerformanceResponse>\\n <EndTime>2022-08-22T01:06:00Z</EndTime>\\n <RequestId>F21AF487-B8C9-57E0-8E3A-A92BC3611FB6</RequestId>\\n <StartTime>2022-08-21T02:15:00Z</StartTime>\\n <Performances>\\n <Key>AnalyticDB_PatternExecutionTime</Key>\\n <Unit>ms</Unit>\\n <Series>\\n <Values>[ \\"2021-11-18 13:38:00\\", \\"224\\" ]</Values>\\n <Name>max_query_time</Name>\\n </Series>\\n </Performances>\\n</DescribePatternPerformanceResponse>","errorExample":""}]', + 'title' => 'DescribePatternPerformance', + 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" + .'* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"TotalSize\\": \\"8388608\\",\\n \\"HotData\\": {\\n \\"TotalSize\\": 4194304,\\n \\"DataSize\\": 1048576,\\n \\"IndexSize\\": 1048576,\\n \\"PrimaryKeyIndexSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n },\\n \\"ColdData\\": {\\n \\"TotalSize\\": 4194304,\\n \\"DataSize\\": 1048576,\\n \\"IndexSize\\": 1048576,\\n \\"PrimaryKeyIndexSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n },\\n \\"DataGrowth\\": {\\n \\"DayGrowth\\": 1048576,\\n \\"WeekGrowth\\": 1048576\\n }\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDBClusterSpaceSummary', + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217360', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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', + ], + ], + [ + '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" + ."\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 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" }]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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" + .' }', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"300\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0******\\",\\n \\"DBClusterId\\": \\"am-bp1ub9grke1****\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"ColumnCount\\": 21,\\n \\"PrimaryKeyCount\\": 2,\\n \\"PrimaryKeyColumns\\": \\"id,date\\\\n\\",\\n \\"SpaceRatio\\": 23,\\n \\"TotalSize\\": 4,\\n \\"PrimaryKeyIndexSize\\": 222\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"主键过多检测\\",\\n \\"Message\\": \\"检测到多个表存在主键过多的问题\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNNING\\\\nCRITICAL\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1906102576997697\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"202515810214480629\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'DescribeExcessivePrimaryKeys', + ], + 'ModifyDBClusterMaintainTime' => [ + 'summary' => 'Modifies the maintenance window of an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp1r053byu48p****', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterMaintainTimeResponse>\\n <RequestId>65BDA532-28AF-4122-AA39-B382721EEE64</RequestId>\\n</ModifyDBClusterMaintainTimeResponse>","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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupTime.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupPeriod.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter BackupRetentionPeriod is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBClusterResourceGroup', + ], + 'ListTagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + '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', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to **dbclusterlakeversion**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dbclusterlakeversion', + ], + ], + [ + 'name' => 'NextToken', + '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', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + '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' => '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', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10788', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The cluster IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1u8c0mgfg58****', + ], + 'required' => false, + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + '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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10841', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of cluster.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf6pl56w1j8h****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'AutoRenewalPeriod', + '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', + ], + ], + [ + 'name' => 'AutoRenewalPeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Auto-renewal duration. Valid values:'."\n" + ."\n" + .'* Year.'."\n" + .'* Month.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + 'default' => 'Month', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '421794A3-72A5-5D27-9E8B-A75A4C503E17', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146751', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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' => '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' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the data synchronization job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aps-hz1686v37sx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + '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":"<DescribeApsResourceGroupsResponse>\\n <RequestId>6FC370D7-1D4C-5A8E-805E-F73366382C66</RequestId>\\n <Message>Success</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <Step>8</Step>\\n <ResourceGroups>\\n <MaxComputeResource>512</MaxComputeResource>\\n <MinComputeResource>0</MinComputeResource>\\n <GroupName>test</GroupName>\\n <GroupType>Job</GroupType>\\n <Available>true</Available>\\n </ResourceGroups>\\n </Data>\\n <Success>true</Success>\\n</DescribeApsResourceGroupsResponse>","errorExample":""}]', + 'title' => 'DescribeApsResourceGroups', + 'description' => '* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.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', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + ], + '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' => '-', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-E606-4A42-BF6D-******\\",\\n \\"APSJobDetail\\": {\\n \\"SourceEndpointRegion\\": \\"cn-beijing\\",\\n \\"SourceEndpointInstanceID\\": \\"pc-*******\\",\\n \\"DestinationEndpointRegion\\": \\"cn-beijing\\",\\n \\"DestinationEndpointInstanceID\\": \\"amv-******\\",\\n \\"PartitionList\\": \\"{}\\",\\n \\"DbList\\": \\"{}\\",\\n \\"TargetTableMode\\": \\"0\\",\\n \\"Status\\": \\"Running\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeApsJobDetail', + ], + 'CreateApsWebhook' => [ + 'summary' => 'Creates a new webhook for the specified cluster or task type.', + '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' => 'amv-bp11q28kvl688****', + ], + ], + [ + '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' => 'JobType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the task. Valid value: Task type. SLS or OSS Export Task: ResultExport.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ResultExport', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The array of webhooks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the webhook.'."\n", + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsBIVU9O', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf63i4ij56b***', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WebhookId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the webhook to be deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '***1*595*', + ], + ], + ], + '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' => '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-uf63i4ij56b***'."\n", + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exampleRegionId', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'formData', + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"exampleRequestId\\",\\n \\"Data\\": \\"-\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"操作成功\\",\\n \\"DBClusterId\\": \\"amv-bp11q28kvl688****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateApsWebhook', + ], + 'ListApsWebhook' => [ + 'summary' => 'Queries the Webhook configurations of a specified database cluster.', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsBIVU9O', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-8vbuyjhrih**', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'formData', + 'schema' => [ + 'description' => '**JobType**\\'."\n" + .'Job type. SLS or OSS Export Task: ResultExport.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResultExport', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned message.'."\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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"exampleRequestId\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Webhook\\": [\\n {\\n \\"WebhookType\\": \\"dingtalk\\",\\n \\"WebhookId\\": \\"**35***\\",\\n \\"Url\\": \\"https://example.com/webhook\\",\\n \\"Key\\": \\"your_secret_key\\",\\n \\"Name\\": \\"webhook_name\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '157674', + 'abilityTreeNodes' => [ + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PartitionSpecs', + 'in' => 'formData', + 'style' => 'json', + '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" }]', + ], + 'required' => false, + ], + ], + [ + '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, + ], + 'required' => true, + ], + ], + [ + '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' => 'WorkloadName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workload.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'LakehouseId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the lakehouse.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The resource group name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps', + ], + ], + [ + 'name' => 'HudiAdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The HUDI configuration of the destination.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hoodie.keep.min.commits=20', + ], + ], + [ + 'name' => 'AdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The advanced configurations.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'FullComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The full synchronization configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2ACU', + ], + ], + [ + 'name' => 'IncrementalComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The incremental synchronization configuration.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2ACU', + ], + ], + [ + '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' => 'KafkaTopic', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Kafka Topic ID. You can get it in the Kafka console.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + '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' => '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' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the user-defined database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the user-defined table.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testTB', + ], + ], + [ + 'name' => 'OutputFormat', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The format of the output data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HUDI', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The destination type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'TargetGenerateRule', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The rules for generating the destination database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + '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' => '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' => 'SourceRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + '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' => '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' => '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' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DataFormatType', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Kafka消息类型，支持的消息类型为：json、general_canal_json、mongo_canal_json、dataworks_json和shareplex_json', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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":"<CreateApsKafkaHudiJobResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>xxx</Data>\\n <RequestId>1A943417-5B0E-1DB9-A8**-A566****C3</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Message>ok</Message>\\n</CreateApsKafkaHudiJobResponse>","errorExample":""}]', + 'title' => 'CreateApsKafkaHudiJob', + ], + 'ListApsLifecycleStrategy' => [ + 'summary' => 'Queries a list of lifecycle management policies of an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '200829', + 'abilityTreeNodes' => [ + 'FEATUREadsNQ1ZDK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + ], + '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' => 'OK', + ], + 'Code' => [ + 'description' => 'The HTTP status code or the error code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Items' => [ + 'description' => 'The queried lifecycle management policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried list of lifecycle management policies of an AnalyticDB for MySQL cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'OperationTables' => [ + 'description' => 'The operation tables.', + 'type' => 'array', + 'items' => [ + 'description' => 'The operation tables.', + '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', + ], + ], + ], + ], + ], + '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-*******', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '200691', + 'abilityTreeNodes' => [ + 'FEATUREadsNQ1ZDK', + ], + ], + '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", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '-', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '207599', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*********', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PartitionSpecs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about partition.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about partition.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '-', + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + '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' => '-', + ], + 'required' => true, + 'example' => '-', + ], + ], + [ + 'name' => 'PrimaryKeyDefinition', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The definition of the primary key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workload.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sls-******', + ], + ], + [ + 'name' => 'LakehouseId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The lakehouse ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The advanced configurations.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'HudiAdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The advanced configurations of Hudi.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'FullComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of full AnalyticDB compute units (ACUs).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'IncrementalComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of increment ACUs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '168', + ], + ], + [ + 'name' => 'Project', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the SLS project.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Store', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The SLS Logstore.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartingOffsets', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start offset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'MaxOffsetsPerTrigger', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The latest offset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dbName', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'OutputFormat', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The format of the output file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The destination type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ADB', + ], + ], + [ + 'name' => 'TargetGenerateRule', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The rules for generating the destination database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'AcrossUid', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cross-account UID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'AcrossRole', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the cross-account role.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-role', + ], + ], + [ + 'name' => 'SourceRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID of the source cluster.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'OssLocation', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Object Storage Service (OSS) URL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test*', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '327', + ], + ], + [ + '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' => 'false', + ], + ], + [ + 'name' => 'UnixTimestampConvert', + 'in' => 'formData', + 'style' => 'json', + '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', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user_test', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The password of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'DirtyDataHandleMode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The dirty data processing mode.'."\n", + 'type' => 'string', + 'required' => true, + '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', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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', + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '200821', + 'abilityTreeNodes' => [ + 'FEATUREadsNQ1ZDK', + ], + ], + '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', + ], + ], + [ + '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' => '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' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult<?>', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '200834', + 'abilityTreeNodes' => [ + 'FEATUREadsNQ1ZDK', + ], + ], + '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-*******', + ], + ], + ], + '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' => '-', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '204210', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + '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' => '******', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"Items\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp1********\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"ComputeResource\\": \\"16ACU\\",\\n \\"StorageResource\\": 0,\\n \\"ReservedACU\\": \\"24ACU\\",\\n \\"DBClusterStatus\\": \\"Running\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209632', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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-*******', + ], + ], + [ + 'name' => 'StartingOffsets', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start offset.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'end_cursor', + ], + ], + [ + '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' => '-', + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'UnixTimestampConvert', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The timestamp conversion.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user-name', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The password of the database account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_123', + ], + ], + ], + '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' => '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', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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', + ], + ], + [ + '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://******', + ], + ], + [ + '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' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-07-20T16:00:00Z', + ], + ], + ], + '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", + '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.', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-57F0-9F06-******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 0,\\n \\"MigrationWorkloads\\": [\\n {\\n \\"ModifyTime\\": \\"2021-06-21T02:15:16Z\\",\\n \\"CreateTime\\": \\"2021-06-21T02:15:16Z\\",\\n \\"Id\\": \\"123\\",\\n \\"State\\": \\"COMPLETED\\",\\n \\"OssLocation\\": \\"oss://******\\",\\n \\"TargetType\\": \\"OSS\\",\\n \\"WorkloadSubType\\": \\"test\\",\\n \\"Name\\": \\"TEST-001\\",\\n \\"AcuCount\\": 0,\\n \\"MaxRT\\": \\"1000\\",\\n \\"FailedMsg\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeApsMigrationWorkloads', + ], + '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' => 'none', + 'abilityTreeCode' => '170284', + 'abilityTreeNodes' => [ + 'FEATUREadsBIVU9O', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + '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", + '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' => '-', + ], + ], + 'example' => '-', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86F92D26-B774-5FA1-8E53-******\\",\\n \\"ApsWorkload\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBClusterId\\": \\"amv-*******\\",\\n \\"WorkloadId\\": \\"aps-******\\",\\n \\"WorkloadName\\": \\"test\\",\\n \\"ResourceGroup\\": \\"test\\",\\n \\"FullComputeUnit\\": \\"16\\",\\n \\"SyncAllowExpression\\": \\"abc\\",\\n \\"SyncDenyExpression\\": \\"def\\",\\n \\"TargetType\\": \\"OSS\\",\\n \\"OssLocation\\": \\"oss://******\\",\\n \\"ConflictStrategy\\": \\"Intercept\\",\\n \\"AdvancedConfig\\": \\"test.adv.config=value\\",\\n \\"DatasourceId\\": 8,\\n \\"DatasourceName\\": \\"sls-******\\",\\n \\"Parallelism\\": 2,\\n \\"WorkloadTypeName\\": \\"test\\",\\n \\"State\\": \\"COMPLETED\\",\\n \\"CreateTime\\": \\"-\\",\\n \\"MetaStoreUri\\": \\"-\\",\\n \\"Vswitch\\": \\"vsw-******\\",\\n \\"EmrClusterId\\": \\"-\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeApsHiveWorkload', + ], + 'CreateApsCopyWorkload' => [ + 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) replication job.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '186455', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'WorkloadType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'SLS_INGESTION_ADB', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + [ + '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' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '-', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168878', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-*******', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + '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.', + '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", + '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' => '-', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-**D8-5***-A***-****587\\",\\n \\"ApsDatasource\\": {\\n \\"DatasourceName\\": \\"kafka-2024***\\",\\n \\"CreateTime\\": \\"2024-04-12T15:03:38Z\\",\\n \\"DatasourceType\\": \\"KAFKA\\",\\n \\"DatasourceDescription\\": \\"test\\",\\n \\"SlsInfo\\": {\\n \\"SourceRegionId\\": \\"cn-hangzhou\\",\\n \\"Project\\": \\"***\\",\\n \\"Store\\": \\"***\\",\\n \\"Across\\": false,\\n \\"AcrossUid\\": \\"123456\\",\\n \\"AcrossRole\\": \\"test\\"\\n },\\n \\"KafkaInfo\\": {\\n \\"KafkaClusterId\\": \\"-\\",\\n \\"KafkaTopic\\": \\"[{\'value\': \'hongxian_test\'}]\\"\\n },\\n \\"HiveInfo\\": {\\n \\"MetaStoreUri\\": \\"-\\",\\n \\"Vswitch\\": \\"vsw-******\\",\\n \\"SecurityGroup\\": \\"sg-******\\",\\n \\"EmrClusterId\\": \\"-\\"\\n },\\n \\"RdsMysqlInfo\\": {\\n \\"UserName\\": \\"-\\",\\n \\"RegionId\\": \\"-\\",\\n \\"InstanceId\\": \\"-\\",\\n \\"ConnectUrl\\": \\"-\\",\\n \\"SecurityGroup\\": \\"-\\"\\n },\\n \\"PolarDBMysqlInfo\\": {\\n \\"UserName\\": \\"-\\",\\n \\"RegionId\\": \\"-\\",\\n \\"InstanceId\\": \\"-\\",\\n \\"ConnectUrl\\": \\"-\\",\\n \\"SecurityGroup\\": \\"-\\",\\n \\"Across\\": true,\\n \\"AcrossUid\\": \\"-\\",\\n \\"AcrossRole\\": \\"-\\"\\n },\\n \\"DBClusterId\\": \\"amv-******\\",\\n \\"DatabricksInfo\\": {\\n \\"accessToken\\": \\"******\\",\\n \\"workspaceURL\\": \\"-\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'DescribeApsDatasource', + ], + 'CreateAPSJob' => [ + 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) job.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '180008', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database account of the destination cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-xxxxx', + ], + ], + [ + 'name' => 'DestinationEndpointPassword', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The password of the database account of the destination cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + ], + [ + 'name' => 'DestinationEndpointUserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database account of the destination cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + ], + [ + 'name' => 'DbList', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The objects to be synchronized.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"EntireInstance":true}', + ], + ], + [ + 'name' => 'ApsJobName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the synchronization job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-xxxxx', + ], + ], + [ + 'name' => 'PartitionList', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The partitions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'TargetTableMode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The mode of the destination table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + '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', + ], + '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', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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", + ], + 'StartApsJob' => [ + 'summary' => 'Starts an AnalyticDB Pipeline Service (APS) job.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '185195', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + ], + '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', + ], + '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', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183067', + 'abilityTreeNodes' => [ + 'FEATUREadsY28JLD', + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ApsJobId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-bj1xxxxxx', + ], + ], + ], + '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', + ], + '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', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '183077', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\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', + ], + ], + [ + 'name' => 'DbList', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The objects to be synchronized.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"EntireInstance":true}', + ], + ], + [ + 'name' => 'PartitionList', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The partitions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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", + ], + 'DeleteApsJob' => [ + 'summary' => 'Deletes an AnalyticDB Pipeline Service (APS) job.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '183073', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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", + ], + 'CreateApsDatasoure' => [ + 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) data source.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168860', + 'abilityTreeNodes' => [ + 'FEATUREadsBIVU9O', + 'FEATUREadsY28JLD', + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'DatasourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the data source.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'KAFKA', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the data source.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sls-******', + ], + ], + [ + 'name' => 'DatasourceDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the data source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALI_CLOUD_INSTANCE', + ], + ], + [ + 'name' => 'SlsInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the source Simple Log Service (SLS) instance or cluster.'."\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', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + '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', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'HiveInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the Hive data source.'."\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' => '******', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + '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-******', + ], + ], + 'required' => false, + 'example' => '-', + ], + ], + [ + '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' => '-', + ], + ], + [ + 'name' => 'PolarDBXInfo', + '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' => '-', + ], + ], + [ + 'name' => 'DatabricksInfo', + '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', + ], + ], + 'required' => false, + '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 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', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the data source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sls-******', + ], + ], + [ + 'name' => 'DatasourceDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the data source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SlsInfo', + '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' => '-', + ], + ], + [ + 'name' => 'KafkaInfo', + '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' => '-', + ], + ], + [ + 'name' => 'LakehouseId', + 'in' => 'formData', + 'style' => 'json', + '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-******', + ], + ], + 'required' => false, + 'example' => '123', + ], + ], + [ + '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' => '-', + ], + ], + [ + 'name' => 'PolarDBMysqlInfo', + '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' => '-', + ], + ], + ], + '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' => 'A3EB3BCD-D974-52D4-B75C-BB06505916CB', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '170156', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + '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' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + [ + 'name' => 'WorkloadName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workload.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sls-2024***93014', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + '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', + ], + '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 response parameters.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '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' => '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', + 'schema' => [ + 'description' => 'The type of the data source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SLS', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the data source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-30', + ], + ], + ], + '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' => '-', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-5213-******-B608-******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"ApsDatasources\\": [\\n {\\n \\"DatasourceName\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-01-10 14:44:33\\",\\n \\"DatasourceType\\": \\"SLS\\",\\n \\"DatasourceDescription\\": \\"test\\",\\n \\"DatasourceId\\": 1,\\n \\"HasJob\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeApsDatasources', + ], + 'CreateApsHiveJob' => [ + 'summary' => 'Creates an AnalyticDB Pipeline Service (APS) job from a Hive data source.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '170254', + 'abilityTreeNodes' => [ + 'FEATUREadsBIVU9O', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'FullComputeUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of AnalyticDB compute units (ACUs) required for data migration.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '16', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '40', + ], + ], + [ + 'name' => 'SyncAllowExpression', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The expression that allows objects to be synchronized.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + [ + 'name' => 'SyncDenyExpression', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The expression that denies objects to be synchronized.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The destination type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + '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/', + ], + ], + [ + '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.', + ], + ], + [ + 'name' => 'AdvancedConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The advanced configurations.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'Parallelism', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of tasks that are allowed in parallel.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171313', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-******', + ], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + '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' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-3EEC-******-9F06-******\\",\\n \\"TotalTableCount\\": 10,\\n \\"SuccessTableCount\\": 10,\\n \\"SuccessPercentage\\": 100,\\n \\"ApsHiveProgress\\": [\\n {\\n \\"DbName\\": \\"test\\",\\n \\"TbName\\": \\"test\\",\\n \\"Progress\\": \\"95\\",\\n \\"Speed\\": \\"2\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeApsProgress', + ], + 'DeleteApsDatasoure' => [ + 'summary' => 'Deletes an AnalyticDB Pipeline Service (APS) data source.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '168866', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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", + ], + 'DescribeApsJobs' => [ + 'summary' => 'Queries a list of AnalyticDB Pipeline Service (APS) jobs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '180030', + 'abilityTreeNodes' => [ + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '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' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-23T01:10Z', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-23T01:10Z', + ], + ], + [ + 'name' => 'ApsJobName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the APS job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aps-xxxxx', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInput', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******-7F9D-5DBD-993E-******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalCount\\": \\"0\\",\\n \\"APSJobs\\": [\\n {\\n \\"Status\\": \\"-\\",\\n \\"ApsJobName\\": \\"data-sync-******\\",\\n \\"DestinationInstanceID\\": \\"amv-*******\\",\\n \\"SourceInstanceID\\": \\"pc-******\\",\\n \\"Delay\\": 0,\\n \\"CreateTime\\": \\"2022-06-28 15:00:04\\",\\n \\"Projress\\": \\"30 ：进度 30%\\",\\n \\"ApsJobId\\": \\"aps-******\\",\\n \\"SubStatus\\": \\"-\\",\\n \\"ErrMessage\\": \\"OK\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"ok\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'DescribeApsJobs', + ], + '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' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '154388', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsY28JLD', + ], + ], + '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****', + ], + ], + [ + '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' => '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'WorkloadId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the real-time data ingestion job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aps-hz109vpvt4fg8528d****', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + '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' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EDBA27-AF3E-5966-9503-FD1557E19167\\",\\n \\"DBClusterId\\": \\"amv-bp1r053byu48p****\\",\\n \\"WorkloadId\\": \\"aps-hz109vpvt4fg8528d****\\",\\n \\"TotalCount\\": \\"3\\",\\n \\"PageSize\\": \\"30\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"ActionLogs\\": [\\n {\\n \\"Time\\": \\"2023-02-01T05:46:30Z\\",\\n \\"Stage\\": \\"FullDataSync\\",\\n \\"State\\": \\"INFO,WARN,ERROR\\",\\n \\"Context\\": \\"DDL migration job finished\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"sampleName\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"111111111111111111\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthResource\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"xxx\\\\\\"\\\\n}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeApsActionLogsResponse>\\n <RequestId>A5EDBA27-AF3E-5966-9503-FD1557E19167</RequestId>\\n <DBClusterId>amv-bp1r053byu48p****</DBClusterId>\\n <WorkloadId>aps-hz109vpvt4fg8528d****</WorkloadId>\\n <TotalCount>3</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNumber>1</PageNumber>\\n <ActionLogs>\\n <Time>2022-09-01T05:46:30Z</Time>\\n <Stage>FullDataSync</Stage>\\n <State>INFO,WARN,ERROR</State>\\n <Context>DDL migration job finished</Context>\\n </ActionLogs>\\n</DescribeApsActionLogsResponse>","errorExample":""}]', + 'title' => 'DescribeApsActionLogs', + 'description' => '* General endpoint: `adb.aliyuncs.com`.'."\n" + .'* Regional public endpoint: `adb.<region-id>.aliyuncs.com`. Example: `adb.cn-hangzhou.aliyuncs.com`.'."\n" + .'* Regional Virtual Private Cloud (VPC) endpoint: `adb-vpc.<region-id>.aliyuncs.com`. Example: `adb-vpc.cn-hangzhou.aliyuncs.com`.'."\n", + ], + 'UpdateLakeStorage' => [ + 'summary' => 'Updates a lake storage.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + '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', + ], + ], + [ + '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' => 'ADB实例ID', + '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' => [ + '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' => '-', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'ListLakeStorages' => [ + 'summary' => 'Queries a list of lake storages.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '216928', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'title' => '查询过滤参数，多个过滤参数之间是且的关系。例如:过滤实例名称为i-a123、i-b123，且实例状态为Stopped：&Filter.1.Name=InstanceName&Filter.1.Value.1=i-a123&Filter.1.Value.2=i-b123&Filter.2.Name=Status&Filter.2.Value=Stopped。', + 'description' => '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' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果的最大个数。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-*******', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'GetLakeStorage' => [ + 'summary' => 'Queries a lake storage.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '216924', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'LakeStorageId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例 ID。', + 'description' => 'The lake storage ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amv-*******', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'CreateLakeStorage' => [ + 'summary' => 'Creates a lake storage.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216925', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '湖存储描述', + 'description' => 'The description of the lake storage.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + '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-******', + ], + ], + [ + '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' => '-', + ], + ], + [ + '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' => '******', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'CreateLakeStorage', + ], + 'DeleteLakeStorage' => [ + 'summary' => 'Deletes a lake storage.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '216926', + 'abilityTreeNodes' => [ + 'FEATUREadsQO9FPM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'LakeStorageId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例 ID。', + 'description' => 'The ID of the lake storage.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '-', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amv-bp*********', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2******-B2C1-408E-AA73-DB8D59******\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"True\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '214852', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<DescribeElasticPlanAttributeResponse>', + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '214834', + 'abilityTreeNodes' => [ + 'FEATUREadsCQJTKP', + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<DescribeElasticPlanAttributeResponse>', + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp149vz49b36t****', + ], + ], + ], + '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' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D761DA51-12F8-5457-AAA9-F52B9F436D2D\\",\\n \\"Data\\": {\\n \\"EnableCompactionService\\": true\\n }\\n}","type":"json"}]', + 'title' => 'DescribeCompactionServiceSwitch', + ], + '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' => '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-bp10yt0gva71ei7d', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'EssdCacheSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The disk cache size. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '500', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '115F9CCA-EF2E-5F91-AB60-4961D52FEAB4', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"115F9CCA-EF2E-5F91-AB60-4961D52FEAB4\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-uf685u1o987hj6rn', + ], + ], + ], + '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.', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"Data\\": {\\n \\"EnableEssdCache\\": true,\\n \\"EssdCacheSize\\": 500\\n }\\n}","type":"json"}]', + 'title' => '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amv-bp14t95lun0w****', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '21ABF219-10E0-571B-94B8-9C9AE5022BF8', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21ABF219-10E0-571B-94B8-9C9AE5022BF8\\"\\n}","type":"json"}]', + 'title' => 'ModifyCompactionServiceSwitch', + ], + 'SubmitResultExportJob' => [ + 'summary' => 'Submits an SQL query and exports a result set.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219535', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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' => '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****', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'tpch_oss', + ], + ], + [ + '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;', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the result set export job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SLS', + ], + ], + ], + '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", + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + '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', + ], + ], + [ + '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****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DatabaseUser', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"InvalidInput\\",\\n \\"Items\\": [\\n {\\n \\"DBClusterId\\": \\"amv-7xv5ty5m9o4v****\\",\\n \\"AliUid\\": \\"120010511678****\\",\\n \\"Sql\\": \\"SELECT * FROM `ADB_SampleData_TPCH`.`supplier` LIMIT 20\\",\\n \\"CreateTime\\": \\"2022-04-01T09:50:18Z\\",\\n \\"StartTime\\": \\"2021-07-03T04:00:00Z\\",\\n \\"EndTime\\": \\"2023-06-15T02:13:00Z\\",\\n \\"DatabaseUser\\": \\"ram_user\\",\\n \\"TimeCost\\": 560,\\n \\"ExportJobId\\": \\"export_2024051319271219802100800401300****\\\\n\\",\\n \\"ResourceGroup\\": \\"test\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExportPath\\": \\"oss://testBucketName/export_test/result_export/2024/05/13/202405131528400210090110690315154****/result.csv\\",\\n \\"Progress\\": \\"30\\",\\n \\"ProcessId\\": \\"202306121421111720161451770345339****\\",\\n \\"ExportRows\\": \\"10000\\",\\n \\"Message\\": \\"Failed to execute SQL\\",\\n \\"Engine\\": \\"XIHE\\",\\n \\"Schema\\": \\"lake_db\\",\\n \\"ExportType\\": \\"-\\",\\n \\"IsExpired\\": true\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 174\\n}","type":"json"}]', + 'title' => 'ListResultExportJobHistory', + ], + 'DescribeSQLWebSocketDomain' => [ + 'summary' => 'Queries the WebSocket domain name of an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '180261', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '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' => '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', + ], + ], + [ + 'name' => 'Module', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'type' => 'string', + ], + ], + ], + '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' => '', + ], + ], + ], + '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', + ], + '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' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + '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', + ], + ], + [ + '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****', + ], + ], + [ + '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', + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254784', + 'abilityTreeNodes' => [ + 'FEATUREadsCORDM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + '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*****', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'ModifySqlTemplatePosition' => [ + 'summary' => 'Modifies the directory location of SQL templates.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amv-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '分组Id', + 'description' => 'The template ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '210208', + ], + ], + [ + 'name' => 'TargetTemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '参数模板Id', + 'description' => 'The ID of the template group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + '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' => '', + ], + ], + ], + '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", + ], + ], + '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', + ], + ], +]; |