diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/adb/2019-03-15 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/adb/2019-03-15')
| -rw-r--r-- | data/en_us/adb/2019-03-15/api-docs.php | 25730 |
1 files changed, 25730 insertions, 0 deletions
diff --git a/data/en_us/adb/2019-03-15/api-docs.php b/data/en_us/adb/2019-03-15/api-docs.php new file mode 100644 index 0000000..fac2c82 --- /dev/null +++ b/data/en_us/adb/2019-03-15/api-docs.php @@ -0,0 +1,25730 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'adb', + 'version' => '2019-03-15', + ], + 'directories' => [ + [ + 'id' => 74180, + 'title' => 'Cluster management', + 'type' => 'directory', + 'children' => [ + 'CreateDBCluster', + 'DeleteDBCluster', + 'ModifyDBCluster', + 'ModifyDBClusterMaintainTime', + 'ModifyDBClusterPayType', + 'ModifyAutoRenewAttribute', + 'ModifyDBClusterDescription', + 'ModifyDBClusterResourceGroup', + 'DescribeDBClusters', + 'DescribeDBClusterStatus', + 'DescribeDBClusterAttribute', + 'DescribeAutoRenewAttribute', + 'DescribeAvailableResource', + 'DescribeComputeResource', + 'DescribeEIURange', + 'AttachUserENI', + 'DetachUserENI', + 'DescribeKernelVersion', + 'UpgradeKernelVersion', + 'MigrateDBCluster', + ], + ], + [ + 'id' => 74192, + 'title' => 'Resource group management (old version)', + 'type' => 'directory', + 'children' => [ + 'CreateDBResourcePool', + 'DeleteDBResourcePool', + 'ModifyDBResourcePool', + 'DescribeDBResourcePool', + 'BindDBResourcePoolWithUser', + 'UnbindDBResourcePoolWithUser', + ], + ], + [ + 'id' => 181276, + 'title' => 'Resource group management (new version)', + 'type' => 'directory', + 'children' => [ + 'CreateDBResourceGroup', + 'BindDBResourceGroupWithUser', + 'UnbindDBResourceGroupWithUser', + 'DescribeDBResourceGroup', + 'ModifyDBResourceGroup', + 'DeleteDBResourceGroup', + 'DescribeResubmitConfig', + 'ModifyResubmitConfig', + 'ModifySQAConfig', + 'DescribeSQAConfig', + ], + ], + [ + 'id' => 74199, + 'title' => 'Elastic plan management', + 'type' => 'directory', + 'children' => [ + 'CreateElasticPlan', + 'DeleteElasticPlan', + 'ModifyElasticPlan', + 'DescribeElasticDailyPlan', + 'DescribeElasticPlan', + ], + ], + [ + 'id' => 74205, + 'title' => 'Database', + 'type' => 'directory', + 'children' => [ + 'DescribeTables', + 'DescribeAllDataSource', + 'DescribeSchemas', + 'DescribeTableDetail', + 'DescribeProcessList', + 'DescribeColumns', + 'DescribeTaskInfo', + 'DescribeSQLPlan', + 'DescribeSQLPlanTask', + 'DescribeTablePartitionDiagnose', + 'DescribeLoadTasksRecords', + 'DescribeConnectionCountRecords', + 'KillProcess', + ], + ], + [ + 'id' => 74219, + 'title' => 'Log management', + 'type' => 'directory', + 'children' => [ + 'ModifyAuditLogConfig', + 'DescribeSlowLogRecords', + 'DescribeAuditLogConfig', + 'DescribeAuditLogRecords', + ], + ], + [ + 'id' => 74225, + 'title' => 'Region management', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 74227, + 'title' => 'Network management', + 'type' => 'directory', + 'children' => [ + 'ModifyClusterConnectionString', + 'DescribeDBClusterNetInfo', + 'AllocateClusterPublicConnection', + 'ReleaseClusterPublicConnection', + 'DescribeVSwitches', + ], + ], + [ + 'id' => 74232, + 'title' => 'Account management', + 'type' => 'directory', + 'children' => [ + 'CreateAccount', + 'DeleteAccount', + 'ModifyAccountDescription', + 'DescribeAllAccounts', + 'DescribeAccounts', + 'DescribeOperatorPermission', + 'GrantOperatorPermission', + 'ResetAccountPassword', + 'RevokeOperatorPermission', + ], + ], + [ + 'id' => 74242, + 'title' => 'Tag management', + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 74251, + 'title' => 'Security management', + 'type' => 'directory', + 'children' => [ + 'ModifyDBClusterAccessWhiteList', + 'DescribeDBClusterAccessWhiteList', + 'DescribeDBClusterSSL', + 'ModifyDBClusterSSL', + ], + ], + [ + 'id' => 186969, + 'title' => 'Others', + 'type' => 'directory', + 'children' => [ + 'ModifyBackupPolicy', + 'ModifyLogBackupPolicy', + 'DescribeBackupPolicy', + 'DescribeBackups', + ], + ], + [ + 'id' => 74254, + 'title' => 'Monitoring management', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterHealthStatus', + 'DescribeDBClusterPerformance', + 'DescribeDBClusterResourcePoolPerformance', + 'DescribeInclinedTables', + ], + ], + [ + 'id' => 74259, + 'title' => 'O\\&M management', + 'type' => 'directory', + 'children' => [ + 'ModifyMaintenanceAction', + 'DescribeMaintenanceAction', + ], + ], + [ + 'id' => 74262, + 'title' => 'SQL diagnostics', + 'type' => 'directory', + 'children' => [ + 'DescribeDiagnosisTasks', + 'DescribeDiagnosisRecords', + 'DescribeDiagnosisDimensions', + 'DescribeDownloadRecords', + 'DownloadDiagnosisRecords', + 'DescribeDiagnosisSQLInfo', + 'DescribeDiagnosisMonitorPerformance', + 'DescribeSQLPatterns', + 'DescribePatternPerformance', + 'EnableAdviceService', + 'ApplyAdviceById', + 'BatchApplyAdviceByIdList', + 'DescribeAdviceServiceEnabled', + 'DescribeAppliedAdvices', + 'DescribeAvailableAdvices', + 'DisableAdviceService', + ], + ], + [ + 'id' => 190394, + 'title' => 'Storage analysis', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterSpaceSummary', + 'DescribeTableStatistics', + 'DescribeExcessivePrimaryKeys', + ], + ], + [ + 'id' => 74267, + 'title' => 'Cluster running reports', + 'type' => 'directory', + 'children' => [ + 'DescribeTableAccessCount', + 'DescribeSqlPattern', + ], + ], + [ + 'id' => 362567, + 'title' => 'Others', + 'type' => 'directory', + 'children' => [ + 'CheckServiceLinkedRole', + 'CreateServiceLinkedRole', + 'DescribeKmsKeys', + 'DescribeLogHubAttribute', + 'DescribeLogStoreKeys', + 'DescribeLoghubDetail', + 'DescribeRdsAnalysisResourceQuotas', + 'DescribeRegionsMixed', + 'DescribeSyncAvailableDBClusterList', + 'DescribeSyncJobList', + 'DescribeVSwitchs', + 'DescribeVpcs', + 'ModifyLogHubStatus', + 'ModifySyncJob', + 'OperateLogHub', + 'CancelActiveOperationTasks', + 'DescribeHistoryEventsStat', + 'ModifyActiveOperationMaintainConf', + 'DescribeActiveOperationTasks', + 'DescribeActiveOperationMaintainConf', + 'ModifyActiveOperationTasks', + 'DescribeControllerDetection', + 'DescribeWorkerDetection', + 'DescribeAbnormalPatternDetection', + 'DescribeBadSqlDetection', + 'DescribeExecutorDetection', + 'ModifyDBClusterVip', + 'GetCreateTableSQL', + 'DescribeInclinedNodes', + 'DescribeOversizeNonPartitionTableInfos', + 'ModifyDBClusterShardNumber', + 'DeleteBackups', + 'DescribeDBClusterShardNumber', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateDBCluster' => [ + 'summary' => 'Creates an AnalyticDB for MySQL Data Warehouse Edition cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10768', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the cluster. Set the value to **3.0**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3.0', + ], + ], + [ + 'name' => 'DBClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'* **Cluster**: reserved mode for Cluster Edition'."\n" + ."\n" + .'<!---->'."\n" + ."\n" + .'* **MixedStorage**: elastic mode for Cluster Edition'."\n" + ."\n" + .'> If the DBClusterCategory parameter is set to Cluster, you must set the Mode parameter to Reserver. If the DBClusterCategory parameter is set to MixedStorage, you must set the Mode parameter to Flexible. Otherwise, the cluster fails to be created.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Cluster', + ], + ], + [ + 'name' => 'DBClusterClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specification of the cluster. Valid values:'."\n" + ."\n" + .'* **C8**'."\n" + .'* **C32**'."\n" + ."\n" + .'> This parameter is required if the Mode parameter is set to Reserver.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'C8', + ], + ], + [ + 'name' => 'DBNodeGroupCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of node groups. Valid values: 1 to 200 (integer).'."\n" + ."\n" + .'> This parameter is required if the Mode parameter is set to Reserver.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'DBNodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of the cluster. Unit: GB.'."\n" + ."\n" + .'* Valid values when DBClusterClass is set to C8: 100 to 1000'."\n" + .'* Valid values when DBClusterClass is set to C32: 100 to 8000'."\n" + ."\n" + .'> * This parameter is required if the Mode parameter is set to Reserver.'."\n" + .'> * 1000 The storage capacity less than 1,000 GB increases in 100 GB increments. The storage capacity greater than 1,000 GB increases in 1,000 GB increments.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'DBClusterNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the cluster. Set the value to **VPC**.'."\n", + 'type' => 'string', + 'required' => true, + '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.'."\n", + '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'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Postpaid', + ], + ], + [ + '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 is required if the PayType parameter is set to Prepaid.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual private cloud (VPC) ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1at5ze0t5u3xtqn****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1aadw9k19x6cis9****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The value is case-sensitive and can contain a maximum of 64 ASCII characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + [ + 'name' => 'ExecutorCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the cluster belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags to add to the cluster.'."\n", + '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://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + '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://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the cluster. Valid values:'."\n" + ."\n" + .'* **Reserver**: the reserved mode.'."\n" + .'* **Flexible**: the elastic mode.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Reserver', + ], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The computing resources of the cluster. You can use computing resources to compute data. The increase in the computing resources can accelerate data queries. The computing resources are available for Cluster Edition and Basic Edition.'."\n" + ."\n" + .'* Computing resources for Cluster Edition include 16 cores and 64 GB memory, 24 cores and 96 GB memory, and 32 cores or more. Cluster Edition supports resource isolation, scheduled scaling, and tiered storage of hot and cold data.'."\n" + .'* Computing resources for Basic Edition include 8 cores and 32 GB memory and 16 cores and 64 GB memory. Alibaba Cloud does not provide an SLA guarantee for Basic Edition, and 4 to 8 hours are required for a failover. We recommend that you do not use Basic Edition in production environments.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeAvailableResource](~~190632~~) operation to query the available computing resources in a region.'."\n" + ."\n" + .'* This parameter must be specified when Mode is set to **Flexible**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32Core128GB', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + ], + [ + 'name' => 'SourceDBInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + ], + [ + 'name' => 'BackupSetID', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + ], + [ + 'name' => 'ElasticIOResource', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The number of elastic I/O units (EIUs). For more information, see [Elasticity of the storage layer](~~189505~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'DiskEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether disk encryption is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'KmsId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Key Management Service (KMS) ID that is used for disk encryption. This parameter takes effect only when DiskEncryption is set to true.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxxx-xxxx-xxxx-xxxx-xxxx', + ], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable SSL encryption. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the cluster belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-4690g37929****', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.', + 'type' => 'string', + 'example' => 'am-bp1r053byu48p****', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'example' => '202353278****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"ResourceGroupId\\": \\"rg-4690g37929****\\",\\n \\"DBClusterId\\": \\"am-bp1r053byu48p****\\",\\n \\"OrderId\\": \\"202353278****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDBClusterResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <ResourceGroupId>rg-4690g37929****</ResourceGroupId>\\n <DBClusterId>am-bp1r053byu48p****</DBClusterId>\\n <OrderId>202353278****</OrderId>\\n</CreateDBClusterResponse>","errorExample":""}]', + 'title' => 'CreateDBCluster', + 'description' => 'After you create a cluster, you are billed for the cluster specifications that you select. For more information about the billable items and pricing for Data Warehouse Edition clusters, see [Billable items of Data Warehouse Edition](~~303131~~) and [Pricing for Data Warehouse Edition](~~135229~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDBCluster' => [ + 'summary' => 'Deletes an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1u8c0mgfg58****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '421693038', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp1u8c0mgfg58****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 421693038,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp1u8c0mgfg58****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBClusterResponse>\\n <TaskId>421693038</TaskId>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <DBClusterId>am-bp1u8c0mgfg58****</DBClusterId>\\n</DeleteDBClusterResponse>","errorExample":""}]', + 'title' => 'DeleteDBCluster', + 'description' => '* You cannot delete subscription clusters by calling API operations. After expiration, subscription clusters are automatically released. If you no longer need a cluster, you can unsubscribe from the cluster in the Expenses and Costs console. For information about cluster refunds, see [Refund policy](~~471477~~).'."\n" + .'* After you delete a cluster, resources of the cluster are immediately released, and data of the cluster is no longer retained and cannot be restored. Proceed with caution.'."\n" + .'* The cluster that you want to delete must be in the Running state.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBCluster' => [ + 'summary' => 'Changes the specifications of an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1u8c0mgfg58****', + ], + ], + [ + 'name' => 'DBNodeGroupCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of node groups. Valid values: 1 to 200.'."\n" + ."\n" + .'> This parameter must be specified when Mode is set to Reserver.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'DBNodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity per node. Unit: GB.'."\n" + ."\n" + .'* Valid values when DBClusterClass is set to C8: 100 to 2000.'."\n" + .'* Valid values when DBClusterClass is set to C32: 100 to 8000.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter must be specified when Mode is set to Reserver.'."\n" + ."\n" + .'* The storage capacity less than 1,000 GB increases in 100 GB increments. The storage capacity greater than 1,000 GB increases in 1,000 GB increments.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node specifications of the cluster. Valid values:'."\n" + ."\n" + .'* **C8**'."\n" + .'* **C32**'."\n" + ."\n" + .'> This parameter must be specified when Mode is set to Reserver.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'C32', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The change type. Valid values:'."\n" + ."\n" + .'* **Upgrade**'."\n" + .'* **Downgrade**'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'ExecutorCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'N/A'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'None'."\n", + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster. You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'N/A'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'None'."\n", + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The computing resources of the cluster. You can call the [DescribeAvailableResource](~~190632~~) operation to query the computing resources that are available within a region.'."\n" + ."\n" + .'> This parameter must be specified when Mode is set to Flexible.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32Core128GBNEW', + ], + ], + [ + 'name' => 'ElasticIOResourceSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The single-node specifications of an elastic I/O unit (EIU). Valid values:'."\n" + ."\n" + .'* **8Core64GB**: If you set the parameter to **8Core64GB**, the specifications of an EIU are 24 cores and 192 GB memory.'."\n" + .'* **12Core96GB**: If you set the parameter to **12Core96GB**, the specifications of an EIU are 36 cores and 288 GB memory.'."\n" + ."\n" + .'> This parameter takes effect only when your cluster meets the following requirements:'."\n" + ."\n" + .'* The cluster is in elastic mode.'."\n" + ."\n" + .'* If the cluster resides in the China (Guangzhou), China (Shenzhen), China (Hangzhou), China (Shanghai), China (Qingdao), China (Beijing), or China (Zhangjiakou) region, the cluster has 16 cores and 64 GB memory or higher specifications.'."\n" + ."\n" + .'* If the cluster resides in another region, the cluster has 32 cores and 128 GB memory or higher specifications.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8Core64GB', + 'enum' => [ + '8Core64GB', + '12Core96GB', + '16Core128GB', + ], + ], + ], + [ + 'name' => 'ElasticIOResource', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The number of EIUs. The number of EIUs that you can purchase varies based on the single-node EIU specifications.'."\n" + ."\n" + .'* If the single-node EIU specifications are 8 cores and 64 GB, you can purchase up to 32 EIUs.'."\n" + .'* If the single-node EIU specifications are 12 cores and 96 GB, you can purchase up to 16 EIUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'DBClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'* **Cluster**: reserved mode for Cluster Edition.'."\n" + .'* **MixedStorage**: elastic mode for Cluster Edition.'."\n" + ."\n" + .'> If you set DBClusterCategory to Cluster, you must set Mode to Reserver. If you set DBClusterCategory to MixedStorage, you must set Mode to Flexible. Otherwise, you fail to change the specifications of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MixedStorage', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the cluster. Valid values:'."\n" + ."\n" + .'* **Reserver**: the reserved mode.'."\n" + .'* **Flexible**: the elastic mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Flexible', + ], + ], + [ + 'name' => 'DiskPerformanceLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Enterprise SSD (ESSD) performance level of the cluster. Valid values:'."\n" + ."\n" + .'* PL0'."\n" + .'* PL1'."\n" + .'* PL2'."\n" + .'* PL3'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + 'enum' => [ + 'PL1', + 'PL2', + 'PL3', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp1u8c0mgfg58****', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'example' => '2035629****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp1u8c0mgfg58****\\",\\n \\"OrderId\\": \\"2035629****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <DBClusterId>am-bp1u8c0mgfg58****</DBClusterId>\\n <OrderId>2035629****</OrderId>\\n</ModifyDBClusterResponse>","errorExample":""}]', + 'title' => 'ModifyDBCluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterMaintainTime' => [ + 'summary' => 'Changes 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', + 'abilityTreeCode' => '10848', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + '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-bp111m2cfrdl****', + ], + ], + [ + 'name' => 'MaintainTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maintenance window of the cluster. Specify the maintenance window in the hh:mmZ-hh:mmZ format.'."\n" + ."\n" + .'> The time range must be 1 hour and start and end at the beginning of an hour.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterMaintainTimeResponse>\\n <RequestId>65BDA532-28AF-4122-AA39-B382721EEE64</RequestId>\\n</ModifyDBClusterMaintainTimeResponse>","errorExample":""}]', + 'title' => 'ModifyDBClusterMaintainTime', + ], + 'ModifyDBClusterPayType' => [ + 'summary' => 'Changes the billing method of an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '119987', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + .'* **Postpaid**: pay-as-you-go.'."\n" + .'* **Prepaid**: subscription.', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'Postpaid', + 'enum' => [ + 'Postpaid', + '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' => 'Year', + 'enum' => [ + 'Year', + '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, + 'maximum' => '9', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'example' => 'am-bp11q28kvl688****', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'example' => '2023532****', + ], + 'PayType' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: pay-as-you-go'."\n" + .'* **Prepaid**: subscription', + 'type' => 'string', + 'example' => 'Postpaid', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPayType.Malformed', + 'errorMessage' => 'The specified parameter "PayType" is not changed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\",\\n \\"OrderId\\": \\"2023532****\\",\\n \\"PayType\\": \\"Prepaid\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterPayTypeResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <DBClusterId>am-bp11q28kvl688****</DBClusterId>\\n <OrderId>2023532****</OrderId>\\n <PayType>Prepaid</PayType>\\n</ModifyDBClusterPayTypeResponse>","errorExample":""}]', + 'title' => 'ModifyDBClusterPayType', + ], + 'ModifyAutoRenewAttribute' => [ + 'summary' => 'Modifies the auto-renewal status of a subscription AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10841', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1u389j9zjh5****', + ], + ], + [ + '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' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The renewal status of the cluster. Valid values:'."\n" + ."\n" + .'* **AutoRenewal**: The cluster is automatically renewed.'."\n" + .'* **Normal**: The cluster is manually renewed.'."\n" + .'* **NotRenewal**: The cluster is not renewed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + 'default' => 'AutoRenewal', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The renewal duration. Default value: **1**.'."\n" + ."\n" + .'* Valid values when PeriodUnit is set to **Month**: 1 to 11.'."\n" + .'* Valid values when PeriodUnit is set to **Year**: 1, 2, 3, and 5.'."\n" + ."\n" + .'> Longer subscription durations offer more savings. Purchasing a cluster for one year is more cost-effective than purchasing the cluster for 10 or 11 months.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the renewal duration. Default value: **Month**. 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' => '4CE6DF97-AEA4-484F-906F-C407EE3770EB', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE3770EB\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAutoRenewAttributeResponse>\\n <RequestId>4CE6DF97-AEA4-484F-906F-C407EE3770EB</RequestId>\\n</ModifyAutoRenewAttributeResponse>","errorExample":""}]', + 'title' => 'ModifyAutoRenewAttribute', + ], + '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', + 'abilityTreeCode' => '10847', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + '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 ID of the request.'."\n", + 'type' => 'string', + 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterDescriptionResponse>\\n <RequestId>17F57FEE-EA4F-4337-8D2E-9C23CAA63D74</RequestId>\\n</ModifyDBClusterDescriptionResponse>","errorExample":""}]', + 'title' => 'ModifyDBClusterDescription', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterResourceGroup' => [ + 'summary' => 'Modifies the resource group 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' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bpxxxxx', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID. For more information, see [View basic information of a resource group](~~151181~~).'."\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' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBClusterResourceGroup', + 'description' => 'Resource Management enables you to build an organizational structure for resources based on your business needs. You can use a resource directory, folders, accounts, and resource groups to hierarchically organize and manage resources. For more information, see [What is Resource Management?](~~94475#concept-zyn-3p1-dhb~~ "Resource Management provides a collection of resource management services that support enterprise IT administration. The services include Resource Directory, Resource Group, and Tag. Resource Directory allows you to build an organizational structure for resources based on your business requirements. Resource Group and Tag allow you to hierarchically manage the resources. Resource Sharing allows you to share the resources among your accounts.")'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeDBClusters' => [ + 'summary' => 'Queries a list of AnalyticDB for MySQL clusters within a region.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10802', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the clusters.'."\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' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster IDs.'."\n" + ."\n" + .'> You can specify the ID of one cluster or IDs of more clusters within the preceding region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-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 state of the cluster. Valid values:'."\n" + ."\n" + .'* **Preparing**: The cluster is being prepared.'."\n" + .'* **Creating**: The cluster is being created.'."\n" + .'* **Restoring**: The cluster is being restored from a backup.'."\n" + .'* **Running**: The cluster is running.'."\n" + .'* **Deleting**: The cluster is being deleted.'."\n" + .'* **ClassChanging**: The cluster specifications are being changed.'."\n" + .'* **NetAddressCreating**: A network connection is being created.'."\n" + .'* **NetAddressDeleting**: A network connection is being deleted.'."\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 ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929XXXX', + ], + ], + [ + '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 key of tag N that is added to the cluster. You can use tags to filter clusters. A tag is a key-value pair. You can specify up to 20 tags in one request. The letter N specifies the sequence number of each key-value pair and must be unique. The values of N must be 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://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => 'The value of tag N that is added to the cluster. You can use tags to filter clusters. A tag is a key-value pair. You can specify up to 20 tags in one request. The letter N specifies the sequence number of each key-value pair and must be unique. The values of N must be 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://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the cluster. Set the value to **3.0**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3.0', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'All', + 'enum' => [ + 'All', + '3.0', + '5.0', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The queried cluster information.'."\n", + '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' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => 'The queried cluster information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried cluster information.'."\n", + 'type' => 'object', + 'properties' => [ + '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', + ], + 'DBNodeCount' => [ + 'description' => 'The number of node groups.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Expired' => [ + 'description' => 'Indicates whether the cluster has expired. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\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. Example: *2021-04-01T09:50:18Z*.'."\n", + 'type' => 'string', + 'example' => '2021-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' => 'Postpaid', + ], + 'DiskType' => [ + 'description' => 'The disk type of the cluster. Valid values:'."\n" + ."\n" + .'* **local_ssd**: local SSD.'."\n" + .'* **cloud**: basic disk.'."\n" + .'* **cloud_ssd**: standard SSD.'."\n" + .'* **cloud_efficiency**: ultra disk.'."\n" + .'* **cloud_essd0**: PL0 Enterprise SSD (ESSD).'."\n" + .'* **cloud_essd**: PL1 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', + ], + '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 a tag to the cluster.'."\n", + 'type' => 'string', + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + 'Mode' => [ + 'description' => 'The mode of the cluster. Valid values:'."\n" + ."\n" + .'* **flexible**: elastic mode.'."\n" + .'* **reserver**: reserved mode.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* For more information about cluster modes, see [Editions](~~205001~~).'."\n", + 'type' => 'string', + 'example' => 'flexible', + ], + 'Port' => [ + 'description' => 'The port number that is used to connect to the cluster. Default value: 3306.'."\n", + 'type' => 'string', + '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" + .'* **LockByRestoration**: The cluster is automatically locked due to cluster restoration.'."\n" + .'* **LockByDiskQuota**: The cluster is automatically locked when 90% of the cluster storage is used.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'StorageResource' => [ + 'description' => 'The specifications of storage resources that are used in the cluster in elastic mode. 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' => '8Core32GB', + ], + 'ExecutorCount' => [ + 'description' => 'The number of compute nodes that are used by the cluster in elastic mode.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp163885f8q21****', + ], + 'ConnectionString' => [ + 'description' => 'The public endpoint that is used to connect to the cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp163885f8q21****.ads.aliyuncs.com', + ], + '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****', + ], + 'DBClusterType' => [ + 'description' => 'The type of the cluster. Valid values:'."\n" + ."\n" + .'* **Common**: common cluster.'."\n" + .'* **RDS_ANALYSIS**: MySQL analytic instance.'."\n", + 'type' => 'string', + 'example' => 'Common', + ], + 'CommodityCode' => [ + 'description' => 'The commodity code. **ads** is returned.'."\n", + 'type' => 'string', + 'example' => 'ads', + ], + 'ExpireTime' => [ + 'description' => 'The expiration time of the cluster. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC. Example: *2999-09-08T16:00:00Z*.'."\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, **2999-09-08T16:00:00Z** is returned.'."\n", + 'type' => 'string', + 'example' => '2999-09-08T16:00:00Z', + ], + 'DBNodeStorage' => [ + 'description' => 'The storage capacity of the cluster. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'DBNodeClass' => [ + 'description' => 'The specifications of the cluster.'."\n", + 'type' => 'string', + 'example' => 'E8', + ], + '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_expired', + ], + 'VPCId' => [ + 'description' => 'The virtual private cloud (VPC) ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp13h7uzhulpuxvnpXXXX', + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ComputeResource' => [ + 'description' => 'The specifications of computing resources that are used in the cluster in elastic mode. 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' => '8Core32GB', + ], + 'ElasticIOResource' => [ + 'description' => 'The number of elastic I/O units (EIUs). For more information, see [Elasticity of the storage layer](~~189505~~).'."\n" + ."\n" + .'> This parameter is returned only for clusters in elastic mode.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1syh8vvw8yech7nXXXX', + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine. **3.0** is returned.'."\n", + 'type' => 'string', + 'example' => '3.0', + ], + 'VPCCloudInstanceId' => [ + 'description' => 'The ID of the cluster that resides in the VPC.'."\n", + 'type' => 'string', + 'example' => 'am-bp163885f8q21****-controller', + ], + 'DBClusterStatus' => [ + 'description' => 'The status of the cluster. For more information, see [Cluster states](~~143075~~).'."\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', + ], + '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', + ], + 'Category' => [ + 'description' => 'The edition of the cluster. 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', + ], + 'Engine' => [ + 'description' => 'The engine of the cluster. **AnalyticDB** is returned.'."\n", + 'type' => 'string', + 'example' => 'AnalyticDB', + ], + 'InnerIp' => [ + 'description' => 'The public IP address of the cluster.'."\n", + 'type' => 'string', + 'example' => '10.1.xx.xx', + ], + 'InnerPort' => [ + 'description' => 'The port number that is used to connect to the cluster.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'TaskInfo' => [ + 'description' => 'The job progress.'."\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 step.'."\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', + ], + ], + ], + ], + ], + ], + ], + ], + 'ProductVersion' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'* **BasicVersion**: Basic Edition.'."\n" + .'* **EnterpriseVersion**: Enterprise Edition.'."\n", + 'type' => 'string', + 'example' => 'EnterpriseVersion', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"DtsJobId\\": \\"dtsb1578j90XXXX\\",\\n \\"DBNodeCount\\": 1,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-04-01T09:50:18Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DiskType\\": \\"cloud_essd\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"Mode\\": \\"flexible\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageResource\\": \\"8Core32GB\\",\\n \\"ExecutorCount\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-bp163885f8q21****\\",\\n \\"ConnectionString\\": \\"am-bp163885f8q21****.ads.aliyuncs.com\\",\\n \\"RdsInstanceId\\": \\"rm-bp11q28kvl688****\\",\\n \\"DBClusterType\\": \\"Common\\",\\n \\"CommodityCode\\": \\"ads\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"DBNodeStorage\\": 300,\\n \\"DBNodeClass\\": \\"E8\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"VPCId\\": \\"vpc-bp13h7uzhulpuxvnpXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ComputeResource\\": \\"8Core32GB\\",\\n \\"ElasticIOResource\\": 0,\\n \\"VSwitchId\\": \\"vsw-bp1syh8vvw8yech7nXXXX\\",\\n \\"DBVersion\\": \\"3.0\\",\\n \\"VPCCloudInstanceId\\": \\"am-bp163885f8q21****-controller\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"DBClusterNetworkType\\": \\"vpc\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Category\\": \\"MIXED_STORAGE\\",\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"InnerIp\\": \\"10.1.xx.xx\\",\\n \\"InnerPort\\": \\"3306\\",\\n \\"TaskInfo\\": {\\n \\"Name\\": \\"analyticDBFlexibleScaleOut\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Progress\\": \\"10\\",\\n \\"StepList\\": {\\n \\"StepList\\": [\\n {\\n \\"StepName\\": \\"ApplyResource\\",\\n \\"StepDesc\\": \\"Apply resource\\",\\n \\"StepStatus\\": \\"SUCCEED\\",\\n \\"StepProgress\\": \\"50\\",\\n \\"StartTime\\": \\"2024-03-10T09:28:34Z\\",\\n \\"EndTime\\": \\"2024-03-10T10:28:34Z\\"\\n }\\n ]\\n }\\n },\\n \\"ProductVersion\\": \\"EnterpriseVersion\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClustersResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <DtsJobId>dtsb1578j90XXXX</DtsJobId>\\n <DBNodeCount>1</DBNodeCount>\\n <Expired>false</Expired>\\n <CreateTime>2021-04-01T09:50:18Z</CreateTime>\\n <PayType>Postpaid</PayType>\\n <DiskType>cloud_essd</DiskType>\\n <Tags>\\n <Key>tag1</Key>\\n <Value>test1</Value>\\n </Tags>\\n <Mode>flexible</Mode>\\n <Port>3306</Port>\\n <LockMode>Unlock</LockMode>\\n <StorageResource>8Core32GB</StorageResource>\\n <ExecutorCount>1</ExecutorCount>\\n <DBClusterId>am-bp163885f8q21****</DBClusterId>\\n <ConnectionString>am-bp163885f8q21****.ads.aliyuncs.com</ConnectionString>\\n <RdsInstanceId>rm-bp11q28kvl688****</RdsInstanceId>\\n <DBClusterType>Common</DBClusterType>\\n <CommodityCode>ads</CommodityCode>\\n <ExpireTime>2999-09-08T16:00:00Z</ExpireTime>\\n <DBNodeStorage>300</DBNodeStorage>\\n <DBNodeClass>E8</DBNodeClass>\\n <LockReason>instance_expired</LockReason>\\n <VPCId>vpc-bp13h7uzhulpuxvnpXXXX</VPCId>\\n <RegionId>cn-hangzhou</RegionId>\\n <ComputeResource>8Core32GB</ComputeResource>\\n <ElasticIOResource>0</ElasticIOResource>\\n <VSwitchId>vsw-bp1syh8vvw8yech7nXXXX</VSwitchId>\\n <DBVersion>3.0</DBVersion>\\n <VPCCloudInstanceId>am-bp163885f8q21****-controller</VPCCloudInstanceId>\\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 <Category>MIXED_STORAGE</Category>\\n <Engine>AnalyticDB</Engine>\\n <InnerIp>10.1.xx.xx</InnerIp>\\n <InnerPort>3306</InnerPort>\\n </Items>\\n</DescribeDBClustersResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusters', + ], + 'DescribeDBClusterStatus' => [ + 'summary' => 'Queries the status of AnalyticDB for MySQL Data Warehouse Edition clusters within a region.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10803', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The status of clusters. 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' => '["Preparing","Creating","Restoring","Running","Deleting","ClassChanging","NetAddressCreating","NetAddressDeleting","NetAddressModifying","EngineVersionUpgrading"]', + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAU', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": [\\n \\"[\\\\\\"Preparing\\\\\\",\\\\\\"Creating\\\\\\",\\\\\\"Restoring\\\\\\",\\\\\\"Running\\\\\\",\\\\\\"Deleting\\\\\\",\\\\\\"ClassChanging\\\\\\",\\\\\\"NetAddressCreating\\\\\\",\\\\\\"NetAddressDeleting\\\\\\",\\\\\\"NetAddressModifying\\\\\\",\\\\\\"EngineVersionUpgrading\\\\\\"]\\"\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAU\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterStatusResponse>\\n <Status>Preparing</Status>\\n <Status>Creating</Status>\\n <Status>Restoring</Status>\\n <Status>Running</Status>\\n <Status>Deleting</Status>\\n <Status>ClassChanging</Status>\\n <Status>NetAddressCreating</Status>\\n <Status>NetAddressDeleting</Status>\\n <Status>NetAddressModifying</Status>\\n <Status>EngineVersionUpgrading</Status>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEAU</RequestId>\\n</DescribeDBClusterStatusResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterStatus', + ], + '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' => '10798', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp111m2cfrdl1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2895BB82-B2C1-408E-AA73-DB8D59******', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => 'The queried cluster information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried cluster information.'."\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' => '2021-04-01T09:50:18Z', + ], + 'EnableSpark' => [ + 'description' => 'Indicates whether a Spark cluster was created. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + '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' => 'dtsb1hp3790****', + ], + 'DBNodeCount' => [ + 'description' => 'The number of node groups.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Expired' => [ + 'description' => 'Indicates whether the cluster has expired. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\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. Example: *04:00Z-05:00Z*, which indicates that routine maintenance is performed from 04:00 to 05:00.'."\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' => 'Postpaid', + ], + '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_essd0**: PL0 Enterprise SSD (ESSD).'."\n" + .'* **cloud_essd**: PL1 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', + ], + '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 a tag to the cluster.'."\n", + 'type' => 'string', + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + 'Mode' => [ + 'description' => 'The mode of the cluster. Valid values:'."\n" + ."\n" + .'* **flexible**: elastic mode.'."\n" + .'* **reserver**: reserved mode.'."\n" + ."\n" + .'> For more information about cluster modes, see [Editions](~~205001~~).'."\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" + .'* **LockByRestoration**: The cluster is automatically locked due to cluster restoration.'."\n" + .'* **LockByDiskQuota**: The cluster is automatically locked when 90% of the cluster storage is used.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'EngineVersion' => [ + 'description' => 'The minor version of the cluster.'."\n", + 'type' => 'string', + 'example' => '3.1.1.9', + ], + 'EnableAirflow' => [ + 'description' => 'Indicates whether an Airflow cluster was created. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExecutorCount' => [ + 'description' => 'The number of compute nodes that are used by the cluster in elastic mode.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'StorageResource' => [ + 'description' => 'The specifications of storage resources that are used in the cluster in elastic mode. 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' => '8Core32GB', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp111m2cfrdl1****', + ], + 'ConnectionString' => [ + 'description' => 'The Virtual Private Cloud (VPC) endpoint that is used to connect to the cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp111m2cfrdl1****.ads.aliyuncs.com', + ], + '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-bp837jsdp2****', + ], + 'DBClusterType' => [ + 'description' => 'The type of the cluster. Valid values:'."\n" + ."\n" + .'* **Common**: common cluster.'."\n" + .'* **RDS_ANALYSIS**: MySQL analytic instance.'."\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', + ], + 'ExpireTime' => [ + 'description' => 'The expiration time of the cluster. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time is displayed in UTC. Example: *2999-09-08T16:00:00Z*.'."\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, **2999-09-08T16:00:00Z** is returned.'."\n", + 'type' => 'string', + 'example' => '2999-09-08T16:00:00Z', + ], + 'DBNodeStorage' => [ + 'description' => 'The storage capacity of the cluster. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'DBNodeClass' => [ + 'description' => 'The instance type of the cluster.'."\n", + 'type' => 'string', + 'example' => 'E8', + ], + '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_expired', + ], + 'VPCId' => [ + 'description' => 'The VPC ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp13h7uzhulpuxvnp****', + ], + 'ComputeResource' => [ + 'description' => 'The specifications of computing resources that are used in the cluster in elastic mode. 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' => '8Core32GB', + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ElasticIOResource' => [ + 'description' => 'The number of elastic I/O units (EIUs).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1syh8vvw8yech7n****', + ], + 'DBVersion' => [ + 'description' => 'The engine version of the cluster. **3.0** is returned.'."\n", + 'type' => 'string', + 'example' => '3.0', + ], + 'VPCCloudInstanceId' => [ + 'description' => 'The ID of the cluster that resides in the VPC.'."\n", + 'type' => 'string', + 'example' => 'am-bp111m2cfrdl1****-controller', + ], + 'DBClusterStatus' => [ + 'description' => 'The status of the cluster. For more information, see [Cluster states](~~143075~~).'."\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', + ], + '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' => 'true', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Category' => [ + 'description' => 'The edition of the cluster. 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', + ], + 'Engine' => [ + 'description' => 'The database engine of the cluster. **AnalyticDB** is returned.'."\n", + 'type' => 'string', + 'example' => 'AnalyticDB', + ], + '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****', + ], + 'InnerIp' => [ + 'description' => 'The public IP address of the cluster.'."\n", + 'type' => 'string', + 'example' => '10.1.XX.XX', + ], + 'InnerPort' => [ + 'description' => 'The public port number.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'DiskPerformanceLevel' => [ + 'description' => 'The ESSD performance level.'."\n", + 'type' => 'string', + 'example' => 'PL1', + ], + 'ElasticIOResourceSize' => [ + 'description' => 'The single-node specifications of an EIU. Valid values:'."\n" + ."\n" + .'* 8Core64GB: If this value is returned, the specifications of an EIU are 24 cores and 192 GB memory.'."\n" + .'* 12Core96GB: If this value is returned, the specifications of an EIU are 36 cores and 288 GB memory.'."\n", + 'type' => 'string', + 'example' => '8Core64GB', + ], + 'DiskEncryption' => [ + 'description' => 'Indicates whether disk encryption is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'TaskInfo' => [ + 'description' => 'The job information.'."\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', + ], + ], + ], + ], + ], + ], + ], + ], + 'ProductVersion' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'* **BasicVersion**: Basic Edition.'."\n" + .'* **EnterpriseVersion**: Enterprise Edition.'."\n", + 'type' => 'string', + 'example' => 'BasicVersion', + ], + 'SecondaryZoneId' => [ + 'type' => 'string', + '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", + 'example' => 'cn-zhangjiakou-b', + ], + 'SecondaryVSwitchId' => [ + 'type' => 'string', + '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", + 'example' => 'vsw-0jlb72a9dan1ja9cvg9tf', + ], + 'ReservedNodeSize' => [ + 'type' => 'string', + ], + 'ReservedNodeCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ProductForm' => [ + 'type' => 'string', + 'enum' => [ + 'IntegrationForm', + 'LegacyForm', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2895BB82-B2C1-408E-AA73-DB8D59******\\",\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"CreationTime\\": \\"2021-04-01T09:50:18Z\\",\\n \\"EnableSpark\\": false,\\n \\"DtsJobId\\": \\"dtsb1hp3790****\\",\\n \\"DBNodeCount\\": 1,\\n \\"Expired\\": \\"false\\",\\n \\"MaintainTime\\": \\"04:00Z-05:00Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DiskType\\": \\"cloud_essd\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"Mode\\": \\"flexible\\",\\n \\"Port\\": 3306,\\n \\"LockMode\\": \\"Unlock\\",\\n \\"EngineVersion\\": \\"3.1.1.9\\",\\n \\"EnableAirflow\\": true,\\n \\"ExecutorCount\\": \\"1\\",\\n \\"StorageResource\\": \\"8Core32GB\\",\\n \\"DBClusterId\\": \\"am-bp111m2cfrdl1****\\",\\n \\"ConnectionString\\": \\"am-bp111m2cfrdl1****.ads.aliyuncs.com\\",\\n \\"RdsInstanceId\\": \\"rm-bp837jsdp2****\\",\\n \\"DBClusterType\\": \\"Common\\",\\n \\"CommodityCode\\": \\"ads\\",\\n \\"ExpireTime\\": \\"2999-09-08T16:00:00Z\\",\\n \\"DBNodeStorage\\": 300,\\n \\"DBNodeClass\\": \\"E8\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"VPCId\\": \\"vpc-bp13h7uzhulpuxvnp****\\",\\n \\"ComputeResource\\": \\"8Core32GB\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ElasticIOResource\\": 2,\\n \\"VSwitchId\\": \\"vsw-bp1syh8vvw8yech7n****\\",\\n \\"DBVersion\\": \\"3.0\\",\\n \\"VPCCloudInstanceId\\": \\"am-bp111m2cfrdl1****-controller\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"DBClusterNetworkType\\": \\"vpc\\",\\n \\"DBClusterDescription\\": \\"adb_test\\",\\n \\"UserENIStatus\\": true,\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Category\\": \\"MIXED_STORAGE\\",\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"KmsId\\": \\"e1935511-cf88-1123-a0f8-1be8d251****\\",\\n \\"InnerIp\\": \\"10.1.XX.XX\\",\\n \\"InnerPort\\": \\"3306\\",\\n \\"DiskPerformanceLevel\\": \\"PL1\\",\\n \\"ElasticIOResourceSize\\": \\"8Core64GB\\",\\n \\"DiskEncryption\\": false,\\n \\"TaskInfo\\": {\\n \\"Name\\": \\"analyticDBFlexibleScaleOut\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Progress\\": \\"10\\",\\n \\"StepList\\": {\\n \\"StepList\\": [\\n {\\n \\"StepName\\": \\"ApplyResource\\",\\n \\"StepDesc\\": \\"Apply resource\\",\\n \\"StepStatus\\": \\"SUCCEED\\",\\n \\"StepProgress\\": \\"50\\",\\n \\"StartTime\\": \\"2024-03-10T09:28:34Z\\",\\n \\"EndTime\\": \\"2024-03-10T10:28:34Z\\"\\n }\\n ]\\n }\\n },\\n \\"ProductVersion\\": \\"BasicVersion\\",\\n \\"SecondaryZoneId\\": \\"cn-hangzhou-i\\",\\n \\"SecondaryVSwitchId\\": \\"vsw-0jlxwqt4531fsb3jdzx6h\\",\\n \\"ReservedNodeSize\\": \\"\\",\\n \\"ReservedNodeCount\\": 0,\\n \\"ProductForm\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterAttributeResponse>\\n <RequestId>2895BB82-B2C1-408E-AA73-DB8D59******</RequestId>\\n <Items>\\n <CreationTime>2021-04-01T09:50:18Z</CreationTime>\\n <EnableSpark>false</EnableSpark>\\n <DtsJobId>dtsb1hp3790****</DtsJobId>\\n <DBNodeCount>1</DBNodeCount>\\n <Expired>false</Expired>\\n <MaintainTime>04:00Z-05:00Z</MaintainTime>\\n <PayType>Postpaid</PayType>\\n <DiskType>cloud_essd</DiskType>\\n <Tags>\\n <Key>tag1</Key>\\n <Value>test1</Value>\\n </Tags>\\n <Mode>flexible</Mode>\\n <Port>3306</Port>\\n <LockMode>Unlock</LockMode>\\n <EngineVersion>3.1.1.9</EngineVersion>\\n <EnableAirflow>true</EnableAirflow>\\n <ExecutorCount>1</ExecutorCount>\\n <StorageResource>8Core32GB</StorageResource>\\n <DBClusterId>am-bp111m2cfrdl1****</DBClusterId>\\n <ConnectionString>am-bp111m2cfrdl1****.ads.aliyuncs.com</ConnectionString>\\n <RdsInstanceId>rm-bp837jsdp2****</RdsInstanceId>\\n <DBClusterType>Common</DBClusterType>\\n <CommodityCode>ads</CommodityCode>\\n <ExpireTime>2999-09-08T16:00:00Z</ExpireTime>\\n <DBNodeStorage>300</DBNodeStorage>\\n <DBNodeClass>E8</DBNodeClass>\\n <LockReason>instance_expired</LockReason>\\n <VPCId>vpc-bp13h7uzhulpuxvnp****</VPCId>\\n <ComputeResource>8Core32GB</ComputeResource>\\n <RegionId>cn-hangzhou</RegionId>\\n <ElasticIOResource>2</ElasticIOResource>\\n <VSwitchId>vsw-bp1syh8vvw8yech7n****</VSwitchId>\\n <DBVersion>3.0</DBVersion>\\n <VPCCloudInstanceId>am-bp111m2cfrdl1****-controller</VPCCloudInstanceId>\\n <DBClusterStatus>Running</DBClusterStatus>\\n <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>\\n <DBClusterNetworkType>vpc</DBClusterNetworkType>\\n <DBClusterDescription>adb_test</DBClusterDescription>\\n <UserENIStatus>true</UserENIStatus>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <Category>MIXED_STORAGE</Category>\\n <Engine>AnalyticDB</Engine>\\n <KmsId>e1935511-cf88-1123-a0f8-1be8d251****</KmsId>\\n <InnerIp>10.1.XX.XX</InnerIp>\\n <InnerPort>3306</InnerPort>\\n <DiskPerformanceLevel>PL1</DiskPerformanceLevel>\\n <ElasticIOResourceSize>8Core64GB</ElasticIOResourceSize>\\n </Items>\\n</DescribeDBClusterAttributeResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterAttribute', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAutoRenewAttribute' => [ + 'summary' => 'Queries the auto-renewal status of a subscription AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10788', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. Separate multiple clusters with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + '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, + '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 ID of the resource group.'."\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 per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoRenewAttribute' => [ + 'description' => 'The renewal information of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp11q28kvl688****', + ], + 'PeriodUnit' => [ + 'description' => 'The unit of the renewal duration. Valid values:'."\n" + ."\n" + .'* **Year**'."\n" + .'* **Month**'."\n", + 'type' => 'string', + 'example' => 'Year', + ], + 'Duration' => [ + 'description' => 'The renewal duration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RenewalStatus' => [ + 'description' => 'The renewal status of the cluster. 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. Three days before the cluster expires, the system sends you a reminder by SMS message to remind you that the cluster is not renewed. However, the system does not send you a reminder when the cluster expires.'."\n", + 'type' => 'string', + 'example' => 'AutoRenewal', + ], + 'AutoRenewEnabled' => [ + 'description' => 'Indicates whether auto-renewal is enabled for the cluster. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 20,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"AutoRenewAttribute\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\",\\n \\"PeriodUnit\\": \\"Year\\",\\n \\"Duration\\": 1,\\n \\"RenewalStatus\\": \\"AutoRenewal\\",\\n \\"AutoRenewEnabled\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TotalRecordCount>20</TotalRecordCount>\\n<PageRecordCount>30</PageRecordCount>\\n<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<PageNumber>1</PageNumber>\\n<Items>\\n <AutoRenewAttribute>\\n <AutoRenewEnabled>true</AutoRenewEnabled>\\n <RenewalStatus>AutoRenewal</RenewalStatus>\\n <DBClusterId>am-bp11q28kvl688****</DBClusterId>\\n <Duration>1</Duration>\\n <RegionId>cn-hangzhou</RegionId>\\n <PeriodUnit>Year</PeriodUnit>\\n </AutoRenewAttribute>\\n</Items>","errorExample":""}]', + 'title' => 'DescribeAutoRenewAttribute', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAvailableResource' => [ + 'summary' => 'Queries the resources of clusters within zones of a region.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* **PrePaid**: subscription.'."\n" + .'* **PostPaid**: pay-as-you-go.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'PostPaid', + 'default' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of query results. Valid values:'."\n" + ."\n" + .'* **zh-CN** (default): Chinese.'."\n" + .'* **en-US**: English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The supported regions.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'AvailableZoneList' => [ + 'description' => 'The supported zones.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The supported zones.'."\n", + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'SupportedMode' => [ + 'description' => 'The supported modes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The supported mode.', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'description' => 'The supported mode. Valid values:'."\n" + ."\n" + .'* **flexible**: elastic mode.'."\n" + .'* **reserver**: reserved mode.'."\n", + 'type' => 'string', + 'example' => 'flexible', + ], + 'SupportedSerialList' => [ + 'description' => 'The supported editions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The supported edition.', + 'type' => 'object', + 'properties' => [ + 'Serial' => [ + 'description' => 'The supported edition. Valid values:'."\n" + ."\n" + .'* **basic**: Basic Edition.'."\n" + .'* **cluster**: Cluster Edition.'."\n" + .'* **mixed_storage**: elastic mode for Cluster Edition.'."\n", + 'type' => 'string', + 'example' => 'mixed_storage', + ], + 'SupportedFlexibleResource' => [ + 'description' => 'The supported resources in elastic mode.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The supported resources in elastic mode', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'description' => 'The disk storage type. Valid values:'."\n" + ."\n" + .'* **hdd**'."\n" + .'* **ssd**'."\n", + 'type' => 'string', + 'example' => 'hdd', + ], + 'SupportedComputeResource' => [ + 'description' => 'The supported computing resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The specifications of supported computing resources.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "8Core32GB",'."\n" + .' "16Core64GB",'."\n" + .' "16Core64GBNEW",'."\n" + .' "24Core96GBNEW",'."\n" + .' "32Core128GBNEW",'."\n" + .' "48Core192GBNEW",'."\n" + .' "64Core256GBNEW",'."\n" + .' "80Core320GBNEW",'."\n" + .' "96Core384GBNEW",'."\n" + .' "128Core512GBNEW",'."\n" + .' "160Core640GBNEW",'."\n" + .' "192Core768GBNEW",'."\n" + .' "224Core896GBNEW",'."\n" + .' "256Core1024GBNEW",'."\n" + .' "288Core1152GBNEW",'."\n" + .' "320Core1280GBNEW",'."\n" + .' "384Core1536GBNEW",'."\n" + .' "416Core1664GBNEW",'."\n" + .' "448Core1792GBNEW",'."\n" + .' "480Core1920GBNEW",'."\n" + .' "512Core2048GBNEW",'."\n" + .' "576Core2304GBNEW",'."\n" + .' "640Core2560GBNEW",'."\n" + .' "768Core3072GBNEW",'."\n" + .' "800Core3200GBNEW",'."\n" + .' "896Core3584GBNEW",'."\n" + .' "960Core3840GBNEW",'."\n" + .' "1024Core4096GBNEW",'."\n" + .' "1120Core4480GBNEW",'."\n" + .' "1280Core5120GBNEW",'."\n" + .' "1440Core5760GBNEW",'."\n" + .' "1600Core6400GBNEW",'."\n" + .' "1792Core7168GBNEW",'."\n" + .' "1920Core7680GBNEW",'."\n" + .' "2048Core8192GBNEW",'."\n" + .' "2400Core9600GBNEW",'."\n" + .' "2560Core10240GBNEW",'."\n" + .' "2880Core11520GBNEW",'."\n" + .' "3200Core12800GBNEW",'."\n" + .' "4800Core19200GBNEW",'."\n" + .' "5600Core22400GBNEW",'."\n" + .' "6400Core25600GBNEW",'."\n" + .' "8000Core32000GBNEW",'."\n" + .' "8800Core35200GBNEW",'."\n" + .' "9600Core38400GBNEW"'."\n" + .' ]', + ], + ], + 'SupportedStorageResource' => [ + 'description' => 'The supported storage resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The supported storage resources.', + 'type' => 'string', + 'example' => 'N/A', + ], + ], + 'SupportedElasticIOResource' => [ + 'description' => 'The supported elastic I/O resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'description' => 'The step size.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'MinCount' => [ + 'description' => 'The minimum amount of elastic I/O resources.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'MaxCount' => [ + 'description' => 'The maximum amount of elastic I/O resources.'."\n", + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + 'SupportedInstanceClassList' => [ + 'description' => 'The supported resources in reserved mode.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The supported resources in reserved mode.', + 'type' => 'object', + 'properties' => [ + 'InstanceClass' => [ + 'description' => 'The supported instance type.'."\n", + 'type' => 'string', + 'example' => 'C32', + ], + 'Tips' => [ + 'description' => 'The description of the instance type.'."\n", + 'type' => 'string', + 'example' => 'C32', + ], + 'SupportedNodeCountList' => [ + 'description' => 'The supported compute nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The supported compute nodes.', + 'type' => 'object', + 'properties' => [ + 'StorageSize' => [ + 'description' => 'The support storage capacity. Unit: GB.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The support storage capacity. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + 'NodeCount' => [ + 'description' => 'The number of the supported compute nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'description' => 'The step size.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'MinCount' => [ + 'description' => 'The minimum number of compute nodes.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'MaxCount' => [ + 'description' => 'The maximum number of compute nodes.'."\n", + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + 'SupportedExecutorList' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A reserved parameter.', + 'type' => 'object', + 'properties' => [ + 'NodeCount' => [ + 'description' => 'The information about the supported compute nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'N/A', + ], + 'MinCount' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'N/A', + ], + 'MaxCount' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'N/A', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'SupportedComputeResource' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'N/A', + ], + ], + 'SupportedStorageResource' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'N/A', + ], + ], + 'ZoneName' => [ + 'type' => 'string', + 'description' => 'The name of the zone.'."\n", + 'example' => 'cn-hangzhou-k', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"AvailableZoneList\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"SupportedMode\\": [\\n {\\n \\"Mode\\": \\"flexible\\",\\n \\"SupportedSerialList\\": [\\n {\\n \\"Serial\\": \\"mixed_storage\\",\\n \\"SupportedFlexibleResource\\": [\\n {\\n \\"StorageType\\": \\"hdd\\",\\n \\"SupportedComputeResource\\": [\\n \\"[\\\\n \\\\\\"8Core32GB\\\\\\",\\\\n \\\\\\"16Core64GB\\\\\\",\\\\n \\\\\\"16Core64GBNEW\\\\\\",\\\\n \\\\\\"24Core96GBNEW\\\\\\",\\\\n \\\\\\"32Core128GBNEW\\\\\\",\\\\n \\\\\\"48Core192GBNEW\\\\\\",\\\\n \\\\\\"64Core256GBNEW\\\\\\",\\\\n \\\\\\"80Core320GBNEW\\\\\\",\\\\n \\\\\\"96Core384GBNEW\\\\\\",\\\\n \\\\\\"128Core512GBNEW\\\\\\",\\\\n \\\\\\"160Core640GBNEW\\\\\\",\\\\n \\\\\\"192Core768GBNEW\\\\\\",\\\\n \\\\\\"224Core896GBNEW\\\\\\",\\\\n \\\\\\"256Core1024GBNEW\\\\\\",\\\\n \\\\\\"288Core1152GBNEW\\\\\\",\\\\n \\\\\\"320Core1280GBNEW\\\\\\",\\\\n \\\\\\"384Core1536GBNEW\\\\\\",\\\\n \\\\\\"416Core1664GBNEW\\\\\\",\\\\n \\\\\\"448Core1792GBNEW\\\\\\",\\\\n \\\\\\"480Core1920GBNEW\\\\\\",\\\\n \\\\\\"512Core2048GBNEW\\\\\\",\\\\n \\\\\\"576Core2304GBNEW\\\\\\",\\\\n \\\\\\"640Core2560GBNEW\\\\\\",\\\\n \\\\\\"768Core3072GBNEW\\\\\\",\\\\n \\\\\\"800Core3200GBNEW\\\\\\",\\\\n \\\\\\"896Core3584GBNEW\\\\\\",\\\\n \\\\\\"960Core3840GBNEW\\\\\\",\\\\n \\\\\\"1024Core4096GBNEW\\\\\\",\\\\n \\\\\\"1120Core4480GBNEW\\\\\\",\\\\n \\\\\\"1280Core5120GBNEW\\\\\\",\\\\n \\\\\\"1440Core5760GBNEW\\\\\\",\\\\n \\\\\\"1600Core6400GBNEW\\\\\\",\\\\n \\\\\\"1792Core7168GBNEW\\\\\\",\\\\n \\\\\\"1920Core7680GBNEW\\\\\\",\\\\n \\\\\\"2048Core8192GBNEW\\\\\\",\\\\n \\\\\\"2400Core9600GBNEW\\\\\\",\\\\n \\\\\\"2560Core10240GBNEW\\\\\\",\\\\n \\\\\\"2880Core11520GBNEW\\\\\\",\\\\n \\\\\\"3200Core12800GBNEW\\\\\\",\\\\n \\\\\\"4800Core19200GBNEW\\\\\\",\\\\n \\\\\\"5600Core22400GBNEW\\\\\\",\\\\n \\\\\\"6400Core25600GBNEW\\\\\\",\\\\n \\\\\\"8000Core32000GBNEW\\\\\\",\\\\n \\\\\\"8800Core35200GBNEW\\\\\\",\\\\n \\\\\\"9600Core38400GBNEW\\\\\\"\\\\n ]\\"\\n ],\\n \\"SupportedStorageResource\\": [\\n \\"无\\"\\n ],\\n \\"SupportedElasticIOResource\\": {\\n \\"Step\\": \\"1\\",\\n \\"MinCount\\": \\"0\\",\\n \\"MaxCount\\": \\"200\\"\\n }\\n }\\n ],\\n \\"SupportedInstanceClassList\\": [\\n {\\n \\"InstanceClass\\": \\"C32\\",\\n \\"Tips\\": \\"C32\\",\\n \\"SupportedNodeCountList\\": [\\n {\\n \\"StorageSize\\": [\\n \\"100\\"\\n ],\\n \\"NodeCount\\": {\\n \\"Step\\": \\"1\\",\\n \\"MinCount\\": \\"1\\",\\n \\"MaxCount\\": \\"200\\"\\n }\\n }\\n ],\\n \\"SupportedExecutorList\\": [\\n {\\n \\"NodeCount\\": {\\n \\"Step\\": \\"无\\",\\n \\"MinCount\\": \\"无\\",\\n \\"MaxCount\\": \\"无\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"SupportedComputeResource\\": [\\n \\"无\\"\\n ],\\n \\"SupportedStorageResource\\": [\\n \\"无\\"\\n ],\\n \\"ZoneName\\": \\"杭州可用区A\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAvailableResourceResponse>\\n <RegionId>cn-hangzhou</RegionId>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <AvailableZoneList>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <SupportedMode>\\n <Mode>flexible</Mode>\\n <SupportedSerialList>\\n <Serial>mixed_storage</Serial>\\n <SupportedFlexibleResource>\\n <StorageType>hdd</StorageType>\\n <SupportedComputeResource>32Core128GB</SupportedComputeResource>\\n <SupportedElasticIOResource>\\n <Step>1</Step>\\n <MinCount>0</MinCount>\\n <MaxCount>200</MaxCount>\\n </SupportedElasticIOResource>\\n </SupportedFlexibleResource>\\n <SupportedInstanceClassList>\\n <InstanceClass>C32</InstanceClass>\\n <Tips>C32</Tips>\\n <SupportedNodeCountList>\\n <StorageSize>100</StorageSize>\\n <NodeCount>\\n <Step>1</Step>\\n <MinCount>1</MinCount>\\n <MaxCount>200</MaxCount>\\n </NodeCount>\\n </SupportedNodeCountList>\\n </SupportedInstanceClassList>\\n </SupportedSerialList>\\n </SupportedMode>\\n </AvailableZoneList>\\n</DescribeAvailableResourceResponse>","errorExample":""}]', + 'title' => 'DescribeAvailableResource', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeComputeResource' => [ + 'summary' => 'Queries the specifications of computing resources for AnalyticDB for MySQL Data Warehouse Edition clusters within a region.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the AnalyticDB for MySQL Data Warehouse Edition cluster. Set the value to **3.0**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3.0', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~129857~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-f', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'Migrate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the specifications of the available computing resources that are migrated from AnalyticDB for MySQL Data Warehouse Edition to Data Lakehouse Edition. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ComputeResource' => [ + 'description' => 'The queried specifications of computing resources.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayValue' => [ + 'description' => 'The specifications of computing resources displayed in the console.'."\n", + 'type' => 'string', + 'example' => '8 Core 32 GB', + ], + 'RealValue' => [ + 'description' => 'The actual specifications of computing resources.'."\n", + 'type' => 'string', + 'example' => '8 Core 32 GB', + ], + ], + 'description' => 'The specifications of computing resources.'."\n" + ."\n" + .'> You can call the [DescribeComputeResource](~~469002~~) operation to query the specifications of computing resources.'."\n", + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEAW', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ComputeResource\\": [\\n {\\n \\"DisplayValue\\": \\"8 Core 32 GB（单机版）\\",\\n \\"RealValue\\": \\"8 Core 32 GB\\"\\n }\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEAW\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeComputeResourceResponse>\\n <ComputeResource>\\n <DisplayValue>8 Core 32 GB（单机版）</DisplayValue>\\n <RealValue>8 Core 32 GB</RealValue>\\n </ComputeResource>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEAW</RequestId>\\n</DescribeComputeResourceResponse>","errorExample":""}]', + 'title' => 'DescribeComputeResource', + ], + 'DescribeEIURange' => [ + 'summary' => 'Queries the range for the number of elastic I/O units (EIUs) for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'* This parameter can be left empty when **Operation** is set to **Buy**.'."\n" + .'* This parameter must be specified when **Operation** is set to **Upgrade** or **Downgrade**.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp16t5ci7r74s****', + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The specifications of computing resources.'."\n" + ."\n" + .'> You can call the [DescribeComputeResource](~~469002~~) operation to query the specifications of computing resources.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "RealValue": "32Core128GBNEW",'."\n" + .' "DisplayValue": "32Core128GB"'."\n" + .' }', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The type of the operation. Valid values:'."\n" + ."\n" + .'* **Buy**: purchases a cluster.'."\n" + .'* **Modify**: changes configurations of a cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Buy', + 'default' => 'buy', + 'enum' => [], + ], + ], + [ + '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' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the AnalyticDB for MySQL Data Warehouse Edition cluster. Set the value to **3.0**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3.0', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~612293~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of storage resources. Default value: **8ACU**. Valid values:'."\n" + ."\n" + .'* **8ACU**'."\n" + .'* **12ACU**'."\n" + .'* **16ACU**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8ACU', + ], + ], + [ + 'name' => 'SubOperation', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the sub-operation. Valid values:'."\n" + ."\n" + .'* **Upgrade**: upgrades a cluster.'."\n" + .'* **Downgrade**: downgrades a cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'ProductVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'type' => 'string', + 'enum' => [ + 'BasicVersion', + 'EnterpriseVersion', + 'basic_version', + 'enterprise_version', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EIUInfo' => [ + 'description' => 'The queried information about the number of EIUs.'."\n", + 'type' => 'object', + 'properties' => [ + 'EIURange' => [ + 'description' => 'The queried range for the number of EIUs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The number of EIUs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1,2,3,4,...200', + ], + ], + 'DefaultValue' => [ + 'description' => 'The suggested value for the number of EIUs.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'StorageResourceRange' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + ], + 'MinValue' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'none'."\n", + ], + 'MaxValue' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'none'."\n", + ], + 'Step' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'none'."\n", + ], + 'DefaultReservedNodeSize' => [ + 'type' => 'string', + ], + 'ReservedNodeSizeRange' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EIUInfo\\": {\\n \\"EIURange\\": [\\n 0\\n ],\\n \\"DefaultValue\\": \\"2\\",\\n \\"StorageResourceRange\\": [\\n \\"none\\"\\n ],\\n \\"MinValue\\": \\"none\\\\n\\",\\n \\"MaxValue\\": \\"none\\\\n\\",\\n \\"Step\\": \\"none\\\\n\\",\\n \\"DefaultReservedNodeSize\\": \\"none\\",\\n \\"ReservedNodeSizeRange\\": [\\n \\"none\\"\\n ]\\n },\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ET****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeEIURangeResponse>\\n <EIUInfo>\\n <DefaultValue>2</DefaultValue>\\n </EIUInfo>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n</DescribeEIURangeResponse>","errorExample":""}]', + 'title' => 'DescribeEIURange', + ], + 'AttachUserENI' => [ + 'summary' => '打通用户ENI', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10760', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'The specified instance state does not support this operation.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachUserENIResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</AttachUserENIResponse>","errorExample":""}]', + 'title' => 'AttachUserENI', + 'description' => 'You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in elastic mode for Cluster Edition.', + ], + 'DetachUserENI' => [ + 'summary' => 'Detaches an elastic network interface (ENI) from 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' => '10831', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachUserENIResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</DetachUserENIResponse>","errorExample":""}]', + 'title' => 'DetachUserENI', + 'description' => 'You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in elastic mode for Cluster Edition.', + ], + 'DescribeKernelVersion' => [ + 'summary' => 'Queries the information about the minor version 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' => '216345', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n" + .'> You can call the DescribeRegions operation to query the most recent region list.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + '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-DD HH:mm:ss 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' => '2023-06-01T10:36:30Z', + ], + 'AvailableKernelVersions' => [ + 'description' => 'The minor versions to which you can update the current minor version of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + '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-DD HH:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-06-01T10:36:30Z'."\n", + ], + 'ExpireDate' => [ + 'description' => 'The maintenance expiration time of the version. The time follows the ISO 8601 standard in the yyyy-MM-DD HH:mm:ss 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' => '2024-06-01T10:36:30Z', + ], + ], + ], + ], + ], + '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\\": \\"2023-06-01T10:36:30Z\\",\\n \\"AvailableKernelVersions\\": [\\n {\\n \\"KernelVersion\\": \\"3.1.9\\",\\n \\"ReleaseDate\\": \\"2023-06-01T10:36:30Z\\\\n\\",\\n \\"ExpireDate\\": \\"2024-06-01T10:36:30Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeKernelVersion', + ], + 'UpgradeKernelVersion' => [ + 'summary' => 'Updates the minor version 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' => '216466', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612241~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.'."\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' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'The specified instance state does not support this operation.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => 'UpgradeKernelVersion', + ], + 'MigrateDBCluster' => [ + 'summary' => 'Migrates data from a Data Warehouse Edition cluster to a Data Lakehouse Edition or Enterprise Edition cluster in AnalyticDB for MySQL.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '187415', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The amount of reserved computing resources.'."\n" + .'Valid values: 0ACU to 4096ACU. Step size: 16. Each AnalyticDB compute unit (ACU) is approximately equal to 1 core and 4 GB memory.', + 'type' => 'string', + 'required' => false, + 'example' => '32ACU', + ], + ], + [ + 'name' => 'StorageResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The amount of reserved storage resources. Valid values: 0ACU to 2064ACU. The value must be in increments of the number of ACUs specified by the StorageResourceSize parameter × 3 (default value: 24ACU). Each ACU is approximately equal to 1 core and 4 GB memory.'."\n" + ."\n" + .'> This parameter must be specified with a unit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '24ACU', + ], + ], + [ + 'name' => 'StorageResourceSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node specifications of reserved storage resources. Valid values: 8ACU, 12ACU, and 16ACU.', + 'type' => 'string', + 'required' => false, + 'example' => '8ACU', + ], + ], + [ + 'name' => 'ShardNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of shards that you want to change during the data migration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '128', + ], + ], + [ + 'name' => 'ReservedNodeSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => '8ACU', + ], + ], + [ + 'name' => 'ReservedNodeCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'ProductVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'ProductForm', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'example' => 'LegacyForm', + 'default' => 'LegacyForm', + 'enum' => [ + 'IntegrationForm', + 'LegacyForm', + ], + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'SecondaryVSwitchId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'The specified instance state does not support this operation.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\"\\n}","type":"json"}]', + 'title' => 'MigrateDBCluster', + ], + 'CreateDBResourcePool' => [ + 'summary' => '创建资源组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10769', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'PoolName', + '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, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode in which to execute SQL statements.'."\n" + ."\n" + .'* **batch**'."\n" + ."\n" + .'* **interactive**'."\n" + ."\n" + .'> For more information, see [Query execution modes](~~189502~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'interactive', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes. Default value: 0.'."\n" + ."\n" + .'* Each node provides 16 cores and 64 GB memory.'."\n" + .'* The total amount of resources provided by the nodes (number of nodes × 16 cores, number of nodes × 64 GB memory) cannot exceed the total amount of resources in the cluster. Set this parameter to a proper value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4294967296', + 'minimum' => '0', + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDBResourcePoolResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</CreateDBResourcePoolResponse>","errorExample":""}]', + 'title' => 'CreateDBResourcePool', + 'description' => 'This operation is applicable only for elastic clusters of 32 cores or more.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDBResourcePool' => [ + 'summary' => 'Deletes a resource group. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition clusters in elastic mode for Cluster Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10778', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBResourcePoolResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</DeleteDBResourcePoolResponse>","errorExample":""}]', + 'title' => 'DeleteDBResourcePool', + 'description' => '**Precautions**'."\n" + ."\n" + .'* This operation is available only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition that have 32 cores or more.'."\n" + .'* The default resource group USER_DEFAULT cannot be deleted.'."\n", + ], + 'ModifyDBResourcePool' => [ + 'summary' => 'Modifies the resources of a resource group. This operation is available only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10850', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode in which SQL statements are executed. Valid values:'."\n" + ."\n" + .'* **batch**'."\n" + .'* **interactive**'."\n" + ."\n" + .'> If you do not specify this parameter, the original value is retained.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'batch', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes.'."\n" + ."\n" + .'* Each node provides 16 cores and 64 GB memory.'."\n" + .'* The amount of resources that you want to add to or remove from the cluster cannot exceed the total amount of resources in the cluster.'."\n" + ."\n" + .'> - If you do not specify this parameter, the original value is retained.'."\n" + .'> - You must specify at least one of the QueryType and NodeNum parameters.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4294967296', + 'minimum' => '0', + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBResourcePoolResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</ModifyDBResourcePoolResponse>","errorExample":""}]', + 'title' => 'ModifyDBResourcePool', + 'description' => '###'."\n" + ."\n" + .'* You can call this operation only for elastic clusters of 32 cores or more.'."\n" + .'* You cannot change the number of nodes for the USER_DEFAULT resource group.'."\n", + ], + 'DescribeDBResourcePool' => [ + 'summary' => 'Queries the information about resource groups of an AnalyticDB for MySQL cluster. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition clusters in elastic mode for Cluster Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10804', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'USER_DEFAULT', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PoolsInfo' => [ + 'description' => 'Details of the resource group.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'QueryType' => [ + 'description' => 'The mode in which SQL statements are executed.'."\n" + ."\n" + .'* **batch**'."\n" + .'* **interactive**'."\n" + ."\n" + .'> For more information, see [Query execution modes](~~189502~~).'."\n", + 'type' => 'string', + 'example' => 'default_type', + ], + 'UpdateTime' => [ + 'description' => 'The time when the resource group was updated.'."\n", + 'type' => 'string', + 'example' => '2022-03-09 16:57:35.241', + ], + 'PoolName' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'USER_DEFAULT', + ], + 'CreateTime' => [ + 'description' => 'The time when the resource group was created.'."\n", + 'type' => 'string', + 'example' => '2022-03-09 16:57:35.241', + ], + 'PoolUsers' => [ + 'description' => 'The database accounts that are associated with the resource group.'."\n", + 'type' => 'string', + 'example' => 'testb,testc', + ], + 'NodeNum' => [ + 'description' => 'The number of nodes.'."\n" + ."\n" + .'> Each node consumes 16 cores and 64 GB memory.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp11q28kvl688****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PoolsInfo\\": [\\n {\\n \\"QueryType\\": \\"default_type\\",\\n \\"UpdateTime\\": \\"2022-03-09 16:57:35.241\\",\\n \\"PoolName\\": \\"USER_DEFAULT\\",\\n \\"CreateTime\\": \\"2022-03-09 16:57:35.241\\",\\n \\"PoolUsers\\": \\"testb,testc\\",\\n \\"NodeNum\\": 2\\n }\\n ],\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBResourcePoolResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <PoolsInfo>\\n <QueryType>default_type</QueryType>\\n <UpdateTime>2022-03-09 16:57:35.241</UpdateTime>\\n <PoolName>USER_DEFAULT</PoolName>\\n <CreateTime>2022-03-09 16:57:35.241</CreateTime>\\n <PoolUsers>testb,testc</PoolUsers>\\n <NodeNum>2</NodeNum>\\n </PoolsInfo>\\n <DBClusterId>am-bp11q28kvl688****</DBClusterId>\\n</DescribeDBResourcePoolResponse>","errorExample":""}]', + 'title' => 'DescribeDBResourcePool', + 'description' => 'This operation is applicable only for elastic clusters of 32 cores or more.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindDBResourcePoolWithUser' => [ + 'summary' => 'Associates a resource group with a database account. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition clusters in elastic mode for Cluster Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10761', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'PoolUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account with which to associate the resource group. It can be a standard account or a privileged account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'accout', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<BindDBResourcePoolWithUserResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</BindDBResourcePoolWithUserResponse>","errorExample":""}]', + 'title' => 'BindDBResourcePoolWithUser', + 'description' => '* This operation is available only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition that have 32 cores or more.'."\n" + .'* The default resource group USER_DEFAULT cannot be associated with a database account.', + ], + 'UnbindDBResourcePoolWithUser' => [ + 'summary' => 'Disassociates a database account from a resource group. This operation can be called only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10866', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bpxxxxxxxx47', + ], + ], + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'PoolUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account with which the resource group is associated.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testb', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbindDBResourcePoolWithUserResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</UnbindDBResourcePoolWithUserResponse>","errorExample":""}]', + 'title' => 'UnbindDBResourcePoolWithUser', + ], + 'CreateDBResourceGroup' => [ + 'summary' => 'Creates a resource group for an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136468', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + '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 an uppercase letter or a digit.'."\n" + .'* The name can contain uppercase letters, digits, hyphens (-), and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query execution mode. Valid values:'."\n" + ."\n" + .'* **interactive** (default)'."\n" + .'* **batch**'."\n" + .'* **job**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'interactive', + ], + ], + [ + 'name' => 'MinComputeResource', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The minimum amount of reserved computing resources. Unit: AnalyticDB compute unit (ACU).'."\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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0ACU', + ], + ], + [ + 'name' => 'MaxComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum amount of reserved computing resources, which refers to the amount of resources that are not allocated in the cluster. Unit: ACU.'."\n" + ."\n" + .'* When GroupType is set to interactive, set this parameter to a value in increments of 16ACU.'."\n" + .'* When GroupType is set to job, set this parameter to a value in increments of 8ACU.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32ACU', + ], + ], + [ + 'name' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource specifications of a single compute cluster. Unit: ACU.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '16ACU', + ], + ], + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of compute clusters that are required in the resource group. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of compute clusters that are allowed in the resource group. Maximum value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The working mode of the resource group. Valid values:'."\n" + ."\n" + .'* **Disable** (default)'."\n" + .'* **AutoScale**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AutoScale', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The engine of the resource group. Valid values:'."\n" + ."\n" + .'* **AnalyticDB** (default)'."\n" + .'* **SparkWarehouse**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AnalyticDB', + ], + ], + [ + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The Spark application configuration parameters that can be applied to all Spark jobs executed in the resource group. If you want to configure parameters for a specific Spark job, you can specify values for the parameters in the code editor when you submit the job.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes. Default value: 0.'."\n" + ."\n" + .'* Each node is configured with the resources of 16 cores and 64 GB memory.'."\n" + .'* Make sure that the amount of resources of the nodes (Number of nodes × 16 cores and 64 GB memory) is less than or equal to the amount of unused resources of the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4294967296', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterStatus', + 'errorMessage' => 'The operation is not permitted due to cluster status.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDBResourceGroupResponse>\\n <RequestId>3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8</RequestId>\\n</CreateDBResourceGroupResponse>","errorExample":""}]', + 'title' => 'CreateDBResourceGroup', + 'description' => 'This operation is suitable for the following editions:'."\n" + ."\n" + .'* **Enterprise Edition**.'."\n" + .'* **Basic Edition**.'."\n" + .'* **Data Lakehouse Edition**.'."\n" + .'* **Data Warehouse Edition in elastic mode**: 32 cores and 128 GB or more.'."\n", + ], + 'BindDBResourceGroupWithUser' => [ + 'summary' => 'Associates a resource group of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster with a database account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136470', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'GroupUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account with which to associate the resource group. It can be a standard account or a privileged account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'accout', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UserAndPoolAlreadyBind', + 'errorMessage' => 'The specified user already binds the resource pool.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<BindDBResourceGroupWithUserResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</BindDBResourceGroupWithUserResponse>","errorExample":""}]', + 'title' => 'BindDBResourceGroupWithUser', + 'description' => '## Precautions'."\n" + ."\n" + .'* This operation is applicable only for elastic clusters of 32 cores or more.'."\n" + .'* The default resource group USER_DEFAULT cannot be associated with a database account.'."\n", + ], + 'UnbindDBResourceGroupWithUser' => [ + 'summary' => 'Disassociates a resource group of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster from a database account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136469', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'GroupUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account with which the resource group is associated.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'accout', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbindDBResourceGroupWithUserResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</UnbindDBResourceGroupWithUserResponse>","errorExample":""}]', + 'title' => 'UnbindDBResourceGroupWithUser', + ], + 'DescribeDBResourceGroup' => [ + 'summary' => 'Queries the information about a resource group 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' => '136466', + 'abilityTreeNodes' => [ + 'FEATUREadsQ3E0F2', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'USER_DEFAULT', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'GroupsInfo' => [ + 'description' => 'The queried resource group.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupType' => [ + 'description' => 'The query execution mode. Valid values:'."\n" + ."\n" + .'* **interactive** (default)'."\n" + .'* **batch**'."\n" + .'* **job**'."\n", + 'type' => 'string', + 'example' => 'interactive', + ], + 'UpdateTime' => [ + 'description' => 'The time when the resource group was updated.'."\n", + 'type' => 'string', + 'example' => '2022-11-09 16:57:35.241', + ], + 'GroupName' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'USER_DEFAULT', + ], + 'MinComputeResource' => [ + 'description' => 'The minimum amount of reserved computing resources. Unit: AnalyticDB compute unit (ACU).'."\n" + ."\n" + .'* If the value of GroupType is **interactive**, 16ACU is returned.'."\n" + .'* If the value of GroupType is **job**, 0ACU is returned.'."\n", + 'type' => 'string', + 'example' => '0ACU', + ], + 'MaxComputeResource' => [ + 'description' => 'The maximum amount of reserved computing resources, which refers to the amount of resources that are not allocated in the cluster. Unit: ACU.'."\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 16ACU.'."\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 8ACU.'."\n", + 'type' => 'string', + 'example' => '32ACU', + ], + 'ClusterSizeResource' => [ + 'description' => 'The resource specifications of a single compute cluster. Unit: ACU.'."\n", + 'type' => 'string', + 'example' => '16ACU', + ], + 'MinClusterCount' => [ + 'description' => 'The minimum number of compute clusters that are required in the resource group. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxClusterCount' => [ + 'description' => 'The maximum number of compute clusters that are allowed in the resource group. Maximum value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'RunningClusterCount' => [ + 'description' => 'The number of compute clusters running in the resource group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ClusterMode' => [ + 'description' => 'The working mode of the resource group. Valid values:'."\n" + ."\n" + .'* **Disable** (default)'."\n" + .'* **AutoScale**'."\n", + 'type' => 'string', + 'example' => 'AutoScale', + ], + 'ElasticMinComputeResource' => [ + 'description' => 'The minimum amount of elastic computing resources. Unit: ACU.'."\n", + 'type' => 'string', + 'example' => '16ACU', + ], + 'CreateTime' => [ + 'description' => 'The time when the resource group was created.'."\n", + 'type' => 'string', + 'example' => '2022-10-09 16:57:35.241', + ], + 'GroupUsers' => [ + 'description' => 'The database accounts that are associated with the resource group. Multiple database accounts are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'testb,testc', + ], + 'NodeNum' => [ + 'description' => 'The number of nodes. Each node provides 16 cores and 64 GB memory.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GroupUserList' => [ + 'description' => 'The database accounts that are associated with the resource group.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The database account that is associated with the resource group.'."\n", + 'type' => 'string', + 'example' => 'user1', + ], + ], + 'Engine' => [ + 'description' => 'The engine of the resource group. Valid values:'."\n" + ."\n" + .'* **AnalyticDB** (default)'."\n" + .'* **SparkWarehouse**'."\n", + 'type' => 'string', + 'example' => 'AnalyticDB', + ], + 'EngineParams' => [ + 'description' => 'The Spark application configuration parameters that can be applied to all Spark jobs executed in the resource group. If you want to configure parameters for a specific Spark job, you can specify values for the parameters in the code editor when you submit the job.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* **Pending**'."\n" + .'* **Running**'."\n" + .'* **Scaling**'."\n" + .'* **Deleting**'."\n" + .'* **Deleted**'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint of the resource group.'."\n" + ."\n" + .'> This parameter is returned only when the value of Engine is SparkWarehouse.'."\n", + 'type' => 'string', + 'example' => 'amv-bp1nw64y******.ads.aliyuncs.com', + ], + 'Port' => [ + 'description' => 'The port number of the resource group.'."\n" + ."\n" + .'> This parameter is returned only when the value of Engine is SparkWarehouse.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + ], + ], + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp1ub9grke1****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"GroupsInfo\\": [\\n {\\n \\"GroupType\\": \\"interactive\\",\\n \\"UpdateTime\\": \\"2022-11-09 16:57:35.241\\",\\n \\"GroupName\\": \\"USER_DEFAULT\\",\\n \\"MinComputeResource\\": \\"0ACU\\",\\n \\"MaxComputeResource\\": \\"32ACU\\",\\n \\"ClusterSizeResource\\": \\"16ACU\\",\\n \\"MinClusterCount\\": 1,\\n \\"MaxClusterCount\\": 4,\\n \\"RunningClusterCount\\": 2,\\n \\"ClusterMode\\": \\"AutoScale\\",\\n \\"ElasticMinComputeResource\\": \\"16ACU\\",\\n \\"CreateTime\\": \\"2022-10-09 16:57:35.241\\",\\n \\"GroupUsers\\": \\"testb,testc\\",\\n \\"NodeNum\\": 2,\\n \\"GroupUserList\\": [\\n \\"user1\\"\\n ],\\n \\"Engine\\": \\"AnalyticDB\\",\\n \\"EngineParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Status\\": \\"Running\\",\\n \\"ConnectionString\\": \\"amv-bp1nw64y******.ads.aliyuncs.com\\",\\n \\"Port\\": \\"3306\\"\\n }\\n ],\\n \\"DBClusterId\\": \\"am-bp1ub9grke1****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBResourceGroupResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <GroupsInfo>\\n <GroupType>interactive</GroupType>\\n <UpdateTime>2022-11-09 16:57:35.241</UpdateTime>\\n <GroupName>USER_DEFAULT</GroupName>\\n <CreateTime>2022-10-09 16:57:35.241</CreateTime>\\n <GroupUsers>testb,testc</GroupUsers>\\n <NodeNum>2</NodeNum>\\n </GroupsInfo>\\n <DBClusterId>am-bp1ub9grke1****</DBClusterId>\\n</DescribeDBResourceGroupResponse>","errorExample":""}]', + 'title' => 'DescribeDBResourceGroup', + 'description' => 'This operation is suitable for the following editions:'."\n" + ."\n" + .'* **Enterprise Edition**.'."\n" + .'* **Basic Edition**.'."\n" + .'* **Data Lakehouse Edition**.'."\n" + .'* **Data Warehouse Edition in elastic mode**: 32 cores and 128 GB or more.'."\n", + ], + 'ModifyDBResourceGroup' => [ + 'summary' => 'Modifies the number of nodes or the query execution mode for a resource group of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136465', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'MinComputeResource', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The minimum amount of reserved computing resources. Unit: AnalyticDB compute unit (ACU).'."\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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0ACU', + ], + ], + [ + 'name' => 'MaxComputeResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum amount of reserved computing resources, which refers to the amount of resources that are not allocated in the cluster. Unit: ACU.'."\n" + ."\n" + .'* When GroupType is set to interactive, set this parameter to a value in increments of 16ACU.'."\n" + .'* When GroupType is set to job, set this parameter to a value in increments of 8ACU.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '48ACU', + ], + ], + [ + 'name' => 'ClusterSizeResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource specifications of a single compute cluster. Unit: ACU.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '16ACU', + ], + ], + [ + 'name' => 'MinClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of compute clusters that are required in the resource group. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxClusterCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of compute clusters that are allowed in the resource group. Maximum value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The working mode of the resource group. Valid values:'."\n" + ."\n" + .'* **Disable** (default)'."\n" + .'* **AutoScale**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AutoScale', + ], + ], + [ + 'name' => 'EngineParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The Spark application configuration parameters that can be applied to all Spark jobs executed in the resource group. If you want to configure parameters for a specific Spark job, you can specify values for the parameters in the code editor when you submit the job.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{\\"spark.adb.version\\":\\"3.5\\"}', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query execution mode. Valid values:'."\n" + ."\n" + .'* **interactive** (default)'."\n" + .'* **batch**'."\n" + .'* **job**'."\n" + ."\n" + .'> For more information, see [Query execution modes](~~189502~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'batch', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes. Default value: 0.'."\n" + ."\n" + .'* Each node is configured with the resources of 16 cores and 64 GB memory.'."\n" + .'* Make sure that the amount of resources of the nodes (Number of nodes × 16 cores and 64 GB memory) is less than or equal to the amount of unused resources of the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4294967296', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'PoolUserList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The database accounts with which to associate the resource group. They can be standard accounts or privileged accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The database account with which to associate the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. 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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-t7241****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'The specified instance state does not support this operation.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBResourceGroupResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</ModifyDBResourceGroupResponse>","errorExample":""}]', + 'title' => 'ModifyDBResourceGroup', + 'description' => 'This operation is suitable for the following editions:'."\n" + ."\n" + .'* **Enterprise Edition**.'."\n" + .'* **Basic Edition**.'."\n" + .'* **Data Lakehouse Edition**.'."\n" + .'* **Data Warehouse Edition in elastic mode**: 32 cores and 128 GB or more. The number of nodes cannot be modified for the default resource group USER_DEFAULT.'."\n", + ], + 'DeleteDBResourceGroup' => [ + 'summary' => 'Deletes a resource group from an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136467', + 'abilityTreeNodes' => [ + 'FEATUREadsYXZ2UA', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1ub9grke1****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_group', + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBResourceGroupResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</DeleteDBResourceGroupResponse>","errorExample":""}]', + 'title' => 'DeleteDBResourceGroup', + 'description' => '### Precautions'."\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" + .'* The default resource group USER_DEFAULT cannot be deleted.'."\n", + ], + 'DescribeResubmitConfig' => [ + 'summary' => '查询Resubmit配置', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929XXXX', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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, + 'docRequired' => true, + 'example' => 'am-8vbyw9awuj141haf9', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the resource group name of a cluster.'."\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' => '8D217417-BBA7-566C-9B9D-FFCBC86112B0', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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', + 'example' => 'am-8vbyw9awuj141haf9', + ], + 'Rules' => [ + 'description' => 'The job resubmission rules.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PeakMemory' => [ + 'description' => 'The peak memory usage.'."\n", + 'type' => 'string', + 'example' => '32', + ], + 'QueryTime' => [ + 'description' => 'The duration of the SQL statement. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '300', + ], + 'TargetGroupName' => [ + 'description' => 'The name of the destination resource group.'."\n", + 'type' => 'string', + 'example' => 'test_target_group', + ], + 'ExceedMemoryException' => [ + 'description' => 'Indicates whether out-of-memory (OOM) check is configured.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'GroupName' => [ + 'description' => 'The name of the source resource group.'."\n", + 'type' => 'string', + 'example' => 'test_group', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D217417-BBA7-566C-9B9D-FFCBC86112B0\\",\\n \\"DBClusterId\\": \\"am-8vbyw9awuj141haf9\\",\\n \\"Rules\\": [\\n {\\n \\"PeakMemory\\": \\"32\\",\\n \\"QueryTime\\": \\"300\\",\\n \\"TargetGroupName\\": \\"test_target_group\\",\\n \\"ExceedMemoryException\\": false,\\n \\"GroupName\\": \\"test_group\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeResubmitConfig', + ], + 'ModifyResubmitConfig' => [ + 'summary' => '修改Resubmit配置', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + '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-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The job resubmission rules.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => 'The name of the source resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test2', + ], + 'PeakMemory' => [ + 'description' => 'The peak memory usage.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'QueryTime' => [ + 'description' => 'The duration of the SQL statement. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + 'ExceedMemoryException' => [ + 'description' => 'Specifies whether to configure out-of-memory (OOM) check.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'TargetGroupName' => [ + 'description' => 'The name of the destination resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_target_group', + ], + ], + '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' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => 'ModifyResubmitConfig', + ], + 'ModifySQAConfig' => [ + 'summary' => '修改SQA配置', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQ3E0F2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-8vb369k7zxdt10tz0', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~459446~~) operation to query the resource group name of a cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SQAStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable short query acceleration (SQA).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'off', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + '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' => '494486CE-6F49-574E-B304-29127EA12E36', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"494486CE-6F49-574E-B304-29127EA12E36\\"\\n}","type":"json"}]', + 'title' => 'ModifySQAConfig', + ], + 'DescribeSQAConfig' => [ + 'summary' => 'Queries the short query acceleration (SQA) configuration 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', + 'abilityTreeNodes' => [ + 'FEATUREadsS1DX44', + ], + ], + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-8vbyw9awuj141haf9', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~612410~~) operation to query the resource group name of a cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test'."\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', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.'."\n", + 'type' => 'string', + 'example' => 'am-8vbyw9awuj141haf9', + ], + 'GroupName' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'test_group', + ], + 'SQAStatus' => [ + 'description' => 'Indicates whether short query acceleration (SQA) is enabled.'."\n", + 'type' => 'string', + 'example' => 'off', + 'enum' => [], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBE843D8-964D-5EA3-9D31-822125611B6E\\",\\n \\"DBClusterId\\": \\"am-8vbyw9awuj141haf9\\",\\n \\"GroupName\\": \\"test_group\\",\\n \\"SQAStatus\\": \\"off\\"\\n}","type":"json"}]', + 'title' => 'DescribeSQAConfig', + ], + 'CreateElasticPlan' => [ + 'summary' => 'Creates a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1d8lbdj22rx****', + ], + ], + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling plan.'."\n" + ."\n" + .'* The name must be 2 to 30 characters in length.'."\n" + .'* The name can contain letters, digits, and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ResourcePoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~466685~~) operation to query the resource group name.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'realtime', + 'default' => 'USER_DEFAULT', + ], + ], + [ + 'name' => 'ElasticPlanNodeNum', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The number of nodes that are involved in the scaling plan.'."\n" + ."\n" + .'* If ElasticPlanType is set to **worker**, you can set this parameter to 0 or leave this parameter empty.'."\n" + .'* If ElasticPlanType is set to **executorcombineworker** or **executor**, you must set this parameter to a value that is greater than 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ElasticPlanTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scale-up time of the scaling plan. Specify the time on the hour in the HH:mm:ss format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '08:00:00', + ], + ], + [ + 'name' => 'ElasticPlanTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The restoration time of the scaling plan. Specify the time on the hour in the HH:mm:ss format. The interval between the scale-up time and the restoration time cannot be more than 24 hours.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10:00:00', + ], + ], + [ + 'name' => 'ElasticPlanWeeklyRepeat', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The days of the week when you want to execute the scaling plan. Valid values: 0 to 6 (Sunday to Saturday). Separate multiple values with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1,2,3,4,5', + ], + ], + [ + 'name' => 'ElasticPlanMonthlyRepeat', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The dates of the month when you want to execute the scaling plan. A number specifies a date of the month. Separate multiple values with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1,15,25', + ], + ], + [ + 'name' => 'ElasticPlanStartDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start date of the scaling plan. Specify the date in the yyyy-MM-dd format.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-12-02', + ], + ], + [ + 'name' => 'ElasticPlanEndDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end date of the scaling plan. Specify the date in the yyyy-MM-dd format.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-12-09', + ], + ], + [ + 'name' => 'ElasticPlanEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the scaling plan takes effect. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ElasticPlanType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '表示分时弹性计划类型'."\n" + .' ■ ExecutorCombineWorker：计算存储联动变配'."\n" + .' ■ Executor：计算独立弹性'."\n" + .' ■ Worker：存储独立弹性', + 'description' => 'The type of the scaling plan. Valid values:'."\n" + ."\n" + .'* **worker**: scales only elastic I/O resources.'."\n" + .'* **executor**: scales only computing resources.'."\n" + .'* **executorcombineworker** (default): scales both elastic I/O resources and computing resources by proportion.'."\n" + .'> - If you want to set this parameter to **executorcombineworker**, make sure that the cluster runs a minor version of 3.1.3.2 or later.'."\n" + .'> - If you want to set this parameter to **worker** or **executor**, make sure that the cluster runs a minor version of 3.1.6.1 or later and a ticket is submitted. After your request is approved, you can set this parameter to **worker** or **executor**.', + 'type' => 'string', + 'required' => false, + 'example' => 'worker', + ], + ], + [ + 'name' => 'ElasticPlanWorkerSpec', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '表示存储独立弹性时worker垂直变配到哪种规格', + 'description' => 'The resource specifications that can be scaled up by the scaling plan. Valid values:'."\n" + ."\n" + .'* 8 Core 64 GB (default)'."\n" + .'* 16 Core 64 GB'."\n" + .'* 32 Core 64 GB'."\n" + .'* 64 Core 128 GB'."\n" + .'* 12 Core 96 GB'."\n" + .'* 24 Core 96 GB'."\n" + .'* 52 Core 86 GB'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32 Core 64 GB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateElasticPlanResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</CreateElasticPlanResponse>","errorExample":""}]', + 'title' => 'CreateElasticPlan', + 'description' => '###'."\n" + ."\n" + .'You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in elastic mode for Cluster Edition that have 32 cores or more.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteElasticPlan' => [ + 'summary' => 'Deletes a scheduled scaling plan. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition clusters in elastic mode for Cluster Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612241~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + '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, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>","errorExample":""}]', + 'title' => 'DeleteElasticPlan', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyElasticPlan' => [ + 'summary' => 'Modifies a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1rqvm70uh2v****', + ], + ], + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling plan.'."\n" + ."\n" + .'* The name must be 2 to 30 characters in length.'."\n" + .'* The name can contain letters, digits, and underscores (\\_).'."\n" + ."\n" + .'> You can call the [DescribeElasticPlan](~~190596~~) operation to query the information about all scaling plans of a cluster, including the scaling plan names.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'realtime', + ], + ], + [ + 'name' => 'ResourcePoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~466685~~) operation to query the resource group name.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test', + 'default' => 'USER_DEFAULT', + ], + ], + [ + 'name' => 'ElasticPlanNodeNum', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The number of nodes that are involved in the scaling plan.'."\n" + ."\n" + .'* If ElasticPlanType is set to **worker**, you can set this parameter to 0 or leave this parameter empty.'."\n" + .'* If ElasticPlanType is set to **executorcombineworker** or **executor**, you must set this parameter to a value that is greater than 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'ElasticPlanTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scale-up time of the scaling plan. Specify the time on the hour in the HH:mm:ss format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8:00:00', + ], + ], + [ + 'name' => 'ElasticPlanTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The restoration time of the scaling plan. Specify the time on the hour in the HH:mm:ss format. The interval between the scale-up time and the restoration time cannot be more than 24 hours.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10:00:00', + ], + ], + [ + 'name' => 'ElasticPlanWeeklyRepeat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The days of the week when you want to execute the scaling plan. Valid values: 0 to 6, which indicate Sunday to Saturday. Separate multiple values with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3,4,5', + ], + ], + [ + 'name' => 'ElasticPlanMonthlyRepeat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dates of the month when you want to execute the scaling plan. A number specifies a date of the month. Separate multiple values with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1,15,25', + ], + ], + [ + 'name' => 'ElasticPlanStartDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start date of the scaling plan. Specify the date in the yyyy-MM-dd format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-02', + ], + ], + [ + 'name' => 'ElasticPlanEndDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end date of the scaling plan. Specify the date in the yyyy-MM-dd format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-09', + ], + ], + [ + 'name' => 'ElasticPlanEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the scaling plan takes effect. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ElasticPlanType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The type of the scaling plan. Valid values:'."\n" + ."\n" + .'* **worker**: scales only elastic I/O resources.'."\n" + .'* **executor**: scales only computing resources.'."\n" + .'* **executorcombineworker** (default): scales both elastic I/O resources and computing resources by proportion.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you want to set this parameter to **executorcombineworker**, make sure that the cluster runs a minor version of 3.1.3.2 or later.'."\n" + ."\n" + .'* If you want to set this parameter to **worker** or **executor**, make sure that the cluster runs a minor version of 3.1.6.1 or later and a ticket is submitted. After your request is approved, you can set this parameter to **worker** or **executor**.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'worker', + ], + ], + [ + 'name' => 'ElasticPlanWorkerSpec', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The resource specifications that can be scaled up by the scaling plan. Valid values:'."\n" + ."\n" + .'* 8 Core 64 GB (default)'."\n" + .'* 16 Core 64 GB'."\n" + .'* 32 Core 64 GB'."\n" + .'* 64 Core 128 GB'."\n" + .'* 12 Core 96 GB'."\n" + .'* 24 Core 96 GB'."\n" + .'* 52 Core 86 GB'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '16 Core 64 GB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ElasticPlanParameterError', + 'errorMessage' => 'The specified elastic plan parameter is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyElasticPlanResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</ModifyElasticPlanResponse>","errorExample":""}]', + 'title' => 'ModifyElasticPlan', + 'description' => 'You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in elastic mode for Cluster Edition that have 32 cores or more.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeElasticDailyPlan' => [ + 'summary' => '查看日资源弹性', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling plan. Valid values:'."\n" + ."\n" + .'* The name must be 2 to 30 characters in length.'."\n" + .'* The name can contain letters, digits, and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'realtimeplan', + ], + ], + [ + 'name' => 'ResourcePoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~466685~~) operation to query the resource group name.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ElasticDailyPlanDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start date of the current-day scaling plan. Specify the date in the yyyy-MM-dd format.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-12-02', + ], + ], + [ + 'name' => 'ElasticDailyPlanStatusList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution state of the current-day scaling plan. Separate multiple values with commas (,). Valid values:'."\n" + ."\n" + .'* **1**: The scaling plan is not executed.'."\n" + .'* **2**: The scaling plan is being executed.'."\n" + .'* **3**: The scaling plan is executed.'."\n" + .'* **4**: The scaling plan fails to be executed.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'ElasticDailyPlanList' => [ + 'description' => 'Details of the current-day scaling plans.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The execution state of the current-day scaling plan. Multiple values are separated by commas (,). Valid values:'."\n" + ."\n" + .'* **1**: The scaling plan is not executed.'."\n" + .'* **2**: The scaling plan is being executed.'."\n" + .'* **3**: The scaling plan is executed.'."\n" + .'* **4**: The scaling plan fails to be executed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Day' => [ + 'description' => 'The start date of the current-day scaling plan. The date is in the yyyy-MM-dd format.'."\n", + 'type' => 'string', + 'example' => '2022-12-02', + ], + 'ResourcePoolName' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'StartTs' => [ + 'description' => 'The actual scale-up time. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2022-12-02 16:00:00', + ], + 'PlanEndTs' => [ + 'description' => 'The scheduled restoration time. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2022-12-02 16:00:00', + ], + 'PlanStartTs' => [ + 'description' => 'The scheduled scale-up time. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2022-12-02 15:00:00', + ], + 'ElasticNodeNum' => [ + 'description' => 'The number of nodes involved in the scaling plan.'."\n" + ."\n" + .'* If ElasticPlanType is set to **worker**, a value of 0 or null is returned.'."\n" + .'* If ElasticPlanType is set to **executorcombineworker** or **executor**, a value greater than 0 is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EndTs' => [ + 'description' => 'The actual restoration time. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2022-12-02 16:00:00', + ], + 'PlanName' => [ + 'description' => 'The name of the scaling plan.'."\n", + 'type' => 'string', + 'example' => 'realtimeplan', + ], + 'ElasticPlanType' => [ + 'description' => 'The type of the scaling plan. Default value: executorcombineworker. Valid values:'."\n" + ."\n" + .'* **worker**: scales only elastic I/O resources.'."\n" + .'* **executor**: scales only computing resources.'."\n" + .'* **executorcombineworker**: scales both elastic I/O resources and computing resources by proportion.'."\n", + 'type' => 'string', + 'example' => 'worker', + ], + 'ElasticPlanWorkerSpec' => [ + 'description' => 'The resource specifications that can be scaled up by the scaling plan. Default value: 8 Core 64 GB. Valid values:'."\n" + ."\n" + .'* 8 Core 64 GB'."\n" + .'* 16 Core 64 GB'."\n" + .'* 32 Core 64 GB'."\n" + .'* 64 Core 128 GB'."\n" + .'* 12 Core 96 GB'."\n" + .'* 24 Core 96 GB'."\n" + .'* 52 Core 86 GB'."\n", + 'type' => 'string', + 'example' => '16 Core 64 GB', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"ElasticDailyPlanList\\": [\\n {\\n \\"Status\\": 3,\\n \\"Day\\": \\"2022-12-02\\",\\n \\"ResourcePoolName\\": \\"test\\",\\n \\"StartTs\\": \\"2022-12-02 16:00:00\\",\\n \\"PlanEndTs\\": \\"2022-12-02 16:00:00\\",\\n \\"PlanStartTs\\": \\"2022-12-02 15:00:00\\",\\n \\"ElasticNodeNum\\": 0,\\n \\"EndTs\\": \\"2022-12-02 16:00:00\\",\\n \\"PlanName\\": \\"realtimeplan\\",\\n \\"ElasticPlanType\\": \\"worker\\",\\n \\"ElasticPlanWorkerSpec\\": \\"16 Core 64 GB\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeElasticDailyPlanResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <ElasticDailyPlanList>\\n <Status>3</Status>\\n <Day>2022-12-02</Day>\\n <ResourcePoolName>test</ResourcePoolName>\\n <StartTs>2022-12-02 16:00:00</StartTs>\\n <PlanEndTs>2022-12-02 16:00:00</PlanEndTs>\\n <PlanStartTs>2022-12-02 15:00:00</PlanStartTs>\\n <ElasticNodeNum>1</ElasticNodeNum>\\n <EndTs>2022-12-02 16:00:00</EndTs>\\n <PlanName>realtimeplan</PlanName>\\n <ElasticPlanType>worker</ElasticPlanType>\\n <ElasticPlanWorkerSpec>16 Core 64 GB</ElasticPlanWorkerSpec>\\n </ElasticDailyPlanList>\\n</DescribeElasticDailyPlanResponse>","errorExample":""}]', + 'title' => 'DescribeElasticDailyPlan', + 'description' => 'This operation is available only for AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in elastic mode for Cluster Edition that have 32 cores or more.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeElasticPlan' => [ + 'summary' => 'Queries scaling plans of an AnalyticDB for MySQL cluster. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsL7JFYD', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp278jg9****', + ], + ], + [ + 'name' => 'ElasticPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling plan.'."\n" + ."\n" + .'* The name must be 2 to 30 characters in length.'."\n" + .'* The name can contain letters, digits, and underscores (\\_).'."\n" + ."\n" + .'> If you do not specify this parameter, the information about all scaling plans for the specified cluster is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'realtime', + ], + ], + [ + 'name' => 'ResourcePoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n" + ."\n" + .'> You can call the [DescribeDBResourceGroup](~~466685~~) operation to query the resource group name.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'USER_DEFAULT', + ], + ], + [ + 'name' => 'ElasticPlanEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the scaling plan takes effect. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'ElasticPlanList' => [ + 'description' => 'The queried scaling plans.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The restoration time of the scaling plan. The interval between the scale-up time and the restoration time cannot be more than 24 hours. The time is in the HH:mm:ss format.'."\n", + 'type' => 'string', + 'example' => '10:00:00', + ], + 'WeeklyRepeat' => [ + 'description' => 'The days of the week when the scaling plan was executed. Valid values: 0 to 6, which indicate Sunday to Saturday. Multiple values are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '3,4,5,6', + ], + 'MonthlyRepeat' => [ + 'description' => 'The days of the month when the scaling plan was executed. A value indicates a day of the month. Multiple values are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '1,15,25', + ], + 'StartTime' => [ + 'description' => 'The scale-up time of the scaling plan. The time is in the HH:mm:ss format.'."\n", + 'type' => 'string', + 'example' => '08:00:00', + ], + 'ResourcePoolName' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'USER_DEFAULT', + ], + 'StartDay' => [ + 'description' => 'The start date of the scaling plan. This parameter is returned only if the start date of the scaling plan is set. The date is in the yyyy-MM-dd format.'."\n", + 'type' => 'string', + 'example' => '2022-12-02', + ], + 'ElasticNodeNum' => [ + 'description' => 'The number of nodes that are involved in the scaling plan.'."\n" + ."\n" + .'* If ElasticPlanType is set to **worker**, a value of 0 or null is returned.'."\n" + .'* If ElasticPlanType is set to **executorcombineworker** or **executor**, a value greater than 0 is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Enable' => [ + 'description' => 'Indicates whether the scaling plan takes effect. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EndDay' => [ + 'description' => 'The end date of the scaling plan. This parameter is returned only if the end date of the scaling plan is set. The date is in the yyyy-MM-dd format.'."\n", + 'type' => 'string', + 'example' => '2022-12-09', + ], + 'PlanName' => [ + 'description' => 'The name of the scaling plan.'."\n", + 'type' => 'string', + 'example' => 'realtime', + ], + 'ElasticPlanType' => [ + 'description' => 'The type of the scaling plan. Valid values:'."\n" + ."\n" + .'* **worker**: scales only elastic I/O resources.'."\n" + .'* **executor**: scales only computing resources.'."\n" + .'* **executorcombineworker** (default): scales both elastic I/O resources and computing resources by proportion.'."\n", + 'type' => 'string', + 'example' => 'worker', + ], + 'ElasticPlanWorkerSpec' => [ + 'description' => 'The resource specifications that can be scaled up by the scaling plan. Valid values:'."\n" + ."\n" + .'* 8 Core 64 GB (default)'."\n" + .'* 16 Core 64 GB'."\n" + .'* 32 Core 64 GB'."\n" + .'* 64 Core 128 GB'."\n" + .'* 12 Core 96 GB'."\n" + .'* 24 Core 96 GB'."\n" + .'* 52 Core 86 GB'."\n", + 'type' => 'string', + 'example' => '16 Core 64 GB', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"ElasticPlanList\\": [\\n {\\n \\"EndTime\\": \\"10:00:00\\",\\n \\"WeeklyRepeat\\": \\"3,4,5,6\\",\\n \\"MonthlyRepeat\\": \\"1,15,25\\",\\n \\"StartTime\\": \\"08:00:00\\",\\n \\"ResourcePoolName\\": \\"USER_DEFAULT\\",\\n \\"StartDay\\": \\"2022-12-02\\",\\n \\"ElasticNodeNum\\": 0,\\n \\"Enable\\": true,\\n \\"EndDay\\": \\"2022-12-09\\",\\n \\"PlanName\\": \\"realtime\\",\\n \\"ElasticPlanType\\": \\"worker\\",\\n \\"ElasticPlanWorkerSpec\\": \\"16 Core 64 GB\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeElasticPlanResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <ElasticPlanList>\\n <EndTime>10:00:00</EndTime>\\n <WeeklyRepeat>3,4,5,6</WeeklyRepeat>\\n <StartTime>08:00:00</StartTime>\\n <ResourcePoolName>USER_DEFAULT</ResourcePoolName>\\n <StartDay>2022-12-02</StartDay>\\n <ElasticNodeNum>0</ElasticNodeNum>\\n <Enable>true</Enable>\\n <EndDay>2022-12-09</EndDay>\\n <PlanName>realtime</PlanName>\\n <ElasticPlanType>WORKER</ElasticPlanType>\\n <ElasticPlanWorkerSpec>16 Core 64 GB</ElasticPlanWorkerSpec>\\n </ElasticPlanList>\\n</DescribeElasticPlanResponse>","errorExample":""}]', + 'title' => 'DescribeElasticPlan', + 'description' => '###'."\n" + ."\n" + .'You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in elastic mode for Cluster Edition that have 32 cores or more.'."\n", + ], + 'DescribeTables' => [ + 'summary' => 'Queries a list of tables in a database 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', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\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' => true, + 'docRequired' => true, + 'example' => 'adb_demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + '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' => [ + '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 Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp1xxxxxxxx47', + ], + 'SchemaName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + '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 \\"Items\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"DBClusterId\\": \\"am-bp1r053byu48p****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeTables', + ], + 'DescribeAllDataSource' => [ + 'summary' => 'Queries a list of databases, tables, and columns in a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~612241~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region.'."\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' => true, + 'docRequired' => true, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + '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 name of the table.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp1xxxxxxxx47', + ], + '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 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 Warehouse Edition cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp1xxxxxxxx47', + ], + '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', + ], + ], + ], + ], + ], + ], + '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 Warehouse Edition cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp1xxxxxxxx47', + ], + 'SchemaName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"Tables\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"DBClusterId\\": \\"am-bp1pke2pcfavw****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n },\\n \\"Columns\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"bigint\\",\\n \\"ColumnName\\": \\"id\\",\\n \\"TableName\\": \\"test\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"am-bp1pke2pcfavw****\\",\\n \\"PrimaryKey\\": false,\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n },\\n \\"Schemas\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp1pke2pcfavw****\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAllDataSource', + ], + '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', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => 'The queried databases.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp1xxxxxxxx47', + ], + 'SchemaName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp1xxxxxxxx47\\",\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSchemasResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <Items>\\n <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>\\n <SchemaName>adb_demo</SchemaName>\\n </Items>\\n</DescribeSchemasResponse>","errorExample":""}]', + 'title' => 'DescribeSchemas', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTableDetail' => [ + 'summary' => 'Queries the distribution of data in a table among partitions.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10825', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~454250~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the DescribeRegions operation to query the available region list.[](~~612393~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AvgSize' => [ + 'description' => 'The average number of rows in partitions.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'description' => 'The queried shard.', + 'type' => 'object', + 'properties' => [ + 'Shard' => [ + 'description' => 'The queried shards.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => 'The number of rows in the partition.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Id' => [ + 'description' => 'The partition ID. Only the numeric part of the partition name is returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AvgSize\\": 0,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Shard\\": [\\n {\\n \\"Size\\": 0,\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<AvgSize>0</AvgSize>\\n<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<Items>\\n <Shard>\\n <Size>0</Size>\\n <Id>1</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>2</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>3</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>4</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>5</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>6</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>7</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>8</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>9</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>10</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>11</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>12</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>13</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>14</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>15</Id>\\n </Shard>\\n <Shard>\\n <Size>0</Size>\\n <Id>16</Id>\\n </Shard>\\n</Items>","errorExample":""}]', + 'title' => 'DescribeTableDetail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeProcessList' => [ + 'summary' => 'Queries the queries that are being executed on a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp11q28kvl688****', + ], + ], + [ + 'name' => 'ShowFull', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to show a complete SQL statement. Valid values:'."\n" + ."\n" + .'* **True**: shows a complete SQL statement.'."\n" + .'* **False**: shows only the first 100 characters of an SQL statement.'."\n" + ."\n" + .'> The default value is False.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + [ + 'name' => 'RunningTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution duration used to filter queries. Queries that take a longer time than the specified execution duration are displayed. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the user used to filter queries.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword in an SQL statement, which is used to filter queries. Set the value to **SELECT**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which queries are sorted based on the specified fields. Specify this parameter as an ordered JSON array in the `[{"Field":"Time","Type":"Desc" },{ "Field":"User", "Type":"Asc" }]` format.'."\n" + ."\n" + .'* **Field** specifies the field used to sort queries. Valid values: Time, User, Host, and DB.'."\n" + .'* **Type** specifies the sorting sequence. Valid values: **Desc** and **Asc**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Field":"Time","Type":"Desc" }, { "Field":"User", "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' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The total number of pages returned.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Process' => [ + 'description' => 'Details of the queries.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + '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' => '2020-11-19T02:48:15Z', + ], + 'Time' => [ + 'description' => 'The amount of time that has elapsed from the start time of the query. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'ProcessId' => [ + 'description' => 'The unique ID of the query. You must specify this parameter when you use the KILL PROCESS statement.'."\n", + 'type' => 'string', + 'example' => '202011191048151921681492420315100****', + ], + 'Host' => [ + 'description' => 'The IP address from which the query was initiated.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX:12308', + ], + 'DB' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'Command' => [ + 'description' => 'The type of the statement. Only SELECT can be returned.'."\n", + 'type' => 'string', + 'example' => 'SELECT', + ], + 'User' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Id' => [ + 'description' => 'The ID of the worker thread.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '49104', + ], + 'Info' => [ + 'description' => 'The SQL statement that is being executed. By default, the first 100 characters of the SQL statement are returned. If the ShowFull parameter is set to True, the complete SQL statement is returned.'."\n", + 'type' => 'string', + 'example' => 'select * from sbtest1,sbtest2,sbtest3,sbtest4', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectModuleVersion', + 'errorMessage' => 'The specified module version does not support this operation.', + ], + [ + 'errorCode' => 'AnalyticDBKernelError', + 'errorMessage' => 'Calling AnalyticDB Kernel error', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Process\\": [\\n {\\n \\"StartTime\\": \\"2020-11-19T02:48:15Z\\",\\n \\"Time\\": 11,\\n \\"ProcessId\\": \\"202011191048151921681492420315100****\\",\\n \\"Host\\": \\"192.168.XX.XX:12308\\",\\n \\"DB\\": \\"adb_demo\\",\\n \\"Command\\": \\"SELECT\\",\\n \\"User\\": \\"test\\",\\n \\"Id\\": 49104,\\n \\"Info\\": \\"select * from sbtest1,sbtest2,sbtest3,sbtest4\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeProcessListResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <StartTime>2020-11-19T02:48:15Z</StartTime>\\n <Time>11</Time>\\n <ProcessId>202011191048151921681492420315100****</ProcessId>\\n <Host>192.168.XX.XX:12308</Host>\\n <DB>adb_demo</DB>\\n <Command>SELECT</Command>\\n <User>test</User>\\n <Id>49104</Id>\\n <Info>select * from sbtest1,sbtest2,sbtest3,sbtest4</Info>\\n </Items>\\n</DescribeProcessListResponse>","errorExample":""}]', + 'title' => 'DescribeProcessList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeColumns' => [ + 'summary' => 'Queries a list of columns in a table within an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => true, + 'docRequired' => true, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => 'The queried columns.'."\n", + 'type' => 'array', + 'items' => [ + '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 auto-incremented.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp1xxxxxxxx47', + ], + 'PrimaryKey' => [ + 'description' => 'Indicates whether the column is a primary key column.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SchemaName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"bigint\\",\\n \\"ColumnName\\": \\"id\\",\\n \\"TableName\\": \\"test\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"am-bp1xxxxxxxx47\\",\\n \\"PrimaryKey\\": false,\\n \\"SchemaName\\": \\"adb_demo\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<Items>\\n <Column>\\n <TableName>test</TableName>\\n <ColumnName>id</ColumnName>\\n <Type>bigint</Type>\\n <AutoIncrementColumn>true</AutoIncrementColumn>\\n <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>\\n <PrimaryKey>false</PrimaryKey>\\n <SchemaName>adb_demo</SchemaName>\\n </Column>\\n <Column>\\n <TableName>test</TableName>\\n <ColumnName>name</ColumnName>\\n <Type>varchar</Type>\\n <AutoIncrementColumn>false</AutoIncrementColumn>\\n <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>\\n <PrimaryKey>false</PrimaryKey>\\n <SchemaName>adb_demo</SchemaName>\\n </Column>\\n <Column>\\n <TableName>test</TableName>\\n <ColumnName>value</ColumnName>\\n <Type>int</Type>\\n <AutoIncrementColumn>false</AutoIncrementColumn>\\n <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>\\n <PrimaryKey>false</PrimaryKey>\\n <SchemaName>adb_demo</SchemaName>\\n </Column>\\n <Column>\\n <TableName>test</TableName>\\n <ColumnName>ts</ColumnName>\\n <Type>timestamp</Type>\\n <AutoIncrementColumn>false</AutoIncrementColumn>\\n <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>\\n <PrimaryKey>false</PrimaryKey>\\n <SchemaName>adb_demo</SchemaName>\\n </Column>\\n</Items>","errorExample":""}]', + 'title' => 'DescribeColumns', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTaskInfo' => [ + 'summary' => 'Queries the information about a task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-hongkong', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '225685759', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskInfo' => [ + 'description' => 'The queried task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status. Valid values:'."\n" + ."\n" + .'* Waiting'."\n" + .'* Running'."\n" + .'* Finished'."\n" + .'* Failed'."\n" + .'* Closed'."\n" + .'* Cancel'."\n" + .'* Retry'."\n" + .'* Pause'."\n" + .'* Stop'."\n", + 'type' => 'string', + 'example' => 'Finished', + ], + 'FinishTime' => [ + 'description' => 'The end time of the task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'example' => '2020-01-07T08:08:50Z', + ], + 'Progress' => [ + 'description' => 'The progress of the task. Unit: %.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'BeginTime' => [ + 'description' => 'The start time of the task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'example' => '2020-01-07T07:39:56Z', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '225685759', + ], + ], + ], + '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 \\"TaskInfo\\": {\\n \\"Status\\": \\"Finished\\",\\n \\"FinishTime\\": \\"2020-01-07T08:08:50Z\\",\\n \\"Progress\\": \\"100\\",\\n \\"BeginTime\\": \\"2020-01-07T07:39:56Z\\",\\n \\"TaskId\\": 225685759\\n },\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + 'title' => 'DescribeTaskInfo', + ], + 'DescribeSQLPlan' => [ + 'summary' => 'Queries the plan information about an SQL statement such as a query statement or an extract-transform-load (ETL) task statement.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-****************', + ], + ], + [ + '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' => true, + 'docRequired' => true, + 'example' => '202105271604431720161662490345*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '22D6DEF0-CBC7-4388-A41C-D5FD62******', + ], + 'StageList' => [ + 'description' => 'The queried plan in different stages.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'State' => [ + 'description' => 'The final execution state of the stage. Valid values:'."\n" + ."\n" + .'* FINISHED'."\n" + .'* CANCELED'."\n" + .'* ABORTED'."\n" + .'* FAILED'."\n", + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'CPUTimeAvg' => [ + 'description' => 'The average `CPU Time` value on each compute node in the stage. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5984', + ], + 'CPUTimeMax' => [ + 'description' => 'The maximum `CPU Time` value on each compute node in the stage. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5984', + ], + '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' => '5984', + ], + 'ScanTimeMax' => [ + 'description' => 'The maximum amount of time consumed by a scan operator to read data on each storage node in the stage. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InputSizeMax' => [ + 'description' => 'The maximum amount of input data on each compute node in the stage. Unit: byte.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173', + ], + 'StageId' => [ + 'description' => 'The stage ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScanSizeMax' => [ + 'description' => 'The maximum amount of data scanned by a scan operator on each storage node in the stage. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CPUTimeMin' => [ + 'description' => 'The minimum `CPU Time` value on each compute node in the stage. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '47', + ], + 'ScanTimeMin' => [ + 'description' => 'The minimum amount of time consumed by a scan operator to read data on each storage node in the stage. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScanSizeMin' => [ + 'description' => 'The minimum amount of data scanned by a scan operator on each storage node in the stage. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InputSizeMin' => [ + 'description' => 'The minimum amount of input data on each compute node in the stage. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173', + ], + 'PeakMemory' => [ + 'description' => 'The maximum memory usage when the SQL statement is executed. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74208', + ], + 'ScanTimeAvg' => [ + 'description' => 'The average amount of time consumed by a scan operator to read data on each storage node in the stage. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScanSizeAvg' => [ + 'description' => 'The average amount of data scanned by a scan operator on each storage node in the stage. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InputSizeAvg' => [ + 'description' => 'The average amount of input data on each compute node in the stage. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173', + ], + ], + ], + ], + 'OriginInfo' => [ + 'description' => 'The original information about the SQL statement.'."\n", + 'type' => 'string', + 'example' => '{\\"queryId\\":\\"20210527_160443_10581_hdhzr\\",\\"session\\":{\\"queryId\\":\\"20210527_160443_10581_hdhzr\\",\\"hasSharedStage\\":false,\\"parentId\\":0}}', + ], + 'Detail' => [ + 'description' => 'The execution information about the SQL statement.'."\n", + 'type' => 'object', + 'properties' => [ + 'SQL' => [ + 'description' => 'The SQL statement.'."\n", + 'type' => 'string', + 'example' => 'INSERT OVERWRITE INTO hdfs_import_external\\nSELECT *\\nFROM adb_hdfs_import_source', + ], + 'OutputSize' => [ + 'description' => 'The total amount of data generated by the SQL statement. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'State' => [ + 'description' => 'The final execution state of the SQL statement. Valid values:'."\n" + ."\n" + .'* FINISHED'."\n" + .'* FAILED'."\n", + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'OutputRows' => [ + 'description' => 'The total number of rows generated by the SQL statement.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'User' => [ + 'description' => 'The name of the user who submitted the SQL statement.'."\n", + 'type' => 'string', + 'example' => 'test_acc', + ], + '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' => 'string', + 'example' => '1622102683243', + ], + 'TotalStage' => [ + 'description' => 'The total number of stages in the SQL statement.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'QueuedTime' => [ + 'description' => 'The amount of time consumed to queue the SQL statement. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalTime' => [ + 'description' => 'The total amount of time consumed to execute the SQL statement. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2340', + ], + 'TotalTask' => [ + 'description' => 'The total number of tasks in the SQL statement.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Database' => [ + 'description' => 'The name of the database on which the SQL statement was executed.'."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'PeakMemory' => [ + 'description' => 'The maximum memory usage when the SQL statement is executed. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '441802', + ], + 'ClientIP' => [ + 'description' => 'The IP address of the client that is used to execute the SQL statement.'."\n", + 'type' => 'string', + 'example' => '172.16.***.***', + ], + 'PlanningTime' => [ + 'description' => 'The amount of time consumed to generate the execution plan of the SQL statement. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '86', + ], + 'CPUTime' => [ + 'description' => 'The total CPU time consumed by all operators on multithreaded servers when the SQL statement is executed. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6100', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"22D6DEF0-CBC7-4388-A41C-D5FD62******\\",\\n \\"StageList\\": [\\n {\\n \\"State\\": \\"FINISHED\\",\\n \\"CPUTimeAvg\\": 5984,\\n \\"CPUTimeMax\\": 5984,\\n \\"OperatorCost\\": 5984,\\n \\"ScanTimeMax\\": 0,\\n \\"InputSizeMax\\": 173,\\n \\"StageId\\": 1,\\n \\"ScanSizeMax\\": 0,\\n \\"CPUTimeMin\\": 47,\\n \\"ScanTimeMin\\": 0,\\n \\"ScanSizeMin\\": 0,\\n \\"InputSizeMin\\": 173,\\n \\"PeakMemory\\": 74208,\\n \\"ScanTimeAvg\\": 0,\\n \\"ScanSizeAvg\\": 0,\\n \\"InputSizeAvg\\": 173\\n }\\n ],\\n \\"OriginInfo\\": \\"{\\\\\\\\\\\\\\"queryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20210527_160443_10581_hdhzr\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"session\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"queryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20210527_160443_10581_hdhzr\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hasSharedStage\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"parentId\\\\\\\\\\\\\\":0}}\\",\\n \\"Detail\\": {\\n \\"SQL\\": \\"INSERT OVERWRITE INTO hdfs_import_external\\\\\\\\nSELECT *\\\\\\\\nFROM adb_hdfs_import_source\\",\\n \\"OutputSize\\": 9,\\n \\"State\\": \\"FINISHED\\",\\n \\"OutputRows\\": 1,\\n \\"User\\": \\"test_acc\\",\\n \\"StartTime\\": \\"1622102683243\\",\\n \\"TotalStage\\": 4,\\n \\"QueuedTime\\": 0,\\n \\"TotalTime\\": 2340,\\n \\"TotalTask\\": 4,\\n \\"Database\\": \\"adb_demo\\",\\n \\"PeakMemory\\": 441802,\\n \\"ClientIP\\": \\"172.16.***.***\\",\\n \\"PlanningTime\\": 86,\\n \\"CPUTime\\": 6100\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSQLPlanResponse>\\n <RequestId>22D6DEF0-CBC7-4388-A41C-D5FD62******</RequestId>\\n <StageList>\\n <ScanSizeMin>0</ScanSizeMin>\\n <ScanSizeAvg>0</ScanSizeAvg>\\n <StageId>0</StageId>\\n <PeakMemory>264960</PeakMemory>\\n <CPUTimeMax>47</CPUTimeMax>\\n <ScanTimeMin>0</ScanTimeMin>\\n <ScanTimeAvg>0</ScanTimeAvg>\\n <InputSizeMax>1023</InputSizeMax>\\n <InputSizeMin>1023</InputSizeMin>\\n <InputSizeAvg>1023</InputSizeAvg>\\n <ScanSizeMax>0</ScanSizeMax>\\n <State>FINISHED</State>\\n <OperatorCost>47</OperatorCost>\\n <ScanTimeMax>0</ScanTimeMax>\\n <CPUTimeMin>47</CPUTimeMin>\\n <CPUTimeAvg>47</CPUTimeAvg>\\n </StageList>\\n <StageList>\\n <ScanSizeMin>0</ScanSizeMin>\\n <ScanSizeAvg>0</ScanSizeAvg>\\n <StageId>1</StageId>\\n <PeakMemory>74208</PeakMemory>\\n <CPUTimeMax>5984</CPUTimeMax>\\n <ScanTimeMin>0</ScanTimeMin>\\n <ScanTimeAvg>0</ScanTimeAvg>\\n <InputSizeMax>173</InputSizeMax>\\n <InputSizeMin>173</InputSizeMin>\\n <InputSizeAvg>173</InputSizeAvg>\\n <ScanSizeMax>0</ScanSizeMax>\\n <State>FINISHED</State>\\n <OperatorCost>5984</OperatorCost>\\n <ScanTimeMax>0</ScanTimeMax>\\n <CPUTimeMin>5984</CPUTimeMin>\\n <CPUTimeAvg>5984</CPUTimeAvg>\\n </StageList>\\n <StageList>\\n <ScanSizeMin>0</ScanSizeMin>\\n <ScanSizeAvg>0</ScanSizeAvg>\\n <StageId>2</StageId>\\n <PeakMemory>102634</PeakMemory>\\n <CPUTimeMax>18</CPUTimeMax>\\n <ScanTimeMin>0</ScanTimeMin>\\n <ScanTimeAvg>0</ScanTimeAvg>\\n <InputSizeMax>173</InputSizeMax>\\n <InputSizeMin>173</InputSizeMin>\\n <InputSizeAvg>173</InputSizeAvg>\\n <ScanSizeMax>0</ScanSizeMax>\\n <State>FINISHED</State>\\n <OperatorCost>18</OperatorCost>\\n <ScanTimeMax>0</ScanTimeMax>\\n <CPUTimeMin>18</CPUTimeMin>\\n <CPUTimeAvg>18</CPUTimeAvg>\\n </StageList>\\n <StageList>\\n <ScanSizeMin>36</ScanSizeMin>\\n <ScanSizeAvg>36</ScanSizeAvg>\\n <StageId>3</StageId>\\n <PeakMemory>0</PeakMemory>\\n <CPUTimeMax>51</CPUTimeMax>\\n <ScanTimeMin>10</ScanTimeMin>\\n <ScanTimeAvg>10</ScanTimeAvg>\\n <InputSizeMax>36</InputSizeMax>\\n <InputSizeMin>36</InputSizeMin>\\n <InputSizeAvg>36</InputSizeAvg>\\n <ScanSizeMax>36</ScanSizeMax>\\n <State>FINISHED</State>\\n <OperatorCost>51</OperatorCost>\\n <ScanTimeMax>10</ScanTimeMax>\\n <CPUTimeMin>51</CPUTimeMin>\\n <CPUTimeAvg>51</CPUTimeAvg>\\n </StageList>\\n <OriginInfo>{\\"queryId\\":\\"20210527_160443_10581_hdhzr\\",\\"session\\":{\\"queryId\\":\\"20210527_160443_10581_hdhzr\\",\\"hasSharedStage\\":false,\\"parentId\\":0}}</OriginInfo>\\n <Detail>\\n <TotalTask>4</TotalTask>\\n <OutputSize>9</OutputSize>\\n <User>test_acc</User>\\n <TotalStage>4</TotalStage>\\n <PeakMemory>441802</PeakMemory>\\n <StartTime>1622102683243</StartTime>\\n <ClientIP>172.16.***.***</ClientIP>\\n <SQL>INSERT OVERWRITE INTO hdfs_import_external\\nSELECT *\\nFROM adb_hdfs_import_source</SQL>\\n <CPUTime>6100</CPUTime>\\n <QueuedTime>0</QueuedTime>\\n <State>FINISHED</State>\\n <Database>adb_demo</Database>\\n <TotalTime>2340</TotalTime>\\n <PlanningTime>86</PlanningTime>\\n <OutputRows>1</OutputRows>\\n </Detail>\\n</DescribeSQLPlanResponse>","errorExample":""}]', + 'title' => 'DescribeSQLPlan', + ], + 'DescribeSQLPlanTask' => [ + 'summary' => 'Queries the information about a task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '201907241445301720211111570315107****', + ], + ], + [ + 'name' => 'StageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The stage of the task.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1785135913****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'TaskList' => [ + 'description' => 'The queried task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ScanCost' => [ + 'description' => 'The amount of time consumed to scan data from a data source in the task. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OutputSize' => [ + 'description' => 'The amount of output data in the task. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '945', + ], + 'InputSize' => [ + 'description' => 'The amount of input data in the task. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3763', + ], + 'State' => [ + 'description' => 'The final execution status of the task. Valid values:'."\n" + ."\n" + .'* FINISHED'."\n" + .'* CANCELED'."\n" + .'* ABORTED'."\n" + .'* FAILED'."\n", + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'OperatorCost' => [ + 'description' => 'The total amount of time consumed by all operators in the task on a specific node. This parameter can be used to determine whether long tails occur in computing. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'OutputRows' => [ + 'description' => 'The number of output rows in the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105', + ], + 'ScanSize' => [ + 'description' => 'The amount of data scanned from a data source in the task. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ElapsedTime' => [ + 'description' => 'The time elapsed from when the task was created to when the task was complete. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ScanRows' => [ + 'description' => 'The number of rows scanned from a data source in the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PeakMemory' => [ + 'description' => 'The peak memory of the task on a specific node. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '898576', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '198877623', + ], + 'InputRows' => [ + 'description' => 'The number of input rows in the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TaskList\\": [\\n {\\n \\"OutputSize\\": 945,\\n \\"ScanCost\\": 0,\\n \\"InputSize\\": 3763,\\n \\"State\\": \\"FINISHED\\",\\n \\"OperatorCost\\": 3,\\n \\"OutputRows\\": 105,\\n \\"ScanSize\\": 0,\\n \\"ElapsedTime\\": 10,\\n \\"ScanRows\\": 0,\\n \\"PeakMemory\\": 898576,\\n \\"TaskId\\": 198877623,\\n \\"InputRows\\": 105\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<TaskList>\\n <OutputSize>945</OutputSize>\\n <TaskId>198877623</TaskId>\\n <InputSize>3763</InputSize>\\n <PeakMemory>898576</PeakMemory>\\n <ElapsedTime>10</ElapsedTime>\\n <InputRows>105</InputRows>\\n <ScanRows>0</ScanRows>\\n <ScanCost>0</ScanCost>\\n <State>FINISHED</State>\\n <OutputRows>105</OutputRows>\\n <OperatorCost>3</OperatorCost>\\n <ScanSize>0</ScanSize>\\n</TaskList>","errorExample":""}]', + 'title' => 'DescribeSQLPlanTask', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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' => '10826', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + '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, + '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' => '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**: Chinese.'."\n" + .'* **en**: English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp1xxxxxxxx47', + ], + 'SuggestMaxRecordsPerPartition' => [ + 'description' => 'The recommended maximum number of rows in each list partition.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640000000', + ], + 'SuggestMinRecordsPerPartition' => [ + 'description' => 'The recommended minimum number of rows in each list partition.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64000000', + ], + 'Items' => [ + 'description' => 'The table statistics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'test_table', + ], + 'PartitionDetail' => [ + 'description' => 'The information about inappropriate partitions.'."\n", + 'type' => 'string', + 'example' => '202005,202006', + ], + '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', + ], + '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%.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '66.23', + ], + 'TotalSize' => [ + 'description' => 'The total data size of the table. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42949672960', + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the detection item.'."\n", + 'type' => 'string', + 'example' => 'Improper Partition Field Diagnosis'."\n", + ], + 'Message' => [ + 'description' => 'The detection result.'."\n", + 'type' => 'string', + 'example' => 'A total of 10 tables have an improper partition field'."\n", + ], + 'Status' => [ + 'description' => 'The severity level of the detection result. Valid values:'."\n" + ."\n" + .'* NORMAL'."\n" + .'* WARNING'."\n" + .'* CRITICAL'."\n", + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageSize\\": 123,\\n \\"PageNumber\\": 34,\\n \\"DBClusterId\\": \\"rm-uf6wjk5xxxxxxxxxx\\",\\n \\"SuggestMaxRecordsPerPartition\\": 640000000,\\n \\"SuggestMinRecordsPerPartition\\": 64000000,\\n \\"Items\\": [\\n {\\n \\"TableName\\": \\"user\\",\\n \\"PartitionDetail\\": \\"[20210110, 20210113,20210123]\\",\\n \\"SchemaName\\": \\"test_db\\",\\n \\"PartitionNumber\\": 34,\\n \\"SpaceRatio\\": 66.23,\\n \\"TotalSize\\": 42949672960\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"表分区合理性检测\\",\\n \\"Message\\": \\"检测到表存在分区不合理的情况\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<PageSize>123</PageSize>\\n<PageNumber>34</PageNumber>\\n<DBClusterId>rm-uf6wjk5xxxxxxxxxx</DBClusterId>\\n<SuggestMaxRecordsPerPartition>640000000</SuggestMaxRecordsPerPartition>\\n<SuggestMinRecordsPerPartition>64000000</SuggestMinRecordsPerPartition>\\n<Items>\\n <TableName>user</TableName>\\n <PartitionDetail>[20210110, 20210113,20210123]</PartitionDetail>\\n <SchemaName>test_db</SchemaName>\\n <PartitionNumber>34</PartitionNumber>\\n</Items>","errorExample":""}]', + 'title' => 'DescribeTablePartitionDiagnose', + ], + 'DescribeLoadTasksRecords' => [ + 'summary' => 'Queries the information about asynchronous import and export tasks 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', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + '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' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters in a region, including cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp2590j****', + ], + ], + [ + '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" + .'> We recommend that you set the query start time to any point in time within 30 days.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-18T06:00:00Z', + ], + ], + [ + '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:mm:ssZ* format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-18T06:30:00Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database that is involved in the import or export task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + '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' => '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' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which to sort the tasks by field. Specify the field and the sort order in the JSON format. Example: `[{"Field":"CreateTime", "Type":"desc"}]`.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* `Field` specifies the field that is used to sort the tasks. Valid values of Field: `State`, `CreateTime`, `DBName`, `ProcessID`, `UpdateTime`, `JobName`, and `ProcessRows`.'."\n" + ."\n" + .'* `Type` specifies the sort order. Valid values of Type: `Desc` and `Asc`. The values are case-insensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"CreateTime", "Type":"desc"}]', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the asynchronous import or export task to be queried. Valid values:'."\n" + ."\n" + .'* **INIT**: The task is being initialized.'."\n" + .'* **RUNNING**: The task is running.'."\n" + .'* **FINISH**: The task is successful.'."\n" + .'* **FAILED**: The task fails.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FINISH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C60B05DB-2B77-421A-98E9-92C20E******', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp2590j****', + ], + 'LoadTasksRecords' => [ + 'description' => 'The queried asynchronous import and export tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried asynchronous import or export task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Sql' => [ + 'description' => 'The SQL statement that is used in the asynchronous import or export task.'."\n", + 'type' => 'string', + 'example' => 'insert overwrite into courses_external_table\\nselect * from courses', + ], + 'State' => [ + 'description' => 'The state of the task.'."\n", + 'type' => 'string', + 'example' => 'FINISH', + ], + 'CreateTime' => [ + 'description' => 'The start time of the task. The time is accurate to milliseconds. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ss.SSSZ* format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-05-18 18:47:27.0', + ], + 'DBName' => [ + 'description' => 'The name of the database that is involved in the import or export task.'."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'ProcessID' => [ + 'description' => 'The process ID.'."\n", + 'type' => 'string', + 'example' => '2021051818472717201616624903453******', + ], + 'UpdateTime' => [ + 'description' => 'The time when the task state was updated. The time is accurate to milliseconds. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ss.SSSZ* format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-05-18 18:47:31.0', + ], + 'JobName' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '2021051818472717201616624903453******', + ], + 'ProcessRows' => [ + 'description' => 'The number of rows that are processed in the asynchronous import or export task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"C60B05DB-2B77-421A-98E9-92C20E******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-bp2590j****\\",\\n \\"LoadTasksRecords\\": [\\n {\\n \\"Sql\\": \\"insert overwrite into courses_external_table\\\\\\\\nselect * from courses\\",\\n \\"State\\": \\"FINISH\\",\\n \\"CreateTime\\": \\"2021-05-18 18:47:27.0\\",\\n \\"DBName\\": \\"adb_demo\\",\\n \\"ProcessID\\": \\"2021051818472717201616624903453******\\",\\n \\"UpdateTime\\": \\"2021-05-18 18:47:31.0\\",\\n \\"JobName\\": \\"2021051818472717201616624903453******\\",\\n \\"ProcessRows\\": 6\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeLoadTasksRecordsResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>C60B05DB-2B77-421A-98E9-92C20E******</RequestId>\\n <PageNumber>1</PageNumber>\\n <DBClusterId>am-bp2590j****</DBClusterId>\\n <LoadTasksRecords>\\n <Sql>insert overwrite into courses_external_table\\\\nselect * from courses</Sql>\\n <State>FINISH</State>\\n <CreateTime>2021-05-18 18:47:27.0</CreateTime>\\n <DBName>adb_demo</DBName>\\n <ProcessID>2021051818472717201616624903453******</ProcessID>\\n <UpdateTime>2021-05-18 18:47:31.0</UpdateTime>\\n <JobName>2021051818472717201616624903453******</JobName>\\n <ProcessRows>6</ProcessRows>\\n </LoadTasksRecords>\\n</DescribeLoadTasksRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeLoadTasksRecords', + 'description' => 'For information about how to asynchronously submit import and export tasks, see [Asynchronously submit an import or export task](~~160291~~).'."\n", + ], + 'DescribeConnectionCountRecords' => [ + 'summary' => 'Queries the current number of connections to an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-bp1jj9xqft1po****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '562C7F89-FBE6-4A04-AAAA-7EBC25******', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp1jj9xqft1po****', + ], + 'AccessIpRecords' => [ + 'description' => 'The queried client IP addresses.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessIp' => [ + 'description' => 'The IP address of the client.'."\n", + 'type' => 'string', + 'example' => '42.120.XX.XX', + ], + 'Count' => [ + 'description' => 'The number of connections.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'UserRecords' => [ + 'description' => 'The queried database accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'User' => [ + 'description' => 'The username of the database account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Count' => [ + 'description' => 'The number of connections.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"562C7F89-FBE6-4A04-AAAA-7EBC25******\\",\\n \\"DBClusterId\\": \\"am-bp1jj9xqft1po****\\",\\n \\"AccessIpRecords\\": [\\n {\\n \\"AccessIp\\": \\"42.120.XX.XX\\",\\n \\"Count\\": 1\\n }\\n ],\\n \\"UserRecords\\": [\\n {\\n \\"User\\": \\"test\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeConnectionCountRecordsResponse>\\n <RequestId>562C7F89-FBE6-4A04-AAAA-7EBC25******</RequestId>\\n <DBClusterId>am-bp1jj9xqft1po****</DBClusterId>\\n <AccessIpRecords>\\n <AccessIp>42.120.XX.XX</AccessIp>\\n <Count>1</Count>\\n </AccessIpRecords>\\n <UserRecords>\\n <User>test</User>\\n <Count>1</Count>\\n </UserRecords>\\n</DescribeConnectionCountRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeConnectionCountRecords', + ], + 'KillProcess' => [ + 'summary' => 'Terminates an ongoing query.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads8FGISX', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the query. You can call the [DescribeProcessList](~~190092~~) operation to obtain the unique ID of a query.'."\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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>","errorExample":""}]', + 'title' => 'KillProcess', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAuditLogConfig' => [ + 'summary' => '修改审计日志设置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10840', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-t4nj8619bz2w3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region. 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' => 'AuditLogStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of SQL audit. Valid values:'."\n" + ."\n" + .'* **on**: SQL audit is enabled.'."\n" + .'* **off**: SQL audit is disabled.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'on', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'UpdateSucceed' => [ + 'description' => 'Indicates whether the status of SQL audit is updated. Valid values:'."\n" + ."\n" + .'* **true**: The status of SQL audit is updated.'."\n" + .'* **false**: The status of SQL audit is not updated.'."\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\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"UpdateSucceed\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyAuditLogConfigResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <UpdateSucceed>true</UpdateSucceed>\\n</ModifyAuditLogConfigResponse>","errorExample":""}]', + 'title' => 'ModifyAuditLogConfig', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => '查看慢日志', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1rqvm70uh2****', + ], + ], + [ + '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, + 'docRequired' => true, + 'example' => '2021-05-20T16: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" + ."\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' => true, + 'docRequired' => true, + 'example' => '2021-05-27T16:00:00Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**. 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 number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProcessID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the process.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021052716044317201616624903453******', + ], + ], + [ + '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"}]`.'."\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 ID of the process.'."\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":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]', + ], + ], + [ + 'name' => 'Range', + 'in' => 'query', + 'schema' => [ + 'description' => 'The range conditions used to filter specified fields, including `Max` and `Min`. Specify this parameter in the JSON format. Example: `[{"Field":"ScanSize","Min":"1000000","Max":"10000000"},{"Field":"QueryTime","Min":"1000","Max":"10000"}]`.'."\n" + ."\n" + .'`Field`: the field to be filtered. Valid values:'."\n" + ."\n" + .'* **ScanSize**: the amount of data to be scanned. Unit: KB.'."\n" + .'* **QueryTime**: the amount of time consumed to execute the statement. Unit: milliseconds.'."\n" + .'* **PeakMemoryUsage**: the maximum memory usage when the SQL statement is executed. Unit: KB.'."\n" + ."\n" + .'> `Min` indicates the minimum value of the query range (left operand). `Max` indicates the maximum value of the query range (right operand). Max and Min are both of the String type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"ScanSize","Min":"1000000","Max":"10000000"},{"Field":"QueryTime","Min":"1000","Max":"10000"}]', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the query. Valid values:'."\n" + ."\n" + .'* **Successed**: successful'."\n" + .'* **Failed**: failed'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Successed', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned on the current page.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D7559209-7EC3-41E1-8F78-156990******', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp1rqvm70uh2****', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SlowLogRecord' => [ + 'description' => 'Details of the slow query logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HostAddress' => [ + 'description' => 'The IP address of the client that is used to connect to the database.'."\n", + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'ScanTime' => [ + 'description' => 'The total amount of time consumed to scan data. It is an accumulated value collected from multiple TableScanNode nodes. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SQLText' => [ + 'description' => 'Details of the SQL statement.'."\n", + 'type' => 'string', + 'example' => 'INSERT OVERWRITE INTO hdfs_import_external\\nSELECT *\\nFROM adb_hdfs_import_source', + ], + 'OutputSize' => [ + 'description' => 'The amount of output data in the task. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '0.009', + ], + 'PeakMemoryUsage' => [ + 'description' => 'The maximum memory usage when the SQL statement is executed. Unit: KB.'."\n", + 'type' => 'string', + 'example' => '431.447', + ], + 'State' => [ + 'description' => 'The execution state of the SQL statement.'."\n", + 'type' => 'string', + 'example' => 'SUCCESSED', + ], + 'WallTime' => [ + 'description' => 'The accumulated CPU Time value of all operators collected from all nodes. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6100', + ], + 'ScanSize' => [ + 'description' => 'The amount of scanned data. Unit: KB.'."\n", + 'type' => 'string', + 'example' => '0.035', + ], + 'ExecutionStartTime' => [ + 'description' => 'The time when the execution started. 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-05-27T08:04:43Z', + ], + 'QueryTime' => [ + 'description' => 'The time consumed to execute the SQL statement. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2344', + ], + 'ReturnRowCounts' => [ + 'description' => 'The number of rows returned by the SQL statement.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ScanRows' => [ + 'description' => 'The number of rows scanned from a data source in the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ParseRowCounts' => [ + 'description' => 'The number of rows parsed by the SQL statement.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DBName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'adb_demo', + ], + 'PlanningTime' => [ + 'description' => 'The amount of time consumed to generate execution plans. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'QueueTime' => [ + 'description' => 'The queuing duration before the query is executed. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UserName' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ProcessID' => [ + 'description' => 'The ID of the process.'."\n", + 'type' => 'string', + 'example' => '2021052716044317201616624903453******', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"100\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"D7559209-7EC3-41E1-8F78-156990******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-bp1rqvm70uh2****\\",\\n \\"Items\\": {\\n \\"SlowLogRecord\\": [\\n {\\n \\"HostAddress\\": \\"172.16.**.**\\",\\n \\"ScanTime\\": 10,\\n \\"SQLText\\": \\"INSERT OVERWRITE INTO hdfs_import_external\\\\\\\\nSELECT *\\\\\\\\nFROM adb_hdfs_import_source\\",\\n \\"OutputSize\\": \\"0.009\\",\\n \\"PeakMemoryUsage\\": \\"431.447\\",\\n \\"State\\": \\"SUCCESSED\\",\\n \\"WallTime\\": 6100,\\n \\"ScanSize\\": \\"0.035\\",\\n \\"ExecutionStartTime\\": \\"2021-05-27T08:04:43Z\\",\\n \\"QueryTime\\": 2344,\\n \\"ReturnRowCounts\\": 1,\\n \\"ScanRows\\": 3,\\n \\"ParseRowCounts\\": 0,\\n \\"DBName\\": \\"adb_demo\\",\\n \\"PlanningTime\\": 12,\\n \\"QueueTime\\": 0,\\n \\"UserName\\": \\"test\\",\\n \\"ProcessID\\": \\"2021052716044317201616624903453******\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSlowLogRecordsResponse>\\n <TotalCount>100</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>D7559209-7EC3-41E1-8F78-156990******</RequestId>\\n <PageNumber>1</PageNumber>\\n <DBClusterId>am-bp1rqvm70uh2****</DBClusterId>\\n <Items>\\n <HostAddress>172.16.**.**</HostAddress>\\n <ScanTime>10</ScanTime>\\n <SQLText>INSERT OVERWRITE INTO hdfs_import_external\\\\nSELECT *\\\\nFROM adb_hdfs_import_source</SQLText>\\n <OutputSize>0.009</OutputSize>\\n <PeakMemoryUsage>431.447</PeakMemoryUsage>\\n <State>SUCCESSED</State>\\n <WallTime>6100</WallTime>\\n <ScanSize>0.035</ScanSize>\\n <ExecutionStartTime>2021-05-27T08:04:43Z</ExecutionStartTime>\\n <QueryTime>2344</QueryTime>\\n <ReturnRowCounts>1</ReturnRowCounts>\\n <ScanRows>3</ScanRows>\\n <ParseRowCounts>0</ParseRowCounts>\\n <DBName>adb_demo</DBName>\\n <PlanningTime>12</PlanningTime>\\n <QueueTime>0</QueueTime>\\n <UserName>test</UserName>\\n <ProcessID>2021052716044317201616624903453******</ProcessID>\\n </Items>\\n</DescribeSlowLogRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeSlowLogRecords', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAuditLogConfig' => [ + 'summary' => 'Queries the SQL audit settings 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' => '10786', + '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-t4nj8619bz2w3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster. 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' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F0983B43-B2EC-536A-8791-142B5CF1E9B6', + ], + 'AuditLogStatus' => [ + 'description' => 'The status of SQL audit. Valid values:'."\n" + ."\n" + .'* **on**: SQL audit is enabled.'."\n" + .'* **off**: SQL audit is disabled.'."\n", + 'type' => 'string', + 'example' => 'on', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-t4nj8619bz2w3****', + ], + '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" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\",\\n \\"AuditLogStatus\\": \\"on\\",\\n \\"DBClusterId\\": \\"am-t4nj8619bz2w3****\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeAuditLogConfigResponse>\\n <RequestId>F0983B43-B2EC-536A-8791-142B5CF1E9B6</RequestId>\\n <AuditLogStatus>on</AuditLogStatus>\\n <DBClusterId>am-t4nj8619bz2w3****</DBClusterId>\\n</DescribeAuditLogConfigResponse>","errorExample":""}]', + 'title' => 'DescribeAuditLogConfig', + ], + 'DescribeAuditLogRecords' => [ + 'summary' => 'Queries the SQL audit logs of an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10787', + 'abilityTreeNodes' => [ + 'FEATUREadsGAMOR7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-t4nj8619bz2w3****', + ], + ], + [ + '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' => '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-01-23T02:18Z', + ], + ], + [ + '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.'."\n" + .'> - The maximum time range that can be specified is 24 hours.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-01-23T22:18Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database on which you want to execute the SQL statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keywords that are included in the SQL statement to query.'."\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, the **SELECT** 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 name of the user who executed the SQL statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which specified fields are sorted. Specify this parameter as an ordered JSON array that consists of the Field and Type fields.'."\n" + ."\n" + .'* Field specifies 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" + .' * Succeed: specifies whether the SQL statement is successfully executed.'."\n" + .' * TotalTime: the total amount of time that is consumed to execute the SQL statement.'."\n" + .' * DBName: the name of the database on which the SQL statement is executed.'."\n" + .' * SQLType: the type of the SQL statement.'."\n" + .' * User: the username that is used to execute the SQL statement.'."\n" + .' * ExecuteTime: the time to start executing the SQL statement.'."\n" + ."\n" + .'* Type specifies the sorting order. 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**'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'> If you leave this parameter empty, the value 10 is used.'."\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. The value is an integer that is greater than 0. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Details of the SQL audit logs.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned 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 of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-t4nj8619bz2w3****', + ], + 'Items' => [ + 'description' => 'The queried SQL audit logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\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' => 'Details of the SQL statement.'."\n", + 'type' => 'string', + 'example' => 'SELECT * FROM tb_courses', + ], + 'TotalTime' => [ + 'description' => 'The amount of time that is consumed to execute the SQL statement. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '216', + ], + 'ConnId' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'DBName' => [ + 'description' => 'The name of the database on which the SQL statement was executed.'."\n", + 'type' => 'string', + 'example' => 'adb_test', + ], + 'SQLType' => [ + 'description' => 'The type of the SQL statement.'."\n", + 'type' => 'string', + 'example' => 'SELECT', + ], + 'ProcessID' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '202106081752021720161662490345362390', + ], + 'User' => [ + 'description' => 'The name of the user who executed the SQL statement.'."\n", + 'type' => 'string', + 'example' => 'test_user', + ], + '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-01-23 16:05:08', + ], + 'ExecuteTimestamp' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"RequestId\\": \\"8A564B7F-8C00-43C0-8EC5-919FBB70573\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-t4nj8619bz2w3****\\",\\n \\"Items\\": [\\n {\\n \\"HostAddress\\": \\"100.104.XX.XX:43908\\",\\n \\"Succeed\\": \\"true\\",\\n \\"SQLText\\": \\"SELECT * FROM tb_courses\\",\\n \\"TotalTime\\": \\"216\\",\\n \\"ConnId\\": \\"无\\",\\n \\"DBName\\": \\"adb_test\\",\\n \\"SQLType\\": \\"SELECT\\",\\n \\"ProcessID\\": \\"202106081752021720161662490345362390\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": \\"2022-01-23 16:05:08\\",\\n \\"ExecuteTimestamp\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAuditLogRecordsResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>8A564B7F-8C00-43C0-8EC5-919FBB70573</RequestId>\\n <PageNumber>1</PageNumber>\\n <DBClusterId>am-t4nj8619bz2w3****</DBClusterId>\\n <Items>\\n <HostAddress>100.104.XX.XX:43908</HostAddress>\\n <Succeed>true</Succeed>\\n <SQLText>SELECT * FROM tb_courses</SQLText>\\n <TotalTime>216</TotalTime>\\n <ConnId>无</ConnId>\\n <DBName>adb_test</DBName>\\n <SQLType>SELECT</SQLType>\\n <ExecuteTime>2022-01-23 16:05:08</ExecuteTime>\\n <ProcessID>202106081752021720161662490345362390</ProcessID>\\n <User>test_user</User>\\n </Items>\\n</DescribeAuditLogRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeAuditLogRecords', + 'description' => 'Before you call the DescribeAuditLogRecords operation to query the SQL audit logs of an AnalyticDB for MySQL cluster, you must enable SQL audit for the cluster. You can call the [DescribeAuditLogConfig](~~190628~~) operation to query the status of SQL audit. If SQL audit is disabled, you can call the [ModifyAuditLogConfig](~~190629~~) operation to enable SQL audit.'."\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. The following operations are not recorded in SQL audit logs: **INSERT INTO VALUES**, **REPLACE INTO VALUES**, and **UPSERT INTO VALUES**.'."\n", + ], + 'DescribeRegions' => [ + 'summary' => 'Queries a list of available regions and zones for AnalyticDB for MySQL.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '95108', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Th language of the `LocalName` response parameter. Valid values:'."\n" + ."\n" + .'* **zh-CN**: Chinese.'."\n" + .'* **en-US**: English.'."\n" + .'* **ja**: Japanese.'."\n" + ."\n" + .'> If you do not specify this parameter, the Chinese language is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en-US', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~612293~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => 'The endpoint of the region.'."\n", + 'type' => 'string', + 'example' => 'adb.aliyuncs.com', + ], + 'LocalName' => [ + 'description' => 'The region name.'."\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 zone name.'."\n", + 'type' => 'string', + 'example' => 'Hangzhou Zone H', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"adb.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"VpcEnabled\\": true,\\n \\"LocalName\\": \\"Hangzhou Zone H\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'ModifyClusterConnectionString' => [ + 'summary' => 'Changes the endpoint 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' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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, + 'docRequired' => true, + 'example' => 'am-bp18934i73vb****', + ], + ], + [ + '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' => true, + 'docRequired' => true, + 'example' => 'test-123', + ], + ], + [ + 'name' => 'CurrentConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The current public endpoint of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusterNetInfo](~~143384~~) operation to query the public endpoint of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp18934i73vb****.ads.aliyuncs.com', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number. Set the value to **3306**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '3306', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '370D09FD-442A-5225-AAD3-7362CAE39177', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"370D09FD-442A-5225-AAD3-7362CAE39177\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyClusterConnectionStringResponse>\\n <RequestId>370D09FD-442A-5225-AAD3-7362CAE39177</RequestId>\\n</ModifyClusterConnectionStringResponse>","errorExample":""}]', + 'title' => 'ModifyClusterConnectionString', + ], + 'DescribeDBClusterNetInfo' => [ + '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' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10799', + 'abilityTreeNodes' => [ + 'FEATUREads4DZDZG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterNetworkType' => [ + 'description' => 'The network type of the cluster.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Address' => [ + 'description' => 'The queried network information about the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n" + ."\n" + .'> If NetType is set to Public, an empty string is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => 'vsw-xxxxxx', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint of the cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bpxxxxxxxx.ads.aliyuncs.com', + ], + 'NetType' => [ + 'description' => 'The network type of the cluster. Valid values:'."\n" + ."\n" + .'* **Public**: public endpoint.'."\n" + .'* **VPC**: Virtual Private Cloud (VPC) endpoint.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => 'The port number that is used to connect to the cluster.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'VPCId' => [ + 'description' => 'The VPC ID.'."\n" + ."\n" + .'> If NetType is set to Public, an empty string is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => 'vpc-xxxxxxxxx', + ], + 'IPAddress' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '192.168.x.x', + ], + 'ConnectionStringPrefix' => [ + 'description' => 'The prefix of the cluster endpoint.'."\n", + 'type' => 'string', + 'example' => 'am-bpxxxxxxxx89k51380', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClusterNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"Address\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-xxxxxx\\",\\n \\"ConnectionString\\": \\"am-bpxxxxxxxx.ads.aliyuncs.com\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-xxxxxxxxx\\",\\n \\"IPAddress\\": \\"192.168.x.x\\",\\n \\"ConnectionStringPrefix\\": \\"am-bpxxxxxxxx89k51380\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterNetInfoResponse>\\n <ClusterNetworkType>VPC</ClusterNetworkType>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <Items>\\n <VSwitchId>vsw-xxxxxx</VSwitchId>\\n <ConnectionString>am-bpxxxxxxxx.ads.aliyuncs.com</ConnectionString>\\n <NetType>VPC</NetType>\\n <Port>3306</Port>\\n <VPCId>vpc-xxxxxxxxx</VPCId>\\n <IPAddress>192.168.x.x</IPAddress>\\n <ConnectionStringPrefix>am-bpxxxxxxxx89k51380</ConnectionStringPrefix>\\n </Items>\\n</DescribeDBClusterNetInfoResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterNetInfo', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AllocateClusterPublicConnection' => [ + 'summary' => 'Applies for a public endpoint for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10759', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Data Warehouse Edition Cluster ID of AnalyticDB for MySQL. You can call the [DescribeDBClusters](~~129857~~) operation to retrieve all Data Warehouse Edition cluster IDs within the specified region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp278jg9****', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the public endpoint.'."\n" + ."\n" + .'* The prefix must 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" + .'* By default, the cluster name is used as the prefix of the public endpoint.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'am-bp278jg9****.ads.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The 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.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<AllocateClusterPublicConnectionResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</AllocateClusterPublicConnectionResponse>","errorExample":""}]', + 'title' => 'AllocateClusterPublicConnection', + ], + 'ReleaseClusterPublicConnection' => [ + 'summary' => 'Releases the public endpoint of an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '10857', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>","errorExample":""}]', + 'title' => 'ReleaseClusterPublicConnection', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVSwitches' => [ + 'summary' => 'Queries the vSwitches.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the VPC ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp13h7uzhulpuxvnp****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~129857~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'VswId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-8vbpu1teend1qcosfojlz', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D65A809F-34CE-4550-9BC1-0ED21ETG380', + ], + 'VSwitches' => [ + 'description' => 'The queried vSwitches.'."\n", + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'description' => 'The queried vSwitch.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The state of the vSwitch. Valid values: **Pending**: the vSwitch is being configured. **Available**: the vSwitch is available.'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values: **true**: The vSwitch is the default vSwitch. **false**: The vSwitch is not the default vSwitch.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-25bcdxs7pv1****', + ], + 'CidrBlock' => [ + 'description' => 'The IPv4 CIDR block of the vSwitch.'."\n", + 'type' => 'string', + 'example' => '172.16.0.0/24', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => 'The time when the vSwitch was created.'."\n", + 'type' => 'string', + 'example' => '2022-01-18T12:43:57Z', + ], + 'AliUid' => [ + 'description' => 'The ID of the Resource Access Management (RAM) user.'."\n", + 'type' => 'string', + 'example' => '195813423043****', + ], + 'GmtModified' => [ + 'description' => 'The time when the vSwitch was modified.'."\n", + 'type' => 'string', + 'example' => '2022-01-22T12:43:57Z', + ], + 'Bid' => [ + 'description' => 'The ID of the user channel.'."\n", + 'type' => 'string', + 'example' => '2****', + ], + 'IzNo' => [ + 'description' => 'The zone ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'VSwitchName' => [ + 'description' => 'The name of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vswitch', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D65A809F-34CE-4550-9BC1-0ED21ETG380\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": false,\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\",\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2022-01-18T12:43:57Z\\",\\n \\"AliUid\\": \\"195813423043****\\",\\n \\"GmtModified\\": \\"2022-01-22T12:43:57Z\\",\\n \\"Bid\\": \\"2****\\",\\n \\"IzNo\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchName\\": \\"vswitch\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVSwitchesResponse>\\n <RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>\\n <VSwitches>\\n <VSwitch>\\n <Status>Available</Status>\\n <IsDefault>false</IsDefault>\\n <VSwitchId>vsw-25bcdxs7pv1****</VSwitchId>\\n <CidrBlock>172.16.0.0/24</CidrBlock>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <GmtCreate>2022-01-18T12:43:57Z</GmtCreate>\\n <AliUid>195813423043****</AliUid>\\n <GmtModified>2022-01-22T12:43:57Z</GmtModified>\\n <Bid>2****</Bid>\\n <IzNo>cn-hangzhou-k</IzNo>\\n <VSwitchName>vswitch</VSwitchName>\\n </VSwitch>\\n </VSwitches>\\n</DescribeVSwitchesResponse>","errorExample":""}]', + 'title' => 'DescribeVSwitches', + ], + 'CreateAccount' => [ + 'summary' => 'Creates a database account for an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10764', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to view cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + '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, + 'docRequired' => 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, + 'docRequired' => 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 can be up to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test account'."\n", + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database account. Valid values:'."\n" + ."\n" + .'* **Normal**: standard account. Up to 256 standard accounts can be created for a cluster.'."\n" + .'* **Super** (default): privileged account. Only a single privileged account can be created for a cluster.'."\n" + ."\n" + .'> If a cluster does not have accounts, you can specify this parameter to create a privileged account or standard account. If a cluster has a privileged account, you must set this parameter to Normal to create a standard account. Otherwise, the operation fails. After an account is created, the privileged account has permissions on all databases of the cluster. The standard account does not have permissions and must be granted permissions on specific databases by the privileged account. For more information, see GRANT.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1564657730', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'example' => 'am-bp1r053byu48p****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 1564657730,\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"DBClusterId\\": \\"am-bp1r053byu48p****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccountResponse>\\n <TaskId>1564657730</TaskId>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n <DBClusterId>am-bp1r053byu48p****</DBClusterId>\\n</CreateAccountResponse>","errorExample":""}]', + 'title' => 'CreateAccount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAccount' => [ + 'summary' => '删除高权限帐号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10773', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '* Normal: standard account'."\n" + .'* Super: privileged account'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>","errorExample":""}]', + 'title' => 'DeleteAccount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountDescription' => [ + 'summary' => 'Modifies the description of a database account 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' => '10839', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the account. The description must meet the following requirements:'."\n" + ."\n" + .'* The description must start with a letter.'."\n" + .'* The description can contain letters, digits, underscores (\\_), and hyphens (-).'."\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' => 'AccDesc', + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>","errorExample":""}]', + 'title' => 'ModifyAccountDescription', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAllAccounts' => [ + 'summary' => 'Queries the information about an account or the list of accounts of a specific database within 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' => '10784', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'AccountList' => [ + 'description' => 'The queried database accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'User' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'rdsdt_dts_adb', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"AccountList\\": [\\n {\\n \\"User\\": \\"rdsdt_dts_adb\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<AccountList>\\n <User>rdsdt_dts_adb</User>\\n</AccountList>","errorExample":""}]', + 'title' => 'DescribeAllAccounts', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAccounts' => [ + 'summary' => 'Queries a list of database accounts 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' => '10782', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + [ + '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 is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'required' => false, + ], + 'Value' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database account. If you do not specify this parameter, the information about all account types is returned. Valid values:'."\n" + ."\n" + .'* **Normal**: standard account.'."\n" + .'* **Super**: privileged account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '64E37E6F-C363-41F3-867A-70EF5DC60EA4', + ], + 'AccountList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBAccount' => [ + 'description' => 'The queried database accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountStatus' => [ + 'description' => 'The state 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' => 'C@test', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'AccountType' => [ + 'description' => 'The type of the database account. Valid values:'."\n" + ."\n" + .'* **Normal**: standard account.'."\n" + .'* **Super**: privileged account.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'AccountName' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CCFAAB4-97B7-5800-B9F2-685EB596E3EF\\",\\n \\"AccountList\\": {\\n \\"DBAccount\\": [\\n {\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountDescription\\": \\"C@test\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_CPU\\",\\n \\"Value\\": \\"0\\"\\n }\\n ]\\n },\\n \\"AccountType\\": \\"Super\\",\\n \\"AccountName\\": \\"adb_user1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAccounts', + ], + 'DescribeOperatorPermission' => [ + 'summary' => 'Queries the details of the permissions granted to the service account 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' => '10811', + 'abilityTreeNodes' => [ + 'FEATUREadsZDDQS0', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CreatedTime' => [ + 'description' => 'The time when the permissions take effect.'."\n", + 'type' => 'string', + 'example' => '2019-05-20T05:41:19Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Privileges' => [ + 'description' => 'The types of the permissions. Valid values: Control and Data.'."\n", + 'type' => 'string', + 'example' => 'Control,Data', + ], + 'ExpiredTime' => [ + 'description' => 'The time when the permissions expire.'."\n", + 'type' => 'string', + 'example' => '2019-05-20T07:41:19Z', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CreatedTime\\": \\"2019-05-20T05:41:19Z\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Privileges\\": \\"Control,Data\\",\\n \\"ExpiredTime\\": \\"2019-05-20T07:41:19Z\\",\\n \\"DBClusterId\\": \\"am-uf6wjk5xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatedTime>2019-05-20T05:41:19Z</CreatedTime>\\n<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<Privileges>Control,Data</Privileges>\\n<ExpiredTime>2019-05-20T07:41:19Z</ExpiredTime>\\n<DBClusterId>rm-uf6wjk5xxxxxxxxxx</DBClusterId>","errorExample":""}]', + 'title' => 'DescribeOperatorPermission', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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', + 'abilityTreeNodes' => [ + 'FEATUREadsZDDQS0', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-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**: configuration permissions. The service account is granted permissions to query and modify cluster configurations.'."\n" + .'* **Data**: data permissions. The service account is granted permissions to query schemas, indexes, and SQL statements.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Control', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A438072A-E2E7-5509-9A3F-66293512A820', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RelatedTaskNotFinish', + 'errorMessage' => 'The related task does not finish.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A438072A-E2E7-5509-9A3F-66293512A820\\"\\n}","errorExample":""},{"type":"xml","example":"<GrantOperatorPermissionResponse>\\n <RequestId>A438072A-E2E7-5509-9A3F-66293512A820</RequestId>\\n</GrantOperatorPermissionResponse>","errorExample":""}]', + 'title' => 'GrantOperatorPermission', + 'description' => '###'."\n" + ."\n" + .'If you need Alibaba Cloud technical support to perform operations on your AnalyticDB for MySQL cluster, you must grant permissions to the service account of your cluster. When the validity period of the authorization ends, the granted permissions are automatically revoked.'."\n", + ], + 'ResetAccountPassword' => [ + 'summary' => 'Resets the password of a database account for 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' => '10858', + 'abilityTreeNodes' => [ + 'FEATUREadsF4WPVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_accout', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the database account.'."\n" + ."\n" + .'* The password can contain 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, + 'docRequired' => true, + 'example' => 'Test_accout1', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '1. Normal: the standard account.'."\n" + .'2. Super: the privileged account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1564657730', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 1564657730,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"rm-uf6wjk5xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<TaskId>1564657730</TaskId>\\n<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<DBClusterId>rm-uf6wjk5xxxxxxxxxx</DBClusterId>","errorExample":""}]', + 'title' => 'ResetAccountPassword', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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' => '10859', + 'abilityTreeNodes' => [ + 'FEATUREadsZDDQS0', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RelatedTaskNotFinish', + 'errorMessage' => 'The related task does not finish.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>","errorExample":""}]', + 'title' => 'RevokeOperatorPermission', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags that are added to AnalyticDB for MySQL clusters, or the AnalyticDB for MySQL clusters that have tags added.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsSUMGII', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster. 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 type of the resource. Set the value to **cluster**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cluster', + ], + ], + [ + '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 multiple cluster IDs. Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following parameters: ResourceId.N and Tag.N.Key.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster ID. You can specify multiple cluster IDs. Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following parameters: ResourceId.N and Tag.N.Key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1l20nxxxxxxxxxx', + ], + 'required' => false, + 'example' => 'am-bp1l20nxxxxxxxxxx', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags that are added to clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag that is added to clusters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag. You can specify multiple 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 following parameters: ResourceId.N and Tag.N.Key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => 'The value of the tag. You can specify multiple 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' => [ + 'description' => 'The response parameters'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken.'."\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 tags that are added to clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag that is added to clusters.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The type of the resource. A value of cluster indicates an AnalyticDB for MySQL cluster.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'TagValue' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => 'testvalue1', + ], + 'ResourceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp1l20nxxxxxxxxxx', + ], + 'TagKey' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'testkey1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec21345\\",\\n \\"RequestId\\": \\"184DE106-CB2C-4DD2-B57F-396652E6C8F8\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"testvalue1\\",\\n \\"ResourceId\\": \\"am-bp1l20nxxxxxxxxxx\\",\\n \\"TagKey\\": \\"testkey1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <NextToken>212db86sca4384811e0b5e8707ec21345</NextToken>\\n <RequestId>184DE106-CB2C-4DD2-B57F-396652E6C8F8</RequestId>\\n <TagResources>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>testvalue1</TagValue>\\n <ResourceId>am-bp1l20nxxxxxxxxxx</ResourceId>\\n <TagKey>testkey1</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => 'ListTagResources', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => 'Adds tags to an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsSUMGII', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster. 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 type of the cluster. Set the value to **ALIYUN::ADB::CLUSTER**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ALIYUN::ADB::CLUSTER', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the cluster to which to add a tag. If you want to add a tag to multiple clusters, click **Add** and enter the cluster IDs.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can add tags to up to 50 clusters at a time.'."\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' => 'array', + 'items' => [ + 'description' => 'The ID of the cluster to which to add a tag. If you want to add a tag to multiple clusters, click **Add** and enter the cluster IDs.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can add tags to up to 50 clusters at a time.'."\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' => false, + 'example' => 'am-bp1gfds6a32s9****', + ], + 'required' => true, + 'example' => 'am-bp1xxx.1', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags to add to the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag. If you want to add multiple tags to a single cluster at a time, click **Add** and enter tag keys and values.'."\n" + ."\n" + .'> You can add up to 20 tags at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => 'The value of the tag. If you want to add multiple tags to a single cluster at a time, click **Add** and enter tag keys and values.'."\n" + ."\n" + .'> You can add up to 20 tags at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '863D51B7-5321-41D8-A0B6-A088B0450EFD', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0450EFD\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>863D51B7-5321-41D8-A0B6-A088B0450EFD</RequestId>","errorExample":""}]', + 'title' => 'TagResources', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => 'Removes all tags from AnalyticDB for MySQL clusters.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsSUMGII', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to **ALIYUN::ADB::CLUSTER**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ALIYUN::ADB::CLUSTER', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove all tags from clusters. Default value: false. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> If you specify TagKey and this parameter, this parameter does not take effect.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of cluster N. Valid values of N: 1 to 50.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-t4n6k19t9p9f3d0j0', + ], + 'required' => true, + 'maxItems' => 51, + 'example' => 'am-bp1xxx.1', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The key of tag N. Valid values of N: 1 to 20.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'productvalue', + ], + 'required' => false, + 'maxItems' => 21, + 'example' => 'a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189484043\\"\\n}","type":"json"}]', + 'title' => 'UntagResources', + ], + 'ModifyDBClusterAccessWhiteList' => [ + 'summary' => 'Modifies the IP address whitelists of a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '10846', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP addresses that you want to use to modify the IP address whitelist of the cluster. Separate multiple IP addresses with commas (,). You can specify up to 500 distinct IP addresses. The following formats are supported:'."\n" + ."\n" + .'* IP address. Example: 10.23.12.24.'."\n" + .'* CIDR block. Example: 10.23.12.24/24. In this example, 24 indicates that the prefix of the CIDR block is 24 bits in length. You can replace 24 with a value that ranges from 1 to 32.'."\n" + ."\n" + .'> This parameter must be specified unless ModifyMode is set to Delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10.23.12.24', + ], + ], + [ + 'name' => 'DBClusterIPArrayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP address whitelist that you want to modify. Default value: **Default**. The name of an IP address whitelist 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 digit.'."\n" + ."\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. 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-X.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hidden', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method that you want to use to modify the IP address whitelist. Valid values:'."\n" + ."\n" + .'* Cover: overwrites the IP address whitelist.'."\n" + .'* Append: adds IP addresses to the IP address whitelist.'."\n" + .'* Delete: removes IP addresses from the IP address whitelist.'."\n" + ."\n" + .'Default value: Cover.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Cover', + ], + ], + ], + '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' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityIPList.Duplicate', + 'errorMessage' => 'The specified IP address is duplicate.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Malformed', + 'errorMessage' => 'The specified SecurityIPList is incorrectly formatted.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 1564657730,\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"DBClusterId\\": \\"rm-uf6wjk5xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<TaskId>1564657730</TaskId>\\n<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n<DBClusterId>rm-uf6wjk5xxxxxxxxxx</DBClusterId>","errorExample":""}]', + 'title' => 'ModifyDBClusterAccessWhiteList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterAccessWhiteList' => [ + 'summary' => 'Queries a list of IP address whitelists 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' => '10797', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-uf6wjk5xxxxxxxxxx', + ], + ], + [ + '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-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IPArray' => [ + 'description' => 'The queried IP address whitelists.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterIPArrayAttribute' => [ + 'description' => 'The attribute of the IP address whitelist. By default, this parameter is empty.'."\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-X.'."\n", + 'type' => 'string', + 'example' => 'hidden', + ], + 'SecurityIPList' => [ + 'description' => 'The IP addresses in the IP address whitelist. Up to 1,000 IP addresses can be returned. Multiple IP addresses are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'DBClusterIPArrayName' => [ + 'description' => 'The name of the IP address whitelist.'."\n" + ."\n" + .'* The name of an IP address whitelist 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 digit.'."\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.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Items\\": {\\n \\"IPArray\\": [\\n {\\n \\"DBClusterIPArrayAttribute\\": \\"hidden\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"DBClusterIPArrayName\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<Items>\\n <IPArray>\\n <DBClusterIPArrayName>test</DBClusterIPArrayName>\\n <SecurityIPList>127.0.0.1</SecurityIPList>\\n <DBClusterIPArrayAttribute>hidden</DBClusterIPArrayAttribute>\\n </IPArray>\\n</Items>","errorExample":""}]', + 'title' => 'DescribeDBClusterAccessWhiteList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterSSL' => [ + 'summary' => 'Queries the SSL configurations of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220651', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~612293~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + ], + ], + [ + '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, + 'docRequired' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '348303D8-6F42-5141-9B00-A6EECA1E37B6', + ], + 'ExpireTime' => [ + 'description' => 'The time when the SSL certificate expires. 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-10-11T08:16:43Z', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint that is protected by SSL encryption.'."\n", + 'type' => 'string', + 'example' => 'am-d7oualxo05x4o5be872***.ads.aliyuncs.com', + ], + 'SSLEnabled' => [ + 'description' => 'Indicates whether SSL encryption is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + '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\\": \\"am-d7oualxo05x4o5be872***.ads.aliyuncs.com\\",\\n \\"SSLEnabled\\": true\\n}","type":"json"}]', + 'title' => 'DescribeDBClusterSSL', + ], + 'ModifyDBClusterSSL' => [ + 'summary' => 'Modifies the SSL configurations of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216076', + 'abilityTreeNodes' => [ + 'FEATUREadsG383TB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of AnalyticDB for MySQL Data Warehouse Edition clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable SSL encryption. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The internal or public endpoint for which the server certificate needs to be created or updated.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'am-d7oualxo05x4o5be872***.ads.aliyuncs.com', + ], + ], + ], + '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' => 'ModifyDBClusterSSL', + ], + 'ModifyBackupPolicy' => [ + 'summary' => 'Modifies the backup policy of an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '10842', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the full backup within a time range. Specify the time range in the HH:mmZ-HH:mmZ format. The time must be in UTC.'."\n" + ."\n" + .'> The time range is 1 hour.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '00:00Z-01:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The days of the week on which to perform 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' => '30', + 'default' => '7', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable real-time log backup. Valid values:'."\n" + ."\n" + .'* **Enable**'."\n" + ."\n" + .'* **Disable**'."\n" + ."\n" + .'> If you leave this parameter empty, the default value Enable is used.', + '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' => '30', + 'default' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter "BackupRetentionPeriod" should be within [7-%s] days.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyBackupPolicyResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</ModifyBackupPolicyResponse>","errorExample":""}]', + 'title' => 'ModifyBackupPolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyLogBackupPolicy' => [ + 'summary' => 'Modifies the log backup settings 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' => '10852', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm4f7oger****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable log backup. Valid values:'."\n" + ."\n" + .'* **Enable**'."\n" + .'* **Disable**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => 'string', + 'required' => false, + 'example' => '30', + 'default' => '7', + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyLogBackupPolicyResponse>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n</ModifyLogBackupPolicyResponse>","errorExample":""}]', + 'title' => 'ModifyLogBackupPolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupPolicy' => [ + 'summary' => 'Queries the backup settings 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' => '10790', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1xxxxxxxx47', + ], + ], + ], + '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 values:'."\n" + ."\n" + .'* Monday'."\n" + .'* Tuesday'."\n" + .'* Wednesday'."\n" + .'* Thursday'."\n" + .'* Friday'."\n" + .'* Saturday'."\n" + .'* Sunday'."\n", + 'type' => 'string', + 'example' => 'Tuesday,Friday', + ], + 'LogBackupRetentionPeriod' => [ + 'description' => 'The number of days for which log backup files are retained.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PreferredBackupTime' => [ + 'description' => 'The backup time. Specify the time in the HH:mmZ-HH:mmZ format.'."\n", + 'type' => 'string', + 'example' => '15:00Z-16:00Z', + ], + 'EnableBackupLog' => [ + 'description' => 'Specifies whether to enable the origin protocol policy.'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreferredBackupPeriod\\": \\"Tuesday,Friday\\",\\n \\"LogBackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"EnableBackupLog\\": \\"true\\",\\n \\"BackupRetentionPeriod\\": 7\\n}","errorExample":""},{"type":"xml","example":"<PreferredBackupPeriod>Tuesday,Friday</PreferredBackupPeriod>\\n<LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>\\n<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n<PreferredBackupTime>15:00Z-16:00Z</PreferredBackupTime>\\n<EnableBackupLog>true</EnableBackupLog>\\n<BackupRetentionPeriod>7</BackupRetentionPeriod>","errorExample":""}]', + 'title' => 'DescribeBackupPolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackups' => [ + 'summary' => 'Queries a list of backup sets 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' => '10791', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp18934i73vb5****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32732****', + ], + ], + [ + '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' => false, + 'example' => '2022-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' => false, + 'docRequired' => false, + 'example' => '2022-06-02T16: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' => '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' => 'CrossUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account to which the backup set belongs.'."\n" + ."\n" + .'> This parameter must be specified only when cross-account backup operations are performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '195****', + ], + ], + [ + 'name' => 'CrossRole', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Resource Access Management (RAM) role of the Alibaba Cloud account to which the backup set belongs.'."\n" + ."\n" + .'> This parameter must be specified only when cross-account backup operations are performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'role-for-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' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'FreeBackupSize' => [ + 'description' => 'The free size of backup sets. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalBackupSize' => [ + 'description' => 'The total size of backup sets. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64953700', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => 'The queried backup sets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried backup set.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.', + 'type' => 'string', + 'example' => 'am-bp18934i73vb5****', + ], + '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' => 'int64', + 'example' => '2167808', + ], + 'BackupEndTime' => [ + 'description' => 'The end time of the backup.'."\n", + 'type' => 'string', + 'example' => '2022-06-02T16:00Z', + ], + 'BackupExpiredTime' => [ + 'description' => 'The expiration time of the backup set.'."\n", + 'type' => 'string', + 'example' => '2022-07-02T16:00Z', + ], + 'BackupId' => [ + 'description' => 'The backup set ID.'."\n", + 'type' => 'string', + 'example' => '32732****', + ], + 'BackupMethod' => [ + 'description' => 'The backup method. Only Snapshot is returned.'."\n", + 'type' => 'string', + 'example' => 'Snapshot', + ], + 'BackupStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'CrossUser.CheckFailed', + 'errorMessage' => 'The input UID and role is not authorized.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"300\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"FreeBackupSize\\": 0,\\n \\"TotalBackupSize\\": 64953700,\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"DBClusterId\\": \\"am-bp18934i73vb5****\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2022-06-01T16:00Z\\",\\n \\"BackupSize\\": 2167808,\\n \\"BackupEndTime\\": \\"2022-06-02T16:00Z\\",\\n \\"BackupExpiredTime\\": \\"2022-07-02T16:00Z\\",\\n \\"BackupId\\": \\"32732****\\",\\n \\"BackupMethod\\": \\"Snapshot\\",\\n \\"BackupStatus\\": \\"Finished\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupsResponse>\\n <TotalCount>300</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <DBClusterId>am-bp18934i73vb5****</DBClusterId>\\n <BackupType>FullBackup</BackupType>\\n <BackupStartTime>2022-06-01T16:00Z</BackupStartTime>\\n <BackupSize>2167808</BackupSize>\\n <BackupEndTime>2022-06-02T16:00Z</BackupEndTime>\\n <BackupId>32732****</BackupId>\\n <BackupMethod>Snapshot</BackupMethod>\\n </Items>\\n</DescribeBackupsResponse>","errorExample":""}]', + 'title' => 'DescribeBackups', + ], + 'DescribeDBClusterHealthStatus' => [ + 'summary' => 'Queries the health status of an AnalyticDB for MySQL Data Warehouse Edition cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '150514', + 'abilityTreeNodes' => [ + 'FEATUREadsCVPI8C', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1d8lbdj22rx****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\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' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CS' => [ + 'description' => 'Health state details of access nodes.'."\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 access nodes.'."\n", + '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**: risky'."\n" + .'* **NORMAL**: healthy'."\n" + .'* **UNAVAILABLE**: unavailable'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + 'Executor' => [ + 'description' => 'Health state details of compute node groups.'."\n", + 'type' => 'object', + 'properties' => [ + 'ActiveCount' => [ + 'description' => 'The number of healthy compute node groups.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'UnavailableCount' => [ + 'description' => 'The number of unavailable compute node groups.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RiskCount' => [ + 'description' => 'The number of risky compute node groups.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpectedCount' => [ + 'description' => 'The total number of compute node groups.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Status' => [ + 'description' => 'The health state of compute node groups. Valid values:'."\n" + ."\n" + .'* **RISK**: risky'."\n" + .'* **NORMAL**: healthy'."\n" + .'* **UNAVAILABLE**: unavailable'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + 'Worker' => [ + 'description' => 'Health state details of storage node groups.'."\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**: risky'."\n" + .'* **NORMAL**: healthy'."\n" + .'* **UNAVAILABLE**: unavailable'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + 'InstanceStatus' => [ + 'description' => 'The health state of the cluster. Valid values:'."\n" + ."\n" + .'* **RISK**: risky'."\n" + ."\n" + .'* **NORMAL**: healthy'."\n" + ."\n" + .'* **UNAVAILABLE**: unavailable'."\n" + ."\n" + .'> If the health states of access nodes, compute node groups, and storage node groups are all **healthy** and the cluster is detected to be alive, the health state of the cluster is **healthy**. If the preceding three health states include **risky**, the health state of the cluster is **risky**. If the preceding three health states include **unavailable**, the health state of the cluster is **unavailable**.', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CS\\": {\\n \\"ActiveCount\\": 2,\\n \\"UnavailableCount\\": 0,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 2,\\n \\"Status\\": \\"NORMAL\\"\\n },\\n \\"Executor\\": {\\n \\"ActiveCount\\": 2,\\n \\"UnavailableCount\\": 0,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 2,\\n \\"Status\\": \\"NORMAL\\"\\n },\\n \\"Worker\\": {\\n \\"ActiveCount\\": 2,\\n \\"UnavailableCount\\": 0,\\n \\"RiskCount\\": 0,\\n \\"ExpectedCount\\": 2,\\n \\"Status\\": \\"NORMAL\\"\\n },\\n \\"InstanceStatus\\": \\"NORMAL\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEA\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterHealthStatusResponse>\\n <CS>\\n <ActiveCount>2</ActiveCount>\\n <UnavailableCount>0</UnavailableCount>\\n <RiskCount>0</RiskCount>\\n <ExpectedCount>2</ExpectedCount>\\n <Status>NORMAL</Status>\\n </CS>\\n <Executor>\\n <ActiveCount>2</ActiveCount>\\n <UnavailableCount>0</UnavailableCount>\\n <RiskCount>0</RiskCount>\\n <ExpectedCount>2</ExpectedCount>\\n <Status>NORMAL</Status>\\n </Executor>\\n <Worker>\\n <ActiveCount>2</ActiveCount>\\n <UnavailableCount>0</UnavailableCount>\\n <RiskCount>0</RiskCount>\\n <ExpectedCount>2</ExpectedCount>\\n <Status>NORMAL</Status>\\n </Worker>\\n <InstanceStatus>NORMAL</InstanceStatus>\\n <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEA</RequestId>\\n</DescribeDBClusterHealthStatusResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterHealthStatus', + ], + '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' => '10800', + 'abilityTreeNodes' => [ + 'FEATUREadsCVPI8C', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL 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, + 'docRequired' => true, + 'example' => 'am-************', + ], + ], + [ + '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', + 'default' => 'AnalyticDB_CPU_Usage_Percentage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the 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-05-03T15:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the 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' => '2021-05-03T15:01Z', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourcePools', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + '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' => '2021-05-03T15:01:00Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', + ], + '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' => '2021-05-03T15:00:00Z', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-************', + ], + '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', + ], + '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 queried performance metric.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the performance metric at a specific point in time.'."\n", + 'type' => 'string', + 'example' => '[ "2021-05-03T15:00:12.72Z", "0.1250" ], [ "2021-05-03T15:00:42.739Z", "0.3125" ]', + ], + ], + 'Name' => [ + 'description' => 'The name of the performance metric value. For more information about the performance metrics, see [Metric overview](~~2863211~~).'."\n", + 'type' => 'string', + 'example' => 'worker_avg_cpu_used', + ], + 'Tags' => [ + 'description' => 'The tags that are added to the cluster.'."\n", + 'type' => 'string', + 'example' => 'instance_name: "amv-8vbf80pjcz*****"', + ], + 'TranslateKey' => [ + 'description' => 'The key that is used to obtain the name of the performance metric value.'."\n", + 'type' => 'string', + 'example' => 'elastic_executor_avg_cpu_use', + ], + ], + ], + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => 'The information about the request denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "AuthAction": "xxx",'."\n" + .' "AuthPrincipalDisplayName": "sampleName",'."\n" + .' "AuthPrincipalOwnerId": "111111111111111111",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthResource": "xxx",'."\n" + .' "NoPermissionType": "xxx",'."\n" + .' "PolicyType": "xxx"'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-05-03T15:01:00Z\\",\\n \\"RequestId\\": \\"25B56BC7-4978-40B3-9E48-4B7067******\\",\\n \\"StartTime\\": \\"2021-05-03T15:00:00Z\\",\\n \\"DBClusterId\\": \\"am-8vbf80pjcz*****\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_CPU\\",\\n \\"Unit\\": \\"%\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n \\"[ \\\\\\"2021-05-03T15:00:12.72Z\\\\\\", \\\\\\"0.1250\\\\\\" ], [ \\\\\\"2021-05-03T15:00:42.739Z\\\\\\", \\\\\\"0.3125\\\\\\" ]\\"\\n ],\\n \\"Name\\": \\"worker_avg_cpu_used\\",\\n \\"Tags\\": \\"instance_name: \\\\\\"amv-8vbf80pjcz*****\\\\\\"\\",\\n \\"TranslateKey\\": \\"elastic_executor_avg_cpu_use\\"\\n }\\n ]\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"sampleName\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"111111111111111111\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthResource\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"xxx\\\\\\"\\\\n}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterPerformanceResponse>\\n <RequestId>25B56BC7-4978-40B3-9E48-4B7067******</RequestId>\\n <EndTime>2021-05-03T15:01:00Z</EndTime>\\n <DBClusterId>am-bp**************</DBClusterId>\\n <StartTime>2021-05-03T15:00:00Z</StartTime>\\n <Performances>\\n <Series>\\n <Values>\\n <0>2021-05-03T15:00:12.72Z</0>\\n <1>0.1875</1>\\n </Values>\\n <Values>\\n <0>2021-05-03T15:00:42.739Z</0>\\n <1>0.1250</1>\\n </Values>\\n <Name>worker_avg_cpu_used</Name>\\n </Series>\\n <Series>\\n <Values>\\n <0>2021-05-03T15:00:12.72Z</0>\\n <1>0.1250</1>\\n </Values>\\n <Values>\\n <0>2021-05-03T15:00:42.739Z</0>\\n <1>0.3125</1>\\n </Values>\\n <Name>executor_avg_cpu_used</Name>\\n </Series>\\n <Unit>%</Unit>\\n <Key>AnalyticDB_CPU</Key>\\n </Performances>\\n</DescribeDBClusterPerformanceResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterPerformance', + 'description' => 'You can call this operation to query the performance data of a cluster over a time range based on its performance metrics. The data is collected every 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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterResourcePoolPerformance' => [ + 'summary' => 'Queries the monitoring information about resource groups within an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-****************', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The metrics of the resource group. You can enter multiple metrics at the same time to query the monitoring information. Separate multiple metrics with commas (,). Valid values:'."\n" + ."\n" + .'* **AnalyticDB_RP_CPU**: the average CPU utilization. Unit: %.'."\n" + .'* **AnalyticDB_RP_RT**: the query response time (RT). Unit: milliseconds.'."\n" + .'* **AnalyticDB_RP_QPS**: the queries per second (QPS). The value of this parameter must be a numeric value.'."\n" + .'* **AnalyticDB_RP_WaitTime**: the query waiting time. Unit: milliseconds.'."\n" + .'* **AnalyticDB_RP_OriginalNode**: the number of basic nodes in the resource group.'."\n" + .'* **AnalyticDB_RP_ActualNode**: the number of scheduled nodes that are scaled out in the resource group.'."\n" + .'* **AnalyticDB_RP_PlanNode**: the number of scheduled nodes to be scaled out in the resource group.'."\n" + .'* **AnalyticDB_RP_TotalNode**: the total number of nodes in the resource group. Total number of nodes = Number of basic nodes + Number of scheduled nodes that are scaled out.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you leave this parameter empty, the monitoring information about all metrics is returned.'."\n" + ."\n" + .'* For more information about scaling plans, see [Create a resource scaling plan](~~189507~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AnalyticDB_RP_CPU', + ], + ], + [ + 'name' => 'ResourcePools', + 'in' => 'query', + 'schema' => [ + 'description' => 'The names of the resource groups that you want to query. You can enter multiple names of resource groups. Separate multiple names with commas (,).'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The value of this parameter is case-insensitive. For example, `USER_DEFAULT` and `user_default` specify the same resource group.'."\n" + ."\n" + .'* If you leave this parameter empty, the monitoring information about the `USER_DEFAULT` resource group is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TEST_POOL', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to monitor the resource group. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.'."\n" + ."\n" + .'> You can view only the monitoring information about the resource groups within the last two days.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-10T07:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to monitor the resource group. 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' => true, + 'docRequired' => true, + 'example' => '2021-06-10T07:01Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The end of the time range for monitoring the resource group. 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-06-10T07:01:00Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C7EDB8E4-9769-4233-88C7-DCA4C9******', + ], + 'StartTime' => [ + 'description' => 'The beginning of the time range for monitoring the resource group. 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-06-10T07:00:00', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-****************', + ], + 'Performances' => [ + 'description' => 'The queried monitoring information about the metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried monitoring information about the metric.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The metric of the resource group.'."\n", + 'type' => 'string', + 'example' => 'AnalyticDB_RP_CPU', + ], + 'Unit' => [ + 'description' => 'The unit of the metric value.'."\n", + 'type' => 'string', + 'example' => '%', + ], + 'ResourcePoolPerformances' => [ + 'description' => 'The queried monitoring information about the resource groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried monitoring information about the resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourcePoolName' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'test_pool', + ], + 'ResourcePoolSeries' => [ + 'description' => 'The sequential monitoring information about the resource groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sequential monitoring information about the resource group.'."\n", + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => 'The value of the metric.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The values of the metric at different points in time.'."\n", + 'type' => 'string', + 'example' => '["2021-06-10T07:00:22.601Z","0.0000"],["2021-06-10T07:00:52.62Z","0.0312"]', + ], + ], + 'Name' => [ + 'description' => 'The name of the metric.'."\n", + 'type' => 'string', + 'example' => 'cpu', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-06-10T07:01:00Z\\",\\n \\"RequestId\\": \\"C7EDB8E4-9769-4233-88C7-DCA4C9******\\",\\n \\"StartTime\\": \\"2021-06-10T07:00:00\\",\\n \\"DBClusterId\\": \\"am-****************\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_RP_CPU\\",\\n \\"Unit\\": \\"%\\",\\n \\"ResourcePoolPerformances\\": [\\n {\\n \\"ResourcePoolName\\": \\"test_pool\\",\\n \\"ResourcePoolSeries\\": [\\n {\\n \\"Values\\": [\\n \\"[\\\\\\"2021-06-10T07:00:22.601Z\\\\\\",\\\\\\"0.0000\\\\\\"],[\\\\\\"2021-06-10T07:00:52.62Z\\\\\\",\\\\\\"0.0312\\\\\\"]\\"\\n ],\\n \\"Name\\": \\"cpu\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterResourcePoolPerformanceResponse>\\n <RequestId>C7EDB8E4-9769-4233-88C7-DCA4C9******</RequestId>\\n <EndTime>2021-06-10T07:01:00Z</EndTime>\\n <StartTime>2021-06-10T07:00:00Z</StartTime>\\n <Performances>\\n <ResourcePoolPerformances>\\n <ResourcePoolSeries>\\n <Values>\\n <0>2021-06-10T07:00:22.601Z</0>\\n <1>0.0000</1>\\n </Values>\\n <Values>\\n <0>2021-06-10T07:00:52.62Z</0>\\n <1>0.0312</1>\\n </Values>\\n <Name>cpu</Name>\\n </ResourcePoolSeries>\\n <ResourcePoolName>test_pool</ResourcePoolName>\\n </ResourcePoolPerformances>\\n <Unit>%</Unit>\\n <Key>AnalyticDB_RP_CPU</Key>\\n </Performances>\\n</DescribeDBClusterResourcePoolPerformanceResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterResourcePoolPerformance', + 'description' => '> You can also view the monitoring information about resource groups within an AnalyticDB for MySQL cluster in elastic mode for Cluster Edition in the form of graphs in the console. For more information, see [View monitoring information](~~188721~~).'."\n", + ], + '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' => '10807', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-k2jofo4pi5zhd****', + ], + ], + [ + 'name' => 'TableType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the table. Valid values:'."\n" + ."\n\n" + .'- **FactTable**: the partitioned table.'."\n" + .'- **DimensionTable**: the dimension table.', + 'type' => 'string', + 'required' => true, + '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" + ."\n" + .' "Field":"Name",'."\n" + ."\n" + .' "Type":"Asc"'."\n" + ."\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.', + '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'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'Default value: 30.', + '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. Default value: 1.', + '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.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-zhangjiakou', + 'default' => 'cn-zhangjiakou', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language in which you want to send requests and receive messages. Default value: zh. Valid values:'."\n" + .'- **zh**: 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', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'PageNumber' => [ + 'description' => 'The page number.', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'The queried tables.', + 'type' => 'object', + 'properties' => [ + 'Table' => [ + 'description' => 'The queried table.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The column type.', + 'type' => 'string', + 'example' => 'executor', + ], + 'Schema' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'example' => 'adm_analyze', + ], + 'Size' => [ + 'description' => 'The number of rows in the table.', + 'type' => 'string', + 'example' => '2416527', + ], + 'Name' => [ + 'description' => 'The name of the table.', + 'type' => 'string', + 'example' => 'ff', + ], + 'IsIncline' => [ + 'description' => 'Indicates whether data is skewed in the table.', + 'type' => 'string', + 'example' => 'true', + ], + 'TotalSize' => [ + 'description' => 'The total data size of the table.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '65', + ], + 'SpaceRatio' => [ + 'description' => 'The percentage of the table size.', + 'type' => 'number', + 'format' => 'double', + 'example' => '89', + ], + 'RowCount' => [ + 'description' => 'The number of rows in the table.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2565', + ], + ], + 'description' => 'The information about the table.', + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The queried detection item and detection result.', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the detection item.', + 'type' => 'string', + 'example' => 'Excessive primary key fields', + ], + 'Message' => [ + 'description' => 'The message of the detection result.', + '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', + 'type' => 'string', + 'example' => 'WARNING', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalFailure', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"15\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Table\\": [\\n {\\n \\"Type\\": \\"executor\\",\\n \\"Schema\\": \\"adm_analyze\\",\\n \\"Size\\": \\"2416527\\",\\n \\"Name\\": \\"ff\\",\\n \\"IsIncline\\": \\"true\\",\\n \\"TotalSize\\": 65,\\n \\"SpaceRatio\\": 89,\\n \\"RowCount\\": 2565\\n }\\n ]\\n },\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"主键字段过多\\",\\n \\"Message\\": \\"检测到多个表存在主键过多的问题\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeInclinedTables', + ], + 'ModifyMaintenanceAction' => [ + 'summary' => 'Changes the switchover time of O\\&M events.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929XXXX', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the pending O\\&M event. You can specify multiple IDs to batch change the switchover time. Separate multiple IDs with commas (,).'."\n" + .'> - You can call the [DescribeMaintenanceAction](~~271738~~) operation to query the information about pending O\\&M events, including the event ID.'."\n" + .'> - You can change the switchover time only for pending O\\&M events. The switchover time of historical O\\&M events cannot be changed. For more information about the status of pending and historical O\\&M events, see [DescribeMaintenanceAction](~~271738~~).', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '11111', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when you want the system to perform operations on the pending O\\&M event. 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' => '2021-07-09T22:00:00Z', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the pending O\\&M event occurs.'."\n" + ."\n" + .'> - You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => 'The O\\&M event ID.'."\n", + 'type' => 'string', + 'example' => '11111', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7856CBE7-5BD0-4EE1-AC62-749392******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + [ + 'errorCode' => 'TaskModifyError', + 'errorMessage' => 'Part of the tasks cannot be modified.', + ], + [ + 'errorCode' => 'SwitchTimeAfterDeadline', + 'errorMessage' => 'The switch time should be earlier than deadline.', + ], + [ + 'errorCode' => 'StartTimeBeforeNow', + 'errorMessage' => 'The start time should not be earlier than the current time.', + ], + ], + 403 => [ + [ + 'errorCode' => 'IncorrectTaskStatus', + 'errorMessage' => 'Certain task\'s status does not support this operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Ids\\": \\"11111\\",\\n \\"RequestId\\": \\"7856CBE7-5BD0-4EE1-AC62-749392******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyMaintenanceActionResponse>\\n <Ids>11111</Ids>\\n <RequestId>7856CBE7-5BD0-4EE1-AC62-749392******</RequestId>\\n</ModifyMaintenanceActionResponse>","errorExample":""}]', + 'title' => 'ModifyMaintenanceAction', + ], + 'DescribeMaintenanceAction' => [ + 'summary' => 'Queries the information about O\\&M events.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Valid values:'."\n" + ."\n" + .'* The ID of the region where the O\\&M event occurs. Example: `cn-hangzhou`. You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n" + .'* You can also set Region to `all` to query the O\\&M events in all regions. If you set `Region` to `all`, you must set `TaskType` to `all`.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the O\\&M event. Valid values:'."\n" + ."\n" + .'* **rds_apsaradb_upgrade**: database software upgrades.'."\n" + .'* **all**: all the O\\&M events in all regions within the current account. If you set `Region` to `all`, you must set `TaskType` to `all`.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds_apsaradb_upgrade', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the information about pending or historical O\\&M events. Valid values:'."\n" + ."\n" + .'* **0**: returns the information about pending O\\&M event.'."\n" + .'* **1**: returns the information about historical O\\&M event.'."\n" + ."\n" + .'If you do not specify this parameter, the information about pending O\\&M event are returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**. Default value: 30.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => 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, + 'docRequired' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the O\\&M event occurs.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E774C8A9-8819-4A09-9E91-07C078******', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalRecordCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Items' => [ + 'description' => 'The queried O\\&M events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The state of the event.'."\n" + ."\n" + .'* If you set `IsHistory` to **0**, the state of the pending O\\&M event is returned. Valid values:'."\n" + ."\n" + .' * **WAITING_MODIFY**: The start time of the O\\&M event is waiting to be set.'."\n" + .' * **WAITING**: The O\\&M event is waiting to be processed.'."\n" + .' * **PROCESSING**: The O\\&M event is being processed. The switchover time of an event in this state cannot be changed.'."\n" + ."\n" + .'* If you set `IsHistory` to **1**, the state of the historical O\\&M event is returned. Valid values:'."\n" + ."\n" + .' * **SUCCESS**: The event ended and the execution succeeded.'."\n" + .' * **FAILED**: The event ended but the execution failed.'."\n" + .' * **CANCEL**: The event was canceled.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Deadline' => [ + 'description' => 'The deadline before which the event can be executed. 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-04T15:59:59Z', + ], + 'PrepareInterval' => [ + 'description' => 'The preparation time that is required before the pending O\\&M event can be switched. The time is in the `HH:mm:ss` format.'."\n", + 'type' => 'string', + 'example' => '02:00:00', + ], + 'DBType' => [ + 'description' => 'The database engine.'."\n", + 'type' => 'string', + 'example' => 'analyticdb', + ], + 'StartTime' => [ + 'description' => 'The time when the task was executed in the backend. 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', + ], + 'TaskType' => [ + 'description' => 'The type of the O\\&M event.'."\n", + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '3.0', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster that is involved in the O\\&M event.'."\n", + 'type' => 'string', + 'example' => 'am-****************', + ], + 'ModifiedTime' => [ + 'description' => 'The point in time at which the switchover time of the O\\&M event was modified. 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-03T06:33:00Z', + ], + 'Region' => [ + 'description' => 'The ID of the region where the O\\&M event occurs.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResultInfo' => [ + 'description' => 'The execution result of the O\\&M event.'."\n" + ."\n" + .'> This parameter is returned only when the value of `Status` is **FAILED** or **CANCEL**.'."\n", + 'type' => 'string', + 'example' => 'autoCancel', + ], + 'CreatedTime' => [ + 'description' => 'The time when the O\\&M event 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' => '2021-06-30T02:44:27Z', + ], + 'Id' => [ + 'description' => 'The ID of the O\\&M event.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11111', + ], + 'SwitchTime' => [ + 'description' => 'The time when the pending O\\&M event is switched. 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-03T06:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"E774C8A9-8819-4A09-9E91-07C078******\\",\\n \\"PageSize\\": 30,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Deadline\\": \\"2021-07-04T15:59:59Z\\",\\n \\"PrepareInterval\\": \\"02:00:00\\",\\n \\"DBType\\": \\"analyticdb\\",\\n \\"StartTime\\": \\"2021-07-03T04:00:00Z\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"DBVersion\\": \\"3.0\\",\\n \\"DBClusterId\\": \\"am-****************\\",\\n \\"ModifiedTime\\": \\"2021-07-03T06:33:00Z\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResultInfo\\": \\"autoCancel\\",\\n \\"CreatedTime\\": \\"2021-06-30T02:44:27Z\\",\\n \\"Id\\": 11111,\\n \\"SwitchTime\\": \\"2021-07-03T06:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeMaintenanceActionResponse>\\n <TotalRecordCount>2</TotalRecordCount>\\n <RequestId>E774C8A9-8819-4A09-9E91-07C078******</RequestId>\\n <PageSize>30</PageSize>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <Status>SUCCESS</Status>\\n <CreatedTime>2021-06-30T02:44:27Z</CreatedTime>\\n <Deadline>2021-07-04T15:59:59Z</Deadline>\\n <StartTime>2021-07-03T04:00:00Z</StartTime>\\n <DBClusterId>am-****************</DBClusterId>\\n <DBType>analyticdb</DBType>\\n <DBVersion>3.0</DBVersion>\\n <ModifiedTime>2021-07-03T06:33:00Z</ModifiedTime>\\n <TaskType>rds_apsaradb_upgrade</TaskType>\\n <PrepareInterval>02:00:00</PrepareInterval>\\n <Region>cn-hangzhou</Region>\\n <Id>11111</Id>\\n <SwitchTime>2021-07-03T06:00:00Z</SwitchTime>\\n </Items>\\n <Items>\\n <Status>CANCEL</Status>\\n <CreatedTime>2021-06-25T06:32:45Z</CreatedTime>\\n <Deadline>2021-06-29T15:59:59Z</Deadline>\\n <StartTime>2021-06-26T16:10:00Z</StartTime>\\n <DBClusterId>am-****************</DBClusterId>\\n <DBType>analyticdb</DBType>\\n <DBVersion>3.0</DBVersion>\\n <ModifiedTime>2021-06-26T18:40:00Z</ModifiedTime>\\n <TaskType>rds_apsaradb_upgrade</TaskType>\\n <PrepareInterval>02:00:00</PrepareInterval>\\n <Region>cn-hangzhou</Region>\\n <Id>22222</Id>\\n <ResultInfo>autoCancel</ResultInfo>\\n <SwitchTime>2021-06-26T18:10:00Z</SwitchTime>\\n </Items>\\n</DescribeMaintenanceActionResponse>","errorExample":""}]', + 'title' => 'DescribeMaintenanceAction', + ], + 'DescribeDiagnosisTasks' => [ + 'summary' => 'Queries the execution information about distributed tasks in a stage of a query.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162538', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-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' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query ID.'."\n" + ."\n" + .'> You can call the [DescribeProcessList](~~190092~~) operation to query the IDs of queries that are being executed.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '202011191048151921681492420315100****', + ], + ], + [ + 'name' => 'StageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a stage in the query that is specified by the `ProcessId` parameter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Stage[26]', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which to sort the tasks by field. Specify the value in the JSON format. Example: `[{"Field":"CreateTime", "Type":"desc"}]`.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* `Field` specifies the field that is used to sort the tasks. Valid values of Field: `State`, `CreateTime`, `DBName`, `ProcessID`, `UpdateTime`, `JobName`, and `ProcessRows`.'."\n" + ."\n" + .'* `Type` specifies the sort order. Valid values of Type: `Desc` and `Asc`. The values are case-insensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"StartTime", "Type": "desc" }]', + ], + ], + [ + '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 per page. Valid values:'."\n" + ."\n" + .'* 30 (default)'."\n" + .'* 50'."\n" + .'* 100'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the asynchronous import or export task to be queried. Valid values:'."\n" + ."\n" + .'* **RUNNING**'."\n" + .'* **FINISHED**'."\n" + .'* **FAILED**'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'FAILED' => 'FAILED', + 'RUNNING' => 'RUNNING', + 'FINISHED' => 'FINISHED', + ], + 'example' => 'RUNNING', + ], + ], + [ + 'name' => 'Host', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address from which the query was initiated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + ], + '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', + ], + 'TaskList' => [ + 'description' => 'The queried tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried task.'."\n", + 'type' => 'object', + 'properties' => [ + 'ScanCost' => [ + 'description' => 'The amount of time that is consumed to scan data from a data source in the task. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OutputDataSize' => [ + 'description' => 'The amount of output data in the task. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'InputDataSize' => [ + 'description' => 'The amount of input data in the task. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'State' => [ + 'description' => 'The final execution state of the task. Valid values:'."\n" + ."\n" + .'* FINISHED'."\n" + .'* CANCELED'."\n" + .'* ABORTED'."\n" + .'* FAILED'."\n", + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'OperatorCost' => [ + 'description' => 'The total amount of time that is consumed by all operators in the task on a node. This parameter can be used to determine whether long tails occur in computing. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'OutputRows' => [ + 'description' => 'The number of output rows in the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105', + ], + 'ScanDataSize' => [ + 'description' => 'The amount of scanned data in the task. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ElapsedTime' => [ + 'description' => 'The amount of time that elapsed from when the task was created to when the task was completed. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '456', + ], + 'ScanRows' => [ + 'description' => 'The number of rows that are scanned from a data source in the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PeakMemory' => [ + 'description' => 'The peak memory of the task. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '22568****', + ], + 'InputRows' => [ + 'description' => 'The number of input rows in the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105', + ], + 'TaskCreateTime' => [ + 'description' => 'The timestamp when the task was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-12-12 00:00:12', + ], + 'TaskEndTime' => [ + 'description' => 'The timestamp when the task ends.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-12-22 00:00:00', + ], + 'TaskHost' => [ + 'description' => 'The IP address of the host where the task was executed.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Drivers' => [ + 'description' => 'The number of tasks that can be executed concurrently.'."\n", + 'type' => 'string', + 'example' => '16', + ], + 'QueuedTime' => [ + 'description' => 'The queuing duration of the task. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '12', + ], + 'ComputeTimeRatio' => [ + 'description' => 'The compute time ratio, which can be used to determine whether the task is really time-consuming. This parameter can be calculated by using the following formula: OperatorCost/Drivers/ElapsedTime. A greater value indicates that the task was executed for computing for most of the task time. A less value indicates that the task was waiting for scheduling or blocked due to other reasons for most of the task time.'."\n", + 'type' => 'string', + 'example' => '0.89', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of tasks in the stage.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '33', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F0983B43-B2EC-536A-8791-142B5CF1E9B6\\",\\n \\"TaskList\\": [\\n {\\n \\"ScanCost\\": 0,\\n \\"OutputDataSize\\": 123,\\n \\"InputDataSize\\": 123,\\n \\"State\\": \\"FINISHED\\",\\n \\"OperatorCost\\": 3,\\n \\"OutputRows\\": 105,\\n \\"ScanDataSize\\": 123,\\n \\"ElapsedTime\\": 456,\\n \\"ScanRows\\": 0,\\n \\"PeakMemory\\": 234,\\n \\"TaskId\\": \\"22568****\\",\\n \\"InputRows\\": 105,\\n \\"TaskCreateTime\\": 0,\\n \\"TaskEndTime\\": 0,\\n \\"TaskHost\\": \\"192.168.XX.XX\\",\\n \\"Drivers\\": \\"16\\",\\n \\"QueuedTime\\": \\"12\\",\\n \\"ComputeTimeRatio\\": \\"0.89\\"\\n }\\n ],\\n \\"TotalCount\\": 33\\n}","errorExample":""},{"type":"xml","example":"<DescribeDiagnosisTasksResponse>\\n <RequestId>F0983B43-B2EC-536A-8791-142B5CF1E9B6</RequestId>\\n <TaskList>\\n <ScanCost>0</ScanCost>\\n <OutputDataSize>123</OutputDataSize>\\n <InputDataSize>123</InputDataSize>\\n <State>FINISHED</State>\\n <OperatorCost>3</OperatorCost>\\n <OutputRows>105</OutputRows>\\n <ScanDataSize>123</ScanDataSize>\\n <ElapsedTime>456</ElapsedTime>\\n <ScanRows>0</ScanRows>\\n <PeakMemory>234</PeakMemory>\\n <TaskId>22568****</TaskId>\\n <InputRows>105</InputRows>\\n <TaskHost>192.168.xx.xx</TaskHost>\\n <Drivers>16</Drivers>\\n <QueuedTime>12</QueuedTime>\\n <ComputeTimeRatio>0.89</ComputeTimeRatio>\\n </TaskList>\\n <TotalCount>33</TotalCount>\\n</DescribeDiagnosisTasksResponse>","errorExample":""}]', + 'title' => 'DescribeDiagnosisTasks', + ], + 'DescribeDiagnosisRecords' => [ + 'summary' => 'Queries the diagnostic information about SQL statements that meet a condition 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' => '71847', + '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-bp1r053byu48p****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> Only data within the last 14 days can be queried.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1632931200000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify 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' => true, + '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`, and `Min` or `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 executed SQL statements. You can set `Value` to `running` to query SQL statements that are being executed. You can also set Value to `failed` to query SQL statements that failed to be executed.'."\n" + .'* `{"Type":"cost","Min":"10","Max":"200"}`: queries SQL statements whose execution durations are in the range of 10 to 200 milliseconds. You can also customize the maximum and minimum execution durations.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"Type":"status","Value":"finished"}', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword for the query.'."\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' => '104428198', + ], + ], + [ + '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 group, database name, username, and source IP address of the SQL statements to be queried.'."\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](~~308210~~) operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_user', + ], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database on which the SQL statements are executed.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.'."\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 group, database name, username, and source IP address of the SQL statements to be queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '59.82.xx.xx', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which to sort the retrieved SQL statements by field. Specify this value in the JSON format. The value is an ordered array that uses the order of the input array and contains the `Field` and `Type` fields. Example: `[{"Field":"StartTime", "Type": "desc" }]`. Fields:'."\n" + ."\n" + .'* `Field` specifies the field that is used to sort the retrieved SQL statements. Valid values:'."\n" + ."\n" + .' * `StartTime`: the start time of the execution.'."\n" + .' * `Status`: the execution state.'."\n" + .' * `UserName`: the username.'."\n" + .' * `Cost`: the execution duration.'."\n" + .' * `PeakMemory`: the peak memory.'."\n" + .' * `ScanSize`: the amount of data to be 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 field 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: **30**, **50**, and **100**. Default value: 30.'."\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" + ."\n" + .'> You can call the [DescribeSQLPatterns](~~321868~~) operation to query the information about all SQL patterns within an AnalyticDB for MySQL cluster in a time range, including SQL pattern IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5575924945138******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + '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', + ], + 'Querys' => [ + 'description' => 'The queried SQL statements.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried SQL statement.'."\n", + 'type' => 'object', + 'properties' => [ + '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 diagnostic information about SQL statements that meet a condition in 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: character. 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 beginning of the time range in which the SQL statement is executed. 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 entries 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 field is returned only for SQL statements that have the `Status` parameter set to `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' => '0', + ], + '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 statement.'."\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, and load (ETL) task.'."\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.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the query property.', + 'type' => 'string', + 'example' => 'ff', + ], + 'Value' => [ + 'description' => 'The value of the query property.', + 'type' => 'string', + 'example' => '40', + ], + ], + 'description' => 'The query property.', + ], + ], + 'PatternId' => [ + 'description' => 'The SQL pattern ID.'."\n" + ."\n" + .'> You can call the [DescribePatternPerformance](~~612503~~) operation to query the performance metrics of an SQL pattern within a time range.'."\n", + 'type' => 'string', + 'example' => '-5575924945138******', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '109462AF-B5FA-3D5A-9377-B27E5B******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Querys\\": [\\n {\\n \\"SQL\\": \\"SELECT count(*)\\\\\\\\nFROM nation\\",\\n \\"SQLTruncatedThreshold\\": 5120,\\n \\"Status\\": \\"finished\\",\\n \\"OutputDataSize\\": 9,\\n \\"Cost\\": 10,\\n \\"OutputRows\\": 1,\\n \\"RcHost\\": \\"10.0.xx.xx:3004\\",\\n \\"ScanSize\\": 9,\\n \\"ProcessId\\": \\"2021093000414401000000023503151******\\",\\n \\"StartTime\\": 1632933704000,\\n \\"SQLTruncated\\": false,\\n \\"Database\\": \\"adb_demo\\",\\n \\"ScanRows\\": 1,\\n \\"ResourceCostRank\\": 1,\\n \\"ClientIp\\": \\"59.82.xx.xx\\",\\n \\"PeakMemory\\": 16648,\\n \\"QueueTime\\": 0,\\n \\"ResourceGroup\\": \\"user_default\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"ExecutionTime\\": 6,\\n \\"TotalPlanningTime\\": 4,\\n \\"EtlWriteRows\\": 0,\\n \\"TotalStages\\": 2,\\n \\"QueryProperties\\": [\\n {\\n \\"Name\\": \\"ff\\",\\n \\"Value\\": \\"40\\"\\n }\\n ],\\n \\"PatternId\\": \\"-5575924945138******\\"\\n }\\n ],\\n \\"RequestId\\": \\"109462AF-B5FA-3D5A-9377-B27E5B******\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDiagnosisRecordsResponse>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</TotalCount>\\n <Querys>\\n <SQL>SELECT count(*)\\\\nFROM nation</SQL>\\n <SQLTruncatedThreshold>5120</SQLTruncatedThreshold>\\n <Status>finished</Status>\\n <OutputDataSize>9</OutputDataSize>\\n <Cost>10</Cost>\\n <OutputRows>1</OutputRows>\\n <RcHost>10.0.xx.xx:3004</RcHost>\\n <ScanSize>9</ScanSize>\\n <ProcessId>2021093000414401000000023503151******</ProcessId>\\n <StartTime>1632933704000</StartTime>\\n <SQLTruncated>false</SQLTruncated>\\n <Database>adb_demo</Database>\\n <ScanRows>1</ScanRows>\\n <ResourceCostRank>1</ResourceCostRank>\\n <ClientIp>59.82.xx.xx</ClientIp>\\n <PeakMemory>16648</PeakMemory>\\n <QueueTime>0</QueueTime>\\n <ResourceGroup>user_default</ResourceGroup>\\n <UserName>test_user</UserName>\\n <ExecutionTime>6</ExecutionTime>\\n <TotalPlanningTime>4</TotalPlanningTime>\\n <EtlWriteRows>0</EtlWriteRows>\\n <TotalStages>2</TotalStages>\\n </Querys>\\n <RequestId>109462AF-B5FA-3D5A-9377-B27E5B******</RequestId>\\n</DescribeDiagnosisRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeDiagnosisRecords', + ], + 'DescribeDiagnosisDimensions' => [ + 'summary' => 'Queries the deduplicated statistics of SQL statements that meet a condition of the resource group, database, username, and source IP address 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' => '72136', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bt6u59zcmd945****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> Only data within the last 14 days can be queried. If you call this operation to query data that is earlier than 14 days, an empty string is returned.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1625220210000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify 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' => true, + 'example' => '1625220213000', + ], + ], + [ + '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' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query condition for SQL statements, which can be a combination of the `Type` and `Value` fields or a combination of the Type, `Min`, and `Max` fields. Specify the conditions 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, **including successful and failed 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' => true, + 'example' => '{"Type":"maxCost","Value":"100"}', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClientIps' => [ + 'description' => 'The source IP addresses.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The source IP address.'."\n", + 'type' => 'string', + 'example' => '106.11.xx.xx', + ], + ], + 'ResourceGroups' => [ + 'description' => 'The resource groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'user_default', + ], + ], + 'UserNames' => [ + 'description' => 'The usernames.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'test_user', + ], + ], + 'Databases' => [ + 'description' => 'The databases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'tpch_1g', + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E0B56BCD-1BED-30EC-8CAF-1D1E5F******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClientIps\\": [\\n \\"106.11.xx.xx\\"\\n ],\\n \\"ResourceGroups\\": [\\n \\"user_default\\"\\n ],\\n \\"UserNames\\": [\\n \\"test_user\\"\\n ],\\n \\"Databases\\": [\\n \\"tpch_1g\\"\\n ],\\n \\"RequestId\\": \\"E0B56BCD-1BED-30EC-8CAF-1D1E5F******\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDiagnosisDimensionsResponse>\\n <ClientIps>[\\"106.11.xx.xx\\",\\"106.11.xx.xx\\"]</ClientIps>\\n <ResourceGroups>[\\"user_default\\"]</ResourceGroups>\\n <UserNames>[\\"test_user\\"]</UserNames>\\n <Databases>[\\"tpch_1g\\"]</Databases>\\n <RequestId>E0B56BCD-1BED-30EC-8CAF-1D1E5F******</RequestId>\\n</DescribeDiagnosisDimensionsResponse>","errorExample":""}]', + 'title' => 'DescribeDiagnosisDimensions', + ], + 'DescribeDownloadRecords' => [ + 'summary' => 'Queries a list of download tasks for the last five SQL queries 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' => '72138', + '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-****************', + ], + ], + [ + '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' => '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', + 'deprecated' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => 'The queried download tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried download task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the download task. Valid values:'."\n" + ."\n" + .'* **running**'."\n" + .'* **finished**'."\n" + .'* **failed**'."\n", + 'type' => 'string', + 'example' => 'finished', + ], + 'DownloadId' => [ + 'description' => 'The download task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '69', + ], + 'ExceptionMsg' => [ + 'description' => 'The error message returned if the download task 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/am-**************/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' => '987F51BE-C4CB-332A-B159-63CE87******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Records\\": [\\n {\\n \\"Status\\": \\"finished\\",\\n \\"DownloadId\\": 69,\\n \\"ExceptionMsg\\": \\"The query result is empty.\\",\\n \\"Url\\": \\"https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******\\\\\\"\\",\\n \\"FileName\\": \\"20210806094635-20210806095135\\"\\n }\\n ],\\n \\"RequestId\\": \\"987F51BE-C4CB-332A-B159-63CE87******\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDownloadRecordsResponse>\\n <RequestId>987F51BE-C4CB-332A-B159-63CE87******</RequestId>\\n <Records>\\n <Status>failed</Status>\\n <FileName>20210806094635-20210806095135.xlsx</FileName>\\n <ExceptionMsg>The query result is empty.</ExceptionMsg>\\n <Url/>\\n <DownloadId>73</DownloadId>\\n </Records>\\n <Records>\\n <Status>finished</Status>\\n <FileName>20210805104301-20210805164302.xlsx</FileName>\\n <ExceptionMsg/>\\n <Url>https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******</Url>\\n <DownloadId>72</DownloadId>\\n </Records>\\n <Records>\\n <Status>finished</Status>\\n <FileName>20210805104301-20210805164301.xlsx</FileName>\\n <ExceptionMsg/>\\n <Url>https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164301.xlsx?Expires=1943513847&OSSAccessKeyId=*********&Signature=******</Url>\\n <DownloadId>71</DownloadId>\\n </Records>\\n <Records>\\n <Status>finished</Status>\\n <FileName>20210804234858-20210805114858.xlsx</FileName>\\n <ExceptionMsg/>\\n <Url>https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210804234858-20210805114858.xlsx?Expires=1943495349&OSSAccessKeyId=*********&Signature=******</Url>\\n <DownloadId>70</DownloadId>\\n </Records>\\n <Records>\\n <Status>finished</Status>\\n <FileName>20210702180330-20210702180333.xlsx</FileName>\\n <ExceptionMsg/>\\n <Url>https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210702180330-20210702180333.xlsx?Expires=1941607637&OSSAccessKeyId=*********&Signature=******</Url>\\n <DownloadId>69</DownloadId>\\n </Records>\\n</DescribeDownloadRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeDownloadRecords', + ], + 'DownloadDiagnosisRecords' => [ + 'summary' => 'Downloads the diagnostic information about SQL statements that meet a condition for an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72137', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-bp1r053byu48p****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> Only data within the last 14 days can be queried.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1625220210000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify 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' => true, + 'docRequired' => true, + 'example' => '1625220213000', + ], + ], + [ + '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' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query condition for SQL statements, which can be a combination of the `Type` and `Value` fields or a combination of the Type, `Min`, and `Max` fields. Specify the conditions 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, **including successful and failed 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' => true, + 'docRequired' => true, + 'example' => '{"Type":"status","Value":"finished"}', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword that is used for the query.'."\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' => '100000000', + ], + ], + [ + 'name' => 'MaxScanSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum scan size of the SQL statements. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '110000000', + ], + ], + [ + '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 group, database name, username, and source IP address of the SQL statements to be queried.'."\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](~~308210~~) operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.'."\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 group, database name, username, and source IP address of the SQL statements to be queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb_demo', + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP addresses.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisDimensions](~~308210~~) operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '106.11.XX.XX', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DownloadId' => [ + 'description' => 'The ID of the download task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '68', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D4ACF4E0-2952-3A87-9A2C-474058******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DownloadId\\": 68,\\n \\"RequestId\\": \\"D4ACF4E0-2952-3A87-9A2C-474058******\\"\\n}","errorExample":""},{"type":"xml","example":"<DownloadDiagnosisRecordsResponse>\\n <RequestId>D4ACF4E0-2952-3A87-9A2C-474058******</RequestId>\\n <DownloadId>68</DownloadId>\\n</DownloadDiagnosisRecordsResponse>","errorExample":""}]', + 'title' => 'DownloadDiagnosisRecords', + ], + 'DescribeDiagnosisSQLInfo' => [ + 'summary' => 'Queries the execution information about an SQL statement, including the execution plan, execution information, resource usage, and self-diagnostics results.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72141', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a specific region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-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 ID of the query.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the SQL summary information of a specified AnalyticDB for MySQL cluster, including the query ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021070216432217201616806503453******', + ], + ], + [ + 'name' => 'ProcessStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution start time of the SQL statement. Specify the time in the UNIX timestamp format. Unit: milliseconds.'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the SQL summary information of a specified AnalyticDB for MySQL cluster, including the execution start time of the SQL statement.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1625215402000', + ], + ], + [ + 'name' => 'ProcessState', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the SQL statement. Valid values:'."\n" + ."\n" + .'* **running**'."\n" + ."\n" + .'* **finished**'."\n" + ."\n" + .'* **failed**'."\n" + ."\n" + .'> You can call the [DescribeDiagnosisRecords](~~308207~~) operation to query the SQL summary information of a specified AnalyticDB for MySQL cluster, including the state of the SQL statement.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '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' => true, + '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 SQL summary information of a specified AnalyticDB for MySQL 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' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DiagnosisSQLInfo' => [ + 'description' => 'Execution details of the SQL statement, including the SQL statement text, 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 ID of the request.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'StageInfos' => [ + 'description' => 'Execution details of the query 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' => '123', + ], + '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' => '231', + ], + 'OutputDataSize' => [ + 'description' => 'The total amount of output data in the stage. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12344', + ], + 'PeakMemory' => [ + 'description' => 'The total peak memory of the stage. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3421', + ], + '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 ID of the stage.'."\n", + 'type' => 'string', + 'example' => 'Stage[26]', + ], + 'State' => [ + 'description' => 'The state of the stage.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'FAILED' => 'FAILED', + 'RUNNING' => 'RUNNING', + 'FINISHED' => 'FINISHED', + ], + 'example' => 'RUNNING', + ], + 'Progress' => [ + 'description' => 'The execution progress of the stage.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0.3', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DiagnosisSQLInfo\\": \\"{ \\\\\\"DiagnosisSQLInfo\\\\\\": { \\\\\\"hasSharedStage\\\\\\": false, \\\\\\"resourceGroup\\\\\\": \\\\\\"user_default\\\\\\", \\\\\\"cost\\\\\\": 274, \\\\\\"queuedTime\\\\\\": 0, \\\\\\"outputDataSize\\\\\\": 9, \\\\\\"scheduled\\\\\\": true, \\\\\\"query\\\\\\": \\\\\\"/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE \'PROMO%\' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate >= DATE \'1995-09-01\' AND l_shipdate < DATE \'1995-09-01\' + INTERVAL \'1\' MONTH\\\\\\", \\\\\\"outputRows\\\\\\": 1, \\\\\\"userName\\\\\\": \\\\\\"test_user\\\\\\", \\\\\\"parentId\\\\\\": 0, \\\\\\"maxOutputRows\\\\\\": 200000, \\\\\\"scanSize\\\\\\": 8247470, \\\\\\"peakMemory\\\\\\": 13188295, \\\\\\"startTime\\\\\\": 1626330527632, \\\\\\"state\\\\\\": \\\\\\"FINISHED\\\\\\", \\\\\\"endTime\\\\\\": 1626330527905, \\\\\\"writeTableRows\\\\\\": 0, \\\\\\"scanRows\\\\\\": 351966 } }\\",\\n \\"RequestId\\": \\"1\\",\\n \\"StageInfos\\": [\\n {\\n \\"InputRows\\": 123,\\n \\"InputDataSize\\": 2341,\\n \\"OutputRows\\": 231,\\n \\"OutputDataSize\\": 12344,\\n \\"PeakMemory\\": 3421,\\n \\"OperatorCost\\": 2341,\\n \\"StageId\\": \\"Stage[26]\\",\\n \\"State\\": \\"RUNNING\\",\\n \\"Progress\\": 0.3\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'DescribeDiagnosisMonitorPerformance' => [ + 'summary' => 'Queries the monitoring information about queries within a time range.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72135', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp108q1py5r78****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to 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' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1671684348000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to 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' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1671687948000', + ], + ], + [ + '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-beijing', + ], + ], + [ + 'name' => 'QueryCondition', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query conditions for SQL statements, which can be a combination of the `Type` and `Value` fields or a combination of the Type, `Min`, and `Max` fields. Specify the conditions 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, **including successful and failed 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' => true, + 'example' => '{\\"Type\\":\\"maxCost\\",\\"Value\\":\\"100\\"}', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformancesThreshold' => [ + 'description' => 'The threshold for the number of queries displayed in a Gantt chart. Default value: 10000.'."\n" + ."\n" + .'> Up to 10,000 queries can be displayed in a Gantt chart even if more queries exist.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'PerformancesTruncated' => [ + 'description' => 'Indicates whether all queries are returned. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8', + ], + 'Performances' => [ + 'description' => 'The monitoring information about queries displayed in Gantt charts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the SQL statement. Valid values:'."\n" + ."\n" + .'* **running**'."\n" + .'* **finished**'."\n" + .'* **failed**'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'ProcessId' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'example' => '202210311015270330101470300315153****', + ], + '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' => '1669011260000', + ], + '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' => '252', + ], + 'ScanRows' => [ + 'description' => 'The number of rows scanned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'PeakMemory' => [ + 'description' => 'The peak memory of the query. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RcHost' => [ + 'description' => 'The IP address of the AnalyticDB for MySQL frontend node on which the SQL statement is executed.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'ScanSize' => [ + 'description' => 'The amount of scanned data. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'UserName' => [ + 'description' => 'The database account that is used to submit the query.'."\n", + 'type' => 'string', + 'example' => 'rpt', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformancesThreshold\\": 10000,\\n \\"PerformancesTruncated\\": false,\\n \\"RequestId\\": \\"0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8\\",\\n \\"Performances\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"ProcessId\\": \\"202210311015270330101470300315153****\\",\\n \\"StartTime\\": 1669011260000,\\n \\"Cost\\": 252,\\n \\"ScanRows\\": 2345,\\n \\"PeakMemory\\": 123,\\n \\"RcHost\\": \\"192.168.XX.XX\\",\\n \\"ScanSize\\": 123,\\n \\"UserName\\": \\"rpt\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDiagnosisMonitorPerformanceResponse>\\n <PerformancesThreshold>10000</PerformancesThreshold>\\n <PerformancesTruncated>false</PerformancesTruncated>\\n <RequestId>0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8</RequestId>\\n <Performances>\\n <Status>running</Status>\\n <ProcessId>202210311015270330101470300315153****</ProcessId>\\n <StartTime>1669011260000</StartTime>\\n <Cost>252</Cost>\\n <ScanRows>2345</ScanRows>\\n <PeakMemory>123</PeakMemory>\\n <RcHost>192.168.XX.XX</RcHost>\\n <ScanSize>123</ScanSize>\\n <UserName>rpt</UserName>\\n </Performances>\\n</DescribeDiagnosisMonitorPerformanceResponse>","errorExample":""}]', + 'title' => 'DescribeDiagnosisMonitorPerformance', + ], + 'DescribeSQLPatterns' => [ + 'summary' => 'Queries a list of SQL patterns for an AnalyticDB for MySQL cluster within a period of time.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '90989', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the information about all AnalyticDB for MySQL clusters in a region, including cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + '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" + .'* Only data within the last 14 days can be queried. For example, if the current time is 2021-11-22T12:00:00Z, you can query SQL patterns at a point in time as early as 2021-11-09T12:00:00Z.'."\n" + ."\n" + .'* The maximum time range that can be specified is 24 hours.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-30T00:10: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' => true, + 'docRequired' => true, + 'example' => '2021-09-30T00:15:00Z', + ], + ], + [ + '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' => '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' => true, + 'example' => '[{"Field":"AverageQueryTime","Type":"Asc"}]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1.'."\n" + ."\n" + .'> If you do not specify this parameter, the value **1** is used.'."\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**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'> If you do not specify this parameter, the value **30** is used.'."\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' => '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' => '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', + ], + '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 database username that is used to commit the SQL pattern.'."\n", + 'type' => 'string', + 'example' => 'reporter', + ], + '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. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '2021-11-12 03: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' => '234149', + ], + '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' => '234', + ], + 'Blockable' => [ + 'description' => 'Indicates whether the execution of the SQL pattern can be blocked. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> Only SELECT and INSERT statements can be blocked.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'QueryTimeSum' => [ + 'description' => 'The total query duration.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'QueryTimePercentage' => [ + 'description' => 'The queue duration of the SQL statement. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '80', + ], + 'PeakMemorySum' => [ + 'description' => 'The total peak memory.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '3600', + ], + 'PeakMemoryPercentage' => [ + 'description' => 'The peak memory percentage.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '80', + ], + 'ScanSizeSum' => [ + 'description' => 'Total total scan size.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'ScanSizePercentage' => [ + 'description' => 'The amount of time consumed to scan data from a data source in the task. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '80', + ], + 'AverageOperatorCost' => [ + 'description' => 'The average operation duration.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '5', + ], + 'MaxOperatorCost' => [ + 'description' => 'The maximum operation duration.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'OperatorCostSum' => [ + 'description' => 'The total operation duration.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '20', + ], + 'OperatorCostPercentage' => [ + 'description' => 'The operation duration percentage.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '75', + ], + 'AverageScanCost' => [ + 'description' => 'The average scan duration.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'MaxScanCost' => [ + 'description' => 'The maximum scan duration.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '7', + ], + 'ScanCostSum' => [ + 'description' => 'The total scan duration.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '11', + ], + 'ScanCostPercentage' => [ + 'description' => 'The scan duration percentage.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '75', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"PatternDetails\\": [\\n {\\n \\"SQLPattern\\": \\"SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)\\",\\n \\"PatternId\\": \\"5575924945138******\\",\\n \\"User\\": \\"reporter\\",\\n \\"AccessIp\\": \\"192.168.xx.xx\\",\\n \\"Tables\\": \\"tpch.orders\\",\\n \\"PatternCreationTime\\": \\"2021-11-12 03:06:00\\",\\n \\"AverageQueryTime\\": 4,\\n \\"MaxQueryTime\\": 2341,\\n \\"AverageExecutionTime\\": 234.78,\\n \\"MaxExecutionTime\\": 2142,\\n \\"AveragePeakMemory\\": 234.22,\\n \\"MaxPeakMemory\\": 234149,\\n \\"AverageScanSize\\": 234149.23,\\n \\"MaxScanSize\\": 234149,\\n \\"QueryCount\\": 345,\\n \\"FailedCount\\": 234,\\n \\"Blockable\\": true,\\n \\"QueryTimeSum\\": 5,\\n \\"QueryTimePercentage\\": 10,\\n \\"PeakMemorySum\\": 5,\\n \\"PeakMemoryPercentage\\": 10,\\n \\"ScanSizeSum\\": 5,\\n \\"ScanSizePercentage\\": 80,\\n \\"AverageOperatorCost\\": 5,\\n \\"MaxOperatorCost\\": 5,\\n \\"OperatorCostSum\\": 5,\\n \\"OperatorCostPercentage\\": 20,\\n \\"AverageScanCost\\": 5,\\n \\"MaxScanCost\\": 5,\\n \\"ScanCostSum\\": 5,\\n \\"ScanCostPercentage\\": 5\\n }\\n ],\\n \\"RequestId\\": \\"6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeSQLPatternsResponse>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</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>reporter</User>\\n <AccessIp>192.168.xx.xx</AccessIp>\\n <Tables>tpch.orders</Tables>\\n <PatternCreationTime>2021-11-12 03: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>234149</MaxScanSize>\\n <QueryCount>345</QueryCount>\\n <FailedCount>234</FailedCount>\\n <Blockable>true</Blockable>\\n </PatternDetails>\\n <RequestId>6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******</RequestId>\\n</DescribeSQLPatternsResponse>","errorExample":""}]', + 'title' => 'DescribeSQLPatterns', + ], + 'DescribePatternPerformance' => [ + 'summary' => 'Queries the metrics of an SQL pattern such as the query duration and average memory usage within a period of time.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91807', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-****************', + ], + ], + [ + '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" + .'* Only data within the last 14 days can be queried. For example, if the current date is November 22 (UTC+8), you can query data on a day as early as November 9 by setting StartTime to 2021-11-08T16:00:00Z. If you set StartTime to a value earlier than 2021-11-08T16:00:00Z, the Performances parameter is empty.'."\n" + ."\n" + .'* The maximum time range that can be specified is 24 hours.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-18T00: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" + ."\n" + .'> The end time must be later than the start time.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-18T18:05:00Z', + ], + ], + [ + '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' => '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' => true, + 'example' => '3847585356974******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + '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' => '2021-11-18T18:05Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '210f47011634026610213529******', + ], + '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' => '2021-11-18T00:00Z', + ], + 'Performances' => [ + 'description' => 'The queried performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried performance metric.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The performance metric that was queried. 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 total 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_PatternQueryCount', + ], + 'Unit' => [ + 'description' => 'The unit of the performance metric. Valid values:'."\n" + ."\n" + .'* When the performance metric is related to the query duration (the `Key` value is `AnalyticDB_PatternQueryTime` or `AnalyticDB_PatternExecutionTime`), **ms** is returned.'."\n" + .'* When the performance metric is related to the memory usage (the `Key` value is `AnalyticDB_PatternPeakMemory`), **MB** is returned.'."\n" + .'* When the performance metric is related to the amount of data scanned (the `Key` value is `AnalyticDB_PatternScanSize`), **MB** is returned.'."\n" + .'* When the performance metric is related to the number of queries (the `Key` value is `AnalyticDB_PatternQueryCount`), this parameter is empty.'."\n", + 'type' => 'string', + 'example' => 'ms', + ], + 'Series' => [ + 'description' => 'The queried performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried performance metrics.', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => 'The queried performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the performance metric.'."\n", + 'type' => 'string', + 'example' => '[ "2021-11-18 13:38:00", "224" ]', + ], + ], + 'Name' => [ + 'description' => 'The name of the performance metric value. Valid values:'."\n" + ."\n" + .'* When the `Key` parameter is set to `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" + .'* When the `Key` parameter is set to `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" + .'* When the `Key` parameter is set to `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" + .'* When the `Key` parameter is set to `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" + .'* When the `Key` parameter is set `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', + ], + ], + ], + ], + ], + ], + ], + 'AccessIp' => [ + 'description' => 'The IP address of the SQL client that submits the SQL pattern.'."\n", + 'type' => 'string', + 'example' => '172.16.14.*', + ], + 'FailedCount' => [ + 'description' => 'The number of failed SQL patterns within the time range.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueryCount' => [ + 'description' => 'The number of queries executed in association with the SQL pattern within the time range.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35018', + ], + 'SQLPattern' => [ + 'description' => 'The SQL statement that represents the SQL pattern.'."\n", + 'type' => 'string', + 'example' => 'SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?', + ], + 'Tables' => [ + 'description' => 'The tables that are in association with the SQL pattern.'."\n", + 'type' => 'string', + 'example' => 'tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation', + ], + 'User' => [ + 'description' => 'The database account that is used to execute the SQL statement.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-11-18T18:05Z\\",\\n \\"RequestId\\": \\"210f47011634026610213529******\\",\\n \\"StartTime\\": \\"2021-11-18T00:00Z\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"AnalyticDB_PatternQueryCount\\",\\n \\"Unit\\": \\"ms\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n \\"[ \\\\\\"2021-11-18 13:38:00\\\\\\", \\\\\\"224\\\\\\" ]\\"\\n ],\\n \\"Name\\": \\"max_query_time\\"\\n }\\n ]\\n }\\n ],\\n \\"AccessIp\\": \\"172.16.14.*\\",\\n \\"FailedCount\\": 0,\\n \\"QueryCount\\": 35018,\\n \\"SQLPattern\\": \\"SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?\\",\\n \\"Tables\\": \\"tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation\\",\\n \\"User\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribePatternPerformanceResponse>\\n <EndTime>2021-11-18T18:05Z</EndTime>\\n <RequestId>210f47011634026610213529******</RequestId>\\n <StartTime>2021-11-18T00:00Z</StartTime>\\n <Performances>\\n <Key>AnalyticDB_PatternQueryCount</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', + ], + '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', + 'abilityTreeCode' => '74019', + '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 Data Warehouse Edition clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1q10xxzq2z4****', + ], + ], + [ + '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-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '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' => 'E1745C03-7CCE-55CF-932E-08121AAFA6AF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"E1745C03-7CCE-55CF-932E-08121AAFA6AF\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableAdviceServiceResponse>\\n <Message>Success</Message>\\n <RequestId>E1745C03-7CCE-55CF-932E-08121AAFA6AF</RequestId>\\n</EnableAdviceServiceResponse>","errorExample":""}]', + 'title' => 'EnableAdviceService', + ], + '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' => '73711', + '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 Warehouse Edition clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + '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' => '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 when the suggestion is generated. Specify the date in the yyyyMMdd format. The date must be in UTC.'."\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 => [ + 'headers' => [], + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'Execution Status', + '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', + 'enumValueTitles' => [ + 'SUCCESS' => 'SUCCESS', + '报错信息' => '', + ], + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5DC10091-348D-12B1-906D-AB49D658012E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"5DC10091-348D-12B1-906D-AB49D658012E\\"\\n}","errorExample":""},{"type":"xml","example":"<ApplyAdviceByIdResponse>\\n <Message>SUCCESS</Message>\\n <RequestId>5DC10091-348D-12B1-906D-AB49D658012E</RequestId>\\n</ApplyAdviceByIdResponse>","errorExample":""}]', + 'title' => 'ApplyAdviceById', + ], + 'BatchApplyAdviceByIdList' => [ + 'summary' => 'Applies multiple optimization suggestions at a time.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '138165', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => 'The region ID of the cluster. You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AdviceIdList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the suggestions to be applied. Separate multiple IDs with commas (,).'."\n", + '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 when the suggestion is generated. Specify the date in the yyyyMMdd format. The date must be in UTC.'."\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' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'Execution Status', + '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' => '86F92D26-B774-5FA1-8E53-82CBEEEBB012', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"86F92D26-B774-5FA1-8E53-82CBEEEBB012\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchApplyAdviceByIdListResponse>\\n <Message>SUCCESS</Message>\\n <RequestId>86F92D26-B774-5FA1-8E53-82CBEEEBB012</RequestId>\\n</BatchApplyAdviceByIdListResponse>","errorExample":""}]', + 'title' => 'BatchApplyAdviceByIdList', + ], + 'DescribeAdviceServiceEnabled' => [ + 'summary' => 'Queries whether the suggestion feature is enabled 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' => '73783', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + '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 Data Warehouse Edition clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-2ze0vp0j6t3to****', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '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' => '[Advisor] Advisor feature is not available for instance: am-2ze0vp0j6t3to****', + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"[Advisor] Advisor feature is not available for instance: am-2ze0vp0j6t3to****\\",\\n \\"RequestId\\": \\"E031AABF-BD56-5966-A063-4283EF18DB45\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeAdviceServiceEnabledResponse>\\n <Message>[Advisor] Advisor feature is not available for instance: am-2ze0vp0j6t3to****</Message>\\n <RequestId>E031AABF-BD56-5966-A063-4283EF18DB45</RequestId>\\n <Result>false</Result>\\n</DescribeAdviceServiceEnabledResponse>","errorExample":""}]', + 'title' => 'DescribeAdviceServiceEnabled', + ], + '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' => '73895', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of AnalyticDB for MySQL Data Warehouse Edition clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + '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' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'StartTime', + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyyMMdd format. The time must be in UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20220811', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'EndTime', + 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyyMMdd format. The time must be in UTC.'."\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', + 'default' => '10', + ], + ], + [ + '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', + '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" + .' * `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":"Benefit","Type":"Desc"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => '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 state 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 state 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. Minimum value: 0. Default value: 0.'."\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 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. The value is an integer that is greater than or equal to 0. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SchemaTableNames' => [ + 'description' => 'The names of the tables 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" + .']', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"AdviceId\\": \\"7417db9c-914d-43f3-a123-4d0e448f****\\",\\n \\"SubmitTime\\": \\"2208131600\\",\\n \\"SubmitStatus\\": \\"SUCCEED\\",\\n \\"SQL\\": \\"alter table `schema1`.`table1` drop key col1_1_idx\\",\\n \\"RollbackSQL\\": \\"alter table `schema1`.`table1` add key col1_1_idx(col1)\\",\\n \\"JobStatus\\": \\"SUCCEED\\",\\n \\"Benefit\\": \\"节省0.4 GB的存储空间\\",\\n \\"BuildSQL\\": \\"build table `schema1`.`table1`\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test\\",\\n \\"IndexFields\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"84489769-3065-5A28-A4CB-977CD426F1C3\\",\\n \\"TotalCount\\": 1,\\n \\"SchemaTableNames\\": [\\n \\"[\\\\n \\\\\\"tpch.lineitem\\\\\\",\\\\n \\\\\\"tpch.partsupp\\\\\\",\\\\n \\\\\\"tpch.orders\\\\\\"\\\\n]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAppliedAdvicesResponse>\\n <Items>\\n <AdviceId>7417db9c-914d-43f3-a123-4d0e448f****</AdviceId>\\n <SubmitTime>2022-08-20T16:00:00Z</SubmitTime>\\n <SubmitStatus>SUCCEED</SubmitStatus>\\n <SQL>alter table `schema1`.`table1` drop key col1_1_idx</SQL>\\n <RollbackSQL>alter table `schema1`.`table1` add key col1_1_idx(col1)</RollbackSQL>\\n <JobStatus>SUCCEED</JobStatus>\\n <Benefit>节省0.4GB空间</Benefit>\\n <BuildSQL>build table `schema1`.`table1`</BuildSQL>\\n <TotalCount>1</TotalCount>\\n <PageSize>30</PageSize>\\n <PageNumber>1</PageNumber>\\n </Items>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <RequestId>84489769-3065-5A28-A4CB-977CD426F1C3</RequestId>\\n <TotalCount>1</TotalCount>\\n</DescribeAppliedAdvicesResponse>","errorExample":""}]', + 'title' => 'DescribeAppliedAdvices', + ], + 'DescribeAvailableAdvices' => [ + 'summary' => 'Queries the available suggestions for cluster optimization.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '73942', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of Data Warehouse Edition (V3.0) clusters.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp198m028ih55****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + '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' => 'AdviceDate', + 'in' => 'query', + 'schema' => [ + 'title' => 'AdviceDate', + 'description' => 'The date when the suggestion is generated. Specify the date in the yyyyMMdd format. The date must be in UTC.'."\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' => true, + 'example' => '20221124', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => 'Lang', + 'description' => 'The display language of the suggestion. 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' => true, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageSize', + 'description' => 'The number of entries to return on each page. Default value: 30. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => 'PageNumber', + 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + '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" + .' * `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":"Benefit","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' => '', + 'type' => 'object', + 'properties' => [ + 'AdviceId' => [ + 'title' => 'AdviceId', + 'description' => 'The suggestion ID.'."\n", + 'type' => 'string', + 'example' => 'dcd04135-0925-4aed-a5a7-e7d92cb1****', + ], + 'AdviceDate' => [ + 'title' => 'AdviceDate', + 'description' => 'The time when the suggestion was generated. The time follows the ISO 8601 standard in the yyyyMMdd format. The time is displayed in UTC.'."\n", + '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. Minimum value: 0. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + '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 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SchemaName' => [ + 'description' => 'The name of the schema.'."\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 of the returned page. The value must be an integer that is greater than 0. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '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', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '96A55627-28E9-5E47-B8F6-D786BE551349', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned. The value must be an integer that is greater than or equal to 0. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + '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' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"AdviceId\\": \\"dcd04135-0925-4aed-a5a7-e7d92cb1****\\",\\n \\"AdviceDate\\": \\"20221124\\",\\n \\"AdviceType\\": \\"Index\\",\\n \\"SQL\\": \\"alter table `schema1`.`table1` drop key col1_1_idx\\",\\n \\"Reason\\": \\"15天未使用，历史使用统计概率小于1%\\",\\n \\"Benefit\\": \\"节省0.4 GB的存储空间。\\",\\n \\"TotalCount\\": 30,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"IndexFields\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"96A55627-28E9-5E47-B8F6-D786BE551349\\",\\n \\"TotalCount\\": 30,\\n \\"SchemaTableNames\\": [\\n \\"[\\\\n \\\\\\"tpch.lineitem\\\\\\",\\\\n \\\\\\"tpch.partsupp\\\\\\",\\\\n \\\\\\"tpch.orders\\\\\\"\\\\n]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAvailableAdvicesResponse>\\n <Items>\\n <AdviceId>dcd04135-0925-4aed-a5a7-e7d92cb1****</AdviceId>\\n <AdviceDate>20221124</AdviceDate>\\n <AdviceType>Index</AdviceType>\\n <SQL>alter table `schema1`.`table1` drop key col1_1_idx</SQL>\\n <Reason>15天未使用，历史使用统计概率小于1%</Reason>\\n <Benefit>节省0.4GB空间</Benefit>\\n <TotalCount>30</TotalCount>\\n <PageSize>30</PageSize>\\n <PageNumber>1</PageNumber>\\n </Items>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <RequestId>96A55627-28E9-5E47-B8F6-D786BE551349</RequestId>\\n <TotalCount>30</TotalCount>\\n</DescribeAvailableAdvicesResponse>","errorExample":""}]', + 'title' => 'DescribeAvailableAdvices', + ], + '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', + 'abilityTreeCode' => '73983', + '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 Data Warehouse Edition clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf67culrr26q2****', + ], + ], + [ + '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, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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' => '57EC6CCA-A582-572C-A33D-F61845CBC03C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"57EC6CCA-A582-572C-A33D-F61845CBC03C\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableAdviceServiceResponse>\\n <Message>Success</Message>\\n <RequestId>57EC6CCA-A582-572C-A33D-F61845CBC03C</RequestId>\\n</DisableAdviceServiceResponse>","errorExample":""}]', + 'title' => 'DisableAdviceService', + ], + 'DescribeDBClusterSpaceSummary' => [ + 'summary' => 'Queries the storage overview information of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster, such as the total data size, hot data size, cold data size, and data growth.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '211904', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1u8c0mgfg58****', + ], + ], + [ + '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' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', + ], + '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 + Other data size.'."\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 other data size. 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 + Other data size.'."\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 other data size. 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 of 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 of 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\\": \\"25B56BC7-4978-40B3-9E48-4B7067******\\",\\n \\"Data\\": {\\n \\"TotalSize\\": \\"8388608\\",\\n \\"HotData\\": {\\n \\"TotalSize\\": 4194304,\\n \\"DataSize\\": 1048576,\\n \\"IndexSize\\": 1048576,\\n \\"PrimaryKeyIndexSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n },\\n \\"ColdData\\": {\\n \\"TotalSize\\": 4194304,\\n \\"DataSize\\": 1048576,\\n \\"IndexSize\\": 1048576,\\n \\"PrimaryKeyIndexSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n },\\n \\"DataGrowth\\": {\\n \\"DayGrowth\\": 1048576,\\n \\"WeekGrowth\\": 1048576\\n }\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDBClusterSpaceSummary', + ], + 'DescribeTableStatistics' => [ + 'summary' => 'Queries the information about table statistics for an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16754', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query a list of cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-****************', + ], + ], + [ + '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' => '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' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which to sort the queried information. Specify this parameter as an ordered JSON array that consists of the `Field` and `Type` fields. Example: `[{ "Field":"TableName", "Type":"Asc" }]`.'."\n" + ."\n" + .'* `Field` specifies the field that is used to sort the queried information. The following fields are supported: `TableName`, ColdDataSize, DataSize, PrimaryKeyIndexSize, RowCount, IndexSize, SchemaName, and PartitionCount.'."\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":"TableName", "Type":"Asc" } ]', + ], + ], + [ + '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-beijing', + 'default' => 'cn-shanghai', + ], + ], + [ + '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' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + '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' => '', + '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 table records. Unit: bytes.'."\n" + ."\n" + .'> The data size of table records, excluding the data size of regular index and primary key indexes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15592', + ], + 'IndexSize' => [ + 'description' => 'The data size of regular indexes. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3076', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => 'The data size of primary key indexes. 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 cold data size. Unit: bytes.'."\n" + ."\n" + .'> The parameter is returned only for AnalyticDB for MySQL clusters of V3.1.3.4 or later.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + '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. Unit: bytes.'."\n" + ."\n" + .'> The following formulas can be used to calculate the total data size: Formula 1: Total data size = Hot data size + Cold data size. 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 hot data size. 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' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"4C4433FF-5D3A-4C3E-A19C-6D93B2******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DBClusterId\\": \\"am-****************\\",\\n \\"Items\\": {\\n \\"TableStatisticRecords\\": [\\n {\\n \\"SchemaName\\": \\"test_schema\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"RowCount\\": 3,\\n \\"DataSize\\": 15592,\\n \\"IndexSize\\": 3076,\\n \\"PrimaryKeyIndexSize\\": 16340,\\n \\"PartitionCount\\": 1,\\n \\"ColdDataSize\\": 0,\\n \\"SpaceRatio\\": 66.23,\\n \\"TotalSize\\": 1577,\\n \\"HotDataSize\\": 1048576,\\n \\"OtherSize\\": 1048576\\n }\\n ]\\n },\\n \\"SchemaNames\\": \\"[\'adb_external_tpch_10gb\', \'dw_bccb\', \'dw_fm\', \'dw_test\', \'dw_yph\']\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeTableStatisticsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>4C4433FF-5D3A-4C3E-A19C-6D93B2******</RequestId>\\n <PageSize>30</PageSize>\\n <PageNumber>1</PageNumber>\\n <DBClusterId>am-****************</DBClusterId>\\n <Items>\\n <TableStatisticRecords>\\n <TableName>test_table</TableName>\\n <ColdDataSize>0</ColdDataSize>\\n <DataSize>15592</DataSize>\\n <PrimaryKeyIndexSize>16340</PrimaryKeyIndexSize>\\n <IndexSize>3076</IndexSize>\\n <RowCount>3</RowCount>\\n <PartitionCount>1</PartitionCount>\\n <SchemaName>test_schema</SchemaName>\\n </TableStatisticRecords>\\n </Items>\\n</DescribeTableStatisticsResponse>","errorExample":""}]', + 'title' => 'DescribeTableStatistics', + ], + 'DescribeExcessivePrimaryKeys' => [ + 'summary' => 'Queries the tables that have excessive primary key fields in an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209775', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) 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' => 'am-bp1u8c0mgfg58****', + ], + ], + [ + '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-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:mm:ssZ* format. The time must be in UTC.'."\n", + '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:mm:ssZ* format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2023-05-15T07:15Z', + ], + ], + [ + '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' => '20', + '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' => 'Lang', + 'in' => 'query', + 'schema' => [ + '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' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order by which to sort query results. Specify the parameter value in the JSON format. Example: `[{"Field":"TableSchema","Type":"Asc"}]`.'."\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":"TableName","Type":"Desc"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\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' => '10', + 'default' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'DBClusterId' => [ + '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 (V3.0) clusters within a region.'."\n", + 'type' => 'string', + 'example' => 'am-bp11q28kvl688****', + ], + 'Tables' => [ + 'description' => 'The queried tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '26', + ], + 'PrimaryKeyCount' => [ + 'description' => 'The number of primary key fields.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PrimaryKeyColumns' => [ + 'description' => 'The queried primary key fields.'."\n", + 'type' => 'string', + 'example' => 'id,date', + ], + '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' => '20', + ], + '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 + Size of other data.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1073741824', + ], + 'PrimaryKeyIndexSize' => [ + 'description' => 'The data size of primary key indexes. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + ], + ], + ], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the detection item.'."\n", + 'type' => 'string', + 'example' => 'evm_identity', + ], + '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" + .'WARNING'."\n" + .'CRITICAL', + ], + ], + ], + ], + '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": "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\\": \\"1\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"DBClusterId\\": \\"am-bp11q28kvl688****\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"ColumnCount\\": 26,\\n \\"PrimaryKeyCount\\": 1,\\n \\"PrimaryKeyColumns\\": \\"id,date\\",\\n \\"SpaceRatio\\": 20,\\n \\"TotalSize\\": 1073741824,\\n \\"PrimaryKeyIndexSize\\": 2345\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"主键字段过多\\",\\n \\"Message\\": \\"检测到表存在主键过多的情况\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1906102576997697\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"202515810214480629\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'DescribeExcessivePrimaryKeys', + ], + 'DescribeTableAccessCount' => [ + 'summary' => '查询表访问统计信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72143', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the details of all AnalyticDB for MySQL clusters within a specified region, including cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1r053byu48p****', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the specific table.'."\n" + ."\n" + .'> If this parameter is not specified, the number of accesses to all tables within the specified cluster for a specified date is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CUSTOMER', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The date to query. Specify the time in the *yyyy-MM-dd* format. The time must be in UTC.'."\n" + ."\n" + .'> Only data for the last 30 days can be queried.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-08-30', + ], + ], + [ + '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"}]`.'."\n" + ."\n" + .'* `Field` indicates the field that is used to sort the retrieved entries. 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` indicates the sorting method. Valid values:'."\n" + ."\n" + .' * `Asc`: ascending order.'."\n" + .' * `Desc`: descending order.'."\n" + ."\n" + .'> If this parameter is not specified, query results are sorted in ascending order of the database to which a specific table belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"Field":"TableSchema","Type":"Asc"}]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. The value must be a positive integer. Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the regions and zones supported by AnalyticDB for MySQL, including region IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C242707A-01D1-54DA-A5F6-671557******', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned on the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'Details about the table usage.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ReportDate' => [ + 'description' => 'The date when the table was used.'."\n", + 'type' => 'string', + 'example' => '2021-08-30', + ], + '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' => 'am-bp1r053byu48p****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C242707A-01D1-54DA-A5F6-671557******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"ReportDate\\": \\"2021-08-30\\",\\n \\"TableSchema\\": \\"tpch\\",\\n \\"AccessCount\\": \\"6\\",\\n \\"TableName\\": \\"CUSTOMER\\",\\n \\"InstanceName\\": \\"am-bp1r053byu48p****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeTableAccessCountResponse>\\n <RequestId>C242707A-01D1-54DA-A5F6-671557******</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n <TotalCount>1</TotalCount>\\n <Items>\\n <ReportDate>2021-08-30</ReportDate>\\n <TableSchema>tpch</TableSchema>\\n <AccessCount>6</AccessCount>\\n <TableName>CUSTOMER</TableName>\\n <InstanceName>am-bp1r053byu48p****</InstanceName>\\n </Items>\\n</DescribeTableAccessCountResponse>","errorExample":""}]', + 'title' => ' DescribeTableAccessCount', + ], + 'DescribeSqlPattern' => [ + 'summary' => 'Queries a list of SQL patterns for an AnalyticDB for MySQL cluster within a time range.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72142', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start date to query. Specify the time 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' => '2021-08-30', + 'default' => '2021-08-30', + ], + ], + [ + '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' => '1', + ], + ], + [ + '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 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-bp1r053byu48p****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. The value must be a positive integer. Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + '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 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'The queried SQL pattern.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AvgStageCount' => [ + 'description' => 'The average number of stages.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'MaxCpuTime' => [ + 'description' => 'The maximum execution duration of the SQL pattern within the time range to query. 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.***.***', + ], + 'AvgScanSize' => [ + 'description' => 'The average amount of data scanned based on the SQL pattern within the query time range. Unit: KB.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'MaxScanSize' => [ + 'description' => 'The maximum amount of data scanned based on the SQL pattern within the query time range. Unit: KB.'."\n", + 'type' => 'string', + 'example' => '0', + ], + '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 time range to query. 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 cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-bp1r053byu48p****', + ], + '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' => '2021-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' => 'B6F2D1B4-2C9F-5622-B424-5E7965******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"AvgStageCount\\": \\"2\\",\\n \\"MaxCpuTime\\": \\"17\\",\\n \\"AccessIP\\": \\"100.104.***.***\\",\\n \\"AvgScanSize\\": \\"0\\",\\n \\"MaxScanSize\\": \\"0\\",\\n \\"MaxPeakMemory\\": \\"480096\\",\\n \\"AvgCpuTime\\": \\"1.0625\\",\\n \\"User\\": \\"test_acc\\",\\n \\"AvgPeakMemory\\": \\"240048\\",\\n \\"MaxStageCount\\": \\"2\\",\\n \\"MaxTaskCount\\": \\"2\\",\\n \\"InstanceName\\": \\"am-bp1r053byu48p****\\",\\n \\"QueryCount\\": \\"16\\",\\n \\"ReportDate\\": \\"2021-08-30\\",\\n \\"Pattern\\": \\"SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1\\",\\n \\"AvgTaskCount\\": \\"2\\"\\n }\\n ],\\n \\"RequestId\\": \\"B6F2D1B4-2C9F-5622-B424-5E7965******\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeSqlPatternResponse>\\n <PageSize>30</PageSize>\\n <PageNumber>1</PageNumber>\\n <TotalCount>1</TotalCount>\\n <Items>\\n <AvgStageCount>2</AvgStageCount>\\n <MaxCpuTime>17</MaxCpuTime>\\n <AccessIP>100.104.***.***</AccessIP>\\n <AvgScanSize>0</AvgScanSize>\\n <MaxScanSize>0</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>am-bp1r053byu48p****</InstanceName>\\n <QueryCount>16</QueryCount>\\n <ReportDate>2021-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>B6F2D1B4-2C9F-5622-B424-5E7965******</RequestId>\\n</DescribeSqlPatternResponse>","errorExample":""}]', + 'title' => 'DescribeSqlPattern', + ], + 'CheckServiceLinkedRole' => [ + 'summary' => 'Checks whether a service-linked role is created.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10762', + 'abilityTreeNodes' => [ + 'FEATUREads11TSMW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-beijing', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ads.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BA0F6761-7A8C-59F8-9624-FB56788C0EDF', + ], + 'HasServiceLinkedRole' => [ + 'description' => 'Indicates whether an SLR is created.'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA0F6761-7A8C-59F8-9624-FB56788C0EDF\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]', + 'title' => 'CheckServiceLinkedRole', + ], + 'CreateServiceLinkedRole' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '10771', + 'abilityTreeNodes' => [ + 'FEATUREads11TSMW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ads.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '051D7910-3547-5316-AB48-02BE2090B148', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"051D7910-3547-5316-AB48-02BE2090B148\\"\\n}","type":"json"}]', + 'title' => 'CreateServiceLinkedRole', + 'summary' => 'Creates a service-linked role.', + ], + 'DescribeKmsKeys' => [ + 'summary' => 'Queries a list of Key Management Service (KMS) keys.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~129857~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + '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' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8F91F25F-8BCF-59E3-AF67-3806DB41FD09', + ], + 'KmsKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'KmsKey' => [ + 'description' => 'The queried KMS keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried KMS key.'."\n", + 'type' => 'object', + 'properties' => [ + 'KeyAlias' => [ + 'description' => 'The alias of the key.'."\n", + 'type' => 'string', + 'example' => 'mykey', + ], + 'KeyId' => [ + 'description' => 'The ID of the key.'."\n", + 'type' => 'string', + 'example' => '2e81355b-f8e7-4090-8082-a8f8124a621c', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F91F25F-8BCF-59E3-AF67-3806DB41FD09\\",\\n \\"KmsKeys\\": {\\n \\"KmsKey\\": [\\n {\\n \\"KeyAlias\\": \\"mykey\\",\\n \\"KeyId\\": \\"2e81355b-f8e7-4090-8082-a8f8124a621c\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeKmsKeys', + ], + 'DescribeLogHubAttribute' => [ + 'summary' => 'Queries the information about a log shipping job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-bp1nz6smy07szs58p', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Simple Log Service project.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dcsz-af-data', + ], + ], + [ + 'name' => 'DeliverName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the log shipping job.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sz_sls2adb_kxdpz_af_data', + ], + ], + [ + 'name' => 'LogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Logstore.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'game2-sms-log', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8A564B7F-8C00-43C0-8EC5-919FBB70573', + ], + 'LoghubInfo' => [ + 'description' => 'The log collection information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Delay' => [ + 'description' => 'The synchronization latency, which is the latency between the latest update time of the synchronization job and the current system time. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '361', + ], + 'TableName' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'test2', + ], + 'LogHubStores' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogHubStore' => [ + 'description' => 'The names of the Logstores.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the Logstore.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogKey' => [ + 'description' => 'The log keyword.'."\n", + 'type' => 'string', + 'example' => 'taskid', + ], + 'FieldKey' => [ + 'description' => 'The value of the log keyword.'."\n", + 'type' => 'string', + 'example' => '255311', + ], + ], + ], + ], + ], + ], + 'ProjectName' => [ + 'description' => 'The name of the Simple Log Service project.'."\n", + 'type' => 'string', + 'example' => 'test-adb', + ], + 'DBType' => [ + 'description' => 'The database type.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'SchemaName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'cbd_bi', + ], + 'SyncStatus' => [ + 'description' => 'The synchronization status.'."\n", + 'type' => 'string', + 'example' => 'processing', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'DeliverName' => [ + 'description' => 'The name of the log shipping job.'."\n", + 'type' => 'string', + 'example' => 'loghub-web-login-new', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-8vbs48m7553du1gz2', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'description', + ], + 'FilterDirtyData' => [ + 'description' => 'Indicates whether dirty data is filtered.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'LogStoreName' => [ + 'description' => 'The name of the Logstore.'."\n", + 'type' => 'string', + 'example' => 'device_login', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'UserName' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'aaa', + ], + 'DeliverTime' => [ + 'description' => 'The log shipping time.'."\n", + 'type' => 'string', + 'example' => '2024-12-06\'T\'10:15\'Z\'', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8A564B7F-8C00-43C0-8EC5-919FBB70573\\",\\n \\"LoghubInfo\\": {\\n \\"Delay\\": 361,\\n \\"TableName\\": \\"test2\\",\\n \\"LogHubStores\\": {\\n \\"LogHubStore\\": [\\n {\\n \\"LogKey\\": \\"taskid\\",\\n \\"FieldKey\\": \\"255311\\"\\n }\\n ]\\n },\\n \\"ProjectName\\": \\"test-adb\\",\\n \\"DBType\\": \\"rds\\",\\n \\"SchemaName\\": \\"cbd_bi\\",\\n \\"SyncStatus\\": \\"processing\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"DeliverName\\": \\"loghub-web-login-new\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBClusterId\\": \\"am-8vbs48m7553du1gz2\\",\\n \\"Description\\": \\"description\\",\\n \\"FilterDirtyData\\": true,\\n \\"LogStoreName\\": \\"device_login\\",\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"UserName\\": \\"aaa\\",\\n \\"DeliverTime\\": \\"2024-12-06\'T\'10:15\'Z\'\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeLogHubAttribute', + ], + 'DescribeLogStoreKeys' => [ + 'summary' => 'Queries a list of log keywords in a Logstore.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Simple Log Service project.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'nbgame-point', + ], + ], + [ + 'name' => 'LogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Logstore.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-hcl2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3BB185E9-BB54-1727-B876-13243E4C0EB5', + ], + 'LogStoreKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogStoreKey' => [ + 'description' => 'The queried log keywords.', + 'type' => 'array', + 'items' => [ + 'description' => 'The queried log keywords.', + 'type' => 'string', + 'example' => 'testKey', + ], + ], + ], + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingProjectName', + 'errorMessage' => 'ProjectName is mandatory for this action.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3BB185E9-BB54-1727-B876-13243E4C0EB5\\",\\n \\"LogStoreKeys\\": {\\n \\"LogStoreKey\\": [\\n \\"testKey\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeLogStoreKeys', + ], + 'DescribeLoghubDetail' => [ + 'summary' => 'Queries the log collection information.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Simple Log Service project.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sls-hz-php-ad', + ], + ], + [ + 'name' => 'ExportName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the log shipping job.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'wap_log_full_to_adb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'LoghubInfo' => [ + 'description' => 'The queried log collection information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'test2', + ], + 'LogHubStores' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogHubStore' => [ + 'description' => 'The log keywords.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The log keyword.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogKey' => [ + 'description' => 'The log keyword.'."\n", + 'type' => 'string', + 'example' => 'put_request', + ], + 'FieldKey' => [ + 'description' => 'The value of the log keyword.'."\n", + 'type' => 'string', + 'example' => 'channel_id', + ], + ], + ], + ], + ], + ], + 'ProjectName' => [ + 'description' => 'The name of the Simple Log Service project.'."\n", + 'type' => 'string', + 'example' => 'test-adb', + ], + 'SchemaName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'cbd_bi', + ], + 'DBType' => [ + 'description' => 'The database type.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'DeliverName' => [ + 'description' => 'The name of the log shipping job.'."\n", + 'type' => 'string', + 'example' => 'hub-pay-callback-ykt', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-8vbs48m7553du1gz2', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'aaa', + ], + 'FilterDirtyData' => [ + 'description' => 'Indicates whether dirty data is filtered.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'LogStoreName' => [ + 'description' => 'The name of the Logstore.'."\n", + 'type' => 'string', + 'example' => 'device_login', + ], + 'UserName' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DeliverTime' => [ + 'description' => 'The log shipping time.'."\n", + 'type' => 'string', + 'example' => '2024-12-06\'T\'10:15\'Z\'', + ], + 'DomainUrl' => [ + 'description' => 'The endpoint.'."\n", + 'type' => 'string', + 'example' => 'am-bp1p38m2c26s7hpk690650.ads.aliyuncs.com', + ], + ], + ], + ], + '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 \\"LoghubInfo\\": {\\n \\"TableName\\": \\"test2\\",\\n \\"LogHubStores\\": {\\n \\"LogHubStore\\": [\\n {\\n \\"LogKey\\": \\"put_request\\",\\n \\"FieldKey\\": \\"channel_id\\"\\n }\\n ]\\n },\\n \\"ProjectName\\": \\"test-adb\\",\\n \\"SchemaName\\": \\"cbd_bi\\",\\n \\"DBType\\": \\"rds\\",\\n \\"DeliverName\\": \\"hub-pay-callback-ykt\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"DBClusterId\\": \\"am-8vbs48m7553du1gz2\\",\\n \\"Description\\": \\"aaa\\",\\n \\"FilterDirtyData\\": true,\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"LogStoreName\\": \\"device_login\\",\\n \\"UserName\\": \\"test\\",\\n \\"DeliverTime\\": \\"2024-12-06\'T\'10:15\'Z\'\\",\\n \\"DomainUrl\\": \\"am-bp1p38m2c26s7hpk690650.ads.aliyuncs.com\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeLoghubDetail', + ], + 'DescribeRdsAnalysisResourceQuotas' => [ + 'summary' => 'Queries the information about specifications of MySQL analytic instances.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'RdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB RDS instance from which data is synchronized to the MySQL analytic instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'rm-2ze09tofcv39h7165', + ], + ], + [ + 'name' => 'NodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the MySQL analytic instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'E32', + ], + ], + [ + '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' => 'ClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of the MySQL analytic instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mixed_storage', + ], + ], + [ + 'name' => 'NodeCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes in the MySQL analytic instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the MySQL analytic instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flexible', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage type of the MySQL analytic instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1A31D7FA-1826-5843-8807-D2F715E70CB0', + ], + 'DBNodeClassList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeClass' => [ + 'description' => 'The instance types of the MySQL analytic instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance type of the MySQL analytic instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The real value.'."\n", + 'type' => 'string', + 'example' => 'E32', + ], + 'Text' => [ + 'description' => 'The display value.'."\n", + 'type' => 'string', + 'example' => 'E32', + ], + ], + ], + ], + ], + ], + 'EngineVersionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EngineVersion' => [ + 'description' => 'The versions of the MySQL analytic instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The version of the MySQL analytic instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The real value.'."\n", + 'type' => 'string', + 'example' => '3.0', + ], + 'Text' => [ + 'description' => 'The display value.'."\n", + 'type' => 'string', + 'example' => '3.0', + ], + ], + ], + ], + ], + ], + 'ModeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Mode' => [ + 'description' => 'The modes of the MySQL analytic instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The mode of the MySQL analytic instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The real value.'."\n", + 'type' => 'string', + 'example' => 'flexible', + ], + 'Text' => [ + 'description' => 'The display value.'."\n", + 'type' => 'string', + 'example' => 'flexible', + ], + ], + ], + ], + ], + ], + 'StorageTypeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StorageType' => [ + 'description' => 'The storage types of the MySQL analytic instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The storage type of the MySQL analytic instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The real value.'."\n", + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Text' => [ + 'description' => 'The display value.'."\n", + 'type' => 'string', + 'example' => 'cloud_essd', + ], + ], + ], + ], + ], + ], + 'DBNodeStorageList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeStorage' => [ + 'description' => 'The storage sizes of the MySQL analytic instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The storage size of the MySQL analytic instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The real value.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Text' => [ + 'description' => 'The display value.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + 'DBNodeCategoryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeCategory' => [ + 'description' => 'The editions of the MySQL analytic instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The edition of the MySQL analytic instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The real value.'."\n", + 'type' => 'string', + 'example' => 'mixed_storage', + ], + 'Text' => [ + 'description' => 'The display value.'."\n", + 'type' => 'string', + 'example' => 'mixed_storage', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A31D7FA-1826-5843-8807-D2F715E70CB0\\",\\n \\"DBNodeClassList\\": {\\n \\"DBNodeClass\\": [\\n {\\n \\"Value\\": \\"E32\\",\\n \\"Text\\": \\"E32\\"\\n }\\n ]\\n },\\n \\"EngineVersionList\\": {\\n \\"EngineVersion\\": [\\n {\\n \\"Value\\": \\"3.0\\",\\n \\"Text\\": \\"3.0\\"\\n }\\n ]\\n },\\n \\"ModeList\\": {\\n \\"Mode\\": [\\n {\\n \\"Value\\": \\"flexible\\",\\n \\"Text\\": \\"flexible\\"\\n }\\n ]\\n },\\n \\"StorageTypeList\\": {\\n \\"StorageType\\": [\\n {\\n \\"Value\\": \\"cloud_essd\\",\\n \\"Text\\": \\"cloud_essd\\"\\n }\\n ]\\n },\\n \\"DBNodeStorageList\\": {\\n \\"DBNodeStorage\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"Text\\": \\"100\\"\\n }\\n ]\\n },\\n \\"DBNodeCategoryList\\": {\\n \\"DBNodeCategory\\": [\\n {\\n \\"Value\\": \\"mixed_storage\\",\\n \\"Text\\": \\"mixed_storage\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeRdsAnalysisResourceQuotas', + ], + 'DescribeRegionsMixed' => [ + 'summary' => 'Queries information about regions.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '10816', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => '2E9450FF-F8AD-54C6-B3C3-009FBD7C0700', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The queried regions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried region.'."\n", + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'The version of the cluster.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 2.0'."\n" + .'* 3.0'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + '2.0' => '2.0', + '3.0' => '3.0', + ], + 'example' => '3.0', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2E9450FF-F8AD-54C6-B3C3-009FBD7C0700\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"Version\\": \\"3.0\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeRegionsMixed', + ], + 'DescribeSyncAvailableDBClusterList' => [ + 'summary' => 'Queries a list of instances or clusters that are available for data synchronization.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsB77AUE', + 'FEATUREadsH8FO36', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Target'."\n" + .'* Source'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Target' => 'Target', + 'Source' => 'Source', + ], + 'example' => 'Source', + ], + ], + [ + 'name' => 'SourceDBCluster', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The source instances or clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The source instance or cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The database type of the source instance or cluster.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* rds: ApsaraDB RDS.'."\n" + .'* sls: Simple Log Service.'."\n" + .'* polardb: PolarDB.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'rds' => 'rds', + 'sls' => 'sls', + 'polardb' => 'polardb', + ], + 'example' => 'rds', + ], + 'ClusterIds' => [ + 'description' => 'The ID of the source instance or cluster. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1l3yh04y7us147n', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'SyncPlatform', + 'in' => 'query', + 'schema' => [ + 'description' => 'The synchronization platform.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ADB-CDC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FBD1DD96-AD1D-516C-9D9A-60BA081F66EE', + ], + 'SyncAvailableDBClusters' => [ + 'description' => 'The queried instances or clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried instance or cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableNumber' => [ + 'description' => 'The number of tables.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'DBClusterId' => [ + 'description' => 'The instance or cluster ID.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1l3yh04y7us147n', + ], + 'DBClusterDescription' => [ + 'description' => 'The description of the instance or cluster.'."\n", + 'type' => 'string', + 'example' => 'DB1', + ], + 'DBType' => [ + 'description' => 'The database type of the instance or cluster.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'StorageSize' => [ + 'description' => 'The storage size.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1000', + ], + ], + ], + ], + ], + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBD1DD96-AD1D-516C-9D9A-60BA081F66EE\\",\\n \\"SyncAvailableDBClusters\\": [\\n {\\n \\"TableNumber\\": 100,\\n \\"DBClusterId\\": \\"rm-bp1l3yh04y7us147n\\",\\n \\"DBClusterDescription\\": \\"DB1\\",\\n \\"DBType\\": \\"rds\\",\\n \\"StorageSize\\": 1000\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeSyncAvailableDBClusterList', + ], + 'DescribeSyncJobList' => [ + 'summary' => 'Queries a list of synchronization jobs 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', + 'abilityTreeNodes' => [ + 'FEATUREads1II0UT', + 'FEATUREadsB77AUE', + 'FEATUREadsH8FO36', + ], + ], + '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', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-8vb39udfi356l9psq', + ], + ], + [ + 'name' => 'SourceDBType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source database type.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + 'rds' => 'rds', + 'sls' => 'sls', + 'polardb' => 'polardb', + ], + 'example' => 'sls', + ], + ], + [ + '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. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SourceDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source cluster. You can call the [DescribeDBClusters](~~170879~~) operation to query backup set IDs.'."\n" + ."\n" + .'> If you want to restore the data of an ApsaraDB for ClickHouse cluster, this parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-t4n766v2llx852n81', + ], + ], + [ + 'name' => 'SourceDBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the source cluster.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'GetSourceDetail', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to obtain details about the source instance or cluster.', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '482B8BAE-6EC0-5C0E-B2AF-FD42A3FC5B67', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'am-j6c22lubl8d9l3989', + ], + 'SyncJobs' => [ + 'description' => 'The queried synchronization jobs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The queried synchronization job.', + 'type' => 'object', + 'properties' => [ + 'SourceStorageSize' => [ + 'description' => 'The storage size of the source instance or cluster.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SourceDBClusterId' => [ + 'description' => 'The ID of the source cluster. You can call the [DescribeDBClusters](~~170879~~) operation to query backup set IDs.'."\n" + ."\n" + .'> If you want to restore the data of an ApsaraDB for ClickHouse cluster, this parameter is required.'."\n", + 'type' => 'string', + 'example' => 'pc-t4n766v2llx852n81', + ], + 'JobId' => [ + 'description' => 'The ID of the Spark job.'."\n", + 'type' => 'string', + 'example' => 'dts-xxxxx', + ], + 'SourceDBType' => [ + 'description' => 'The database type of the source instance or cluster.', + 'type' => 'string', + 'example' => 'polardb', + ], + 'SourceDBClusterDescription' => [ + 'description' => 'The description of the source instance or cluster.', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SourceTableNumber' => [ + 'description' => 'The number of tables in the source instance or cluster.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SyncPlatform' => [ + 'description' => 'The synchronization platform.'."\n", + 'type' => 'string', + 'example' => 'ADB-CDC', + ], + ], + ], + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"482B8BAE-6EC0-5C0E-B2AF-FD42A3FC5B67\\",\\n \\"PageNumber\\": 1,\\n \\"DBClusterId\\": 0,\\n \\"SyncJobs\\": [\\n {\\n \\"SourceStorageSize\\": 100,\\n \\"SourceDBClusterId\\": \\"pc-t4n766v2llx852n81\\",\\n \\"JobId\\": \\"dts-xxxxx\\",\\n \\"SourceDBType\\": \\"polardb\\",\\n \\"SourceDBClusterDescription\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SourceTableNumber\\": 100,\\n \\"SyncPlatform\\": \\"ADB-CDC\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeSyncJobList', + ], + 'DescribeVSwitchs' => [ + 'summary' => 'Queries a list of available vSwitches.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the VPC ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze1lz7nk4pn4zwy1j7pm', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~129857~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1B892DA2-9ABC-5CC0-AD73-405479C3FA53', + ], + 'VSwitches' => [ + 'description' => 'The queried vSwitches.'."\n", + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'description' => 'The queried vSwitch.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the vSwitch.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The state of the vSwitch. Valid values: **Pending**: the vSwitch is being configured. **Available**: the vSwitch is available.'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values: **true**: The vSwitch is the default vSwitch. **false**: The vSwitch is not the default vSwitch.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-25bcdxs7pv1****', + ], + 'CidrBlock' => [ + 'description' => 'The IPv4 CIDR block of the vSwitch.'."\n", + 'type' => 'string', + 'example' => '172.16.0.0/24', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => 'The time when the vSwitch was created.'."\n", + 'type' => 'string', + 'example' => '2022-01-18T12:43:57Z', + ], + 'AliUid' => [ + 'description' => 'The ID of the Resource Access Management (RAM) user.'."\n", + 'type' => 'string', + 'example' => '195813423043****', + ], + 'GmtModified' => [ + 'description' => 'The time when the vSwitch was modified.'."\n", + 'type' => 'string', + 'example' => '2022-01-22T12:43:57Z', + ], + 'Bid' => [ + 'description' => 'The ID of the user channel.'."\n", + 'type' => 'string', + 'example' => '26842', + ], + 'IzNo' => [ + 'description' => 'The zone ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'VSwitchName' => [ + 'description' => 'The name of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'VSW-Test-hangzhou-I', + ], + ], + ], + ], + ], + ], + ], + 'description' => 'The response parameters.', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B892DA2-9ABC-5CC0-AD73-405479C3FA53\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": true,\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\",\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2022-01-18T12:43:57Z\\",\\n \\"AliUid\\": \\"195813423043****\\",\\n \\"GmtModified\\": \\"2022-01-22T12:43:57Z\\",\\n \\"Bid\\": \\"26842\\",\\n \\"IzNo\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchName\\": \\"VSW-测试-杭州-I\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeVSwitchs', + ], + 'DescribeVpcs' => [ + 'summary' => 'Queries a list of available virtual private clouds (VPCs).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp13h7uzhulpuxvnp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Vpcs' => [ + 'description' => 'The queried VPCs.'."\n", + 'type' => 'object', + 'properties' => [ + 'Vpc' => [ + 'description' => 'The queried VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the VPC. Valid values:'."\n" + ."\n" + .'* Pending'."\n" + .'* Available'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'VpcName' => [ + 'description' => 'The name of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc1', + ], + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6m0r5pihw1r79od6990', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the VPC is the default VPC in the region. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'CidrBlock' => [ + 'description' => 'The IPv4 CIDR block of the VPC.'."\n", + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'RegionNo' => [ + 'description' => 'The region in which the VPC resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => 'The time when the VPC was created.'."\n", + 'type' => 'string', + 'example' => '1693217052000', + ], + 'AliUid' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '1431771514176727', + ], + 'VSwitchs' => [ + 'description' => 'The vSwitches in the VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID in the VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the vSwitch. Valid values:'."\n" + ."\n" + .'* Pending'."\n" + .'* Available'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-8vbxk6ij0yz16bu4l3ijj', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values: **true** **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'CidrBlock' => [ + 'description' => 'The IPv4 CIDR block of the vSwitch.'."\n", + 'type' => 'string', + 'example' => '172.17.0.0/24', + ], + 'GmtCreate' => [ + 'description' => 'The time when the vSwitch was created.'."\n", + 'type' => 'string', + 'example' => '1549012834000', + ], + 'GmtModified' => [ + 'description' => 'The time when the vSwitch was modified.'."\n", + 'type' => 'string', + 'example' => '1731031910000', + ], + 'IzNo' => [ + 'description' => 'The zone ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'VSwitchName' => [ + 'description' => 'The name of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vs1', + ], + ], + ], + ], + 'GmtModified' => [ + 'description' => 'The time when the VPC was modified.'."\n", + 'type' => 'string', + 'example' => '1724639118000', + ], + 'Bid' => [ + 'description' => 'The user channel ID.'."\n", + 'type' => 'string', + 'example' => '26842', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '78BDC895-F7C0-5961-92BE-F1C3D12B4BB5', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"vpc1\\",\\n \\"VpcId\\": \\"vpc-uf6m0r5pihw1r79od6990\\",\\n \\"IsDefault\\": false,\\n \\"CidrBlock\\": \\"192.168.0.0/16\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"1693217052000\\",\\n \\"AliUid\\": \\"1431771514176727\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-8vbxk6ij0yz16bu4l3ijj\\",\\n \\"IsDefault\\": false,\\n \\"CidrBlock\\": \\"172.17.0.0/24\\",\\n \\"GmtCreate\\": \\"1549012834000\\",\\n \\"GmtModified\\": \\"1731031910000\\",\\n \\"IzNo\\": \\"cn-hangzhou-j\\",\\n \\"VSwitchName\\": \\"vs1\\"\\n }\\n ],\\n \\"GmtModified\\": \\"1724639118000\\",\\n \\"Bid\\": \\"26842\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"78BDC895-F7C0-5961-92BE-F1C3D12B4BB5\\"\\n}","type":"json"}]', + 'title' => 'DescribeVpcs', + ], + 'ModifyLogHubStatus' => [ + 'summary' => 'Changes the status of a log shipping job.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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, + 'docRequired' => true, + 'example' => 'am-uf6j8370er80m6wf3', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Simple Log Service project.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-adb', + ], + ], + [ + 'name' => 'DeliverName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the log shipping job.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'loghub-mnp-report', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the log shipping job.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Delete'."\n" + .'* Pause'."\n" + .'* Restart'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Delete' => 'Delete', + 'Pause' => 'Pause', + 'Restart' => 'Restart', + ], + 'example' => 'Pause', + ], + ], + [ + 'name' => 'LogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Logstore.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay-notify-wx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0AA1F421-395B-5BC4-BDDC-762C508A952B', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AA1F421-395B-5BC4-BDDC-762C508A952B\\"\\n}","type":"json"}]', + 'title' => 'ModifyLogHubStatus', + ], + 'ModifySyncJob' => [ + 'summary' => 'Modifies the synchronization jobs for 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' => [ + 'FEATUREadsB77AUE', + 'FEATUREadsH8FO36', + 'FEATUREads1II0UT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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, + 'docRequired' => true, + 'example' => 'am-bp12bh6z59nh8497f', + ], + ], + [ + 'name' => 'SourceDBCluster', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The source instances or clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The source instance or cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The source database type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* rds: ApsaraDB RDS.'."\n" + .'* sls: Simple Log Service.'."\n" + .'* polardb: PolarDB.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'rds' => 'rds', + 'sls' => 'sls', + 'polardb' => 'polardb', + ], + 'example' => 'sls', + ], + 'OperateType' => [ + 'description' => 'The operation type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Create'."\n" + .'* Modify'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Create' => 'Create', + 'Modify' => 'Modify', + ], + 'example' => 'Create', + ], + 'ClusterIds' => [ + 'description' => 'The ID of the source instance or cluster. Separate multiple IDs with commas (,).', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-2zepqn129i9s3l2z3,rm-2zea4dj583129ksp6', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + 'JobId' => [ + 'description' => 'The ID of the synchronization job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dts-xxxxxx', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'SyncPlatform', + 'in' => 'query', + 'schema' => [ + 'description' => 'The synchronization platform.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ADB-CDC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5AD3D9DF-614F-5B97-9522-A2406A432012', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.InvalidSourceDBCluster', + 'errorMessage' => 'The operation is not permitted due to pc-wz9li839to71d2659 not synchronizing with this ADB cluster', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5AD3D9DF-614F-5B97-9522-A2406A432012\\"\\n}","type":"json"}]', + 'title' => 'ModifySyncJob', + ], + 'OperateLogHub' => [ + 'summary' => '修改LogHub投递规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREadsTYGUV3', + ], + ], + 'parameters' => [ + [ + 'name' => 'Create', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to create the log shipping job.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + '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, + 'docRequired' => true, + 'example' => 'am-uf6rtqaj25491628z', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Simple Log Service project.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-adb', + ], + ], + [ + 'name' => 'LogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Logstore.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'beta-game-mjxb-ham-pool-export', + ], + ], + [ + 'name' => 'DeliverName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the log shipping job.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xhxsblz_limited_gift_pay', + ], + ], + [ + 'name' => 'DeliverTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The shipping time.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2024-10-24\'T\'13:10\'Z\'', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the log shipping job.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'wddata', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rest_action_latest', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'admin', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ads_123', + ], + ], + [ + 'name' => 'FilterDirtyData', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to filter dirty data.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'Provider', + 'in' => 'query', + 'schema' => [ + 'description' => 'The channel of the log shipping job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SLS', + ], + ], + [ + 'name' => 'LogHubStores', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The log keywords.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The log keyword.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogKey' => [ + 'description' => 'The log keyword.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testKey', + ], + 'FieldKey' => [ + 'description' => 'The value of the log keyword.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testValue', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '71B41FF9-1275-5F75-973D-8BC3C60236E6', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvokeSLSException', + 'errorMessage' => 'An exception occured while invoke SLS Service.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"71B41FF9-1275-5F75-973D-8BC3C60236E6\\"\\n}","type":"json"}]', + 'title' => 'OperateLogHub', + ], + 'CancelActiveOperationTasks' => [ + 'summary' => 'Cancels O\\\\\\&M events.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '149993', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-xxxxxxxx', + ], + ], + ], + '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' => '642F3512-C628-5D0C-8815-F6670CEA00D4', + ], + 'Ids' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-xxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"642F3512-C628-5D0C-8815-F6670CEA00D4\\",\\n \\"Ids\\": \\"am-xxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'CancelActiveOperationTasks', + ], + 'DescribeHistoryEventsStat' => [ + 'summary' => 'Queries the information about historical events in the event center.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149605', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'adb', + ], + ], + [ + 'name' => 'ArchiveStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the event. Valid values:'."\n" + ."\n" + .'* Archived'."\n" + .'* UnArchived'."\n" + .'* All'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Only tasks that have a start time later than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The start time can be up to 30 days earlier than the current time. If you set this parameter to a time more than 30 days earlier than the current time, this time is automatically converted to a time that is exactly 30 days earlier than the current time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Only tasks that have a start time earlier than or equal to the time specified by this parameter are queried. 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-03-02T11:31:03Z'."\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' => 'BA0F6761-7A8C-59F8-9624-FB56788C0EDF', + ], + 'Items' => [ + 'description' => 'The queried events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried event.'."\n", + 'type' => 'object', + 'properties' => [ + 'EventCategory' => [ + 'description' => 'The system event category. Valid values:'."\n" + ."\n" + .'* Exception'."\n" + .'* Optimize'."\n" + .'* Notification'."\n" + .'* Maintenance'."\n", + 'type' => 'string', + 'example' => 'Exception', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA0F6761-7A8C-59F8-9624-FB56788C0EDF\\",\\n \\"Items\\": [\\n {\\n \\"EventCategory\\": \\"Exception\\",\\n \\"TotalCount\\": 2\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeHistoryEventsStat', + ], + 'ModifyActiveOperationMaintainConf' => [ + 'summary' => 'Changes the time configuration of O\\\\\\&M events.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'CycleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the O\\&M cycle. Set the value to Week.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Week', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The days on which you want to execute O\\&M events. Valid values: 1 to 7.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3,4,5,6,7', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the maintenance window.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '02:00:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the maintenance window.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '02:00:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable O\\&M events.'."\n" + ."\n" + .'* 1: yes.'."\n" + .'* 0: no.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '0A156332-D2AC-5C98-8872-9779EA1CC022', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A156332-D2AC-5C98-8872-9779EA1CC022\\"\\n}","type":"json"}]', + 'title' => 'ModifyActiveOperationMaintainConf', + ], + 'DescribeActiveOperationTasks' => [ + 'summary' => 'Queries the information about O\\&M tasks.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region information.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the O\\&M tasks that you want to query. Set the value to all to query all O\\&M tasks configured by the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 25.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '25', + ], + ], + [ + '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' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ads', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'analyticdb', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the O\\&M task. Valid values:'."\n" + ."\n" + .'* \\-1: all statuses.'."\n" + .'* 3: pending.'."\n" + .'* 4: executing.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'InsName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-2ze307ym37t762hnl', + ], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the execution time of the O\\&M task can be changed. Valid values:'."\n" + ."\n" + .'* \\-1: yes for all O\\&M tasks.'."\n" + .'* 0: no.'."\n" + .'* 1: yes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the O\\&M task can be canceled. Valid values:'."\n" + ."\n" + .'* \\-1: yes for all O\\&M tasks.'."\n" + .'* 0: no.'."\n" + .'* 1: yes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The trigger level of the O\\&M task. Default value: all. Valid values:'."\n" + ."\n" + .'* all: all task levels.'."\n" + .'* S0: exception fixing.'."\n" + .'* S1: system O\\&M.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + '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', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalRecordCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Items' => [ + 'description' => 'The queried O\\&M tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried O\\&M task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the O\\&M task. Valid values:'."\n" + ."\n" + .'* 3: pending.'."\n" + .'* 4: executing.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ChangeLevelEn' => [ + 'description' => 'The trigger level of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => 'Risk repairment', + ], + 'TaskType' => [ + 'description' => 'The type of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'InsName' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'am-2ze307ym37t762hnl', + ], + 'Region' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ImpactZh' => [ + 'description' => 'The impact of the O\\&M task in Chinese.'."\n", + 'type' => 'string', + 'example' => 'Service interruption and minor version update', + ], + 'CreatedTime' => [ + 'description' => 'The time when the O\\&M task was created.'."\n", + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'SwitchTime' => [ + 'description' => 'The time when the switchover was performed.'."\n", + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'ChangeLevelZh' => [ + 'description' => 'The trigger level of the O\\&M task in Chinese.'."\n", + 'type' => 'string', + 'example' => 'System maintenance', + ], + 'Deadline' => [ + 'description' => 'The end time of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'PrepareInterval' => [ + 'description' => 'The preparation time period for the O\\&M task.'."\n", + 'type' => 'string', + 'example' => '03:00:00', + ], + 'Impact' => [ + 'description' => 'The impact of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => 'TransientDisconnectionAndMinorVersionUpgrade', + ], + 'TaskTypeZh' => [ + 'description' => 'The type of the O\\&M task in Chinese.'."\n", + 'type' => 'string', + 'example' => 'Minor version update', + ], + 'CurrentAVZ' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-beijing-k', + ], + 'AllowChange' => [ + 'description' => 'Indicates whether the execution time of the O\\&M task can be changed. Valid values:'."\n" + ."\n" + .'* 0: no.'."\n" + .'* 1: yes.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'DbVersion' => [ + 'description' => 'The database version.'."\n", + 'type' => 'string', + 'example' => '3.0', + ], + 'ImpactEn' => [ + 'description' => 'The impact of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => 'Transient instance disconnection, minor version upgrade', + ], + 'InsComment' => [ + 'description' => 'The description of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'StartTime' => [ + 'description' => 'The start time of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'ModifiedTime' => [ + 'description' => 'The time when the O\\&M task was modified.'."\n", + 'type' => 'string', + 'example' => '2021-06-15T16:00:00Z', + ], + 'AllowCancel' => [ + 'description' => 'Indicates whether the O\\&M task can be canceled. Valid values:'."\n" + ."\n" + .'* 0: no.'."\n" + .'* 1: yes.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'DbType' => [ + 'description' => 'The database type.'."\n", + 'type' => 'string', + 'example' => 'analyticdb', + ], + 'ChangeLevel' => [ + 'description' => 'The trigger level of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => 'all', + ], + 'TaskTypeEn' => [ + 'description' => 'The type of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => 'Minor version update', + ], + 'ResultInfo' => [ + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'Id' => [ + 'description' => 'The O\\&M task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2389899', + ], + 'SubInsNames' => [ + 'description' => 'The child instance IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The child instance ID.'."\n", + 'type' => 'string', + 'example' => 'am-xxxxxx', + ], + ], + 'TaskParams' => [ + 'description' => 'The parameters of the O\\&M task.'."\n", + 'type' => 'string', + 'example' => '{\\"outer_user_params\\":{\\"TargetMinorVersion\\":\\"3.2.2.6\\",\\"detailCode\\":\\"OldKernelVersionUpgrade\\",\\"cancelCode\\":\\"OutOfNewFeatureAndStability\\"},\\"params\\":{},\\"internal_params\\":{\\"instanceInfo\\":[],\\"destHostInfo\\":[]}}', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"421794A3-72A5-5D27-9E8B-A75A4C503E17\\",\\n \\"PageNumber\\": 12,\\n \\"PageSize\\": 10,\\n \\"TotalRecordCount\\": 20,\\n \\"Items\\": [\\n {\\n \\"Status\\": 3,\\n \\"ChangeLevelEn\\": \\"Risk repairment\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"InsName\\": \\"am-2ze307ym37t762hnl\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ImpactZh\\": \\"实例闪断,小版本号更新\\",\\n \\"CreatedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"SwitchTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"ChangeLevelZh\\": \\"系统维护\\",\\n \\"Deadline\\": \\"2021-06-15T16:00:00Z\\",\\n \\"PrepareInterval\\": \\"03:00:00\\",\\n \\"Impact\\": \\"TransientDisconnectionAndMinorVersionUpgrade\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\",\\n \\"CurrentAVZ\\": \\"cn-beijing-k\\",\\n \\"AllowChange\\": \\"0\\",\\n \\"DbVersion\\": \\"3.0\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection, minor version upgrade\\",\\n \\"InsComment\\": \\"xxx\\",\\n \\"StartTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"ModifiedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"AllowCancel\\": \\"1\\",\\n \\"DbType\\": \\"analyticdb\\",\\n \\"ChangeLevel\\": \\"all\\",\\n \\"TaskTypeEn\\": \\"Minor version update\\",\\n \\"ResultInfo\\": \\"xxx\\",\\n \\"Id\\": 2389899,\\n \\"SubInsNames\\": [\\n \\"am-xxxxxx\\"\\n ],\\n \\"TaskParams\\": \\"{\\\\\\\\\\\\\\"outer_user_params\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"TargetMinorVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"3.2.2.6\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"detailCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"OldKernelVersionUpgrade\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cancelCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"OutOfNewFeatureAndStability\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"params\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"internal_params\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"instanceInfo\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"destHostInfo\\\\\\\\\\\\\\":[]}}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeActiveOperationTasks', + ], + 'DescribeActiveOperationMaintainConf' => [ + 'summary' => 'Queries the configuration information about O\\\\\\&M tasks.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '149987', + 'abilityTreeNodes' => [ + 'FEATUREads12ZDDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzuemxkbvwqq', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-xxxxxxxx', + ], + ], + ], + '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' => '92B3D2F0-B5E3-5592-9A6F-D0A6C34ACBA9', + ], + 'HasConfig' => [ + 'description' => 'Indicates whether the O\\&M task is configured. Valid values:'."\n" + ."\n" + .'* 1: yes.'."\n" + .'* 0: no.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Config' => [ + 'description' => 'The queried configuration information.'."\n", + 'type' => 'object', + 'properties' => [ + 'CycleType' => [ + 'description' => 'The unit of the O\\&M task cycle. Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Week'."\n", + 'type' => 'string', + 'example' => 'Month', + ], + 'Status' => [ + 'description' => 'Indicates whether the configuration takes effect. Valid values:'."\n" + ."\n" + .'* 1: yes.'."\n" + .'* 2: no.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ModifiedTime' => [ + 'description' => 'The time when the O\\&M task was modified.'."\n", + 'type' => 'string', + 'example' => '2023-05-12T12:34:40Z', + ], + 'MaintainStartTime' => [ + 'description' => 'The start time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '18:00:00Z', + ], + 'MaintainEndTime' => [ + 'description' => 'The end time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '20:00:00Z'."\n", + ], + 'CycleTime' => [ + 'description' => 'The days on which the O\\&M task is executed every week.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'CreatedTime' => [ + 'description' => 'The time when the O\\&M task was created. The time follows the ISO 8601 standard in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-06-08T02:23:13Z', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"92B3D2F0-B5E3-5592-9A6F-D0A6C34ACBA9\\",\\n \\"HasConfig\\": 1,\\n \\"Config\\": {\\n \\"CycleType\\": \\"Month\\",\\n \\"Status\\": 2,\\n \\"ModifiedTime\\": \\"2023-05-12T12:34:40Z\\",\\n \\"MaintainStartTime\\": \\"18:00:00Z\\",\\n \\"MaintainEndTime\\": \\"20:00:00Z\\\\n\\",\\n \\"CycleTime\\": \\"0\\",\\n \\"CreatedTime\\": \\"2023-06-08T02:23:13Z\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeActiveOperationMaintainConf', + ], + 'ModifyActiveOperationTasks' => [ + 'summary' => 'Changes the execution time of O\\&M events.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The ID of the O\\&M event.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1482487', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time from which you want to execute the O\\&M event.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-08-15T12:00:00Z', + ], + ], + [ + 'name' => 'ImmediateStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to immediately execute the O\\&M event. Valid values:'."\n" + ."\n" + .'* 1: immediately executes the O\\&M event.'."\n" + .'* 0: executes the O\\&M event at a specific point in time.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => 'The O\\&M event IDs that are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8B709A33-5E8D-511F-A225-AFC0B6AAAD76', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"1\\",\\n \\"RequestId\\": \\"8B709A33-5E8D-511F-A225-AFC0B6AAAD76\\"\\n}","type":"json"}]', + 'title' => 'ModifyActiveOperationTasks', + ], + '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' => '191870', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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, + '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-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-05-03T15: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" + ."\n" + .'> The end time must be later than the start time.'."\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' => '8', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D9856CFD-10DC-50AF-AE29-07C30FC57B86', + ], + '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' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"8\\",\\n \\"RequestId\\": \\"D9856CFD-10DC-50AF-AE29-07C30FC57B86\\",\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Message\\": \\"检测到接入节点存在CPU增高。\\",\\n \\"Name\\": \\"CPU增高检测\\",\\n \\"Status\\": \\"NORMAL\\\\nWARNING\\\\nCRITICAL\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeControllerDetection', + ], + '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' => '190701', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse 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' => 'am-xxxxx', + ], + ], + [ + '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" + ."\n" + .'> You can query data only within the last 15 days.'."\n", + 'type' => 'string', + 'required' => false, + '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' => false, + 'docRequired' => true, + 'example' => '2024-04-25T02:04Z', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: 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' => '144', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '37A6F56E-B970-50AF-AF33-C71E57AB2C8E', + ], + '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' => [ + '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' => [ + 'description' => 'The detection result items of the skewed table.'."\n", + 'type' => 'object', + 'properties' => [ + 'SchemaName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'kp_ods', + ], + 'TableName' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'train_data_test', + ], + 'DDL' => [ + 'description' => 'The SQL statement that is used to create the table.'."\n", + 'type' => 'string', + 'example' => 'create table(id varchar)', + ], + 'PartitionCount' => [ + 'description' => 'The number of partitions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TotalDataSize' => [ + 'description' => 'The total data size of the table. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'TotalRowCount' => [ + 'description' => 'The total number of rows in the table.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2335', + ], + 'TotalPkSize' => [ + 'description' => 'The data size of the primary key. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TotalRemoteDataSize' => [ + 'description' => 'The size of cold data. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23456', + ], + 'TotalLocalDataSize' => [ + 'description' => 'The size of hot data. Unit: bytes.', + 'type' => 'string', + 'example' => '211', + ], + 'ShardSkewedRows' => [ + 'description' => 'The number of skewed rows in the table.'."\n", + 'type' => 'string', + 'example' => '345', + ], + ], + ], + ], + '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' => 'kp_ods', + ], + 'TableName' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'lake_count', + ], + 'DDL' => [ + 'description' => 'The SQL statement that is used to create the table.'."\n", + 'type' => 'string', + 'example' => 'create table user(id varchar)', + ], + 'PartitionCount' => [ + 'description' => 'The number of partitions.'."\n", + 'type' => 'string', + 'example' => '4', + ], + 'PartitionIds' => [ + 'description' => 'The ID of the improper partition.'."\n", + 'type' => 'string', + 'example' => '[2025,2026]', + ], + 'TotalDataSize' => [ + 'description' => '1234', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[2024,2025]', + ], + ], + ], + ], + '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' => 'Table accesses', + ], + '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' => 'adb_lake_logs_pgsql', + ], + 'MaxScanCost' => [ + 'description' => 'The maximum amount of time for scanning. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + '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' => '234', + ], + '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' => '345', + ], + ], + ], + ], + ], + ], + ], + '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' => 'Peak memory', + ], + 'SearchResults' => [ + 'description' => 'The detection result items of abnormal operators.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => 'The query ID that can be used for diagnostics.'."\n", + 'type' => 'string', + 'example' => '2024072416154919216812815303453136244', + ], + 'StageId' => [ + 'description' => 'The stage ID.'."\n", + 'type' => 'string', + 'example' => 'Stage[7]', + ], + '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' => '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' => '235', + ], + 'InputRows' => [ + 'description' => 'The number of rows input by the operator.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'OutputRows' => [ + 'description' => 'The number of rows output by the operator.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '345', + ], + 'InputSize' => [ + 'description' => 'The amount of data input by the operator. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'OutputSize' => [ + 'description' => 'The amount of data output by the operator. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '323', + ], + 'OperatorInfo' => [ + 'description' => 'The property information about the operator.'."\n", + 'type' => 'string', + 'example' => 'Aggregate function: count', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'OperatorAgg' => [ + 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detection result items of operator metric aggregation.'."\n", + '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' => [ + 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'type' => 'object', + 'properties' => [ + 'OperatorName' => [ + 'description' => 'The name of the operator.'."\n", + 'type' => 'string', + 'example' => 'StageOutput', + ], + 'MaxValue' => [ + 'description' => 'The maximum value of the operator metric.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'TotalValue' => [ + 'description' => 'The cumulative value of the operator metric.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3333', + ], + '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' => '345', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => 'The information about the detection result.'."\n", + 'type' => 'string', + 'example' => 'Multiple abnormal operators 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', + ], + ], + ], + ], + ], + '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\\": \\"144\\",\\n \\"RequestId\\": \\"37A6F56E-B970-50AF-AF33-C71E57AB2C8E\\",\\n \\"DBClusterId\\": \\"amv-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"指标检测\\",\\n \\"Results\\": {\\n \\"SkewedTables\\": [\\n {\\n \\"SchemaName\\": \\"kp_ods\\",\\n \\"TableName\\": \\"train_data_test\\",\\n \\"DDL\\": \\"create table(id varchar)\\",\\n \\"PartitionCount\\": 3,\\n \\"TotalDataSize\\": 2345,\\n \\"TotalRowCount\\": 2335,\\n \\"TotalPkSize\\": 1234,\\n \\"TotalRemoteDataSize\\": 23456,\\n \\"TotalLocalDataSize\\": \\"211\\",\\n \\"ShardSkewedRows\\": \\"345\\"\\n }\\n ],\\n \\"PartitionedTables\\": [\\n {\\n \\"SchemaName\\": \\"kp_ods\\",\\n \\"TableName\\": \\"lake_count\\",\\n \\"DDL\\": \\"create table user(id varchar)\\",\\n \\"PartitionCount\\": \\"4\\",\\n \\"PartitionIds\\": \\"[2025,2026]\\",\\n \\"TotalDataSize\\": 0\\n }\\n ],\\n \\"TopAccessTables\\": [\\n {\\n \\"MetricName\\": \\"表访问次数\\",\\n \\"SearchResults\\": [\\n {\\n \\"TableName\\": \\"adb_lake_logs_pgsql\\",\\n \\"MaxScanCost\\": 2345,\\n \\"AvgScanCost\\": 234,\\n \\"MaxScanSize\\": 234,\\n \\"AvgScanSize\\": 234,\\n \\"AccessCount\\": 345\\n }\\n ]\\n }\\n ],\\n \\"OperatorDetails\\": [\\n {\\n \\"MetricName\\": \\"峰值内存\\",\\n \\"SearchResults\\": [\\n {\\n \\"ProcessId\\": \\"2024072416154919216812815303453136244\\",\\n \\"StageId\\": \\"Stage[7]\\",\\n \\"OperatorName\\": \\"TableScan\\",\\n \\"PeakMemory\\": 234,\\n \\"OperatorCost\\": 235,\\n \\"InputRows\\": 235,\\n \\"OutputRows\\": 345,\\n \\"InputSize\\": 2345,\\n \\"OutputSize\\": 323,\\n \\"OperatorInfo\\": \\"聚合函数：count\\"\\n }\\n ]\\n }\\n ],\\n \\"OperatorAgg\\": [\\n {\\n \\"MetricName\\": \\"OperatorCost\\",\\n \\"SearchResults\\": [\\n {\\n \\"OperatorName\\": \\"StageOutput\\",\\n \\"MaxValue\\": 3,\\n \\"TotalValue\\": 3333,\\n \\"AvgValue\\": 234,\\n \\"OperatorCount\\": 345\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"检测到存在多个指标异常算子\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeWorkerDetection', + ], + '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' => '191995', + '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-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-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' => false, + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-05-18T06:30Z', + ], + ], + [ + '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' => '300', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '36B66482-A215-5F04-A42E-859983D89D7B', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-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.'."\n", + 'type' => 'string', + 'example' => 'Cost，PeakMemory', + ], + 'Results' => [ + 'description' => 'The detection result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detection result items.'."\n", + 'type' => 'object', + 'properties' => [ + 'PatternId' => [ + 'description' => 'The SQL pattern ID.'."\n", + 'type' => 'string', + 'example' => '5495577090378760322', + ], + 'SQLPattern' => [ + 'description' => 'The SQL statement that represents the SQL pattern.'."\n", + 'type' => 'string', + 'example' => 'SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?', + ], + 'Detail' => [ + 'description' => 'The details about the detection report of the SQL pattern.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + '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.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'AccessIp' => [ + 'description' => 'The IP address of the SQL client that submits the SQL pattern.'."\n", + 'type' => 'string', + 'example' => '11.81.238.102', + ], + 'Tables' => [ + 'description' => 'The names of tables.'."\n", + 'type' => 'string', + 'example' => 'ad_marketing_engine.prod_dws_oe_promotion_daily_trend_report', + ], + 'QueryCount' => [ + 'description' => 'The number of executed SQL patterns within the time range.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72', + ], + 'FailedCount' => [ + 'description' => 'The number of failed SQL patterns within the time range.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '63', + ], + ], + ], + ], + 'Status' => [ + 'description' => 'The severity level of the detection result. Valid values:'."\n" + ."\n" + .'* NORMAL'."\n" + .'* WARNING'."\n" + .'* CRITICAL'."\n", + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNNING'."\n" + .'CRITICAL', + ], + 'Message' => [ + 'description' => 'The description of the detection result.'."\n", + '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.', + ], + ], + ], + ], + ], + '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\\": \\"300\\",\\n \\"RequestId\\": \\"36B66482-A215-5F04-A42E-859983D89D7B\\",\\n \\"DBClusterId\\": \\"am-xxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"Cost，PeakMemory\\",\\n \\"Results\\": [\\n {\\n \\"PatternId\\": \\"5495577090378760322\\",\\n \\"SQLPattern\\": \\"SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?\\",\\n \\"Detail\\": \\"{}\\",\\n \\"RelatedMetrics\\": \\"最大查询耗时:1.43s\\\\n最大峰值内存:20.73MB\\\\n最大表读取数据量:10.12MB\\",\\n \\"User\\": \\"test\\",\\n \\"AccessIp\\": \\"11.81.238.102\\",\\n \\"Tables\\": \\"ad_marketing_engine.prod_dws_oe_promotion_daily_trend_report\\",\\n \\"QueryCount\\": 72,\\n \\"FailedCount\\": 63\\n }\\n ],\\n \\"Status\\": \\"NORMAL\\\\nWARNNING\\\\nCRITICAL\\",\\n \\"Message\\": \\"检测到2个totalTime指标异常Pattern，可能导致CPU使用率增高，或者查询变慢，影响系统稳定性，请到监控页面使用一键诊断查看详情，并进行优化\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeAbnormalPatternDetection', + ], + 'DescribeBadSqlDetection' => [ + 'summary' => 'Queries the bad SQL statements that affect cluster stability within a time range.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190267', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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-xxx', + ], + ], + [ + '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' => 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' => '2021-05-18T06:00:00Z', + ], + ], + [ + '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 *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-09-30T00:15Z', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '32C6E870-81E5-5E2A-BE7D-F9623F090DAB', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-xxx', + ], + 'DetectionItems' => [ + 'description' => 'The queried detection items and detection results.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the detection item.'."\n", + 'type' => 'string', + 'example' => 'PeakMemory'."\n" + .'OperatorCost'."\n" + .'ScanSize', + ], + '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' => '37', + ], + 'PeakMemory' => [ + 'description' => 'The peak memory.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + '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' => '12345', + ], + 'ScanSize' => [ + 'description' => 'The amount of scanned data. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'OutputDataSize' => [ + 'description' => 'The amount of returned data. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProcessId' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'example' => '2023120808405202104101604703151654257', + ], + 'TotalStages' => [ + 'description' => 'The total number of stages generated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'DiagnosisResults' => [ + 'description' => 'The diagnostic result items.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The diagnostic code.'."\n", + 'type' => 'string', + 'example' => 'FILTER_NOT_PUSHDOWN', + ], + 'Detail' => [ + 'description' => 'The information about the diagnostic result.', + 'type' => 'string', + 'example' => 'The query consumes a large amount of memory resources. Perform memory optimization on the query.', + ], + 'StageId' => [ + 'description' => 'The stage ID.'."\n", + 'type' => 'string', + 'example' => 'Stage[1]', + ], + 'OperatorId' => [ + 'description' => 'The operator ID.'."\n", + 'type' => 'string', + 'example' => 'Join[234]', + ], + ], + 'description' => 'The diagnostic result item.', + ], + ], + '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 user', + ], + 'PatternId' => [ + 'description' => 'The SQL pattern ID.'."\n", + 'type' => 'string', + 'example' => '-5978869478527645300', + ], + '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-05-05T02:13Z', + ], + ], + ], + ], + 'Status' => [ + 'description' => 'The severity level of the detection result. Valid values:'."\n", + 'type' => 'string', + 'example' => 'NORMAL'."\n" + .'WARNNING'."\n" + .'CRITICAL', + ], + 'Message' => [ + 'description' => 'The information about the diagnostic result.', + 'type' => 'string', + 'example' => 'Multiple bad SQL statements are detected. Perform optimization on the statements.', + ], + ], + 'description' => 'The queried detection item and detection result.'."\n", + ], + ], + '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\\": \\"5\\",\\n \\"RequestId\\": \\"32C6E870-81E5-5E2A-BE7D-F9623F090DAB\\",\\n \\"DBClusterId\\": \\"am-xxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"PeakMemory\\\\nOperatorCost\\\\nScanSize\\",\\n \\"Results\\": [\\n {\\n \\"Cost\\": 37,\\n \\"PeakMemory\\": 1234,\\n \\"OperatorCost\\": 12345,\\n \\"ScanSize\\": 1234,\\n \\"OutputDataSize\\": 1234,\\n \\"ProcessId\\": \\"2023120808405202104101604703151654257\\",\\n \\"TotalStages\\": 123,\\n \\"DiagnosisResults\\": [\\n {\\n \\"Code\\": \\"FILTER_NOT_PUSHDOWN\\",\\n \\"Detail\\": \\"查询消耗了较多的内存资源，请进行查询内存调优\\",\\n \\"StageId\\": \\"Stage[1]\\",\\n \\"OperatorId\\": \\"Join[234]\\"\\n }\\n ],\\n \\"SQL\\": \\"select * from user\\",\\n \\"PatternId\\": \\"-5978869478527645300\\",\\n \\"StartTime\\": \\"2024-05-05T02:13Z\\"\\n }\\n ],\\n \\"Status\\": \\"NORMAL\\\\nWARNNING\\\\nCRITICAL\\",\\n \\"Message\\": \\"检测到多条BadSQL，请进行优化\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1*****************7\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"2***************9\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescribeBadSqlDetection', + ], + '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' => '190614', + '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 information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\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' => 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' => '2024-10-31T02:06Z', + ], + ], + [ + '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" + .'> '."\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' => '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' => '20', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B20BA053-27A1-5FDF-B063-6D6146720DF6', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-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.'."\n", + 'type' => 'string', + 'example' => 'CPU increase 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' => [ + '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' => '202405061006230110150170540315119xxxx', + ], + 'StageId' => [ + 'description' => 'The stage ID.'."\n", + 'type' => 'string', + 'example' => 'Stage[7]', + ], + 'OperatorName' => [ + 'description' => 'The name of the operator.'."\n", + 'type' => 'string', + 'example' => 'TableScan', + ], + 'PeakMemory' => [ + 'description' => 'The peak memory of the operator.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2334', + ], + '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' => '2354', + ], + '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' => '2354', + ], + 'InputSize' => [ + 'description' => 'The amount of data input by the operator. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'OutputSize' => [ + 'description' => 'The amount of data output by the operator. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'OperatorInfo' => [ + 'description' => 'The property information about the operator.'."\n", + 'type' => 'string', + 'example' => 'GROUP BY field: uid', + ], + ], + ], + ], + ], + 'description' => 'The detection result items of abnormal operators.'."\n", + ], + ], + 'OperatorAgg' => [ + 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => 'The name of the detection metric.'."\n", + 'type' => 'string', + 'example' => 'PeakMemory', + ], + 'SearchResults' => [ + 'description' => 'The detection result items of operator metric aggregation.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detection result items of operator metric aggregation.'."\n", + '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' => '2335', + ], + 'TotalValue' => [ + 'description' => 'The cumulative value of the operator metric.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'AvgValue' => [ + 'description' => 'The average value of the operator metric.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '235.5', + ], + 'OperatorCount' => [ + 'description' => 'The number of occurrences of the operator.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => 'The information about the detection result.'."\n", + 'type' => 'string', + 'example' => 'Large amounts of memory resources are used by the Aggregation operator.'."\n", + ], + '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\\": \\"B20BA053-27A1-5FDF-B063-6D6146720DF6\\",\\n \\"DBClusterId\\": \\"am-xxxx\\",\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"CPU增高检测\\",\\n \\"Results\\": {\\n \\"OperatorDetails\\": [\\n {\\n \\"MetricName\\": \\"PeakMemory\\",\\n \\"SearchResults\\": [\\n {\\n \\"ProcessId\\": \\"202405061006230110150170540315119xxxx\\",\\n \\"StageId\\": \\"Stage[7]\\",\\n \\"OperatorName\\": \\"TableScan\\",\\n \\"PeakMemory\\": 2334,\\n \\"OperatorCost\\": 2354,\\n \\"InputRows\\": 123,\\n \\"OutputRows\\": 2354,\\n \\"InputSize\\": 2345,\\n \\"OutputSize\\": 2345,\\n \\"OperatorInfo\\": \\"Group By字段：uid\\"\\n }\\n ]\\n }\\n ],\\n \\"OperatorAgg\\": [\\n {\\n \\"MetricName\\": \\"PeakMemory\\",\\n \\"SearchResults\\": [\\n {\\n \\"OperatorName\\": \\"Aggregation\\",\\n \\"MaxValue\\": 2335,\\n \\"TotalValue\\": 234,\\n \\"AvgValue\\": 235.5,\\n \\"OperatorCount\\": 5\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"检测到Aggregation算子消耗内存资源较多\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeExecutorDetection', + ], + 'ModifyDBClusterVip' => [ + 'summary' => 'Changes the virtual IP address (VIP) that is used to connect to an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREads3N2V5J', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a specific region.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-2ze8mbuai97*****', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual private cloud (VPC) ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-bp1at5ze0t5u3xtqn****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp1aadw9k19x6cis9****', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The internal or public endpoint for which the server certificate needs to be created or updated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'am-2ze8mbuai974s4y2500000169.ads.aliyuncs.com', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + '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' => '1AD222E9-****-4A42-BF6D-8A4442913CEF', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '1564657730', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'adb::2019-03-15::DescribeTaskInfo', + 'callbackInterval' => 60000, + 'maxCallbackTimes' => 10, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-****-4A42-BF6D-8A4442913CEF\\",\\n \\"TaskId\\": \\"1564657730\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBClusterVip', + ], + 'GetCreateTableSQL' => [ + 'summary' => 'Queries the table creation statement for tables.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'Perth', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212741', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '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, + 'docRequired' => true, + 'example' => 'am-uf6wjk5xxxxxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\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' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + ], + 'SQL' => [ + 'description' => 'The SQL statement.'."\n", + 'type' => 'string', + 'example' => 'create table ('."\n" + .' id varchar(32)'."\n" + .');', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The detailed reason why the access was denied.'."\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" + .' }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"SQL\\": \\"create table (\\\\n id varchar(32)\\\\n);\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"1906102576997697\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcNqPqHV6lwR4INiAGjIvK1ngXxN1O+6ORRB6A8YvztEOGywOk81ZmuNk0YrNy+qk7+UVDTHeXKsy8h9e/ePY/LMidj0RCmDpo/YpCumd0UGe0qEPe2U+UJAm/+UHlnEFLVg6BP3yIB5D++MCy7mgWm8Kwyhk62IeYly4hQ+5IpXjkh1GQXuDgLVVPVpxEek9n30vnCUL4KsaMgfa7dgojb+3TM8xGsD2zVK5STJNrsXclscIJEqyNXd7CBYiRJVZi1HPO6drN9WW0chLpCSTgjO8n0bNanZaxXKumW9PSwV58UoSFASeMWfZK3TLngX+oq8nGmnTwcJosVjfF4RGzAnS1IXt0Q9N2WHDnpwyLBU/nOz7Hsy8IZ+h+OVjsBTXSM9688/vOF707a5mNzpETvQeGRcua3A5livcKAM2cML0yeUs/Zyj/+BGqtVa+wektspDHC/CECh6R5lxQjRmUdPawY8VDs2onmdLuEH8DdmYt+Yv/jBFBUMWOyAluzkPYcX5nuQKouCIUJUFTSbsJsuH5CTIh7Ls5rbmkj+T1qTVz8gnDR8LxwaqoMSna+elXgVyOOxXtMkenVntsmoC3p/4G7yTPL1hu8JyWGIIvZHZGGLXGEH7FeSuMV8buKxPGFWG3arG8e9LGvDdz5dgTien4y6G5AQ0o1iQdXDos5VWdH3u7k5PrsvdEOpvMi6uSd8a42na80FsYlgGlwM5upydcWUC5Un2HCkJpT1xgk2L6shdVTrK6bidRrqE784FhW9bBQePzGaxSupPENZya0VUctRt+7uq3QwIn4y5jzjgX0E0jgmqPrgiVDjBesMQZYfGPCGysWYWYzfoh+G6V7N2VVGtNnGUwNWzM0WJBPONAgxPv+AmixFRCQ==\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"SubUser\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"202515810214480629\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"adb:DescribeExcessivePrimaryKeys\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'GetCreateTableSQL', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + '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', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215312', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-ufxxxxxxxxxx3q1x1', + ], + ], + [ + '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' => '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' => '8C1A419E-5A79-51A9-B533-FCCB98AD8FD5', + ], + '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. Unit: %.'."\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', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C1A419E-5A79-51A9-B533-FCCB98AD8FD5\\",\\n \\"Items\\": [\\n {\\n \\"Node\\": \\"Node1\\",\\n \\"DiskUsageRatio\\": \\"90.5\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeInclinedNodes', + 'description' => 'For information about the endpoints of AnalyticDB for MySQL, see [Endpoints](~~612373~~).'."\n", + ], + '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' => '209781', + 'abilityTreeNodes' => [ + 'FEATUREadsDAZVRM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-8vb46cpn2aaxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\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' => '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", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2021-05-03T15:01:00Z', + ], + ], + [ + '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. Pages start from page 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**: 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. Example: `[{"Field":"SchemaName","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" + .' * `IndexSize`: the data size of regular indexes.'."\n" + .' * `PrimaryKeySize`: the data size of the primary key index.'."\n" + .' * `DataSize`: the data size of table records.'."\n" + .' * `LocalDataSize`: the size of hot data.'."\n" + .' * `RemoteDataSize`: the size of cold data.'."\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 total data size of each table in descending order.'."\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' => '21', + ], + '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' => '100', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F67B5AC5-6CDE-5187-9E25-B1EEE9AC4D91', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'am-8vb46cpn2aaxxxxxx', + ], + 'Tables' => [ + 'description' => 'The queried oversized non-partitioned tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried oversized non-partitioned table.'."\n", + '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' => '3294', + ], + 'IndexSize' => [ + 'description' => 'The data size of regular indexes. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1073741824', + ], + 'DataSize' => [ + 'description' => 'The data size of table records. Unit: bytes.'."\n" + ."\n" + .'> The data size of table records does not include the data size of regular and primary key indexes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21474836480', + ], + 'LocalDataSize' => [ + 'description' => 'The size of hot data. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24696061952', + ], + 'PrimaryKeySize' => [ + 'description' => 'The data size of the primary key index. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2147483648', + ], + 'RemoteDataSize' => [ + 'description' => 'The size of cold data. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + '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%.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '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' => '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. 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.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"21\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"RequestId\\": \\"F67B5AC5-6CDE-5187-9E25-B1EEE9AC4D91\\",\\n \\"DBClusterId\\": \\"am-8vb46cpn2aaxxxxxx\\",\\n \\"Tables\\": [\\n {\\n \\"SchemaName\\": \\"adb_demo\\",\\n \\"TableName\\": \\"test\\",\\n \\"RowCount\\": 3294,\\n \\"IndexSize\\": 1073741824,\\n \\"DataSize\\": 21474836480,\\n \\"LocalDataSize\\": 24696061952,\\n \\"PrimaryKeySize\\": 2147483648,\\n \\"RemoteDataSize\\": 0,\\n \\"SpaceRatio\\": 23\\n }\\n ],\\n \\"DetectionItems\\": [\\n {\\n \\"Name\\": \\"非分区表过大检测\\",\\n \\"Message\\": \\"检测到表存在分区不合理的情况\\",\\n \\"Status\\": \\"WARNING\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeOversizeNonPartitionTableInfos', + ], + 'ModifyDBClusterShardNumber' => [ + 'summary' => 'Changes the number of shards for an AnalyticDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237895', + 'abilityTreeNodes' => [ + 'FEATUREadsQEKELU', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.'."\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' => 'amv-bp1xxxxxxxx47', + ], + ], + [ + 'name' => 'NewShardNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The desired number of shards.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '256', + ], + ], + [ + 'name' => 'SwitchTimeMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode in which you want the change operation to be performed. Valid values:'."\n" + ."\n" + .'* **Immediate** (default): immediately performs the change operation.'."\n" + .'* **MaintainTime**: performs the change operation within the maintenance window of the cluster. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window.'."\n" + .'* **ScheduleTime**: performs the change operation at the point in time that you specify. If you specify this value, you must also specify **SwitchTime**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'Immediate', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when you want the system to perform the change operation. 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' => '2021-07-09T22:00:00Z', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run. Valid values:'."\n" + ."\n" + .'* true: sends a request to check whether the cluster meets the prerequisites for changing the number of shards and whether the desired number of shards is valid, but **does not** perform the change operation.'."\n" + .'* false (default): sends a request to perform a check and trigger the change operation.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '25B56BC7-4978-40B3-9E48-4B7067******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25B56BC7-4978-40B3-9E48-4B7067******\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBClusterShardNumber', + ], + 'DeleteBackups' => [ + 'summary' => 'Manually deletes backup sets.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '245779', + 'abilityTreeNodes' => [ + 'FEATUREadsM6VDCK', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the AnalyticDB for MySQL cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'am-bp1ub9grke1****', + ], + ], + [ + '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' => '766,767', + ], + ], + [ + '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' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '771C5FAA-530F-52F7-B84D-EBAD4561D590', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771C5FAA-530F-52F7-B84D-EBAD4561D590\\"\\n}","type":"json"}]', + 'title' => 'DeleteBackups', + '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", + ], + 'DescribeDBClusterShardNumber' => [ + 'summary' => 'Queries the number of shards 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' => '248197', + 'abilityTreeNodes' => [ + 'FEATUREadsULBR2S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + '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' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~129857~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'am-uf6g8w25jacm7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBE843D8-964D-5EA3-9D31-822125611B6E', + ], + 'ShardNumber' => [ + 'description' => 'The number of shards that you want to change during the data migration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128', + ], + 'AvailableShardNumberList' => [ + 'description' => 'The supported numbers of shards, including the number of current shards and the number of desired shards.', + 'type' => 'array', + 'items' => [ + 'description' => 'The supported numbers of shards, including the number of current shards and the number of desired shards.', + 'type' => 'object', + 'properties' => [ + 'ShardNumber' => [ + 'description' => 'The number of shards.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128', + ], + ], + ], + ], + 'AvailableShardNumbers' => [ + 'description' => 'The number of desired shards, excluding the number of current shards.', + 'type' => 'array', + 'items' => [ + 'description' => 'The number of shards.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '['."\n" + .' 128,'."\n" + .' 256,'."\n" + .' 512'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBE843D8-964D-5EA3-9D31-822125611B6E\\",\\n \\"ShardNumber\\": 128,\\n \\"AvailableShardNumberList\\": [\\n {\\n \\"ShardNumber\\": 128\\n }\\n ],\\n \\"AvailableShardNumbers\\": [\\n 0\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDBClusterShardNumber', + ], + ], + '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', + ], + ], +]; |