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/dds | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/dds')
| -rw-r--r-- | data/en_us/dds/2015-12-01/api-docs.php | 34253 |
1 files changed, 34253 insertions, 0 deletions
diff --git a/data/en_us/dds/2015-12-01/api-docs.php b/data/en_us/dds/2015-12-01/api-docs.php new file mode 100644 index 0000000..5f9fc8a --- /dev/null +++ b/data/en_us/dds/2015-12-01/api-docs.php @@ -0,0 +1,34253 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dds', + 'version' => '2015-12-01', + ], + 'directories' => [ + [ + 'children' => [ + 'CreateDBInstance', + 'CreateShardingDBInstance', + ], + 'type' => 'directory', + 'title' => 'Create or clone an instance', + ], + [ + 'children' => [ + 'CreateNode', + 'CreateNodeBatch', + 'DeleteNode', + 'ModifyDBInstanceSpec', + 'ModifyNodeSpec', + 'ModifyNodeSpecBatch', + 'ModifyDBInstanceDiskType', + ], + 'type' => 'directory', + 'title' => 'Modify instance configuration', + ], + [ + 'children' => [ + 'DeleteDBInstance', + 'ModifyDBInstanceMaintainTime', + 'ModifyDBInstanceDescription', + 'ModifyDBInstanceNetExpireTime', + 'UpgradeDBInstanceEngineVersion', + 'UpgradeDBInstanceKernelVersion', + 'SwitchDBInstanceHA', + 'RestartDBInstance', + 'DestroyInstance', + 'RestartNode', + ], + 'type' => 'directory', + 'title' => 'Instance Management', + ], + [ + 'children' => [ + 'ModifyInstanceAutoRenewalAttribute', + 'TransformInstanceChargeType', + 'DescribePrice', + 'DescribeRenewalPrice', + 'TransformToPrePaid', + 'RenewDBInstance', + ], + 'type' => 'directory', + 'title' => 'Renewal management', + ], + [ + 'children' => [ + 'DescribeDBInstanceSpecInfo', + 'DescribeReplicaSetRole', + 'DescribeKernelReleaseNotes', + 'DescribeAvailableEngineVersion', + 'DescribeDBInstances', + 'DescribeDBInstanceSwitchLog', + 'DescribeDBInstanceAttribute', + 'DescribeRoleZoneInfo', + 'DescribeInstanceAutoRenewalAttribute', + 'DescribeActiveOperationTaskCount', + 'DescribeActiveOperationTasks', + 'DescribeActiveOperationTaskType', + 'DescribeDBInstancesOverview', + 'DescribeHistoryTasks', + 'DescribeHistoryTasksStat', + 'ModifyTaskInfo', + 'ModifyActiveOperationTasks', + ], + 'type' => 'directory', + 'title' => 'Query instances', + ], + [ + 'children' => [ + 'DescribeAvailableResource', + 'EvaluateResource', + 'DescribeAvailabilityZones', + 'ModifyResourceGroup', + ], + 'type' => 'directory', + 'title' => 'Resource Management', + ], + [ + 'children' => [ + 'DescribeRegions', + 'MigrateToOtherZone', + 'MigrateAvailableZone', + ], + 'type' => 'directory', + 'title' => 'Region management', + ], + [ + 'children' => [ + 'ModifyInstanceVpcAuthMode', + 'ModifyDBInstanceNetworkType', + 'ModifyDBInstanceConnectionString', + 'DescribeShardingNetworkAddress', + 'AllocatePublicNetworkAddress', + 'ReleasePublicNetworkAddress', + 'AllocateNodePrivateNetworkAddress', + 'ReleaseNodePrivateNetworkAddress', + ], + 'type' => 'directory', + 'title' => 'Connection management', + ], + [ + 'children' => [ + 'ListTagResources', + 'DescribeTags', + 'TagResources', + 'UntagResources', + ], + 'type' => 'directory', + 'title' => 'Tag management', + ], + [ + 'children' => [ + 'CreateAccount', + 'ResetAccountPassword', + 'ModifyAccountDescription', + 'DescribeAccounts', + ], + 'type' => 'directory', + 'title' => 'Account Management', + ], + [ + 'children' => [ + 'ModifySecurityIps', + 'ModifySecurityGroupConfiguration', + 'DescribeSecurityIps', + 'DescribeSecurityGroupConfiguration', + 'ModifyGlobalSecurityIPGroup', + 'DescribeGlobalSecurityIPGroup', + 'ModifyGlobalSecurityIPGroupName', + 'DescribeGlobalSecurityIPGroupRelation', + 'CreateGlobalSecurityIPGroup', + 'ModifyGlobalSecurityIPGroupRelation', + 'DeleteGlobalSecurityIPGroup', + ], + 'type' => 'directory', + 'title' => 'Whitelists and security groups', + ], + [ + 'children' => [ + 'ModifyDBInstanceTDE', + 'CheckCloudResourceAuthorized', + 'DescribeUserEncryptionKeyList', + 'DescribeDBInstanceEncryptionKey', + 'DescribeDBInstanceTDEInfo', + 'DescribeKmsKeys', + ], + 'type' => 'directory', + 'title' => 'Keys', + ], + [ + 'children' => [ + 'ModifyDBInstanceSSL', + 'DescribeDBInstanceSSL', + ], + 'type' => 'directory', + 'title' => 'SSL encryption', + ], + [ + 'children' => [ + 'ModifyAuditLogFilter', + 'ModifyAuditPolicy', + 'DescribeAuditRecords', + 'DescribeAuditPolicy', + 'DescribeAuditLogFilter', + 'DescribeMongoDBLogConfig', + ], + 'type' => 'directory', + 'title' => 'Audit logs', + ], + [ + 'children' => [ + 'DescribeSlowLogRecords', + 'DescribeErrorLogRecords', + 'DescribeRunningLogRecords', + ], + 'type' => 'directory', + 'title' => 'Log Management', + ], + [ + 'children' => [ + 'ModifyDBInstanceMonitor', + 'DescribeDBInstancePerformance', + 'DescribeDBInstanceMonitor', + ], + 'type' => 'directory', + 'title' => 'Performance monitoring', + ], + [ + 'children' => [ + 'ModifyParameters', + 'DescribeParameterModificationHistory', + 'DescribeParameterTemplates', + 'DescribeParameters', + ], + 'type' => 'directory', + 'title' => 'Parameter Management', + ], + [ + 'children' => [ + 'CreateBackup', + 'ModifyBackupPolicy', + 'DescribeBackupPolicy', + 'DescribeBackups', + 'DescribeBackupDBs', + 'DescribeRestoreDBInstanceList', + 'CheckRecoveryCondition', + 'TransferClusterBackup', + 'DescribeClusterBackups', + 'DescribeClusterRecoverTime', + 'DescribeBackupStorage', + 'DescribeBackupTasks', + 'DescribeInstanceRecoverTime', + ], + 'type' => 'directory', + 'title' => 'Backup and recovery', + ], + [ + 'children' => [ + 'DescribeActiveOperationTask', + 'AllocateDBInstanceSrvNetworkAddress', + 'CancelActiveOperationTasks', + 'DescribeActiveOperationTaskRegion', + 'DescribeActiveOperationMaintenanceConfig', + 'CheckServiceLinkedRole', + 'ModifyDBInstanceConfig', + 'CreateNodeRoleTag', + 'ModifyDBInstanceAttribute', + 'ModifySrvNetworkAddress', + 'DescribeRdsVSwitchs', + 'DescribeRdsVpcs', + 'DescribeRoleTagStatus', + 'DescribeVpcsForMongoDB', + ], + 'type' => 'directory', + 'title' => 'Additional Information', + ], + [ + 'children' => [ + 'DeleteBackup', + 'ModifyActiveOperationMaintenanceConfig', + 'ModifyBackupExpireTime', + ], + 'title' => 'Others', + 'type' => 'directory', + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AllocateDBInstanceSrvNetworkAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '230916', + 'abilityTreeNodes' => [ + 'FEATUREmongodbORMA6Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze5eb9514e31364', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a mongos or shard node in a sharded cluster instance.'."\n" + ."\n" + .'> This parameter is not currently required.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp1b7bb3bbe****', + 'title' => '', + ], + ], + [ + 'name' => 'SrvConnectionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of SRV connection string to enable.'."\n" + ."\n" + .'- `vpc`: SRV connection string for the VPC.'."\n" + ."\n" + .'- `public`: Public SRV connection string.'."\n" + ."\n" + .'> The default is the VPC connection string.', + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'vpc', + 'public', + ], + 'example' => 'vpc', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '6B82A9EF-9961-5A31-A19F-009B7098ACCA', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Forbid', + 'errorMessage' => 'Specified account name is a keyword.', + 'description' => 'The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'AllocateDBInstanceSrvNetworkAddress', + 'summary' => 'Applies for an SRV connection string for an ApsaraDB for MongoDB instance.', + 'description' => 'Applicable only to cloud disk-based replica set and sharded cluster instances.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:AllocateDBInstanceSrvNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6B82A9EF-9961-5A31-A19F-009B7098ACCA\\"\\n}","type":"json"}]', + ], + 'AllocateNodePrivateNetworkAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8235', + 'abilityTreeNodes' => [ + 'FEATUREmongodb2UY0EW', + ], + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone to which the instance belongs.'."\n" + ."\n" + .'> You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the zone ID of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sharded cluster instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1fa5efaa93****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard or Configserver node.'."\n" + ."\n" + .'> You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the ID of the shard or Configserver node.', + 'type' => 'string', + 'required' => true, + 'example' => 'd-bp124beeb0ac****', + 'title' => '', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- The username must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (\\_). The username must start with a lowercase letter.'."\n" + ."\n" + .'- You must configure the account and password only when you apply for the endpoint of a shard or Configserver node for the first time. The account and password are required for all shard and Configserver nodes.'."\n" + ."\n" + .'- The permissions of this account are fixed to read-only.', + 'type' => 'string', + 'required' => false, + 'example' => 'shardcsaccount', + 'title' => '', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password for the account.'."\n" + ."\n" + .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `! # $ % ^ & * ( ) _ + - =`'."\n" + ."\n" + .'- The password must be 8 to 32 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'Test123456', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '60EEBD77-227C-5B39-86EA-D89163C5****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Forbid', + 'errorMessage' => 'Specified account name is a keyword.', + 'description' => 'The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.', + ], + ], + ], + 'title' => 'AllocateNodePrivateNetworkAddress', + 'summary' => 'Applies for an internal endpoint for a shard or Configserver node in an ApsaraDB for MongoDB sharded cluster instance.', + 'description' => 'This operation is applicable only to sharded cluster instances. For more information, see [Apply for an endpoint for a shard or Configserver node](~~134037~~).'."\n" + ."\n" + .'> The allocated endpoints can be used only for internal access. To gain Internet access, you must call the [AllocatePublicNetworkAddress](~~67602~~) operation to apply for public endpoints.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:AllocateNodePrivateNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60EEBD77-227C-5B39-86EA-D89163C5****\\"\\n}","type":"json"}]', + ], + 'AllocatePublicNetworkAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8236', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAOTVP9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance'."\n" + ."\n" + .'> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp11483712c1****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the mongos, shard, or Configserver node in the sharded cluster instance. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the ID of the mongos, shard, or Configserver node.'."\n" + ."\n" + .'> This parameter is required only when you specify the **DBInstanceId** parameter to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 's-bp18e6d84ae3****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '8AA45036-497F-52E7-B951-F9C7B239****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'AllocatePublicNetworkAddress', + 'summary' => 'Allocates a public endpoint to an instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:AllocatePublicNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8AA45036-497F-52E7-B951-F9C7B239****\\"\\n}","type":"json"}]', + ], + 'CancelActiveOperationTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '37477', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWP8F69', + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the O\\&M events to cancel. Separate multiple IDs with commas (,).', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1508850,1508310,1507849,1506274,1505811'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-xxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => 'The IDs of the canceled O\\&M events. Multiple IDs are separated by commas (,).', + 'type' => 'string', + 'example' => '1508850,1508310,1507849,1506274,1505811', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '55A2504F-xxxx-xxxx-xxxx-C7C5E57350A6', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'CancelActiveOperationTasks', + 'summary' => 'Cancels Operations and Maintenance (O&M) events in a batch.', + 'description' => 'An O\\&M event cannot be canceled in the following scenarios:'."\n" + ."\n" + .'- The event is not cancelable if the value of the AllowCancel parameter is 0.'."\n" + ."\n" + .'- The scheduled start time of the O\\&M event has passed.'."\n" + ."\n" + .'- The status of the O\\&M event is not Pending if the value of the Status parameter is not 3.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"1508850,1508310,1507849,1506274,1505811\\",\\n \\"RequestId\\": \\"55A2504F-xxxx-xxxx-xxxx-C7C5E57350A6\\"\\n}","type":"json"}]', + ], + 'CheckCloudResourceAuthorized' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp18f7d6b6a7****', + 'title' => '', + ], + ], + [ + 'name' => 'TargetRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the region ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorizationState' => [ + 'description' => 'Indicates whether KMS keys are authorized to ApsaraDB for MongoDB instances. Valid values:'."\n" + ."\n" + .'- **0**: KMS keys are not authorized.'."\n" + ."\n" + .'- **1**: KMS keys are authorized.'."\n" + ."\n" + .'- **2**: KMS is not enabled.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'A0181AC4-F186-46ED-87CA-100C70B86729', + 'title' => '', + ], + 'RoleArn' => [ + 'description' => 'The role information of the authorized Alibaba Resource Name (ARN).'."\n" + ."\n" + .'> This parameter is returned only when the value of the **AuthorizationState** parameter is **1**.', + 'type' => 'string', + 'example' => 'acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'CheckCloudResourceAuthorized', + 'summary' => 'Checks whether Key Management Service (KMS) keys are authorized to an ApsaraDB for MongoDB instance.', + 'description' => 'Before you enable Transparent Data Encryption (TDE) by calling the [ModifyDBInstanceTDE](~~131267~~) operation, you can call this operation to check whether KMS keys are authorized to ApsaraDB for MongoDB instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:CheckCloudResourceAuthorized', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthorizationState\\": 1,\\n \\"RequestId\\": \\"A0181AC4-F186-46ED-87CA-100C70B86729\\",\\n \\"RoleArn\\": \\"acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole\\"\\n}","type":"json"}]', + ], + 'CheckRecoveryCondition' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8238', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceDBInstance', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1378****', + 'title' => '', + ], + ], + [ + 'name' => 'DatabaseNames', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the source database. The value is a JSON array.'."\n" + ."\n" + .'> If you do not specify this parameter, all databases are restored by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["db1","db2"]', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time to which the instance is restored. 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 time can be a point in time within the past seven days. The time must be earlier than the current time, but later than the time when the instance was created.'."\n" + .'> * You must specify one of the RestoreTime and **BackupId** parameters.', + 'type' => 'string', + 'required' => false, + 'example' => '2022-08-22T08:00:00Z', + 'title' => '', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup ID.'."\n" + ."\n" + .'> * You can call the [DescribeBackups](~~62172~~) operation to query the backup ID.'."\n" + .'> * You must specify one of the **RestoreTime** and BackupId parameters.'."\n" + .'> * This parameter is not applicable to sharded cluster instances.', + 'type' => 'string', + 'required' => false, + 'example' => '5664****', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp179****', + 'title' => '', + ], + ], + [ + 'name' => 'SourceDBInstance', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1378****', + 'title' => '', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the source instance resides.'."\n" + ."\n" + .'> * This parameter is required when you set the RestoreType parameter to 2.'."\n" + .'> * This parameter is required when you set the RestoreType parameter to 3.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region of the backup set used for the cross-region backup and restoration.'."\n" + ."\n" + .'> This parameter is required when you set the RestoreType parameter to 3.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The restoration type.'."\n" + ."\n" + .'> * 0: The data of the source instance is restored to a new instance in the same region.'."\n" + .'> * 1: The data of the source instance is restored to an earlier point in time.'."\n" + .'> * 2: The data of a deleted instance is restored to a new instance from the backup set.'."\n" + .'> * 3: The data of a deleted instance is restored to a new instance in another region from the backup set.', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance architecture. Valid values:'."\n" + ."\n" + .'* replicate'."\n" + .'* sharding'."\n" + ."\n" + .'> * This parameter is required when you set the RestoreType parameter to 2.'."\n" + .'> * This parameter is required when you set the RestoreType parameter to 3.', + 'type' => 'string', + 'required' => false, + 'example' => 'replicate', + 'title' => '', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine version of the instance.'."\n" + ."\n" + .'* **6.0**'."\n" + .'* **5.0**'."\n" + .'* **4.4**'."\n" + .'* **4.2**'."\n" + .'* **4.0**'."\n" + .'* **3.4**', + 'type' => 'string', + 'required' => false, + 'example' => '4.2', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D563A3E7-6010-45FE-A0CD-9283414C9657', + 'title' => '', + ], + 'DBInstanceName' => [ + 'description' => 'The instance ID'."\n", + 'type' => 'string', + 'example' => 'dds-bp1378****', + 'title' => '', + ], + 'IsValid' => [ + 'description' => 'Indicates whether the data of the instance can be restored. Valid values:'."\n" + ."\n" + .'* **true**: The data of the instance can be restored.'."\n" + .'* **false**: The data of the instance cannot be restored.'."\n", + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMeta.WrongFormat', + 'errorMessage' => 'Meta information is wrong formatter.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidRestoreTime.Format', + 'errorMessage' => 'Specified restore time is not valid.', + 'description' => 'The specified RestoreTime value is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidDBName', + 'errorMessage' => 'The specified database name is not allowed.', + 'description' => 'The specified database name is invalid.', + ], + [ + 'errorCode' => 'InvalidMeta.TooLarge', + 'errorMessage' => 'Meta information is too large.', + 'description' => 'The metadata is too large.', + ], + [ + 'errorCode' => 'SingleDBRestore.BackupSetNotSupport', + 'errorMessage' => 'This backup set do not support this operation.', + 'description' => 'Single-database recovery is not supported for the specified time point or backup file.', + ], + [ + 'errorCode' => 'IncorrectDBInstanceType', + 'errorMessage' => 'Current DB instance type does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectEngineVersion', + 'errorMessage' => 'Current engine version does not support operations.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidBackupLogStatus', + 'errorMessage' => 'Current backup log enable status does not support this operation.', + 'description' => 'The operation is not supported when log backup is enabled.', + ], + [ + 'errorCode' => 'IncorrectBackupSetState', + 'errorMessage' => 'Current backup set state does not support operations..', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'InvalidBackupSetID.NotFound', + 'errorMessage' => 'Specifiedbackup set ID does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidBackup.NotFound', + 'errorMessage' => 'Theavailable backup does not exist in recovery time.', + 'description' => 'No backup set is available during the specified recovery period.', + ], + ], + ], + 'title' => 'CheckRecoveryCondition', + 'summary' => 'Queries whether the data of an ApsaraDB for MongoDB instance can be restored.', + 'description' => 'This operation is applicable to replica set instances and sharded cluster instances.'."\n" + ."\n" + .'> After you call this operation to confirm that the data of the instance can be restored, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:CheckRecoveryCondition', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D563A3E7-6010-45FE-A0CD-9283414C9657\\",\\n \\"DBInstanceName\\": \\"dds-bp1378****\\",\\n \\"IsValid\\": true\\n}","type":"json"}]', + ], + 'CheckServiceLinkedRole' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7BE0D8D2-6702-5639-A9C2-xxxxxxx', + ], + 'ServiceLinkedRoleExists' => [ + 'description' => 'Indicates whether an SLR is created.', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'title' => 'CheckServiceLinkedRole', + 'summary' => 'Checks whether a service-linked role (SLR) is created for an instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:CheckServiceLinkedRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BE0D8D2-6702-5639-A9C2-xxxxxxx\\",\\n \\"ServiceLinkedRoleExists\\": true\\n}","type":"json"}]', + ], + 'CreateAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '8239', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-uf6e9433e955xxxx', + 'title' => '', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account. The name must be 4 to 16 characters in length. It can contain lowercase letters, digits, and underscores (\\_). It must start with a lowercase letter. The account is granted read-only permissions.', + 'type' => 'string', + 'required' => true, + 'example' => 'admin1', + 'title' => '', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the database account. The password must be 8 to 32 characters in length. It can contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! # $ % ^ & \\* ( ) \\_ + - =', + 'type' => 'string', + 'required' => true, + 'example' => 'Test123456!', + 'title' => '', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the account that you want to create. Valid values:'."\n" + ."\n" + .'- **db** (default): shard account (available)'."\n" + ."\n" + .'- **cs**: ConfigServer account'."\n" + ."\n" + .'- **normal**: replica set account'."\n" + ."\n" + .'> You can set this parameter only to **db**.', + 'type' => 'string', + 'default' => 'db', + 'enum' => [ + 'db', + 'cs', + 'normal', + ], + 'required' => false, + 'example' => 'db', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '7FEF1BEF-2842-5758-9126-415A297XXXXX', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'Specified parameter AccountName is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'Specified parameter AccountPassword is not valid.', + 'description' => 'The specified parameter AccountPassword is invalid.', + ], + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'Specified parameter AccountDescription is not valid.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'AccountLimitExceeded', + 'errorMessage' => 'AccountQuotaExceeded: Exceeding the allowed amount of account.', + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'CreateAccount', + 'summary' => 'Creates an account that is granted read-only permissions for shard nodes in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.', + 'description' => '- You can create an account for shard nodes only in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.'."\n" + ."\n" + .'- The account is granted read-only permissions.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FEF1BEF-2842-5758-9126-415A297XXXXX\\"\\n}","type":"json"}]', + ], + 'CreateBackup' => [ + 'summary' => 'Creates a backup for a MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '95111', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'd-bp2235****', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup method of the instance. Valid values:'."\n" + ."\n" + .'- **Snapshot**: snapshot backup.'."\n" + ."\n" + .'- **Logical**: logical backup.'."\n" + ."\n" + .'- **Physical** (default): physical backup.'."\n" + ."\n" + .'> * Instances that use disks support only snapshot backups.'."\n" + .'>'."\n" + .'> * You can select a backup method for only ReplicaSet and sharded cluster instances. You do not need to specify this parameter for standalone instances. Standalone instances use snapshot backups.', + 'type' => 'string', + 'required' => false, + 'default' => 'Physical', + 'title' => '', + 'example' => 'Logical', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => 'The number of days to retain the backup.'."\n" + ."\n" + .'> If you do not specify this parameter, the retention period specified in the default backup policy is used. Valid values:'."\n" + .'>'."\n" + .'> - 7 to 730'."\n" + .'>'."\n" + .'> - -1 (permanent retention)', + 'required' => false, + 'title' => '', + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BackupId' => [ + 'description' => 'The backup ID.'."\n" + ."\n" + .'> This parameter is deprecated. To obtain the backup ID, call the [DescribeBackups](~~468441~~) operation.', + 'type' => 'string', + 'title' => '', + 'example' => '5664****', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '7016B12F-7F64-40A4-BAFF-013F02AC82FC', + ], + 'BackupJobId' => [ + 'type' => 'string', + 'description' => 'The backup job ID.', + 'title' => '', + 'example' => '775051', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBackupMethod.ValueNotSupport', + 'errorMessage' => 'The specified parameter BackupMethod is not valid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.BackupJobExists', + 'errorMessage' => 'The operation is not permitted due to backup job exist.', + 'description' => 'A backup task is in progress. Try again later.', + ], + [ + 'errorCode' => 'OperationDenied.NoDatabase', + 'errorMessage' => 'The operation is not permitted due to no database.', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackupId\\": \\"5664****\\",\\n \\"RequestId\\": \\"7016B12F-7F64-40A4-BAFF-013F02AC82FC\\",\\n \\"BackupJobId\\": \\"775051\\"\\n}","type":"json"}]', + 'title' => 'CreateBackup', + 'description' => 'The instance must be running when you call the CreateBackup operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'CreateDBInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '8241', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. To query the region ID, call the [DescribeRegions]() operation.'."\n" + ."\n" + .'> When you clone an instance or restore an instance from the recycle bin, this parameter must be the same as the region ID of the source instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot be more than 64 characters long.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID. To query the zone ID, call the [DescribeRegions]() operation.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + 'title' => '', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine version. Valid values:'."\n" + ."\n" + .'- **8.0**'."\n" + ."\n" + .'- **7.0**'."\n" + ."\n" + .'- **6.0**'."\n" + ."\n" + .'- **5.0**'."\n" + ."\n" + .'- **4.4**'."\n" + ."\n" + .'- **4.2**'."\n" + ."\n" + .'- **4.0**'."\n" + ."\n" + .'> When you clone an instance or restore an instance from the recycle bin, this parameter must be the same as the engine version of the source instance.'."\n" + ."\n" + .'><warning>'."\n" + ."\n" + .'Versions 3.4 and earlier are discontinued.'."\n" + ."\n" + .'></warning>', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => [ + '4.0', + '4.2', + '4.4', + '5.0', + '6.0', + '7.0', + '3.4', + '8.0', + ], + 'example' => '4.4', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type. To query instance types, call the [DescribeAvailableResource]() operation.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds.mongo.standard', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage space of the instance in GB.'."\n" + ."\n" + .'The value of this parameter varies based on the instance type. For more information, see [Replica set instance types]().', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name. The name must meet the following requirements:'."\n" + ."\n" + .'- It must start with a letter or a Chinese character.'."\n" + ."\n" + .'- It can contain letters, Chinese characters, digits, underscores (\\_), periods (.), and hyphens (-).'."\n" + ."\n" + .'- It must be 2 to 256 characters long.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address whitelist of the instance. Separate multiple IP addresses with commas (,). Each IP address in the whitelist must be unique. The whitelist can be in one of the following formats:'."\n" + ."\n" + .'- 0.0.0.0/0'."\n" + ."\n" + .'- An IP address, for example, 10.23.12.24.'."\n" + ."\n" + .'- A CIDR block, for example, 10.23.12.0/24. The /24 indicates that the prefix of the CIDR block is 24 bits in length. You can set the prefix to a value from 1 to 32.'."\n" + ."\n" + .'> * You can add a maximum of 1,000 IP addresses or CIDR blocks to all IP address whitelists.'."\n" + .'>'."\n" + .'> * If you set the whitelist to 0.0.0.0/0, all IP addresses can access the instance. This is a high-risk setting. Use this with caution.', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.xx.xx,192.168.xx.xx', + 'title' => '', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password for the root account. The password must meet the following requirements:'."\n" + ."\n" + .'- It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + ."\n" + .'- The special characters are !@#$%^&\\*()\\_+-='."\n" + ."\n" + .'- It must be 8 to 32 characters long.'."\n" + ."\n" + .'> For more information about connection failures caused by special characters in passwords, see [How do I fix a connection failure that is caused by special characters in a password?]().', + 'type' => 'string', + 'required' => false, + 'example' => '123456Aa', + 'title' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the instance in months.'."\n" + ."\n" + .'Valid values: **1** to **9** (integers), **12**, **24**, **36**, and **60**.'."\n" + ."\n" + .'> This parameter is required and takes effect only when you set the **ChargeType** parameter to **PrePaid**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PostPaid**: The default value. Pay-as-you-go.'."\n" + ."\n" + .'- **PrePaid**: Subscription.'."\n" + ."\n" + .'> If you set this parameter to **PrePaid**, you must also specify the **Period** parameter.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'default' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + 'example' => 'PrePaid', + 'title' => '', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'**VPC**: virtual private cloud (VPC).', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'default' => 'VPC', + 'enum' => [ + 'VPC', + ], + 'example' => 'VPC', + 'title' => '', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The VPC ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vpc-bp175iuvg8nxqraf2****', + 'title' => '', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + 'title' => '', + ], + ], + [ + 'name' => 'SrcDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source instance ID.'."\n" + ."\n" + .'> When you clone an instance, you must specify this parameter and the **BackupId** or **RestoreTime** parameter. When you restore an instance from the recycle bin, you only need to specify this parameter. You do not need to specify the **BackupId** or **RestoreTime** parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp1ee12ad351****', + 'title' => '', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup point ID. To query the backup point ID, call the [DescribeBackups]() operation.'."\n" + ."\n" + .'> You must specify this parameter and the **SrcDBInstanceId** parameter only when you clone an instance based on a backup point.', + 'type' => 'string', + 'required' => false, + 'example' => '32994****', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time to which you want to restore the instance. You can specify any point in time within the last seven days. The time must be in the *yyyy-MM-dd*T*HH:mm:ss*Z format and in UTC.'."\n" + ."\n" + .'> You must specify this parameter and the **SrcDBInstanceId** parameter only when you clone an instance based on a point in time.', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-13T12:11:14Z', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information. This is an optional parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + 'title' => '', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" + ."\n" + .'- **true**: Enables auto-renewal.'."\n" + ."\n" + .'- **false**: The default value. Disables auto-renewal. You must manually renew the instance.'."\n" + ."\n" + .'> This parameter is optional and takes effect only when you set the **ChargeType** parameter to **PrePaid**.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'DatabaseNames', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n" + ."\n" + .'> When you clone an instance, you can specify this parameter to clone specific databases. If you do not specify this parameter, all databases of the instance are cloned.', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodbtest', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" + ."\n" + .'- **default** or **null** (default): Uses a coupon.'."\n" + ."\n" + .'- **youhuiquan\\_promotion\\_option\\_id\\_for\\_blank**: Does not use a coupon.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'title' => '', + ], + ], + [ + 'name' => 'StorageEngine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage engine of the instance. The value is fixed as **WiredTiger**.'."\n" + ."\n" + .'> - When you clone an instance or restore an instance from the recycle bin, this parameter must be the same as the storage engine of the source instance.'."\n" + .'>'."\n" + .'> - For more information about the constraints on storage engines and database versions, see [Versions and storage engines]().', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'default' => 'WiredTiger', + 'enum' => [ + 'WiredTiger', + ], + 'example' => 'WiredTiger', + 'title' => '', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of **primary and secondary nodes** in the replica set instance. Valid values:'."\n" + ."\n" + .'- **3** (default)'."\n" + ."\n" + .'- **5**'."\n" + ."\n" + .'- **7**'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'You do not need to specify this parameter for standalone instances.'."\n" + ."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'default' => '3', + 'example' => '3', + 'title' => '', + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of **read-only nodes** in the replica set instance. Valid values are integers from **0** to **5**. The default value is **0**.', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine. The value is fixed as **MongoDB**.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'MongoDB', + ], + 'example' => 'MongoDB', + 'title' => '', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The storage class. Valid values:'."\n" + ."\n" + .'- **cloud\\_essd1**: ESSD PL1 disk.'."\n" + ."\n" + .'- **cloud\\_essd2**: ESSD PL2 disk.'."\n" + ."\n" + .'- **cloud\\_essd3**: ESSD PL3 disk.'."\n" + ."\n" + .'- **cloud\\_auto**: ESSD AutoPL disk.'."\n" + ."\n" + .'- **local\\_ssd**: Local SSD.'."\n" + ."\n" + .'> * For standalone instances, if you pass the value cloud\\_essd1, an ESSD disk is used.'."\n" + .'>'."\n" + .'> * ESSD AutoPL disks are available only on the China site (aliyun.com).'."\n" + .'>'."\n" + .'> * For instances of version 4.4 or later, the default value is **cloud\\_essd1**.'."\n" + .'>'."\n" + .'> * For instances of version 4.2 or earlier, the default value is **local\\_ssd**.', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd1', + 'title' => '', + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The zone where the secondary node is deployed. This parameter is used for multi-zone deployment. Valid values:'."\n" + ."\n" + .'- **cn-hangzhou-g**: Zone G in Hangzhou.'."\n" + ."\n" + .'- **cn-hangzhou-h**: Zone H in Hangzhou.'."\n" + ."\n" + .'- **cn-hangzhou-i**: Zone I in Hangzhou.'."\n" + ."\n" + .'- **cn-hongkong-b**: Zone B in Hong Kong (China).'."\n" + ."\n" + .'- **cn-hongkong-c**: Zone C in Hong Kong (China).'."\n" + ."\n" + .'- **cn-hongkong-d**: Zone D in Hong Kong (China).'."\n" + ."\n" + .'- **cn-wulanchabu-a**: Zone A in Ulanqab.'."\n" + ."\n" + .'- **cn-wulanchabu-b**: Zone B in Ulanqab.'."\n" + ."\n" + .'- **cn-wulanchabu-c**: Zone C in Ulanqab.'."\n" + ."\n" + .'- **ap-southeast-1a**: Zone A in Singapore.'."\n" + ."\n" + .'- **ap-southeast-1b**: Zone B in Singapore.'."\n" + ."\n" + .'- **ap-southeast-1c**: Zone C in Singapore.'."\n" + ."\n" + .'- **ap-southeast-5a**: Zone A in Jakarta.'."\n" + ."\n" + .'- **ap-southeast-5b**: Zone B in Jakarta.'."\n" + ."\n" + .'- **ap-southeast-5c**: Zone C in Jakarta.'."\n" + ."\n" + .'- **eu-central-1a**: Zone A in Frankfurt.'."\n" + ."\n" + .'- **eu-central-1b**: Zone B in Frankfurt.'."\n" + ."\n" + .'- **eu-central-1c**: Zone C in Frankfurt.'."\n" + ."\n" + .'> * This parameter is available when the instance uses disks.'."\n" + .'>'."\n" + .'> * The value of this parameter cannot be the same as the value of the **ZoneId** or **HiddenZoneId** parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + ], + [ + 'name' => 'HiddenZoneId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The zone where the hidden node is deployed. This parameter is used for multi-zone deployment. Valid values:'."\n" + ."\n" + .'- **cn-hangzhou-g**: Zone G in Hangzhou.'."\n" + ."\n" + .'- **cn-hangzhou-h**: Zone H in Hangzhou.'."\n" + ."\n" + .'- **cn-hangzhou-i**: Zone I in Hangzhou.'."\n" + ."\n" + .'- **cn-hongkong-b**: Zone B in Hong Kong (China).'."\n" + ."\n" + .'- **cn-hongkong-c**: Zone C in Hong Kong (China).'."\n" + ."\n" + .'- **cn-hongkong-d**: Zone D in Hong Kong (China).'."\n" + ."\n" + .'- **cn-wulanchabu-a**: Zone A in Ulanqab.'."\n" + ."\n" + .'- **cn-wulanchabu-b**: Zone B in Ulanqab.'."\n" + ."\n" + .'- **cn-wulanchabu-c**: Zone C in Ulanqab.'."\n" + ."\n" + .'- **ap-southeast-1a**: Zone A in Singapore.'."\n" + ."\n" + .'- **ap-southeast-1b**: Zone B in Singapore.'."\n" + ."\n" + .'- **ap-southeast-1c**: Zone C in Singapore.'."\n" + ."\n" + .'- **ap-southeast-5a**: Zone A in Jakarta.'."\n" + ."\n" + .'- **ap-southeast-5b**: Zone B in Jakarta.'."\n" + ."\n" + .'- **ap-southeast-5c**: Zone C in Jakarta.'."\n" + ."\n" + .'- **eu-central-1a**: Zone A in Frankfurt.'."\n" + ."\n" + .'- **eu-central-1b**: Zone B in Frankfurt.'."\n" + ."\n" + .'- **eu-central-1c**: Zone C in Frankfurt.'."\n" + ."\n" + .'> * This parameter is available when the instance uses disks.'."\n" + .'>'."\n" + .'> * The value of this parameter cannot be the same as the value of the **ZoneId** or **SecondaryZoneId** parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + 'title' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The custom tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n" + ."\n" + .'> - **N** specifies the Nth tag. For example, **Tag.1.Key** specifies the key of the first tag, and **Tag.2.Key** specifies the key of the second tag.', + 'type' => 'string', + 'required' => false, + 'example' => 'testdatabase', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n" + ."\n" + .'> **N** specifies the Nth tag. For example, **Tag.1.Value** specifies the value of the first tag, and **Tag.2.Value** specifies the value of the second tag.', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + 'title' => '', + ], + ], + 'required' => false, + 'description' => 'The custom tags added to the instance.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'GlobalSecurityGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The global IP address whitelist templates for the instance. Separate multiple templates with commas (,). The templates cannot be repeated. This feature is in canary release.', + 'type' => 'string', + 'required' => false, + 'example' => 'g-qxieqf40xjst1ngpr3jz ', + 'title' => '', + ], + ], + [ + 'name' => 'Encrypted', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable disk encryption.', + 'type' => 'boolean', + 'default' => 'flase', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom key ID.', + 'type' => 'string', + 'required' => false, + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => 'The provisioned IOPS (input/output operations per second). Valid values: 0 to 50000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1960', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method to restore an instance from a backup.'."\n" + ."\n" + .'- 0: Restores the instance to a specified backup set.'."\n" + ."\n" + .'- 1: Restores the instance to a specified point in time.'."\n" + ."\n" + .'- 2: Restores a released instance to a specified backup set.'."\n" + ."\n" + .'- 3: Restores the instance to a specified geo-redundant backup set.', + 'type' => 'string', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the source instance is located.'."\n" + ."\n" + .'> - This parameter is required when RestoreType is set to 2 or 3.', + 'type' => 'string', + 'required' => false, + 'example' => '2', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + 'title' => '', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-bp144a7f2db8****', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'example' => '21077576248****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityRisk.AuthVerification', + 'errorMessage' => 'we have detected a risk with your default payment method. An email and notification has been sent to you. Please re-submit your order before after verificaiton.', + 'description' => '', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Period is mandatory for this action.', + 'description' => '', + ], + [ + 'errorCode' => 'ORDER.ACCOUNT_INFORMATION_INCOMPLETE', + 'errorMessage' => 'Your information is incomplete. Complete your information before ordering.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => 'Specified parameter ClientToken is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidDBInstanceDescription.Malformed', + 'errorMessage' => 'Specified parameter DBInstanceDescription is not valid.', + 'description' => 'Invalid node name.', + ], + [ + 'errorCode' => 'InvalidSecurityIPListLength.Malformed', + 'errorMessage' => 'The quota of security ip exceeds.', + 'description' => '', + ], + [ + 'errorCode' => 'InsufficientBalance', + 'errorMessage' => 'Your account does not have enough balance.', + 'description' => '', + ], + [ + 'errorCode' => 'QuotaExceed.AfterpayInstance', + 'errorMessage' => 'Living afterpay instances quota exceeded.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidCapacity.NotFound', + 'errorMessage' => 'The Capacity provided does not exist in our records.', + 'description' => '', + ], + [ + 'errorCode' => 'ResourceNotAvailable', + 'errorMessage' => 'Resource you requested is not available for finance user.', + 'description' => '', + ], + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Malformed', + 'errorMessage' => 'The specified parameter "SecurityIPList" is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'The Security IP address is not in the available range or occupied.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidDBInstanceStorage.ValueNotSupported', + 'errorMessage' => 'The specified parameter DBInstanceStorage is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'Specified parameter AccountPassword is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'TokenServiceError', + 'errorMessage' => 'Duplicate ClientToken request.', + 'description' => '', + ], + [ + 'errorCode' => 'Zone.Closed', + 'errorMessage' => 'The specified zone is closed.', + 'description' => '', + ], + [ + 'errorCode' => 'PRICE.ORIGIN_PRICE_ERROR', + 'errorMessage' => 'The origin price error.', + 'description' => '', + ], + [ + 'errorCode' => 'NO_AVAILABLE_PAYMENT_METHOD', + 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEcsImage.NotFound', + 'errorMessage' => 'Specified ecs image does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'SaleValidateNoSpecificCodeFailed', + 'errorMessage' => 'Specified Storage or Version or InstanceClass is invalid.', + 'description' => 'Storage or Version or InstanceClass is empty.', + ], + [ + 'errorCode' => 'Trade_Not_Support_Async_Pay', + 'errorMessage' => 'Trade not support async pay.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidZoneld', + 'errorMessage' => 'The specified primary zone, secondary zone and hidden zone cannot be the same.', + 'description' => 'The parameters of the primary zone, secondary zone and hidden zone cannot be the same.', + ], + [ + 'errorCode' => 'SameZoneId', + 'errorMessage' => 'The specified primary zone, secondary zone require two different zones.', + 'description' => 'The specified primary zone, secondary zone require two different zones.', + ], + ], + 403 => [ + [ + 'errorCode' => 'RealNameAuthenticationError', + 'errorMessage' => 'Your account has not passed the real-name authentication yet.', + 'description' => '', + ], + [ + 'errorCode' => 'RegionUnauthorized', + 'errorMessage' => 'There is no authority to create instance in the specified region.', + 'description' => '', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'The resource is out of usage.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEngineVersionInRegion.NotAvailable', + 'errorMessage' => 'The EngineVersion in the Region is not available.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidBackupLogStatus', + 'errorMessage' => 'Current backup log enable status does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectBackupSetState', + 'errorMessage' => 'Current backup set state does not support operations.', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'InvalidBackup.NotFound', + 'errorMessage' => 'The available backup does not exist in recovery time.', + 'description' => '', + ], + ], + ], + 'title' => 'CreateDBInstance', + 'summary' => 'Creates or clones an ApsaraDB for MongoDB replica set instance.', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props> of ApsaraDB for MongoDB.'."\n" + ."\n" + .'For more information about the instance types of ApsaraDB for MongoDB, see [Instance types]().'."\n" + ."\n" + .'To create a sharded cluster instance, call the [CreateShardingDBInstance]() operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8F1D721-6439-4257-A89C-F1E8E9C9****\\",\\n \\"DBInstanceId\\": \\"dds-bp144a7f2db8****\\",\\n \\"OrderId\\": \\"21077576248****\\"\\n}","type":"json"}]', + ], + 'CreateGlobalSecurityIPGroup' => [ + 'summary' => 'Creates a global IP whitelist template.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '168608', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'- It can contain lowercase letters, digits, and underscores (\\_).'."\n" + ."\n" + .'- It must start with a letter and end with a letter or digit.'."\n" + ."\n" + .'- It must be 2 to 120 characters in length.', + 'type' => 'string', + 'required' => true, + 'maxLength' => 120, + 'minLength' => 2, + 'example' => 'aizy', + 'title' => '', + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP addresses in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP address whitelists.', + 'type' => 'string', + 'required' => true, + 'example' => '27.18.86.18,183.92.40.129', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'F8CA8312-530A-413A-9129-F2BB32A8D404', + 'title' => '', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'The IP whitelist templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IP whitelist template.', + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the IP whitelist template.', + 'type' => 'string', + 'example' => 'g-2ifynl1jfkdlhhxgva3q', + 'title' => '', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'- It can contain lowercase letters, digits, and underscores (\\_).'."\n" + ."\n" + .'- It must start with a letter and end with a letter or digit.'."\n" + ."\n" + .'- It must be 2 to 120 characters in length.', + 'type' => 'string', + 'example' => 'developer', + 'title' => '', + ], + 'GIpList' => [ + 'description' => 'The IP addresses in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP address whitelists.', + 'type' => 'string', + 'example' => '111.207.194.217,61.149.7.154', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', + 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Format', + 'errorMessage' => 'Specified security IP list format is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'Specified user does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'CreateGlobalSecurityIPGroup', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8CA8312-530A-413A-9129-F2BB32A8D404\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-2ifynl1jfkdlhhxgva3q\\",\\n \\"GlobalIgName\\": \\"developer\\",\\n \\"GIpList\\": \\"111.207.194.217,61.149.7.154\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateNode' => [ + 'summary' => 'Adds a shard or mongos node to an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '8244', + 'abilityTreeNodes' => [ + 'FEATUREmongodbYP9Z1H', + 'FEATUREmongodbZAXC46', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sharded cluster instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp11501cd7b5****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the shard or mongos node. For more information, see [Instance types](~~57141~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'dds.shard.mid', + 'title' => '', + ], + ], + [ + 'name' => 'NodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The disk capacity of the node. Unit: GB.'."\n" + ."\n" + .'Valid values: **10** to **2000**. The value must be a multiple of 10.'."\n" + ."\n" + .'> This parameter is required only when the NodeType parameter is set to **shard**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'- **shard**: shard node'."\n" + ."\n" + .'- **mongos**: mongos node', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'mongos', + 'shard', + ], + 'example' => 'shard', + 'title' => '', + ], + ], + [ + '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 generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + 'title' => '', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" + ."\n" + .'- **true** (default): enables automatic payment. Make sure that you have sufficient balance within your account.'."\n" + ."\n" + .'- **false**: disables automatic payment. You can perform the following operations to pay for the instance: Log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, choose **Expenses** > Orders. On the **Orders** page, find the order that you want to pay for and complete the payment.'."\n" + ."\n" + .'> This parameter is required only when the billing method of the instance is subscription.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of read-only nodes in the shard node.'."\n" + ."\n" + .'Valid values: **0**, 1, 2, 3, 4, and **5**. Default value: **0**.'."\n" + ."\n" + .'> This parameter is available only for ApsaraDB for MongoDB instances that are purchased on the China site (aliyun.com).', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '5', + 'minimum' => '0', + 'default' => '0', + 'required' => false, + 'example' => '5', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information. This is an additional parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The coupon code. Default value: **youhuiquan\\_promotion\\_option\\_id\\_for\\_blank**.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'title' => '', + ], + ], + [ + 'name' => 'ShardDirect', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to apply for an endpoint for the shard node. Valid values:'."\n" + ."\n" + .'- **true**: applies for an endpoint for the shard node.'."\n" + ."\n" + .'- **false** (default): does not apply for an endpoint for the shard node.', + 'type' => 'boolean', + 'default' => 'false', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account. The username must meet the following requirements:'."\n" + ."\n" + .'- The username starts with a lowercase letter.'."\n" + ."\n" + .'- The username can contain lowercase letters, digits, and underscores (\\_).'."\n" + ."\n" + .'- The username must be 4 to 16 characters in length.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- Keywords cannot be used as accounts.'."\n" + ."\n" + .'- This account is granted the read-only permissions.'."\n" + ."\n" + .'- The username and password need to be set if you apply for an endpoint for the shard node for the first time.', + 'type' => 'string', + 'required' => false, + 'example' => 'ceshi', + 'title' => '', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account. The password must meet the following requirements:'."\n" + ."\n" + .'- The password contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + ."\n" + .'- These special characters include ! @ # $ % ^ & \\* ( ) \\_ + - ='."\n" + ."\n" + .'- The password is 8 to 32 characters in length.'."\n" + ."\n" + .'> ApsaraDB for MongoDB does not allow you to reset the password of an account.', + 'type' => 'string', + 'required' => false, + 'example' => '123+abc', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '7D48FB19-20CA-4725-A870-3D8F5CE6****', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'The node ID.', + 'type' => 'string', + 'example' => 'd-bp1b234bf7a4****', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'example' => '20951063702****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SSLNotSupportAddNode', + 'errorMessage' => 'Instance with SSL certificate can\'t add node, please contact us to solve this problem.', + 'description' => 'SSL encryption instances do not allow nodes to be added. If you need to, contact us to solve the problem.', + ], + [ + 'errorCode' => 'ErrorInsufficientResource', + 'errorMessage' => 'There is not enough resource for your operation, requestId: %s.', + 'description' => 'There is not enough resource for your operation, requestId: %s.', + ], + ], + ], + 'title' => 'CreateNode', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.'."\n" + ."\n" + .'This operation applies only to sharded cluster instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D48FB19-20CA-4725-A870-3D8F5CE6****\\",\\n \\"NodeId\\": \\"d-bp1b234bf7a4****\\",\\n \\"OrderId\\": \\"20951063702****\\"\\n}","type":"json"}]', + ], + 'CreateNodeBatch' => [ + 'summary' => 'Batch adds mongos or shard nodes for a sharded cluster instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '52777', + 'abilityTreeNodes' => [ + 'FEATUREmongodbYP9Z1H', + 'FEATUREmongodbZAXC46', + ], + ], + 'parameters' => [ + [ + '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 ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + 'title' => '', + ], + ], + [ + 'name' => 'FromApp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the request. Valid values:'."\n" + ."\n" + .'- **OpenApi**: ApsaraDB for MongoDB API'."\n" + ."\n" + .'- **mongo\\_buy**: ApsaraDB for MongoDB console', + 'type' => 'string', + 'required' => false, + 'default' => 'OpenApi', + 'example' => 'OpenApi', + 'title' => '', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic payment. Default value: true. Valid values:'."\n" + ."\n" + .'- **true**: enables automatic payment. Make sure that you have sufficient balance within your account.'."\n" + ."\n" + .'- **false**: disables automatic payment. In this case, you must manually pay for the instance. You can perform the following operations to pay for the instance: Log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, choose **Expenses** > **Orders**. On the Orders page, find the order and complete the payment.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance for which you want to add nodes.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp18b0934e70****', + 'title' => '', + ], + ], + [ + 'name' => 'NodesInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the mongos or shard node that you want to add. For more information, see [Instance types](~~57141~~).'."\n" + ."\n" + .'> Up to 32 mongos or shard nodes are supported for each sharded cluster instance.', + 'type' => 'string', + 'required' => true, + 'example' => '{"Shards":[{"DBInstanceClass":"mdb.shard.4x.large.d","Storage":20}]}', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use coupons. Default value: null. Valid values:'."\n" + ."\n" + .'- **default** or **null**: uses coupons.'."\n" + ."\n" + .'- **youhuiquan\\_promotion\\_option\\_id\\_for\\_blank**: does not use coupons.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information.', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + 'title' => '', + ], + ], + [ + 'name' => 'ShardDirect', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to apply for an endpoint for the shard node. Default value: false. Valid values:'."\n" + ."\n" + .'- **true**: applies for an endpoint for the shard node.'."\n" + ."\n" + .'- **false**: does not apply for an endpoint for the shard node.', + 'type' => 'boolean', + 'default' => 'false', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account. The username must meet the following requirements:'."\n" + ."\n" + .'- The username starts with a lowercase letter.'."\n" + ."\n" + .'- The username contains lowercase letters, digits, and underscores (\\_).'."\n" + ."\n" + .'- The username is 4 to 16 characters in length.'."\n" + ."\n" + .'> * Keywords cannot be used as account usernames.'."\n" + .'>'."\n" + .'> * The permissions of this account are fixed at read-only.'."\n" + .'>'."\n" + .'> * The username and password are required to be set only when you apply for an endpoint for the shard node for the first time.', + 'type' => 'string', + 'required' => false, + 'example' => 'ceshi', + 'title' => '', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account. The password must meet the following requirements:'."\n" + ."\n" + .'- The password contains at least three of the following character types: uppercase letters, lowercase letters, digits, and specific special characters.'."\n" + ."\n" + .'- These special characters include ! @ # $ % ^ & \\* ( ) \\_ + - ='."\n" + ."\n" + .'- The password is 8 to 32 characters in length.'."\n" + ."\n" + .'> The account password of the shard node cannot be reset.', + 'type' => 'string', + 'required' => false, + 'example' => 'PassWord123', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '55D41A94-1ACE-55E8-8BC7-67D622E7****', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.', + 'type' => 'string', + 'example' => '50179021707****', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'The ID of the added mongos or shard node.', + 'type' => 'string', + 'example' => 'd-bp18f7d6b6a7****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SSLNotSupportAddNode', + 'errorMessage' => 'Instance with SSL certificate can\'t add node, please contact us to solve this problem.', + 'description' => 'SSL encryption instances do not allow nodes to be added. If you need to, contact us to solve the problem.', + ], + [ + 'errorCode' => 'ErrorInsufficientResource', + 'errorMessage' => 'There is not enough resource for your operation, requestId: %s.', + 'description' => 'There is not enough resource for your operation, requestId: %s.', + ], + ], + ], + 'title' => 'CreateNodeBatch', + 'description' => 'Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.'."\n" + ."\n" + .'This operation is applicable only to sharded cluster instances.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateNodeBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"55D41A94-1ACE-55E8-8BC7-67D622E7****\\",\\n \\"OrderId\\": \\"50179021707****\\",\\n \\"NodeId\\": \\"d-bp18f7d6b6a7****\\"\\n}","type":"json"}]', + ], + 'CreateNodeRoleTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '226294', + 'abilityTreeNodes' => [ + 'FEATUREmongodbX5X8MM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze09d7be1fxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ShardList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard node.'."\n" + ."\n" + .'> - This parameter applies only to sharded cluster instances.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-l5xf98b78b9fxxxx,d-l5xf98b7sf9fxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'B0B7DE3E-xxxx-xxxx-xxxx-0B16F8834E0B', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => 'The parameter entered is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterParam', + 'errorMessage' => 'Specified filter is not valid.', + 'description' => '', + ], + ], + ], + 'title' => 'CreateNodeRoleTag', + 'summary' => 'Creates a role tag for an instance node.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B0B7DE3E-xxxx-xxxx-xxxx-0B16F8834E0B\\"\\n}","type":"json"}]', + ], + 'CreateShardingDBInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '8247', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~61933~~) operation to query the region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID. You can call the [DescribeRegions](~~61933~~) operation to query the zone ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + 'title' => '', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine. Set the value to **MongoDB**.', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'MongoDB', + ], + 'example' => 'MongoDB', + 'title' => '', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database version. Valid values:'."\n" + ."\n" + .'- **8.0**'."\n" + ."\n" + .'- **7.0**'."\n" + ."\n" + .'- **6.0**'."\n" + ."\n" + .'- **5.0**'."\n" + ."\n" + .'- **4.4**'."\n" + ."\n" + .'- **4.2**'."\n" + ."\n" + .'- **4.0**'."\n" + ."\n" + .'> * For more information about the constraints on storage engines and database versions, see [Versions and storage engines](~~61906~~).'."\n" + .'>'."\n" + .'> * When you clone an instance by calling this operation, the value of this parameter must be the same as that of the source instance.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => [ + '3.0', + '3.2', + '3.4', + '4.0', + '4.2', + '4.4', + '5.0', + '6.0', + '7.0', + '8.0', + ], + 'example' => '4.4', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance. The name must meet the following requirements:'."\n" + ."\n" + .'- It must start with a Chinese character or a letter.'."\n" + ."\n" + .'- It can contain digits, Chinese characters, letters, underscores (\\_), periods (.), and hyphens (-).'."\n" + ."\n" + .'- It must be 2 to 256 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address whitelist of the instance. Separate multiple IP addresses with commas (,). Each IP address in the whitelist must be unique. The following formats are supported:'."\n" + ."\n" + .'- 0.0.0.0/0'."\n" + ."\n" + .'- IP addresses, such as 10.23.12.24.'."\n" + ."\n" + .'- CIDR blocks, such as 10.23.12.0/24. The /24 part indicates the prefix length of the CIDR block. The prefix length ranges from 1 to 32.'."\n" + ."\n" + .'> * You can add a maximum of 1,000 IP addresses or CIDR blocks to all IP address whitelists.'."\n" + .'>'."\n" + .'> * The 0.0.0.0/0 entry allows access from all IP addresses. This is a high-risk setting. Configure it with caution.', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.xx.xx,192.168.xx.xx', + 'title' => '', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the root account. The password must meet the following requirements:'."\n" + ."\n" + .'- It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + ."\n" + .'- Special characters include !@#$%^&\\*()\\_+-='."\n" + ."\n" + .'- It must be 8 to 32 characters in length.'."\n" + ."\n" + .'> For information about how to resolve connection failures caused by special characters in passwords, see [How do I fix connection failures caused by special characters in a password?](~~471568~~).', + 'type' => 'string', + 'required' => false, + 'example' => '123456Aa', + 'title' => '', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PostPaid**: pay-as-you-go. This is the default value.'."\n" + ."\n" + .'- **PrePaid**: subscription.'."\n" + ."\n" + .'> If you set this parameter to **PrePaid**, you must also specify the **Period** parameter.', + 'type' => 'string', + 'required' => false, + 'default' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + 'example' => 'PrePaid', + 'title' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the instance. Unit: month.'."\n" + ."\n" + .'Valid values: **1** to **9** (integer), **12**, **24**, **36**, and **60**.'."\n" + ."\n" + .'> This parameter is required and takes effect only when you set the **ChargeType** parameter to **PrePaid**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'**VPC**: virtual private cloud.', + 'type' => 'string', + 'required' => false, + 'default' => 'VPC', + 'enum' => [ + 'VPC', + 'Classic', + ], + 'example' => 'VPC', + 'title' => '', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual private cloud (VPC) ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vpc-bp1n3i15v90el48nx****', + 'title' => '', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual switch ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vsw-bp1vj604nj5a9zz74****', + 'title' => '', + ], + ], + [ + 'name' => 'SrcDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source instance ID.'."\n" + ."\n" + .'> This parameter is required only when you clone an instance by calling this operation. You must also specify the **RestoreTime** parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp11483712c1****', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time to which you want to restore data. You can specify any point in time within the last seven days. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'> This parameter is required only when you clone an instance by calling this operation. You must also specify the **SrcDBInstanceId** parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-08T02:30:25Z', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A 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.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + 'title' => '', + ], + ], + [ + 'name' => 'StorageEngine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage engine of the instance. Set the value to **WiredTiger**.'."\n" + ."\n" + .'> - When you clone an instance by calling this operation, the value of this parameter must be the same as that of the source instance.'."\n" + .'>'."\n" + .'> - For more information about the constraints on storage engines and database versions, see [Versions and storage engines](~~61906~~).', + 'type' => 'string', + 'required' => false, + 'default' => 'WiredTiger', + 'enum' => [ + 'WiredTiger', + 'RocksDB', + ], + 'example' => 'WiredTiger', + 'title' => '', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" + ."\n" + .'- **true**: Auto-renewal is enabled.'."\n" + ."\n" + .'- **false**: Auto-renewal is disabled. You must manually renew the instance. This is the default value.'."\n" + ."\n" + .'> This parameter is optional and takes effect only when you set the **ChargeType** parameter to **PrePaid**.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type of the instance. Valid values:'."\n" + ."\n" + .'- **mongodb**: MongoDB protocol.'."\n" + ."\n" + .'- **dynamodb**: DynamoDB protocol.', + 'type' => 'string', + 'required' => false, + 'default' => 'mongodb', + 'enum' => [ + 'mongodb', + 'dynamodb', + ], + 'example' => 'mongodb', + 'title' => '', + ], + ], + [ + 'name' => 'Mongos', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information of Mongos nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of Mongos nodes.', + 'type' => 'object', + 'properties' => [ + 'Class' => [ + 'description' => 'The instance type of the Mongos node. For more information, see [Sharded cluster instance types](~~311414~~).'."\n" + ."\n" + .'> - **N** in the parameter name specifies the serial number of the Mongos node. For example, **Mongos.2.Class** specifies the instance type of the second Mongos node.'."\n" + .'>'."\n" + .'> - The value of **N** ranges from **2** to **32**.', + 'type' => 'string', + 'required' => true, + 'example' => 'mdb.shard.2x.xlarge.d', + 'title' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 32, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ReplicaSet', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information of shard nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of shard nodes.', + 'type' => 'object', + 'properties' => [ + 'Class' => [ + 'description' => 'The instance type of the shard node. For more information, see [Sharded cluster instance types](~~311414~~).'."\n" + ."\n" + .'> - **N** in the parameter name specifies the serial number of the shard node. For example, **ReplicaSet.2.Class** specifies the instance type of the second shard node.'."\n" + .'>'."\n" + .'> - The value of **N** ranges from **2** to **32**.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds.shard.standard', + 'title' => '', + ], + 'Storage' => [ + 'description' => 'The storage space of the shard node. Unit: GB.'."\n" + ."\n" + .'> - The value of this parameter is constrained by the instance type. For more information, see [Sharded cluster instance types](~~311414~~).'."\n" + .'>'."\n" + .'> - **N** in the parameter name specifies the serial number of the shard node. For example, **ReplicaSet.2.Storage** specifies the storage space of the second shard node.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + 'title' => '', + ], + 'ReadonlyReplicas' => [ + 'description' => 'The number of read-only nodes in the shard node.'."\n" + ."\n" + .'Valid values: **0** to **5**. The default value is **0**.'."\n" + ."\n" + .'> **N** in the parameter name specifies the serial number of the shard node. For example, **ReplicaSet.2.ReadonlyReplicas** specifies the number of read-only nodes in the second shard node.', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '5', + 'minimum' => '0', + 'default' => '0', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 32, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ConfigServer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information of Configserver nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of Configserver nodes.', + 'type' => 'object', + 'properties' => [ + 'Class' => [ + 'description' => 'The instance type of the Configserver node. Valid values:'."\n" + ."\n" + .'- **mdb.shard.2x.xlarge.d**: 4-core 8 GB (dedicated). This instance type is available only for instances that run MongoDB 4.4 or later.'."\n" + ."\n" + .'- **dds.cs.mid**: 1-core 2 GB (general-purpose). This instance type is available only for instances that run MongoDB 4.2 or earlier.', + 'type' => 'string', + 'required' => true, + 'example' => 'mdb.shard.2x.xlarge.d', + 'title' => '', + ], + 'Storage' => [ + 'description' => 'The storage space of the Configserver node. Unit: GB.'."\n" + ."\n" + .'> The value of this parameter is constrained by the instance type. For more information, see [Sharded cluster instance types](~~311414~~).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 32, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The secondary zone 1 for multi-zone deployment. Valid values:'."\n" + ."\n" + .'- **cn-hangzhou-g**: Hangzhou Zone G.'."\n" + ."\n" + .'- **cn-hangzhou-h**: Hangzhou Zone H.'."\n" + ."\n" + .'- **cn-hangzhou-i**: Hangzhou Zone I.'."\n" + ."\n" + .'- **cn-hongkong-b**: Hong Kong (China) Zone B.'."\n" + ."\n" + .'- **cn-hongkong-c**: Hong Kong (China) Zone C.'."\n" + ."\n" + .'- **cn-hongkong-d**: Hong Kong (China) Zone D.'."\n" + ."\n" + .'- **cn-wulanchabu-a**: Ulanqab Zone A.'."\n" + ."\n" + .'- **cn-wulanchabu-b**: Ulanqab Zone B.'."\n" + ."\n" + .'- **cn-wulanchabu-c**: Ulanqab Zone C.'."\n" + ."\n" + .'- **ap-southeast-1a**: Singapore Zone A.'."\n" + ."\n" + .'- **ap-southeast-1b**: Singapore Zone B.'."\n" + ."\n" + .'- **ap-southeast-1c**: Singapore Zone C.'."\n" + ."\n" + .'- **ap-southeast-5a**: Jakarta Zone A.'."\n" + ."\n" + .'- **ap-southeast-5b**: Jakarta Zone B.'."\n" + ."\n" + .'- **ap-southeast-5c**: Jakarta Zone C.'."\n" + ."\n" + .'- **eu-central-1a**: Frankfurt Zone A.'."\n" + ."\n" + .'- **eu-central-1b**: Frankfurt Zone B.'."\n" + ."\n" + .'- **eu-central-1c**: Frankfurt Zone C.'."\n" + ."\n" + .'> * This parameter is available for disk-based instances.'."\n" + .'>'."\n" + .'> * The value of this parameter cannot be the same as the value of **ZoneId** or **HiddenZoneId**.'."\n" + .'>'."\n" + .'> * For more information about the multi-zone deployment policy for sharded cluster instances, see [Create a multi-zone sharded cluster instance](~~117865~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + ], + [ + 'name' => 'HiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The secondary zone 2 for multi-zone deployment. Valid values:'."\n" + ."\n" + .'- **cn-hangzhou-g**: Hangzhou Zone G.'."\n" + ."\n" + .'- **cn-hangzhou-h**: Hangzhou Zone H.'."\n" + ."\n" + .'- **cn-hangzhou-i**: Hangzhou Zone I.'."\n" + ."\n" + .'- **cn-hongkong-b**: Hong Kong (China) Zone B.'."\n" + ."\n" + .'- **cn-hongkong-c**: Hong Kong (China) Zone C.'."\n" + ."\n" + .'- **cn-hongkong-d**: Hong Kong (China) Zone D.'."\n" + ."\n" + .'- **cn-wulanchabu-a**: Ulanqab Zone A.'."\n" + ."\n" + .'- **cn-wulanchabu-b**: Ulanqab Zone B.'."\n" + ."\n" + .'- **cn-wulanchabu-c**: Ulanqab Zone C.'."\n" + ."\n" + .'- **ap-southeast-1a**: Singapore Zone A.'."\n" + ."\n" + .'- **ap-southeast-1b**: Singapore Zone B.'."\n" + ."\n" + .'- **ap-southeast-1c**: Singapore Zone C.'."\n" + ."\n" + .'- **ap-southeast-5a**: Jakarta Zone A.'."\n" + ."\n" + .'- **ap-southeast-5b**: Jakarta Zone B.'."\n" + ."\n" + .'- **ap-southeast-5c**: Jakarta Zone C.'."\n" + ."\n" + .'- **eu-central-1a**: Frankfurt Zone A.'."\n" + ."\n" + .'- **eu-central-1b**: Frankfurt Zone B.'."\n" + ."\n" + .'- **eu-central-1c**: Frankfurt Zone C.'."\n" + ."\n" + .'> * This parameter is available for disk-based instances.'."\n" + .'>'."\n" + .'> * The value of this parameter cannot be the same as the value of **ZoneId** or **SecondaryZoneId**.'."\n" + .'>'."\n" + .'> * For more information about the multi-zone deployment policy for sharded cluster instances, see [Create a multi-zone sharded cluster instance](~~117865~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + 'title' => '', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The storage type. Valid values:'."\n" + ."\n" + .'- **cloud\\_essd1**: enhanced SSD (ESSD) PL1.'."\n" + ."\n" + .'- **cloud\\_essd2**: ESSD PL2.'."\n" + ."\n" + .'- **cloud\\_essd3**: ESSD PL3.'."\n" + ."\n" + .'- **local\\_ssd**: local SSD.'."\n" + ."\n" + .'> * Instances that run MongoDB 4.4 or later support only disks. If you do not specify this parameter, **cloud\\_essd1** is used.'."\n" + .'>'."\n" + .'> * Instances that run MongoDB 4.2 or earlier support only local disks. If you do not specify this parameter, **local\\_ssd** is used.', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd1', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalSecurityGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The global IP address whitelist templates of the instance. Separate multiple templates with commas (,). Each template must be unique.', + 'type' => 'string', + 'required' => false, + 'example' => 'g-qxieqf40xjst1ngpr3jz ', + 'title' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The custom tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n" + ."\n" + .'> - **N** specifies the serial number of the tag. For example, **Tag.1.Key** specifies the key of the first tag, and **Tag.2.Key** specifies the key of the second tag.', + 'type' => 'string', + 'required' => false, + 'example' => 'testdatabase', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n" + ."\n" + .'> **N** specifies the serial number of the tag. For example, **Tag.1.Value** specifies the value of the first tag, and **Tag.2.Value** specifies the value of the second tag.', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + 'title' => '', + ], + ], + 'required' => false, + 'description' => 'The custom tags added to the instance.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Encrypted', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable disk encryption.', + 'type' => 'boolean', + 'default' => 'false', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom key ID.', + 'type' => 'string', + 'required' => false, + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => 'The provisioned IOPS.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1960', + 'title' => '', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region of the source instance.'."\n" + ."\n" + .'> - This parameter is required when you recreate a released instance from a backup.'."\n" + .'>'."\n" + .'> - This parameter is required when you clone an instance from a geo-redundant backup.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster backup ID.'."\n" + ."\n" + .'> - This parameter is required only when RestoreType is set to 2 or 3.', + 'type' => 'string', + 'required' => false, + 'example' => 'cb-xxx', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup-based instance restoration method.'."\n" + ."\n" + .'- 1: Restore the instance to a specific point in time.'."\n" + ."\n" + .'- 2: Restore a released instance from a specific backup set.'."\n" + ."\n" + .'- 3: Restore the instance from a specific geo-redundant backup set.', + 'type' => 'string', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the geo-redundant backup is stored.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + 'title' => '', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-bp114f14849d****', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'example' => '21010996721****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityRisk.AuthVerification', + 'errorMessage' => 'we have detected a risk with your default payment method. An email and notification has been sent to you. Please re-submit your order before after verificaiton.', + 'description' => '', + ], + [ + 'errorCode' => 'InvaliadParameter.ShardsCount.LessThanSrc', + 'errorMessage' => 'The specified number of shards is less than that of source instance.', + 'description' => '', + ], + [ + 'errorCode' => 'ORDER.ACCOUNT_INFORMATION_INCOMPLETE', + 'errorMessage' => 'Your information is incomplete. Complete your information before ordering.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidRegion.Format', + 'errorMessage' => 'Specified Region is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'Zone.Closed', + 'errorMessage' => 'The specified zone is closed.', + 'description' => '', + ], + [ + 'errorCode' => 'TokenServiceError', + 'errorMessage' => 'The request token is duplicated.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Param not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEngineVersion.Malformed', + 'errorMessage' => 'Specified engine version is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => 'The parameter entered is invalid.', + ], + [ + 'errorCode' => 'RestoreTypeNotSupported', + 'errorMessage' => 'The specified restoreType is not supported for the instance, check the input parameters \'RestoreType/BackupID/RestoreTime\'.', + 'description' => 'The specified restoreType is not supported for the instance, check the input parameters \'RestoreType/BackupID/RestoreTime\'.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidBackupLogStatus', + 'errorMessage' => 'Current backup log enable status does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'ReduceDiskNotSupport', + 'errorMessage' => 'Reduce disk size is not supported in clone/restore.', + 'description' => 'Reduce disk size is not supported in clone/restore.', + ], + ], + 500 => [ + [ + 'errorCode' => 'VpcServiceError', + 'errorMessage' => 'Invoke vpc service error.', + 'description' => '', + ], + ], + ], + 'title' => 'CreateShardingDBInstance', + 'summary' => 'Creates or clones a MongoDB sharded cluster instance.', + 'description' => '- Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props> of ApsaraDB for MongoDB.'."\n" + ."\n" + .'- For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](~~57141~~).'."\n" + ."\n" + .'- To create a standalone or replica set instance, you can call the [CreateDBInstance](~~61763~~) operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateShardingDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8F1D721-6439-4257-A89C-F1E8E9C9****\\",\\n \\"DBInstanceId\\": \\"dds-bp114f14849d****\\",\\n \\"OrderId\\": \\"21010996721****\\"\\n}","type":"json"}]', + ], + 'DeleteBackup' => [ + 'summary' => 'Deletes a MongoDB backup set.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '273122', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dds-bp11483712c1****', + 'title' => '', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup ID.', + 'type' => 'string', + 'required' => true, + 'example' => '5664****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '7A9807F0-1301-4154-9849-6497E94A****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBackupMethod.ValueNotSupport', + 'errorMessage' => 'The specified parameter BackupMethod is not valid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.BackupJobExists', + 'errorMessage' => 'The operation is not permitted due to backup job exist.', + 'description' => 'A backup task is in progress. Try again later.', + ], + [ + 'errorCode' => 'OperationDenied.NoDatabase', + 'errorMessage' => 'The operation is not permitted due to no database.', + 'description' => '', + ], + ], + ], + 'title' => 'DeleteBackup', + 'description' => 'You can delete only manual backups.'."\n" + ."\n" + .'This operation supports only MongoDB instances that use cloud disks.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A9807F0-1301-4154-9849-6497E94A****\\"\\n}","type":"json"}]', + ], + 'DeleteDBInstance' => [ + 'summary' => 'Releases a pay-as-you-go MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A token that ensures the idempotence of the request. The client generates this value, which must be unique among different requests. The value can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '72651AF9-7897-41A7-8B67-6C15C7F26A0A', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ChargeTypeViolation', + 'errorMessage' => 'The operation is not permitted due to charge type of the instance. ', + 'description' => '', + ], + [ + 'errorCode' => 'GadInstanceNotSupport', + 'errorMessage' => 'GAD Instance doesn\'t support the operation.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'InstanceReleaseProtection', + 'errorMessage' => 'The operation is not permitted due to instance release protection.', + 'description' => '', + ], + ], + ], + 'title' => 'DeleteDBInstance', + 'description' => 'The instance must meet the following conditions:'."\n" + ."\n" + .'- The instance status is running.'."\n" + ."\n" + .'- The billing method of the instance is pay-as-you-go.'."\n" + ."\n" + .'> After an instance is released, its data cannot be recovered. Proceed with caution.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DeleteDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72651AF9-7897-41A7-8B67-6C15C7F26A0A\\"\\n}","type":"json"}]', + ], + 'DeleteGlobalSecurityIPGroup' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '168662', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~61933~~) operation to query the latest list of regions.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP address whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'- It must consist of lowercase letters, digits, and underscores (\\_).'."\n" + ."\n" + .'- It must start with a letter and end with a letter or a digit.'."\n" + ."\n" + .'- It must be 2 to 120 characters in length.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'corp', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the IP address whitelist template.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'g-qxieqf40xjst1ngpr3jz', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request. If you encounter an issue, provide this request ID to our support staff for troubleshooting.', + 'type' => 'string', + 'example' => '2F42BB4E-461F-5B55-A37C-53B1141C****', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DeleteGlobalSecurityIPGroup', + 'summary' => 'Deletes a global IP address whitelist template.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DeleteGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2F42BB4E-461F-5B55-A37C-53B1141C****\\"\\n}","type":"json"}]', + ], + 'DeleteNode' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard or mongos node that you want to delete. You can call the [DescribeDBInstanceAttribute](~~61923~~) operation to query node IDs.', + 'type' => 'string', + 'required' => true, + 'example' => 's-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + '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 generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The ID of the task.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '111111111', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '9F9BDE64-BF30-41F3-BD29-C19CE4AB3404', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'example' => '111111111111111', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DeleteNode', + 'summary' => 'Deletes a shard or mongos node from an ApsaraDB for MongoDB sharded cluster instance.', + 'description' => 'Before you call this operation, make sure that the instance meets the following requirements:'."\n" + ."\n" + .'- The instance is in the Running state.'."\n" + ."\n" + .'- The instance is a sharded cluster instance.'."\n" + ."\n" + .'- The billing method of the instance is pay-as-you-go.'."\n" + ."\n" + .'- The number of the shard or mongos nodes in the instance is greater than two.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DeleteNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": 111111111,\\n \\"RequestId\\": \\"9F9BDE64-BF30-41F3-BD29-C19CE4AB3404\\",\\n \\"OrderId\\": \\"111111111111111\\"\\n}","type":"json"}]', + ], + 'DescribeAccounts' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1fd530f271****', + 'title' => '', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account. Set the value to **root**.', + 'type' => 'string', + 'required' => false, + 'example' => 'root', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'B562A65B-39AB-4EE8-8635-5A222054FB35', + 'title' => '', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => 'The details of the account.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CharacterType' => [ + 'description' => 'The role of the account. Valid values:'."\n" + ."\n" + .'- **db**: shard node'."\n" + ."\n" + .'- **cs**: Configserver node'."\n" + ."\n" + .'- **mongos**: mongos node'."\n" + ."\n" + .'- **logic**: sharded cluster instance'."\n" + ."\n" + .'- **normal**: replica set instance', + 'type' => 'string', + 'example' => 'mongos', + 'title' => '', + ], + 'AccountStatus' => [ + 'description' => 'The status of the account. Valid values:'."\n" + ."\n" + .'- **Unavailable**'."\n" + ."\n" + .'- **Available**', + 'type' => 'string', + 'default' => 'Unavailable', + 'example' => 'Available', + 'title' => '', + ], + 'AccountDescription' => [ + 'description' => 'The description of the account.', + 'type' => 'string', + 'example' => '管理员', + 'title' => '', + ], + 'DBInstanceId' => [ + 'description' => 'The ID of the instance to which the account belongs.', + 'type' => 'string', + 'example' => 'dds-bp1fd530f271****', + 'title' => '', + ], + 'AccountName' => [ + 'description' => 'The name of the account.', + 'type' => 'string', + 'example' => 'root', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ResponseEmptyError', + 'errorMessage' => 'The Response is empty, maybe server request timeout.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeAccounts', + 'summary' => 'Queries the database accounts of an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B562A65B-39AB-4EE8-8635-5A222054FB35\\",\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"CharacterType\\": \\"mongos\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountDescription\\": \\"管理员\\",\\n \\"DBInstanceId\\": \\"dds-bp1fd530f271****\\",\\n \\"AccountName\\": \\"root\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeActiveOperationMaintenanceConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '37473', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HasConfig' => [ + 'description' => 'Indicates whether a configuration is set.'."\n" + ."\n" + .'- 1: A configuration is set.'."\n" + ."\n" + .'- 0: No configuration is set.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '72651AF9-7897-41A7-8B67-6C15C7F26A0A', + 'title' => '', + ], + 'Config' => [ + 'description' => 'The details of the configuration.', + 'type' => 'object', + 'properties' => [ + 'CycleType' => [ + 'description' => 'The cycle type.'."\n" + ."\n" + .'- Month'."\n" + ."\n" + .'- Week', + 'type' => 'string', + 'example' => 'Month', + 'title' => '', + ], + 'Status' => [ + 'description' => 'Indicates whether the configuration is enabled.'."\n" + ."\n" + .'- 1: Enabled'."\n" + ."\n" + .'- 2: Disabled', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'The time when the operations and maintenance (O\\&M) task configuration was modified. The time is in the *yyyy-mm-dd*T*hh:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'example' => '2024-05-30T14:30:00Z', + 'title' => '', + ], + 'MaintainStartTime' => [ + 'description' => 'The start time of the O\\&M time window. The time is in the *hh:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'example' => '18:00:00Z', + 'title' => '', + ], + 'MaintainEndTime' => [ + 'description' => 'The end time of the O\\&M time window. The time is in the *hh:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'example' => '20:00:00Z'."\n", + 'title' => '', + ], + 'CycleTime' => [ + 'description' => 'The days of the cycle.'."\n" + ."\n" + .'- If CycleType is set to Month, this parameter returns the days of the month. Valid values: 1 to 28. Multiple values are separated by commas (,).'."\n" + ."\n" + .'- If CycleType is set to Week, this parameter returns the days of the week. Valid values: 1 to 7. Multiple values are separated by commas (,).', + 'type' => 'string', + 'example' => '1,2,3', + 'title' => '', + ], + 'CreatedTime' => [ + 'description' => 'The time when the O\\&M task configuration was created. The time is in the *yyyy-mm-dd*T*hh:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeActiveOperationMaintenanceConfig', + 'summary' => 'Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationMaintenanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HasConfig\\": 0,\\n \\"RequestId\\": \\"72651AF9-7897-41A7-8B67-6C15C7F26A0A\\",\\n \\"Config\\": {\\n \\"CycleType\\": \\"Month\\",\\n \\"Status\\": 1,\\n \\"ModifiedTime\\": \\"2024-05-30T14:30:00Z\\",\\n \\"MaintainStartTime\\": \\"18:00:00Z\\",\\n \\"MaintainEndTime\\": \\"20:00:00Z\\\\n\\",\\n \\"CycleTime\\": \\"1,2,3\\",\\n \\"CreatedTime\\": \\"2018-05-30T14:30:00Z\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeActiveOperationTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8253', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance.'."\n" + ."\n" + .'> If you set the Region parameter to **all**, all tasks created within your Alibaba Cloud account are queried. In this case, you must set the **taskType** parameter to **all**.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + 'title' => '', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'- rds\\_apsaradb\\_ha: master-replica switchover'."\n" + ."\n" + .'- rds\\_apsaradb\\_transfer: instance migration'."\n" + ."\n" + .'- rds\\_apsaradb\\_upgrade: minor version update', + 'type' => 'string', + 'required' => true, + 'example' => 'rds_apsaradb_ha', + 'title' => '', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the historical tasks.'."\n" + ."\n" + .'Default value: 0. Valid values:'."\n" + ."\n" + .'- 0: returns the current task.'."\n" + ."\n" + .'- 1: returns the historical tasks.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Specify a value greater than 10. Default value: 30.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'default' => '30', + 'example' => '30', + 'title' => '', + ], + ], + [ + '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.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the product.', + 'type' => 'string', + 'required' => false, + 'example' => 'MongoDB', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '6FD47DC4-0750-5524-A89E-E7D559Cxxxxx', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Items' => [ + 'description' => 'The list of tasks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The state of the task. Valid values:'."\n" + ."\n" + .'- 2: The task is waiting for users to specify a switchover time.'."\n" + ."\n" + .'- 3: The task is waiting to be performed.'."\n" + ."\n" + .'- 4: The task is being performed. If the task is in this state, the ModifyActiveOperationTask operation cannot be called to modify the scheduled switchover time.'."\n" + ."\n" + .'- 5: The task is performed.'."\n" + ."\n" + .'- 6: The task fails.'."\n" + ."\n" + .'- 7: The task is canceled.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'TaskParams' => [ + 'description' => 'The task parameters.', + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + 'PrepareInterval' => [ + 'description' => 'The required preparation period between the task start time and the switchover time. The time is displayed in the HH:mm:ss format.', + 'type' => 'string', + 'example' => '14:00:00', + 'title' => '', + ], + 'Deadline' => [ + 'description' => 'The deadline before which the time to preform the task can be modified. The time in UTC is displayed in the yyyy-MM-ddTHH:mm:ssZ format.', + 'type' => 'string', + 'example' => '2023-03-29T13:59:59Z', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'The time when the task was preformed. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-03-20T02:40:00Z', + 'title' => '', + ], + 'TaskType' => [ + 'description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'- rds\\_apsaradb\\_ha: master-replica switchover'."\n" + ."\n" + .'- rds\\_apsaradb\\_transfer: instance migration'."\n" + ."\n" + .'- rds\\_apsaradb\\_upgrade: minor version update'."\n" + ."\n" + .'- all: all types', + 'type' => 'string', + 'example' => 'rds_apsaradb_ha', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'The time when the task was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-02-24T08:18:53Z', + 'title' => '', + ], + 'InsName' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-bp12721xxxx9b914', + 'title' => '', + ], + 'DbType' => [ + 'description' => 'The database type of the instance.', + 'type' => 'string', + 'example' => 'mongodb', + 'title' => '', + ], + 'Region' => [ + 'description' => 'The region of the instance.', + 'type' => 'string', + 'example' => 'cn-beijing', + 'title' => '', + ], + 'ResultInfo' => [ + 'description' => 'The result information.', + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + 'CreatedTime' => [ + 'description' => 'The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2024-11-06T13:11:08Z', + 'title' => '', + ], + 'Id' => [ + 'description' => 'The task ID.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50xx', + 'title' => '', + ], + 'SwitchTime' => [ + 'description' => 'The time when the system performs the switchover operation. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2024-11-06T14:11:08Z'."\n", + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeActiveOperationTask', + 'summary' => 'Queries the detailed information about tasks of an ApsaraDB for MongoDB instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 0,\\n \\"RequestId\\": \\"6FD47DC4-0750-5524-A89E-E7D559Cxxxxx\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 2,\\n \\"TaskParams\\": \\"\\\\\\"\\\\\\"\\",\\n \\"PrepareInterval\\": \\"14:00:00\\",\\n \\"Deadline\\": \\"2023-03-29T13:59:59Z\\",\\n \\"StartTime\\": \\"2023-03-20T02:40:00Z\\",\\n \\"TaskType\\": \\"rds_apsaradb_ha\\",\\n \\"ModifiedTime\\": \\"2023-02-24T08:18:53Z\\",\\n \\"InsName\\": \\"dds-bp12721xxxx9b914\\",\\n \\"DbType\\": \\"mongodb\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"ResultInfo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreatedTime\\": \\"2024-11-06T13:11:08Z\\",\\n \\"Id\\": 0,\\n \\"SwitchTime\\": \\"2024-11-06T14:11:08Z\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeActiveOperationTaskCount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8254', + 'abilityTreeNodes' => [ + 'FEATUREmongodbKYZJ28', + 'FEATUREmongodbCG2XVB', + 'FEATUREmongodbW8WH59', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp5689ac****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '770D7F11-21A2-402B-9DF6-D1A620570EF9', + 'title' => '', + ], + 'NeedPop' => [ + 'description' => 'Indicates whether any O\\&M tasks need pop-up windows to notify users actions. Valid values:'."\n" + ."\n" + .'- **0**: No O\\&M tasks need pop-up windows to notify users actions.'."\n" + ."\n" + .'- **1**: Some O\\&M tasks need pop-up windows to notify users actions.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'TaskCount' => [ + 'description' => 'The number of pending O\\&M tasks.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeActiveOperationTaskCount', + 'summary' => 'Queries the number of operation and maintenance tasks on an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"770D7F11-21A2-402B-9DF6-D1A620570EF9\\",\\n \\"NeedPop\\": 0,\\n \\"TaskCount\\": 0\\n}","type":"json"}]', + ], + 'DescribeActiveOperationTaskRegion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '8255', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task type. Valid values:'."\n" + ."\n" + .'- rds\\_apsaradb\\_ha: a primary/secondary node switchover.'."\n" + ."\n" + .'- rds\\_apsaradb\\_transfer: an instance migration.'."\n" + ."\n" + .'- rds\\_apsaradb\\_upgrade: a minor version upgrade.', + 'type' => 'string', + 'required' => true, + 'example' => 'rds_apsaradb_upgrade', + 'title' => '', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return historical tasks. Valid values:'."\n" + ."\n" + .'- 0: The default value. Returns current tasks.'."\n" + ."\n" + .'- 1: Returns historical tasks.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '3C4A2494-XXXX-XXXX-93CF-548DB3375193', + 'title' => '', + ], + 'RegionList' => [ + 'description' => 'The list of regions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'example' => 'cn-beijing', + 'title' => '', + ], + 'Count' => [ + 'description' => 'The number of tasks.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'title' => 'Query maintenance task types and task quantities.', + 'summary' => 'Queries the types and number of O&M tasks for a MongoDB instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskRegion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C4A2494-XXXX-XXXX-93CF-548DB3375193\\",\\n \\"RegionList\\": [\\n {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeActiveOperationTaskType' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8256', + 'abilityTreeNodes' => [ + 'FEATUREmongodbKYZJ28', + 'FEATUREmongodbCG2XVB', + 'FEATUREmongodbW8WH59', + ], + ], + 'parameters' => [ + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return historical O\\&M tasks. Valid values:'."\n" + ."\n" + .'- **0** (default): The system returns only pending O\\&M tasks.'."\n" + ."\n" + .'- **1**: The system returns historical O\\&M tasks.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID. You can call the [DescribeSecurityGroupConfiguration](~~146130~~) operation to query the resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'C7EE83BF-7BA8-5087-BAC9-ED85ED54****', + 'title' => '', + ], + 'TypeList' => [ + 'description' => 'The O\\&M tasks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'- **rds\\_apsaradb\\_transfer**: data migration'."\n" + ."\n" + .'- **rds\\_apsaradb\\_upgrade**: minor version update', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + 'title' => '', + ], + 'TaskTypeInfoEn' => [ + 'description' => 'The task type in English.', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + 'title' => '', + ], + 'TaskTypeInfoZh' => [ + 'description' => 'The task type in Chinese.', + 'type' => 'string', + 'example' => '小版本升级', + 'title' => '', + ], + 'Count' => [ + 'description' => 'The number of pending tasks.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeActiveOperationTaskType', + 'summary' => 'Queries the types of Operation and Maintenance tasks and the number of tasks of each type for an ApsaraDB for MongoDB instance.', + 'description' => 'This operation is no longer updated and will be unavailable.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7EE83BF-7BA8-5087-BAC9-ED85ED54****\\",\\n \\"TypeList\\": [\\n {\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"TaskTypeInfoEn\\": \\"rds_apsaradb_upgrade\\",\\n \\"TaskTypeInfoZh\\": \\"小版本升级\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeActiveOperationTasks' => [ + 'summary' => 'Queries the details of scheduled operations and maintenance (O&M) tasks for a MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '37476', + 'abilityTreeNodes' => [ + 'FEATUREmongodbKYZJ28', + 'FEATUREmongodbCG2XVB', + 'FEATUREmongodbW8WH59', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the pending event is located. Call the DescribeRegions operation to obtain the region ID.'."\n" + ."\n" + .'> A value of **all** indicates all region IDs.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task type. Valid values:'."\n" + ."\n" + .'- **rds\\_apsaradb\\_ha**: primary-secondary node switchover.'."\n" + ."\n" + .'- **rds\\_apsaradb\\_transfer**: instance migration.'."\n" + ."\n" + .'- **rds\\_apsaradb\\_upgrade**: minor version upgrade.'."\n" + ."\n" + .'- **rds\\_apsaradb\\_maxscale**: proxy minor version upgrade.'."\n" + ."\n" + .'- **all**: all task types.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'all', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**. Default value: **30**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'default' => '30', + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be greater than **0**. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product name. For MongoDB instances, set this parameter to **MongoDB**.', + 'type' => 'string', + 'required' => false, + 'example' => 'MongoDB', + 'title' => '', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database type. Default value: **all**.', + 'type' => 'string', + 'required' => false, + 'example' => 'mongoDb', + 'title' => '', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task status. This parameter filters the returned tasks.'."\n" + ."\n" + .'- **-1**: all tasks.'."\n" + ."\n" + .'- **3**: pending tasks.'."\n" + ."\n" + .'- **4**: running tasks.'."\n" + ."\n" + .'- **5**: successfully completed tasks.'."\n" + ."\n" + .'- **6**: failed tasks.'."\n" + ."\n" + .'- **7**: canceled tasks.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + 'title' => '', + ], + ], + [ + 'name' => 'InsName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance. This parameter is optional. You can specify only one instance name.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp16aaccfe10****', + 'title' => '', + ], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the time can be changed. Valid values:'."\n" + ."\n" + .'- **-1** (default): returns all tasks.'."\n" + ."\n" + .'- **0**: returns only tasks whose time cannot be changed.'."\n" + ."\n" + .'- **1**: returns only tasks whose time can be changed.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + 'title' => '', + ], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the task can be canceled. Valid values:'."\n" + ."\n" + .'- **-1** (default): returns all tasks.'."\n" + ."\n" + .'- **0**: returns only tasks that cannot be canceled.'."\n" + ."\n" + .'- **1**: returns only tasks that can be canceled.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + 'title' => '', + ], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the task. Valid values:'."\n" + ."\n" + .'- **all** (default): returns all tasks.'."\n" + ."\n" + .'- **S0**: returns tasks for exception fixing.'."\n" + ."\n" + .'- **S1**: returns tasks for system O\\&M.', + 'type' => 'string', + 'required' => false, + 'example' => '***', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '111E7B16-0A87-4CBA-B271-F34AD61E****', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'TotalRecordCount' => [ + 'description' => 'The number of returned task records.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Items' => [ + 'description' => 'The list of O\\&M tasks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The task status.'."\n" + ."\n" + .'- **3**: pending.'."\n" + ."\n" + .'- **4**: running.'."\n" + ."\n" + .'- **5**: successful.'."\n" + ."\n" + .'- **6**: failed.'."\n" + ."\n" + .'- **7**: canceled.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'ChangeLevelEn' => [ + 'description' => 'The event level in English.', + 'type' => 'string', + 'example' => 'System maintenance', + 'title' => '', + ], + 'TaskType' => [ + 'description' => 'The task type. Valid values:'."\n" + ."\n" + .'- **rds\\_apsaradb\\_ha**: primary-secondary node switchover.'."\n" + ."\n" + .'- **rds\\_apsaradb\\_transfer**: instance migration.'."\n" + ."\n" + .'- **rds\\_apsaradb\\_upgrade**: minor version upgrade.'."\n" + ."\n" + .'- **rds\\_apsaradb\\_maxscale**: proxy minor version upgrade.'."\n" + ."\n" + .'- **all**: all task types.', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + 'title' => '', + ], + 'InsName' => [ + 'description' => 'The instance name.', + 'type' => 'string', + 'example' => 'dds-bp16aaccfe10****', + 'title' => '', + ], + 'Region' => [ + 'description' => 'The ID of the region where the pending event is located.', + 'type' => 'string', + 'example' => 'cn-beijing'."\n", + 'title' => '', + ], + 'ImpactZh' => [ + 'description' => 'The impact of the event in Chinese.', + 'type' => 'string', + 'example' => '实例闪断', + 'title' => '', + ], + 'CreatedTime' => [ + 'description' => 'The time when the task was created. The time is in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-05-30T14:30:00Z', + 'title' => '', + ], + 'SwitchTime' => [ + 'description' => 'The time when the switchover was initiated. The time is in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-05-30T14:30:00Z', + 'title' => '', + ], + 'ChangeLevelZh' => [ + 'description' => 'The event level in Chinese.', + 'type' => 'string', + 'example' => '系统运维', + 'title' => '', + ], + 'Deadline' => [ + 'description' => 'The latest time to which the task execution time can be postponed. The time is in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-05-30T23:59:59Z', + 'title' => '', + ], + 'PrepareInterval' => [ + 'description' => 'The preparation time required between the start time of the O\\&M task and the switchover time. The time is in the *HH:mm:ss* format.', + 'type' => 'string', + 'example' => '04:00:00', + 'title' => '', + ], + 'TaskTypeZh' => [ + 'description' => 'The reason for the task in Chinese.', + 'type' => 'string', + 'example' => '小版本升级', + 'title' => '', + ], + 'CurrentAVZ' => [ + 'description' => 'The current zone.', + 'type' => 'string', + 'example' => 'cn-beijing-h', + 'title' => '', + ], + 'AllowChange' => [ + 'description' => 'Indicates whether the time can be changed.'."\n" + ."\n" + .'- **1**: The time can be changed.'."\n" + ."\n" + .'- **0**: The time cannot be changed.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'DbVersion' => [ + 'description' => 'The database engine version number.', + 'type' => 'string', + 'example' => '5.6', + 'title' => '', + ], + 'ImpactEn' => [ + 'description' => 'The impact of the event in English.', + 'type' => 'string', + 'example' => 'Transient instance disconnection'."\n", + 'title' => '', + ], + 'InsComment' => [ + 'description' => 'The alias or description of the instance.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'The time when the task was executed. The time is in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-05-30T00:00:00Z', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'The time when the task was modified. The time is in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-05-30T14:30:00Z'."\n", + 'title' => '', + ], + 'AllowCancel' => [ + 'description' => 'Indicates whether the task can be canceled.'."\n" + ."\n" + .'- **1**: The task can be canceled.'."\n" + ."\n" + .'- **0**: The task cannot be canceled.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'DbType' => [ + 'description' => 'The database engine type.', + 'type' => 'string', + 'example' => 'mongoDb', + 'title' => '', + ], + 'ChangeLevel' => [ + 'description' => 'The code of the event level.'."\n" + ."\n" + .'- **S1**: system O\\&M.'."\n" + ."\n" + .'- **S0**: threat fixing.', + 'type' => 'string', + 'example' => 'S1', + 'title' => '', + ], + 'TaskTypeEn' => [ + 'description' => 'The reason for the task in English.', + 'type' => 'string', + 'example' => 'Minor version update'."\n", + 'title' => '', + ], + 'ResultInfo' => [ + 'description' => 'The information about the execution result.', + 'type' => 'string', + 'example' => 'userCancel', + 'title' => '', + ], + 'Id' => [ + 'description' => 'The task ID.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11111', + 'title' => '', + ], + 'SubInsNames' => [ + 'description' => 'The list of child instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the child instance.', + 'type' => 'string', + 'example' => 'sub1369716295573-tes2cy6****.2013052818****', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TaskParams' => [ + 'description' => 'The task parameters.', + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + ], + 'description' => 'The list of O\\&M tasks.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeActiveOperationTasks', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"111E7B16-0A87-4CBA-B271-F34AD61E****\\",\\n \\"PageSize\\": 30,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 3,\\n \\"ChangeLevelEn\\": \\"System maintenance\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"InsName\\": \\"dds-bp16aaccfe10****\\",\\n \\"Region\\": \\"cn-beijing\\\\n\\",\\n \\"ImpactZh\\": \\"实例闪断\\",\\n \\"CreatedTime\\": \\"2023-05-30T14:30:00Z\\",\\n \\"SwitchTime\\": \\"2023-05-30T14:30:00Z\\",\\n \\"ChangeLevelZh\\": \\"系统运维\\",\\n \\"Deadline\\": \\"2023-05-30T23:59:59Z\\",\\n \\"PrepareInterval\\": \\"04:00:00\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\",\\n \\"CurrentAVZ\\": \\"cn-beijing-h\\",\\n \\"AllowChange\\": \\"1\\",\\n \\"DbVersion\\": \\"5.6\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\\\n\\",\\n \\"InsComment\\": \\"test\\",\\n \\"StartTime\\": \\"2023-05-30T00:00:00Z\\",\\n \\"ModifiedTime\\": \\"2023-05-30T14:30:00Z\\\\n\\",\\n \\"AllowCancel\\": \\"1\\",\\n \\"DbType\\": \\"mongoDb\\",\\n \\"ChangeLevel\\": \\"S1\\",\\n \\"TaskTypeEn\\": \\"Minor version update\\\\n\\",\\n \\"ResultInfo\\": \\"userCancel\\",\\n \\"Id\\": 11111,\\n \\"SubInsNames\\": [\\n \\"sub1369716295573-tes2cy6****.2013052818****\\"\\n ],\\n \\"TaskParams\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAuditLogFilter' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + 'title' => '', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of the node in the instance. Valid values:'."\n" + ."\n" + .'* **mongos**: mongos node.'."\n" + .'* **db** : shard node.'."\n" + .'* **logic** : logical instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'logic', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7BAFB0B3-2A54-5B65-B13E-3937CF08FEE6', + 'title' => '', + ], + 'Filter' => [ + 'description' => 'The type of the audit log entries. Valid values:'."\n" + ."\n" + .'* **admin**: O\\&M and management operations'."\n" + .'* **slow**: slow query logs'."\n" + .'* **query**: query operations'."\n" + .'* **insert**: insert operations'."\n" + .'* **update**: update operations'."\n" + .'* **delete**: delete operations'."\n" + .'* **command**: protocol commands such as the aggregate method'."\n", + 'type' => 'string', + 'example' => 'admin,slow,insert,query,update,delete,command', + 'title' => '', + ], + 'RoleType' => [ + 'description' => 'The role of the node.'."\n", + 'type' => 'string', + 'example' => 'logic', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeAuditLogFilter', + 'summary' => 'Queries the types of entries in the audit log collected for an ApsaraDB for MongoDB instance.', + 'description' => '* The instance must be in the running state when you call this operation.'."\n" + .'* This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.'."\n" + .'* You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAuditLogFilter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7BAFB0B3-2A54-5B65-B13E-3937CF08FEE6\\",\\n \\"Filter\\": \\"admin,slow,insert,query,update,delete,command\\",\\n \\"RoleType\\": \\"logic\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeAuditLogFilterResponse>\\n <RequestId>7BAFB0B3-2A54-5B65-B13E-3937CF08FEE6</RequestId>\\n <Filter>admin</Filter>\\n</DescribeAuditLogFilterResponse>","errorExample":""}]', + ], + 'DescribeAuditPolicy' => [ + 'summary' => 'Queries whether the audit log feature is enabled for a MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmongodb41X9VC', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'dds-bp12c5b040dc****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '111E7B16-0A87-4CBA-B271-F34AD61E099F', + ], + 'LogAuditStatus' => [ + 'description' => 'The status of the audit log.'."\n" + ."\n" + .'- Enable: The audit log is enabled.'."\n" + ."\n" + .'- Disabled: The audit log is disabled.'."\n" + ."\n" + .'The default value is Disabled.', + 'type' => 'string', + 'title' => '', + 'example' => 'Enable', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBInstance.Malformed', + 'errorMessage' => 'Too many instance ids or instance id format is invalid.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeAuditPolicy', + 'description' => '- The instance must be in the running state.'."\n" + ."\n" + .'- This operation is available only for **General-purpose Local Disk Edition** and **Dedicated Local Disk Edition** instances.'."\n" + ."\n" + .'- You can call this operation up to 30 times per minute. Calls that exceed this limit are throttled. To make frequent calls, use Log Service. For more information, see [Manage a Logstore](~~48990~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAuditPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"111E7B16-0A87-4CBA-B271-F34AD61E099F\\",\\n \\"LogAuditStatus\\": \\"Enable\\"\\n}","type":"json"}]', + ], + 'DescribeAuditRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a Mongos node or a shard node in the sharded cluster instance.'."\n" + ."\n" + .'> This parameter is available only when **DBInstanceId** is set to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp128a003436****', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.', + 'type' => 'string', + 'required' => true, + 'example' => '2019-03-13T12:11:14Z', + 'title' => '', + ], + ], + [ + '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:ss*Z format. The time must be in UTC.'."\n" + ."\n" + .'> The time range between the start time and the end time cannot exceed 24 hours. Otherwise, the operation fails.', + 'type' => 'string', + 'required' => true, + 'example' => '2019-03-13T13:11:14Z', + 'title' => '', + ], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database. By default, all databases are queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'database****', + 'title' => '', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account. By default, all accounts are queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'Form', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format of the returned audit records. Valid values:'."\n" + ."\n" + .'- **File**: Triggers the generation of an audit log file. If you set this parameter to File, only common parameters are returned.'."\n" + ."\n" + .'- **Stream** (default): Returns a data stream.'."\n" + ."\n" + .'> The **File** parameter is deprecated.', + 'type' => 'string', + 'required' => false, + 'default' => 'Stream', + 'enum' => [ + 'File', + 'Stream', + ], + 'example' => 'Stream', + 'title' => '', + ], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keywords for the query. You can specify up to 10 keywords. Separate multiple keywords with spaces.', + 'type' => 'string', + 'required' => false, + 'example' => 'slow', + 'title' => '', + ], + ], + [ + 'name' => 'LogicalOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logical operator for the keyword search. The default value is and.', + 'type' => 'string', + 'default' => 'and', + 'enum' => [ + 'and', + 'or', + ], + 'required' => false, + 'example' => 'and', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **30** (default), **50**, and **100**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '30', + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number to return. The value must be greater than 0 and must not exceed the maximum value of the integer data type. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which to sort the returned audit log entries by time. Valid values:'."\n" + ."\n" + .'- **asc**: Sorts the entries in ascending order.'."\n" + ."\n" + .'- **desc**: Sorts the entries in descending order.', + 'type' => 'string', + 'required' => false, + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + 'example' => 'asc', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of entries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + 'title' => '', + ], + 'PageRecordCount' => [ + 'description' => 'The number of entries on the current page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '3278BEB8-503B-4E46-8F7E-D26E040C9769', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SQLRecord' => [ + 'description' => 'The list of audit log details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an audit log entry.', + 'type' => 'object', + 'properties' => [ + 'HostAddress' => [ + 'description' => 'The IP address of the client.', + 'type' => 'string', + 'example' => '11.xxx.xxx.xxx', + 'title' => '', + ], + 'TableName' => [ + 'description' => 'The name of the MongoDB collection.', + 'type' => 'string', + 'example' => 'C1', + 'title' => '', + ], + 'ReturnRowCounts' => [ + 'description' => 'The number of returned rows.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'title' => '', + ], + 'DBName' => [ + 'description' => 'The database name.', + 'type' => 'string', + 'example' => 'test123', + 'title' => '', + ], + 'ExecuteTime' => [ + 'description' => 'The time when the statement was executed. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'example' => '2019-03-11T03:30:27Z', + 'title' => '', + ], + 'ThreadID' => [ + 'description' => 'The thread ID.', + 'type' => 'string', + 'example' => '140682188297984', + 'title' => '', + ], + 'TotalExecutionTimes' => [ + 'description' => 'The execution time, in microseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '700', + 'title' => '', + ], + 'Syntax' => [ + 'description' => 'The executed statement.', + 'type' => 'string', + 'example' => '{ \\"atype\\" : \\"createCollection\\", \\"param\\" : { \\"ns\\" : \\"123.test1\\" }, \\"result\\": \\"OK\\" }', + 'title' => '', + ], + 'AccountName' => [ + 'description' => 'The name of the database account.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Format', + 'errorMessage' => 'Specified start time is not valid.', + 'description' => 'The specified start time is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Format', + 'errorMessage' => 'Specified end time is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEndTime.Invalid', + 'errorMessage' => 'Specified end time is before this service active time.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidQueryKeyword.Format', + 'errorMessage' => 'Specified Query Keyword is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidDatabase.Format', + 'errorMessage' => 'Specified Database is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidQueryTime.Format', + 'errorMessage' => 'Specified query time is not valid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'IncorrectSQLLogActiveStatus', + 'errorMessage' => 'Current DB instance SQL log active status does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'LogApiFrequencyExceeded', + 'errorMessage' => 'Exceeding the allowed frequency of log api.', + 'description' => '', + ], + [ + 'errorCode' => 'ConcurrentTaskExceeded', + 'errorMessage' => 'Concurrent task exceeding the allowed amount.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeAuditRecords', + 'summary' => 'Queries the audit logs of a MongoDB instance.', + 'description' => '- When you call this operation, ensure that the audit log feature of the instance is enabled. Otherwise, the operation returns an empty audit log.'."\n" + ."\n" + .'- This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.'."\n" + ."\n" + .'- You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAuditRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 40,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"3278BEB8-503B-4E46-8F7E-D26E040C9769\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"SQLRecord\\": [\\n {\\n \\"HostAddress\\": \\"11.xxx.xxx.xxx\\",\\n \\"TableName\\": \\"C1\\",\\n \\"ReturnRowCounts\\": 2,\\n \\"DBName\\": \\"test123\\",\\n \\"ExecuteTime\\": \\"2019-03-11T03:30:27Z\\",\\n \\"ThreadID\\": \\"140682188297984\\",\\n \\"TotalExecutionTimes\\": 700,\\n \\"Syntax\\": \\"{ \\\\\\\\\\\\\\"atype\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"createCollection\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"param\\\\\\\\\\\\\\" : { \\\\\\\\\\\\\\"ns\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"123.test1\\\\\\\\\\\\\\" }, \\\\\\\\\\\\\\"result\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"OK\\\\\\\\\\\\\\" }\\",\\n \\"AccountName\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAvailabilityZones' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '88755', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query the latest available regions.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query available zones.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the product. Valid values:'."\n" + ."\n" + .'- **PrePaid**: subscription'."\n" + ."\n" + .'- **PostPaid:** pay-as-you-go', + 'type' => 'string', + 'required' => false, + 'default' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + 'example' => 'PrePaid', + 'title' => '', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The architecture of the instance. Valid values:'."\n" + ."\n" + .'- **normal**: replica set instance'."\n" + ."\n" + .'- **sharding**: sharded cluster instance', + 'type' => 'string', + 'default' => 'normal', + 'enum' => [ + 'normal', + 'sharding', + ], + 'required' => false, + 'example' => 'normal', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. For more information, see [View basic information of a resource group](~~151181~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmx2m4rqu7pry', + 'title' => '', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the returned **RegionName** and **ZoneName** parameter values. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', + 'type' => 'string', + 'default' => 'zh', + 'required' => false, + 'example' => 'zh', + 'title' => '', + ], + ], + [ + 'name' => 'StorageSupport', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage type. Valid values:'."\n" + ."\n" + .'- **cloud**: displays only zones available for instances that use cloud disks.'."\n" + ."\n" + .'- **local**: only displays zones available for instances that use local disks instances.'."\n" + ."\n" + .'- **default** or unspecified: displays zones available for instances that use cloud disks and those that use local disks.', + 'type' => 'string', + 'default' => 'default', + 'title' => '', + 'required' => false, + 'example' => 'local', + ], + ], + [ + 'name' => 'MongoType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The edition of the instance. High-Available Edition and Preview Edition (dbfs) are supported.', + 'type' => 'string', + 'default' => 'default', + 'title' => '', + 'required' => false, + 'example' => 'dbfs', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage type. Valid values:'."\n" + ."\n" + .'- **cloud\\_essd1**: PL1 Enterprise SSDs (ESSDs)'."\n" + ."\n" + .'- **cloud\\_essd2**: PL2 ESSDs'."\n" + ."\n" + .'- **cloud\\_essd3**: PL3 ESSDs'."\n" + ."\n" + .'- **local\\_ssd**: local SSDs'."\n" + ."\n" + .'> * Instances that run MongoDB 4.4 or later only use cloud disks to store data. If you do not specify this parameter, the value **cloud\\_essd1** is used by default.'."\n" + .'>'."\n" + .'> * Instances that run MongoDB 4.2 and earlier only use local disks to store data. If you do not specify this parameter, the value **local\\_ssd** is used by default.', + 'type' => 'string', + 'default' => 'default', + 'required' => false, + 'example' => 'local_ssd', + 'title' => '', + ], + ], + [ + 'name' => 'ExcludeZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID that is excluded from the query results.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-g', + 'title' => '', + ], + ], + [ + 'name' => 'ExcludeSecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The secondary zone ID that is excluded from the query results. You can configure the ExcludeZoneId and ExcludeSecondaryZoneId parameters to specify the IDs of multiple zones that are excluded from the query results.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-b', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The instance type of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.mongo.standard', + 'title' => '', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The database engine version of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => '5.0', + 'title' => '', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes in the instance.'."\n" + ."\n" + .'> This parameter is available only for replica set instances.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- 1'."\n" + ."\n" + .'- 3'."\n" + ."\n" + .'- 5'."\n" + ."\n" + .'- 7', + 'enumValueTitles' => [ + 1 => '1', + 3 => '3', + 5 => '5', + 7 => '7', + ], + 'type' => 'string', + 'enum' => [], + 'required' => false, + 'example' => '3', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The architecture of the instance. Valid values:'."\n" + ."\n" + .'- **sharding**: sharded cluster instance'."\n" + ."\n" + .'- **replicate**: replica set or standalone instance', + 'type' => 'string', + 'required' => false, + 'example' => 'replicate', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '19A13A33-0FAD-5120-8AE1-B1636F74DD80', + 'title' => '', + ], + 'AvailableZones' => [ + 'description' => 'The details of the zones in which you can create ApsaraDB for MongoDB instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The ID of the zone.', + 'type' => 'string', + 'example' => 'cn-beijing-f', + 'title' => '', + ], + 'ZoneName' => [ + 'description' => 'The name of the zone.'."\n" + ."\n" + .'The return value of the ZoneName parameter is in the language that is specified by the **AcceptLanguage** parameter. For example, if the value of the ZoneId parameter in the response is **cn-hangzhou-h**, the following values are returned for the ZoneName parameter:'."\n" + ."\n" + .'- If the value of the **AcceptLanguage** parameter is **zh**, **H** is returned for the ZoneName parameter.'."\n" + ."\n" + .'- If the value of the **AcceptLanguage** parameter is **en**, **Hangzhou Zone H** is returned for the ZoneName parameter.', + 'type' => 'string', + 'example' => '杭州 可用区H', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The ID of the region. You can call the [DescribeRegions](~~61933~~) operation to query the latest available regions.', + 'type' => 'string', + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeAvailabilityZones', + 'summary' => 'Queries a list of the zones that are supported by an ApsaraDB for MongoDB instance.', + 'description' => 'Queries the zones in which an ApsaraDB for MongoDB instance can be deployed under specified purchase conditions. The region ID is required in the purchase condition.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeAvailabilityZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"19A13A33-0FAD-5120-8AE1-B1636F74DD80\\",\\n \\"AvailableZones\\": [\\n {\\n \\"ZoneId\\": \\"cn-beijing-f\\",\\n \\"ZoneName\\": \\"杭州 可用区H\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAvailableEngineVersion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '52507B6B-003B-47A3-A0A3-9FE992C7A243', + 'title' => '', + ], + 'EngineVersions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EngineVersion' => [ + 'description' => 'The list of one or more engine versions to which an ApsaraDB for MongoDB instance can be upgraded.'."\n" + ."\n" + .'> An empty string is returned if the latest version is being used.', + 'type' => 'array', + 'items' => [ + 'description' => 'The engine version that can be upgraded.', + 'type' => 'string', + 'example' => '4.0', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeAvailableEngineVersion', + 'summary' => 'Queries the engine versions to which an ApsaraDB for MongoDB instance can be upgraded.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAvailableEngineVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52507B6B-003B-47A3-A0A3-9FE992C7A243\\",\\n \\"EngineVersions\\": {\\n \\"EngineVersion\\": [\\n \\"4.0\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAvailableResource' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region. You can call the [DescribeRegions](~~61933~~) operation to query the latest available regions.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone. You can call the [DescribeRegions](~~61933~~) operation to query the available zones.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PrePaid** (default): subscription'."\n" + ."\n" + .'- **PostPaid**: pay-as-you-go', + 'type' => 'string', + 'required' => false, + 'default' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + 'example' => 'PrePaid', + 'title' => '', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The architecture of the instance. Valid values:'."\n" + ."\n" + .'- **normal**: replica set instance'."\n" + ."\n" + .'- **sharding**: sharded cluster instance', + 'type' => 'string', + 'enum' => [ + 'normal', + 'sharding', + ], + 'required' => false, + 'example' => 'sharding', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The storage type of the instance. Valid values:'."\n" + ."\n" + .'- local\\_ssd: local SSD'."\n" + ."\n" + .'- cloud\\_essd1: PL1 enhanced SSD (ESSD)'."\n" + ."\n" + .'- cloud\\_essd2: PL2 ESSD'."\n" + ."\n" + .'- cloud\\_essd3: PL3 ESSD'."\n" + ."\n" + .'- cloud\\_auto: ESSD AutoPL disk'."\n" + ."\n" + .'This parameter is empty by default, which indicates all types of storage resources are queried.', + 'type' => 'string', + 'enum' => [ + 'local_ssd', + 'cloud_essd1', + 'cloud_essd2', + 'cloud_essd3', + 'cloud_auto', + ], + 'required' => false, + 'example' => 'local_ssd', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The instance type of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.mongo.standard', + 'title' => '', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The major engine version of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => '5.0', + 'title' => '', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes, only applicable to replica sets.', + 'enumValueTitles' => [ + 1 => '1', + 3 => '3', + 5 => '5', + 7 => '7', + ], + 'type' => 'string', + 'required' => false, + 'example' => '3', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '344EE51D-8850-4935-B68B-58A8F4DCE3BD', + 'title' => '', + ], + 'SupportedDBTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedDBType' => [ + 'description' => 'The supported database types.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AvailableZones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableZone' => [ + 'description' => 'The available zones.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedEngineVersions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedEngineVersion' => [ + 'description' => 'The supported storage engine versions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedEngines' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedEngine' => [ + 'description' => 'The supported storage engines.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedNodeTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedNodeType' => [ + 'description' => 'The supported instance types.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'description' => 'The number of nodes in the instance.', + 'type' => 'string', + 'example' => '3', + 'title' => '', + ], + 'NetworkTypes' => [ + 'description' => 'The network type of the instance.', + 'type' => 'string', + 'example' => 'VPC', + 'title' => '', + ], + 'AvailableResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableResource' => [ + 'description' => 'The details of the available resources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceClassRemark' => [ + 'description' => 'The type of the instance.', + 'type' => 'string', + 'example' => '4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））', + 'title' => '', + ], + 'InstanceClass' => [ + 'description' => 'The instance family.', + 'type' => 'string', + 'example' => 'mdb.shard.2x.xlarge.d', + 'title' => '', + ], + 'DBInstanceStorageRange' => [ + 'description' => 'The storage capacity range of the instance.', + 'type' => 'object', + 'properties' => [ + 'Min' => [ + 'description' => 'The minimum storage capacity. Unit: GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'Max' => [ + 'description' => 'The maximum storage capacity. Unit: GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16000', + 'title' => '', + ], + 'Step' => [ + 'description' => 'The step size for adjusting the storage capacity. Unit: GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Engine' => [ + 'description' => 'The storage engine of the instance.', + 'type' => 'string', + 'example' => 'WiredTiger', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Version' => [ + 'description' => 'The database engine version of the instance.', + 'type' => 'string', + 'example' => '4.0', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DbType' => [ + 'description' => 'The architecture of the instance. Valid values:'."\n" + ."\n" + .'- **normal**: replica set instance'."\n" + ."\n" + .'- **sharding**: sharded cluster instance', + 'type' => 'string', + 'example' => 'sharding', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeAvailableResource', + 'summary' => 'Queries the available resources in the specified zone.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAvailableResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"344EE51D-8850-4935-B68B-58A8F4DCE3BD\\",\\n \\"SupportedDBTypes\\": {\\n \\"SupportedDBType\\": [\\n {\\n \\"AvailableZones\\": {\\n \\"AvailableZone\\": [\\n {\\n \\"SupportedEngineVersions\\": {\\n \\"SupportedEngineVersion\\": [\\n {\\n \\"SupportedEngines\\": {\\n \\"SupportedEngine\\": [\\n {\\n \\"SupportedNodeTypes\\": {\\n \\"SupportedNodeType\\": [\\n {\\n \\"NodeType\\": \\"3\\",\\n \\"NetworkTypes\\": \\"VPC\\",\\n \\"AvailableResources\\": {\\n \\"AvailableResource\\": [\\n {\\n \\"InstanceClassRemark\\": \\"4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））\\",\\n \\"InstanceClass\\": \\"mdb.shard.2x.xlarge.d\\",\\n \\"DBInstanceStorageRange\\": {\\n \\"Min\\": 20,\\n \\"Max\\": 16000,\\n \\"Step\\": 10\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"Engine\\": \\"WiredTiger\\"\\n }\\n ]\\n },\\n \\"Version\\": \\"4.0\\"\\n }\\n ]\\n },\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"DbType\\": \\"sharding\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeBackupDBs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page. Default value: 30. Valid values: **30**, **50**, and **100**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'SourceDBInstance', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2286****', + 'title' => '', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time to which the instance is restored. 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" + .'- The time can be a point in time within the previous seven days. The time must be earlier than the current time, but later than the time when the instance was created.'."\n" + ."\n" + .'- You must specify one of the RestoreTime and **BackupId** parameters.', + 'type' => 'string', + 'required' => false, + 'example' => '2019-08-22T12:00:00Z', + 'title' => '', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup ID.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- You can call the [DescribeBackups](~~62172~~) operation to query the backup ID.'."\n" + ."\n" + .'- You must specify one of the **RestoreTime** and BackupId parameters.', + 'type' => 'string', + 'required' => false, + 'example' => '5664****', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ax68****', + 'title' => '', + ], + ], + [ + 'name' => 'SourceDBInstance', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2286****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The number of returned databases.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'Databases' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Database' => [ + 'description' => 'The details of the databases.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBName' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'example' => 'mongodbtest', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number of the page returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMeta.WrongFormat', + 'errorMessage' => 'Meta information is wrong formatter.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidRestoreTime.Format', + 'errorMessage' => 'Specified restore time is not valid.', + 'description' => 'The specified RestoreTime value is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidDBName', + 'errorMessage' => 'The specified database name is not allowed.', + 'description' => 'The specified database name is invalid.', + ], + [ + 'errorCode' => 'InvalidMeta.TooLarge', + 'errorMessage' => 'Meta information is too large.', + 'description' => 'The metadata is too large.', + ], + [ + 'errorCode' => 'SingleDBRestore.BackupSetNotSupport', + 'errorMessage' => 'This backup set do not support this operation.', + 'description' => 'Single-database recovery is not supported for the specified time point or backup file.', + ], + [ + 'errorCode' => 'IncorrectDBInstanceType', + 'errorMessage' => 'Current DB instance type does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectEngineVersion', + 'errorMessage' => 'Current engine version does not support operations.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidBackupLogStatus', + 'errorMessage' => 'Current backup log enable status does not support this operation.', + 'description' => 'The operation is not supported when log backup is enabled.', + ], + [ + 'errorCode' => 'IncorrectBackupSetState', + 'errorMessage' => 'Current backup set state does not support operations..', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'InvalidBackupSetID.NotFound', + 'errorMessage' => 'Specifiedbackup set ID does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidBackup.NotFound', + 'errorMessage' => 'Theavailable backup does not exist in recovery time.', + 'description' => 'No backup set is available during the specified recovery period.', + ], + ], + ], + 'title' => 'DescribeBackupDBs', + 'summary' => 'Queries the databases at a specified time or the databases in a specified backup set before you restore a database for an ApsaraDB for MongoDB instance.', + 'description' => 'You can call the [CreateDBInstance](~~61763~~) operation to restore a database for an ApsaraDB for MongoDB instance. For more information, see [Restore one database of an ApsaraDB for MongoDB instance](~~112274~~).'."\n" + ."\n" + .'Before you call this operation, make sure that the instance meets the following requirements:'."\n" + ."\n" + .'- The instance was created after March 26, 2019.'."\n" + ."\n" + .'- The instance is located in the China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Hangzhou), China (Shanghai), China (Shenzhen), or Singapore region. Other regions are not supported.'."\n" + ."\n" + .'- The instance is a replica set instance.'."\n" + ."\n" + .'- The instance runs MongoDB 3.4, MongoDB 4.0, or MongoDB 4.2. In addition, the instance uses local disks to store data.'."\n" + ."\n" + .'- The storage engine of the instance is WiredTiger.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeBackupDBs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5,\\n \\"Databases\\": {\\n \\"Database\\": [\\n {\\n \\"DBName\\": \\"mongodbtest\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1\\n}","type":"json"}]', + ], + 'DescribeBackupPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8266', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp16cb162771****', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type.'."\n" + ."\n" + .'- replicate: replica set instance'."\n" + ."\n" + .'- sharding: sharded cluster instance', + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'replicate', + 'sharding', + ], + 'example' => 'sharding', + 'title' => '', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the instance is located.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => 'The backup cycle. Valid values:'."\n" + ."\n" + .'- **Monday**: Monday.'."\n" + ."\n" + .'- **Tuesday**: Tuesday.'."\n" + ."\n" + .'- **Wednesday**: Wednesday.'."\n" + ."\n" + .'- **Thursday**: Thursday.'."\n" + ."\n" + .'- **Friday**: Friday.'."\n" + ."\n" + .'- **Saturday**: Saturday.'."\n" + ."\n" + .'- **Sunday**: Sunday.', + 'type' => 'string', + 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '5A9464CA-F7DC-5434-90B1-DF7F197C****', + 'title' => '', + ], + 'PreferredBackupTime' => [ + 'description' => 'The backup time in the format of *HH:mm*Z-*HH:mm*Z (UTC time).', + 'type' => 'string', + 'example' => '09:00Z-10:00Z', + 'title' => '', + ], + 'BackupRetentionPeriod' => [ + 'description' => 'The backup retention period in days.', + 'type' => 'string', + 'example' => '30', + 'title' => '', + ], + 'PreferredNextBackupTime' => [ + 'description' => 'The next regular backup time in the format of *yyyy-mm-dd*t*hh:mm*z (UTC time).', + 'type' => 'string', + 'example' => '2024-06-19T19:11Z', + 'title' => '', + ], + 'EnableBackupLog' => [ + 'description' => 'Indicates whether log backup is enabled. Valid values:'."\n" + ."\n" + .'- **0**: disabled (default).'."\n" + ."\n" + .'- **1**: enabled.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'LogBackupRetentionPeriod' => [ + 'description' => 'The log backup retention period in days. Valid values: 7 to 730.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + 'title' => '', + ], + 'SnapshotBackupType' => [ + 'description' => 'The snapshot backup type. Valid values:'."\n" + ."\n" + .'- **Flash**: second-level backup.'."\n" + ."\n" + .'- **Standard**: regular backup (default).', + 'type' => 'string', + 'example' => 'Standard', + 'title' => '', + ], + 'BackupInterval' => [ + 'description' => 'The high-frequency backup frequency. Valid values:'."\n" + ."\n" + .'- **-1**: high-frequency backup is disabled.'."\n" + ."\n" + .'- **15**: every 15 minutes.'."\n" + ."\n" + .'- **30**: every 30 minutes.'."\n" + ."\n" + .'- **60**: every 1 hour.'."\n" + ."\n" + .'- **120**: every 2 hours.'."\n" + ."\n" + .'- **180**: every 3 hours.'."\n" + ."\n" + .'- **240**: every 4 hours.'."\n" + ."\n" + .'- **360**: every 6 hours.'."\n" + ."\n" + .'- **480**: every 8 hours.'."\n" + ."\n" + .'- **720**: every 12 hours.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + 'title' => '', + ], + 'HighFrequencyBackupRetention' => [ + 'description' => 'The high-frequency backup retention period in days.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'BackupRetentionPolicyOnClusterDeletion' => [ + 'description' => 'The backup retention policy.'."\n" + ."\n" + .'1. 0: All backup sets of the instance are immediately deleted when the instance is released'."\n" + ."\n" + .'2. 1: The instance is automatically backed up when it is released, and the backup set is retained for a long time'."\n" + ."\n" + .'3. 2: The instance is automatically backed up when it is released, and all backup sets of the cluster are retained for a long time'."\n" + ."\n" + .'For more information, see [Long-term backup retention](~~2779111~~)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'SrcRegion' => [ + 'description' => 'The region where the source instance is located.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'DestRegion' => [ + 'description' => 'The region where the geo-redundancy backup is located.', + 'type' => 'string', + 'example' => 'cn-shenzhen', + 'title' => '', + ], + 'CrossRetentionType' => [ + 'description' => 'The geo-redundancy backup retention type.'."\n" + ."\n" + .'- delay: retained for a period of time'."\n" + ."\n" + .'- never: never expires', + 'type' => 'string', + 'example' => 'delay', + 'title' => '', + ], + 'CrossRetentionValue' => [ + 'description' => 'The geo-redundancy backup retention period.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + 'title' => '', + ], + 'CrossBackupPeriod' => [ + 'description' => 'The geo-redundancy backup retention time.'."\n" + ."\n" + .'1. Monday: Monday.'."\n" + ."\n" + .'2. Tuesday: Tuesday.'."\n" + ."\n" + .'3. Wednesday: Wednesday.'."\n" + ."\n" + .'4. Thursday: Thursday.'."\n" + ."\n" + .'5. Friday: Friday.'."\n" + ."\n" + .'6. Saturday: Saturday.'."\n" + ."\n" + .'7. Sunday: Sunday.'."\n" + ."\n" + .'> Required for geo-redundancy backup', + 'type' => 'string', + 'example' => 'Monday', + 'title' => '', + ], + 'EnableCrossLogBackup' => [ + 'description' => 'Indicates whether cross-region log backup is enabled.'."\n" + ."\n" + .'> Required for geo-redundancy backup'."\n" + .'>'."\n" + .'> - 1: enabled (must be 1 for sharded cluster instances)'."\n" + .'>'."\n" + .'> - 0: disabled (must be 0 for replica set instances)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'CrossLogRetentionType' => [ + 'description' => 'The geo-redundancy log backup retention type.'."\n" + ."\n" + .'- delay: retained for a period of time'."\n" + ."\n" + .'- never: never expires', + 'type' => 'string', + 'example' => 'delay', + 'title' => '', + ], + 'CrossLogRetentionValue' => [ + 'description' => 'The geo-redundancy log backup retention period.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + 'title' => '', + ], + 'PreserveOneEachHour' => [ + 'type' => 'boolean', + 'description' => 'Indicates whether sparse backup within an hour is enabled.'."\n" + ."\n" + .'- true: When the backup frequency is at the minute level, all snapshots within 1 hour from the current time are retained. For snapshots that are more than 1 hour but within 24 hours from the current time, only the first snapshot after each hour is retained.'."\n" + ."\n" + .'- false: Sparse backup within an hour is disabled: all snapshots within the high-frequency backup retention period are retained.', + 'example' => 'false', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeBackupPolicy', + 'summary' => 'Queries the backup policy of a MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\",\\n \\"RequestId\\": \\"5A9464CA-F7DC-5434-90B1-DF7F197C****\\",\\n \\"PreferredBackupTime\\": \\"09:00Z-10:00Z\\",\\n \\"BackupRetentionPeriod\\": \\"30\\",\\n \\"PreferredNextBackupTime\\": \\"2024-06-19T19:11Z\\",\\n \\"EnableBackupLog\\": 1,\\n \\"LogBackupRetentionPeriod\\": 7,\\n \\"SnapshotBackupType\\": \\"Standard\\",\\n \\"BackupInterval\\": -1,\\n \\"HighFrequencyBackupRetention\\": \\"1\\",\\n \\"BackupRetentionPolicyOnClusterDeletion\\": 0,\\n \\"SrcRegion\\": \\"cn-hangzhou\\",\\n \\"DestRegion\\": \\"cn-shenzhen\\",\\n \\"CrossRetentionType\\": \\"delay\\",\\n \\"CrossRetentionValue\\": 7,\\n \\"CrossBackupPeriod\\": \\"Monday\\",\\n \\"EnableCrossLogBackup\\": 1,\\n \\"CrossLogRetentionType\\": \\"delay\\",\\n \\"CrossLogRetentionValue\\": 7,\\n \\"PreserveOneEachHour\\": false\\n}","type":"json"}]', + ], + 'DescribeBackupStorage' => [ + 'summary' => 'Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209318', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance is located. Call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the region ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-bejing', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2zeb2d64cb46xxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard node in the sharded cluster instance.'."\n" + ."\n" + .'> This parameter is required if the **DBInstanceId** parameter specifies the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-2zee48956b4axxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D648B367-15B6-1B42-BD4B-4XXXXXXXXX', + 'title' => '', + ], + 'FullStorageSize' => [ + 'description' => 'The storage space used by full backups. Unit: bytes.'."\n" + ."\n" + .'> Instances that use cloud disks are backed up using snapshots. The size of a full backup is the total size of the snapshot chain.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '789221621', + 'title' => '', + ], + 'LogStorageSize' => [ + 'description' => 'The storage space used by log backups. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7892216', + 'title' => '', + ], + 'FreeSize' => [ + 'description' => 'The free backup quota for the instance. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42949672960', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBInstance.Malformed', + 'errorMessage' => 'Too many instance ids or instance id format is invalid.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DescribeBackupStorage', + 'description' => 'Backup usage for a sharded cluster is billed on a per-shard basis. You can use this operation to query the backup usage for a single shard.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeBackupStorage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D648B367-15B6-1B42-BD4B-4XXXXXXXXX\\",\\n \\"FullStorageSize\\": 789221621,\\n \\"LogStorageSize\\": 7892216,\\n \\"FreeSize\\": 42949672960\\n}","type":"json"}]', + ], + 'DescribeBackupTasks' => [ + 'summary' => 'Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209100', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2zeb2d64cb46xxxx', + 'title' => '', + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup job ID.'."\n" + ."\n" + .'> If you call [CreateBackup](~~468439~~) to perform a manual backup, you can pass the returned backup ID to query the backup progress.', + 'type' => 'string', + 'required' => false, + 'example' => '170034', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'D648B367-15B6-1B42-BD4B-47507C9CC****', + ], + 'BackupJobs' => [ + 'title' => '', + 'description' => 'The details of the backup jobs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the backup job.', + 'type' => 'object', + 'properties' => [ + 'BackupjobId' => [ + 'description' => 'The backup job ID.', + 'type' => 'string', + 'example' => '170034'."\n", + 'title' => '', + ], + 'BackupSetStatus' => [ + 'description' => 'The status of the backup job.'."\n" + ."\n" + .'- **Scheduled**: The backup job is scheduled. This includes regular backup jobs that have not started.'."\n" + ."\n" + .'- **Checking**: The instance is being checked before the backup.'."\n" + ."\n" + .'- **Backuping**: The backup is in progress.'."\n" + ."\n" + .'- **Finished**: The backup is complete.', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Scheduled', + ], + 'BackupStartTime' => [ + 'description' => 'The start time of the backup.', + 'type' => 'string', + 'example' => '2024-01-16T11:04:56Z', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'The backup progress in percentage. The progress is displayed only for running backup jobs.', + 'type' => 'string', + 'example' => '18%', + 'title' => '', + ], + 'JobMode' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'- **Automated**: automatic backup.'."\n" + ."\n" + .'- **Manual**: manual backup.', + 'type' => 'string', + 'example' => 'Manual', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D648B367-15B6-1B42-BD4B-47507C9CC****\\",\\n \\"BackupJobs\\": [\\n {\\n \\"BackupjobId\\": \\"170034\\\\n\\",\\n \\"BackupSetStatus\\": \\"Scheduled\\",\\n \\"BackupStartTime\\": \\"2024-01-16T11:04:56Z\\",\\n \\"Progress\\": \\"18%\\",\\n \\"JobMode\\": \\"Manual\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeBackupTasks', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:DescribeBackupTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeBackups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8267', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> If the instance is a sharded cluster instance, you must also specify the **NodeId** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1a7009eb24****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard node in the sharded cluster instance.'."\n" + ."\n" + .'> This parameter is required if you specify the ID of a sharded cluster instance for the **DBInstanceId** parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp128a003436****', + 'title' => '', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup ID.'."\n" + ."\n" + .'If you specify the ID of a sharded cluster instance for the **DBInstanceId** parameter, the number of backup IDs must be the same as the number of shard nodes. Separate the backup IDs with commas (,).', + 'type' => 'string', + 'required' => false, + 'example' => '2072****,2072****,2072****', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be greater than 0 and not greater than the maximum value of the integer data type. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30** (Default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'> This parameter is invalid if you specify the BackupId parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-13T13:00Z', + 'title' => '', + ], + ], + [ + '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" + ."\n" + .'> This parameter is invalid if you specify the BackupId parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-14T13:00Z', + 'title' => '', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the instance resides.'."\n" + ."\n" + .'> - This parameter is required to restore a deleted instance.'."\n" + .'>'."\n" + .'> - This parameter is required for geo-redundancy.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the backup resides.'."\n" + ."\n" + .'> This parameter is required for geo-redundancy.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.', + 'type' => 'string', + 'example' => 'rg-xxxx', + 'title' => '', + 'required' => false, + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup job ID.', + 'type' => 'string', + 'example' => '775051', + 'title' => '', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of backups.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '275D43C3-F12F-5224-B375-************', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page. Valid values:'."\n" + ."\n" + .'- **30** (Default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Backups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => 'The details of the backup files.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the backup files.', + 'type' => 'object', + 'properties' => [ + 'BackupStatus' => [ + 'description' => 'The backup status. Valid values:'."\n" + ."\n" + .'- **Success**: The backup is successful.'."\n" + ."\n" + .'- **Failed**: The backup failed.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'BackupType' => [ + 'description' => 'The backup type. Valid values:'."\n" + ."\n" + .'- **FullBackup**: full backup.'."\n" + ."\n" + .'- **IncrementalBackup**: incremental backup.', + 'type' => 'string', + 'example' => 'FullBackup', + 'title' => '', + ], + 'BackupStartTime' => [ + 'description' => 'The start time of the backup. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'example' => '2022-01-14T03:56:17Z', + 'title' => '', + ], + 'BackupIntranetDownloadURL' => [ + 'description' => 'The internal download URL for the backup file.'."\n" + ."\n" + .'> Use this URL to download the backup file from an ECS instance. The ECS instance must be in the same network as the MongoDB instance.', + 'type' => 'string', + 'example' => 'http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=******************************&Region=cn-hangzhou', + 'title' => '', + ], + 'BackupSize' => [ + 'description' => 'The size of the backup file. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6168576', + 'title' => '', + ], + 'BackupDownloadURL' => [ + 'description' => 'The external download URL for the backup file. If the file is not available for download, an empty string is returned.', + 'type' => 'string', + 'example' => 'http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=************************&Signature=******************************&Region=cn-hangzhou', + 'title' => '', + ], + 'BackupMode' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'- **Automated**: automatic backup.'."\n" + ."\n" + .'- **Manual**: manual backup.', + 'type' => 'string', + 'example' => 'Automated', + 'title' => '', + ], + 'BackupEndTime' => [ + 'description' => 'The end time of the backup. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'example' => '2022-01-14T03:57:34Z', + 'title' => '', + ], + 'BackupId' => [ + 'description' => 'The backup ID.', + 'type' => 'string', + 'example' => '32102****', + 'title' => '', + ], + 'BackupDBNames' => [ + 'description' => 'The name of the database that is backed up.', + 'type' => 'string', + 'example' => 'database', + 'title' => '', + ], + 'BackupMethod' => [ + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'- **Snapshot**: snapshot backup.'."\n" + ."\n" + .'- **Physical**: physical backup.'."\n" + ."\n" + .'- **Logical**: logical backup.', + 'type' => 'string', + 'example' => 'Physical', + 'title' => '', + ], + 'BackupJobId' => [ + 'description' => 'The ID of the backup set job.', + 'type' => 'string', + 'example' => '1123xxxx', + 'title' => '', + ], + 'BackupName' => [ + 'description' => 'The name of the backup set. This parameter is currently invalid.', + 'type' => 'string', + 'example' => '12345678.tar.gz', + 'title' => '', + ], + 'BackupScale' => [ + 'description' => 'The backup granularity. This parameter is currently invalid.', + 'type' => 'string', + 'example' => 'DBInstance', + 'title' => '', + ], + 'IsAvail' => [ + 'description' => 'Indicates whether the backup set is available. Valid values:'."\n" + ."\n" + .'- **false**: unavailable.'."\n" + ."\n" + .'- **true**: available.', + 'type' => 'boolean', + 'example' => '1', + 'title' => '', + ], + 'EngineVersion' => [ + 'description' => 'The database engine version of the instance when the backup was created. Valid values:'."\n" + ."\n" + .'- **7.0**'."\n" + ."\n" + .'- **6.0**'."\n" + ."\n" + .'- **5.0**'."\n" + ."\n" + .'- **4.4**'."\n" + ."\n" + .'- **4.2**'."\n" + ."\n" + .'- **4.0**'."\n" + ."\n" + .'- **3.4**', + 'type' => 'string', + 'example' => '4.2', + 'title' => '', + ], + 'BackupExpireTime' => [ + 'description' => 'The expiration time of the backup. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'A value of "9999-01-01T00:00:00Z" indicates that the backup is permanently retained.'."\n" + ."\n" + .'></notice>', + 'type' => 'string', + 'example' => '2025-08-30T09:49:11Z', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The Specified parameter StartTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The Specified parameter EndTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidStartTimeAndEndTime.Malformed', + 'errorMessage' => 'The Specified parameter StartTime or EndTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeBackups', + 'summary' => 'Queries the backups of a MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"275D43C3-F12F-5224-B375-************\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"Backups\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2022-01-14T03:56:17Z\\",\\n \\"BackupIntranetDownloadURL\\": \\"http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=******************************&Region=cn-hangzhou\\",\\n \\"BackupSize\\": 6168576,\\n \\"BackupDownloadURL\\": \\"http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=************************&Signature=******************************&Region=cn-hangzhou\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupEndTime\\": \\"2022-01-14T03:57:34Z\\",\\n \\"BackupId\\": \\"32102****\\",\\n \\"BackupDBNames\\": \\"database\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"BackupJobId\\": \\"1123xxxx\\",\\n \\"BackupName\\": \\"12345678.tar.gz\\",\\n \\"BackupScale\\": \\"DBInstance\\",\\n \\"IsAvail\\": true,\\n \\"EngineVersion\\": \\"4.2\\",\\n \\"BackupExpireTime\\": \\"2025-08-30T09:49:11Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeClusterBackups' => [ + 'summary' => 'Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190126', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'dds-bp16cb162771****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster backup.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '5664****', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value must be a positive integer. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + 'title' => '', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30** (Default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '20', + 'enum' => [ + '30', + '50', + '100', + '10', + '20', + '5', + ], + 'title' => '', + 'example' => '30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'> This parameter is invalid if you specify the BackupId parameter.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '2019-03-13T12:11Z', + ], + ], + [ + '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" + ."\n" + .'> This parameter is invalid if you specify the BackupId parameter.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '2019-03-14T13:10Z', + ], + ], + [ + 'name' => 'IsOnlyGetClusterBackUp', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Specifies whether to query the information about the child nodes in the cluster backup. Valid values:'."\n" + ."\n" + .'- **true**: Returns only the basic information about the cluster backup, not the backup information about all child nodes.'."\n" + ."\n" + .'- **false** (Default): Returns the backup information about all child nodes.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'flase', + 'example' => 'true', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the instance resides.'."\n" + ."\n" + .'> - This parameter is required when you query the backup sets of a released instance.'."\n" + .'>'."\n" + .'> - This parameter is required when you query geo-redundant backups.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the geo-redundant backup resides.'."\n" + ."\n" + .'> This parameter is required when you query geo-redundant backups.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'title' => '', + 'description' => 'The ID of the resource group.', + 'required' => false, + 'example' => 'rg-xxxx', + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'title' => '', + 'description' => 'The ID of the backup job.', + 'required' => false, + 'example' => '775051', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '2F42BB4E-461F-5B55-A37C-53B1141C****', + ], + 'MaxResults' => [ + 'title' => '', + 'description' => 'The maximum number of entries returned in this request.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'title' => '', + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '', + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ClusterBackups' => [ + 'title' => '', + 'description' => 'The details of the cluster backup sets. A cluster backup contains the backup sets of all nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the cluster backup sets. A cluster backup contains the backup sets of all nodes.', + 'type' => 'object', + 'properties' => [ + 'IsAvail' => [ + 'title' => '', + 'description' => 'Indicates whether the cluster backup set is valid. Valid values:'."\n" + ."\n" + .'- **1**: The cluster backup set is valid.'."\n" + ."\n" + .'- **0**: The backup sets of child nodes are not complete or have failed.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterBackupId' => [ + 'title' => '', + 'description' => 'The ID of the cluster backup.', + 'type' => 'string', + 'example' => 'cb-o8c2ugnxo26kx***', + ], + 'ClusterBackupStatus' => [ + 'title' => '', + 'description' => 'The status of the cluster backup.', + 'type' => 'string', + 'example' => 'OK', + ], + 'ClusterBackupStartTime' => [ + 'description' => 'The time when the cluster backup started.', + 'type' => 'string', + 'title' => '', + 'example' => '2023-10-16T19:33:20Z', + ], + 'ClusterBackupSize' => [ + 'title' => '', + 'description' => 'The size of the cluster backup set, in bytes.', + 'type' => 'string', + 'example' => '107374182400', + ], + 'ClusterBackupEndTime' => [ + 'description' => 'The time when the cluster backup finished.', + 'type' => 'string', + 'title' => '', + 'example' => '2023-10-16T19:33:20Z', + ], + 'ClusterBackupMode' => [ + 'description' => 'The mode of the cluster backup.', + 'type' => 'string', + 'title' => '', + 'example' => 'Automated', + ], + 'ExtraInfo' => [ + 'description' => 'The supplementary information. The value is a JSON-formatted string.', + 'type' => 'object', + 'properties' => [ + 'RegistryFromHistory' => [ + 'title' => '', + 'description' => 'Indicates whether the backup set was migrated from a historical backup. A value of **1** indicates that the backup was migrated.', + 'type' => 'string', + 'example' => '1', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Backups' => [ + 'title' => '', + 'description' => 'The backup sets of each child node in the cluster backup.', + 'type' => 'array', + 'items' => [ + 'description' => 'The backup sets of each child node in the cluster backup.', + 'type' => 'object', + 'properties' => [ + 'BackupId' => [ + 'description' => 'The ID of the backup.', + 'type' => 'string', + 'title' => '', + 'example' => '738025367', + ], + 'InstanceName' => [ + 'description' => 'The name of the shard in the MongoDB cluster.', + 'type' => 'string', + 'title' => '', + 'example' => 'd-bp16cb162771****'."\n", + ], + 'BackupDownloadURL' => [ + 'description' => 'The public URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.', + 'type' => 'string', + 'title' => '', + 'example' => 'http://oss.com/xxx', + ], + 'BackupIntranetDownloadURL' => [ + 'description' => 'The internal URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.', + 'type' => 'string', + 'title' => '', + 'example' => 'http://oss.com/xxx', + ], + 'BackupStartTime' => [ + 'description' => 'The time when the backup started. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'title' => '', + 'example' => '2023-10-16T19:33:20Z', + ], + 'BackupEndTime' => [ + 'description' => 'The time when the backup finished. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'title' => '', + 'example' => '2023-10-16T19:33:20Z', + ], + 'BackupSize' => [ + 'description' => 'The size of the backup file, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '77544597650', + ], + 'IsAvail' => [ + 'description' => 'Indicates whether the backup set is available. Valid values:'."\n" + ."\n" + .'- **0**: unavailable.'."\n" + ."\n" + .'- **1**: available.', + 'type' => 'string', + 'title' => '', + 'example' => '1', + ], + 'BackupStatus' => [ + 'description' => 'The backup status. Valid values:'."\n" + ."\n" + .'- **Success**: The backup is successful.'."\n" + ."\n" + .'- **Failed**: The backup failed.', + 'type' => 'string', + 'title' => '', + 'example' => 'Success', + ], + 'BackupName' => [ + 'description' => 'The name of the backup.', + 'type' => 'string', + 'title' => '', + 'example' => '12345678.tar.gz', + ], + 'ExtraInfo' => [ + 'description' => 'The information about the instance node that is associated with the backup.', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'description' => 'The ID of the node.', + 'type' => 'string', + 'title' => '', + 'example' => 'd-2ze75ab1fa5d****', + ], + 'StorageSize' => [ + 'description' => 'The storage space of the node, in MB.', + 'type' => 'string', + 'title' => '', + 'example' => '20480', + ], + 'InstanceClass' => [ + 'description' => 'The specifications of the node.', + 'type' => 'string', + 'title' => '', + 'example' => 'mdb.shard.4x.large.d', + ], + 'NodeType' => [ + 'description' => 'The type of the node.', + 'type' => 'string', + 'title' => '', + 'example' => 'db', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Progress' => [ + 'title' => '', + 'description' => 'The backup progress in percentage.'."\n" + .'This parameter is returned only for backups that are in progress.', + 'type' => 'string', + 'example' => '50', + ], + 'AttachLogStatus' => [ + 'description' => 'The status of the attached log backup. Valid values:'."\n" + ."\n" + .'- **Init**: initialization.'."\n" + ."\n" + .'- **No\\_Need**: No attached log backup is available.'."\n" + ."\n" + .'- **Running**: The attached log backup is in progress.'."\n" + ."\n" + .'- **Ready**: The attached log backup is complete.'."\n" + ."\n" + .'- **Failed**: The attached log backup failed.'."\n" + ."\n" + .'> If the value of the **ClusterBackupStatus** parameter is OK, it only indicates that the full backup was successful. For a cluster instance for which log backup is enabled, the attached log backup must be complete before you can perform a point-in-time restore or ensure data consistency.', + 'type' => 'string', + 'title' => '', + 'example' => 'Ready', + ], + 'EngineVersion' => [ + 'description' => 'The database engine version of the instance when the backup was created. Valid values:'."\n" + ."\n" + .'- **7.0**'."\n" + ."\n" + .'- **6.0**'."\n" + ."\n" + .'- **5.0**'."\n" + ."\n" + .'- **4.4**'."\n" + ."\n" + .'- **4.2**'."\n" + ."\n" + .'- **4.0**'."\n" + ."\n" + .'- **3.4**', + 'type' => 'string', + 'title' => '', + 'example' => '4.2', + ], + 'BackupExpireTime' => [ + 'type' => 'string', + 'description' => 'The time when the backup expires. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'A value of "9999-01-01T00:00:00Z" indicates that the backup is permanently retained.'."\n" + ."\n" + .'></notice>', + 'title' => '', + 'example' => '2025-03-29T03:47:12Z', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The Specified parameter StartTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The Specified parameter EndTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidStartTimeAndEndTime.Malformed', + 'errorMessage' => 'The Specified parameter StartTime or EndTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2F42BB4E-461F-5B55-A37C-53B1141C****\\",\\n \\"MaxResults\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"ClusterBackups\\": [\\n {\\n \\"IsAvail\\": 1,\\n \\"ClusterBackupId\\": \\"cb-o8c2ugnxo26kx***\\",\\n \\"ClusterBackupStatus\\": \\"OK\\",\\n \\"ClusterBackupStartTime\\": \\"2023-10-16T19:33:20Z\\",\\n \\"ClusterBackupSize\\": \\"107374182400\\",\\n \\"ClusterBackupEndTime\\": \\"2023-10-16T19:33:20Z\\",\\n \\"ClusterBackupMode\\": \\"Automated\\",\\n \\"ExtraInfo\\": {\\n \\"RegistryFromHistory\\": \\"1\\"\\n },\\n \\"Backups\\": [\\n {\\n \\"BackupId\\": \\"738025367\\",\\n \\"InstanceName\\": \\"d-bp16cb162771****\\\\n\\",\\n \\"BackupDownloadURL\\": \\"http://oss.com/xxx\\",\\n \\"BackupIntranetDownloadURL\\": \\"http://oss.com/xxx\\",\\n \\"BackupStartTime\\": \\"2023-10-16T19:33:20Z\\",\\n \\"BackupEndTime\\": \\"2023-10-16T19:33:20Z\\",\\n \\"BackupSize\\": \\"77544597650\\",\\n \\"IsAvail\\": \\"1\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupName\\": \\"12345678.tar.gz\\",\\n \\"ExtraInfo\\": {\\n \\"NodeId\\": \\"d-2ze75ab1fa5d****\\",\\n \\"StorageSize\\": \\"20480\\",\\n \\"InstanceClass\\": \\"mdb.shard.4x.large.d\\",\\n \\"NodeType\\": \\"db\\"\\n }\\n }\\n ],\\n \\"Progress\\": \\"50\\",\\n \\"AttachLogStatus\\": \\"Ready\\",\\n \\"EngineVersion\\": \\"4.2\\",\\n \\"BackupExpireTime\\": \\"2025-03-29T03:47:12Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeClusterBackups', + 'description' => 'For sharded cluster instances that use cloud disks and were created before October 19, 2023, you must first call the [TransferClusterBackup](~~2587931~~) operation to convert shard backups to cluster backups.'."\n" + ."\n" + .'Sharded cluster instances that use cloud disks and were created after October 19, 2023 use cluster backups by default.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeClusterBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeClusterRecoverTime' => [ + 'summary' => 'Queries the recoverable time range of an ApsaraDB for MongoDB sharded cluster instance with disk storage.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190632', + 'abilityTreeNodes' => [ + 'FEATUREmongodbH6KW66', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp18f7d6b6a7****', + 'title' => '', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region of the source instance for geo-redundancy.'."\n" + ."\n" + .'> - This parameter is required when you query a geo-redundant backup.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the geo-redundant backup set is located.'."\n" + ."\n" + .'> - This parameter is required when you query a geo-redundant backup.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'example' => 'rg-xxxx', + 'title' => '', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '60EEBD77-227C-5B39-86EA-D89163C5****', + ], + 'RestoreRanges' => [ + 'title' => '', + 'description' => 'A list of cluster backups. Each backup includes the backup set for every node.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RestoreBeginTime' => [ + 'description' => 'The beginning of the restorable time range.', + 'type' => 'string', + 'title' => '', + 'example' => '2023-10-16T19:33:20Z', + ], + 'RestoreEndTime' => [ + 'description' => 'The end of the restorable time range.', + 'type' => 'string', + 'title' => '', + 'example' => '2023-10-16T19:43:20Z', + ], + 'RestoreType' => [ + 'description' => 'The restoration method. Valid value:'."\n" + ."\n" + .'- **PointInTime** (default): point-in-time recovery.', + 'type' => 'string', + 'example' => 'PointInTime', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60EEBD77-227C-5B39-86EA-D89163C5****\\",\\n \\"RestoreRanges\\": [\\n {\\n \\"RestoreBeginTime\\": \\"2023-10-16T19:33:20Z\\",\\n \\"RestoreEndTime\\": \\"2023-10-16T19:43:20Z\\",\\n \\"RestoreType\\": \\"PointInTime\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeClusterRecoverTime', + 'description' => '- This operation applies only to sharded cluster instances that run MongoDB 4.4 or later and use Enhanced SSDs (ESSDs).'."\n" + ."\n" + .'- If an instance was created before October 19, 2023, you must call the TransferClusterBackup operation to switch it to the cluster backup mode. You can call this operation directly for instances that were created on or after October 19, 2023, or have already been switched to the cluster backup mode.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeClusterRecoverTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeDBInstanceAttribute' => [ + 'summary' => 'Queries the details of an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8269', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWP8F69', + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine. Set the value to **MongoDB**.', + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'MongoDB', + ], + 'example' => 'MongoDB', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp11483712c1****', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. For more information, see [View the basic information of a resource group](~~151181~~).'."\n" + ."\n" + .'> Only available on the Alibaba Cloud China site (www\\.aliyun.com).', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + [ + 'name' => 'IsDelete', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Indicates if the instance is deleted. Valid values:'."\n" + ."\n" + .'- **false**: The instance is running.'."\n" + ."\n" + .'- **true**: The instance is deleted.', + 'type' => 'boolean', + 'default' => 'false', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details of the instance.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'A935A8EE-A6CC-53DE-98BA-20ABAA7E632B', + 'title' => '', + ], + 'DBInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'itemNode' => true, + 'description' => 'The details of the instance.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the instance.', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the instance was created. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2022-01-02T07:43:59Z', + 'title' => '', + ], + 'ReplicaSets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReplicaSet' => [ + 'description' => 'The details of the replica set instance.'."\n" + ."\n" + .'> Returned when the instance is a replica set.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the replica set instance.'."\n" + ."\n" + .'> Returned when the instance is a replica set.', + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n" + ."\n" + .'> Returned when the network type is VPC.', + 'type' => 'string', + 'example' => 'vpc-bp1jk5vwkcri27qme****', + 'title' => '', + ], + 'ConnectionPort' => [ + 'description' => 'The connection port of the node.', + 'type' => 'string', + 'example' => '3717', + 'title' => '', + ], + 'ReplicaSetRole' => [ + 'description' => 'The role of the node. Valid values:'."\n" + ."\n" + .'- **Primary**: the primary node.'."\n" + ."\n" + .'- **Secondary**: a secondary node.', + 'type' => 'string', + 'example' => 'Primary', + 'title' => '', + ], + 'ConnectionDomain' => [ + 'description' => 'The endpoint of the node.', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + 'VPCCloudInstanceId' => [ + 'description' => 'The VPC instance ID of the replica set node.'."\n" + ."\n" + .'> Returned when the network type is VPC.', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****', + 'title' => '', + ], + 'NetworkType' => [ + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'- **Classic**: classic network.'."\n" + ."\n" + .'- **VPC**: VPC.', + 'type' => 'string', + 'example' => 'VPC', + 'title' => '', + ], + 'VPCId' => [ + 'description' => 'The VPC ID.'."\n" + ."\n" + .'> Returned when the network type is VPC.', + 'type' => 'string', + 'example' => 'vpc-bp1jk5vwkcri27qme****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ReplacateId' => [ + 'description' => 'The logical ID of the Global Distributed Cache instance.'."\n" + ."\n" + .'> You can no longer purchase new instances of this type. This parameter is returned only for existing Global Distributed Cache instances.', + 'type' => 'string', + 'example' => 'bls-m****', + 'title' => '', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'A list of tags attached to the instance.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of tags attached to the instance.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The tag value.', + 'type' => 'string', + 'example' => 'api', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'VpcAuthMode' => [ + 'description' => 'The password-free access mode over a private network. Valid values:'."\n" + ."\n" + .'- **Open**: Password-free access is enabled.'."\n" + ."\n" + .'- **Close**: Password-free access is disabled. You must use a password to access the instance.'."\n" + ."\n" + .'- **NotSupport**: The instance does not support this feature.', + 'type' => 'string', + 'example' => 'Open', + 'title' => '', + ], + 'NetworkType' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'- **Classic**: classic network.'."\n" + ."\n" + .'- **VPC**: VPC.', + 'type' => 'string', + 'example' => 'VPC', + 'title' => '', + ], + 'LockMode' => [ + 'description' => 'The lock status of the instance. Valid values:'."\n" + ."\n" + .'- **Unlock**: The instance is not locked.'."\n" + ."\n" + .'- **ManualLock**: The instance is manually locked.'."\n" + ."\n" + .'- **LockByExpiration**: The instance is automatically locked due to expiration.'."\n" + ."\n" + .'- **LockByRestoration**: The instance is automatically locked before a rollback.'."\n" + ."\n" + .'- **LockByDiskQuota**: The instance is automatically locked because the disk space is exhausted.', + 'type' => 'string', + 'example' => 'Unlock', + 'title' => '', + ], + 'EngineVersion' => [ + 'description' => 'The major version of the database engine.', + 'type' => 'string', + 'example' => '4.4', + 'title' => '', + ], + 'MaxIOPS' => [ + 'description' => 'The maximum input/output operations per second (IOPS) of the instance.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + 'title' => '', + ], + 'MaxMBPS' => [ + 'description' => 'The maximum throughput of the disk, in MB/s.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '350', + 'title' => '', + ], + 'VPCCloudInstanceIds' => [ + 'description' => 'The VPC instance ID.'."\n" + ."\n" + .'> Returned when the network type is VPC.'."\n" + .'>'."\n" + .'> ><notice>'."\n" + .'>'."\n" + .'> This parameter is deprecated.'."\n" + .'>'."\n" + .'> ></notice>', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****', + 'title' => '', + ], + 'MongosList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MongosAttribute' => [ + 'description' => 'A list of Mongos node information.'."\n" + ."\n" + .'> Returned when the instance is a sharded cluster.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of Mongos node information.'."\n" + ."\n" + .'> Returned when the instance is a sharded cluster.', + 'type' => 'object', + 'properties' => [ + 'VpcCloudInstanceId' => [ + 'description' => 'The VPC instance ID of the Mongos node.', + 'type' => 'string', + 'example' => 's-bp1d8c262a158****', + 'title' => '', + ], + 'LockMode' => [ + 'description' => 'The lock status of the instance. Valid values:'."\n" + ."\n" + .'- **Unlock**: The instance is not locked.'."\n" + ."\n" + .'- **ManualLock**: The instance is manually locked.'."\n" + ."\n" + .'- **LockByExpiration**: The instance is automatically locked due to expiration.'."\n" + ."\n" + .'- **LockByRestoration**: The instance is automatically locked before a rollback.'."\n" + ."\n" + .'- **LockByDiskQuota**: The instance is automatically locked because the disk space is exhausted.', + 'type' => 'string', + 'example' => 'Unlock', + 'title' => '', + ], + 'MaxIOPS' => [ + 'description' => 'The maximum IOPS of the Mongos node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '800', + 'title' => '', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n" + ."\n" + .'> Returned when the network type is VPC.', + 'type' => 'string', + 'example' => 'vsw-bp1vj604nj5a9zz74****', + 'title' => '', + ], + 'NodeClass' => [ + 'description' => 'The instance type of the Mongos node.', + 'type' => 'string', + 'example' => 'dds.mongos.mid', + 'title' => '', + ], + 'MaxConnections' => [ + 'description' => 'The maximum number of connections to the Mongos node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + 'title' => '', + ], + 'Port' => [ + 'description' => 'The connection port of the Mongos node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3717', + 'title' => '', + ], + 'VPCId' => [ + 'description' => 'The VPC ID.'."\n" + ."\n" + .'> Returned when the network type is VPC.', + 'type' => 'string', + 'example' => 'vpc-bp1n3i15v90el48nx****', + 'title' => '', + ], + 'ConnectSting' => [ + 'description' => 'The endpoint of the Mongos node.'."\n" + ."\n" + .'><warning>'."\n" + ."\n" + .'This parameter is being deprecated. Use the ConnectString parameter instead.'."\n" + ."\n" + .'></warning>', + 'type' => 'string', + 'example' => 's-bp1d8c262a15****.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + 'NodeDescription' => [ + 'description' => 'The name of the Mongos node.', + 'type' => 'string', + 'example' => 'mongos1', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'The ID of the Mongos node.', + 'type' => 'string', + 'example' => 's-bp1d8c262a15****', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the Mongos node. For more information, see [Instance states](~~63870~~).', + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'CurrentKernelVersion' => [ + 'description' => 'The minor engine version of the MongoDB node.', + 'type' => 'string', + 'example' => 'mongodb_20220518_4.0.21', + 'title' => '', + ], + 'ConnectString' => [ + 'description' => 'The endpoint of the Mongos node.', + 'type' => 'string', + 'example' => 's-bp1d8c262a15****.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ProtocolType' => [ + 'description' => 'The protocol type of the instance. Valid values:'."\n" + ."\n" + .'- **mongodb**: MongoDB protocol.'."\n" + ."\n" + .'- **dynamodb**: DynamoDB protocol.'."\n" + ."\n" + .'> Returned when the instance is a sharded cluster.', + 'type' => 'string', + 'example' => 'mongodb', + 'title' => '', + ], + 'DBInstanceDescription' => [ + 'description' => 'The instance name.', + 'type' => 'string', + 'example' => '测试数据库', + 'title' => '', + ], + 'CurrentKernelVersion' => [ + 'description' => 'The minor engine version of the instance.', + 'type' => 'string', + 'example' => '5.0.5-20220721143518_0', + 'title' => '', + ], + 'DBInstanceReleaseProtection' => [ + 'description' => 'Indicates whether release protection is enabled for the instance. Valid values:'."\n" + ."\n" + .'- **true**: Release protection is enabled.'."\n" + ."\n" + .'- **false**: Release protection is disabled.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'ExpireTime' => [ + 'description' => 'The expiration time of the subscription instance. The time is in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n" + ."\n" + .'> Returned when the charge type is prepaid.', + 'type' => 'string', + 'example' => '2022-02-05T16:00Z', + 'title' => '', + ], + 'MaintainStartTime' => [ + 'description' => 'The start time of the maintenance window. The time is in the *HH:mm*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '18:00Z', + 'title' => '', + ], + 'DBInstanceType' => [ + 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- **replicate**: replica set instance.'."\n" + ."\n" + .'- **sharding**: sharded cluster instance.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **serverless**: Serverless instance.'."\n" + ."\n" + .'</props>', + 'type' => 'string', + 'example' => 'replicate', + 'title' => '', + ], + 'LastDowngradeTime' => [ + 'description' => 'The time when the instance was last downgraded.', + 'type' => 'string', + 'example' => '2022-01-08', + 'title' => '', + ], + 'ShardList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ShardAttribute' => [ + 'description' => 'A list of shard node information.'."\n" + ."\n" + .'> Returned when the instance is a sharded cluster.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of shard node information.'."\n" + ."\n" + .'> Returned when the instance is a sharded cluster.', + 'type' => 'object', + 'properties' => [ + 'LockMode' => [ + 'description' => 'The lock mode of the cluster. Valid values:'."\n" + ."\n" + .'- **Unlock**: The cluster is not locked.'."\n" + ."\n" + .'- **ManualLock**: The cluster is manually locked.'."\n" + ."\n" + .'- **LockByExpiration**: The cluster is automatically locked due to expiration.'."\n" + ."\n" + .'- **LockByRestoration**: The cluster is automatically locked before a rollback.'."\n" + ."\n" + .'- **LockByDiskQuota**: The cluster is automatically locked because the disk space is exhausted.', + 'type' => 'string', + 'example' => 'Unlock', + 'title' => '', + ], + 'MaxIOPS' => [ + 'description' => 'The maximum IOPS of the shard node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + 'title' => '', + ], + 'ConnectString' => [ + 'description' => 'The endpoint of the shard node.', + 'type' => 'string', + 'example' => 'd-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****', + 'title' => '', + ], + 'NodeClass' => [ + 'description' => 'The instance type of the shard node.', + 'type' => 'string', + 'example' => 'dds.shard.mid', + 'title' => '', + ], + 'MaxConnections' => [ + 'description' => 'The maximum number of connections to the shard node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + 'title' => '', + ], + 'Port' => [ + 'description' => 'The port of the shard node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3717', + 'title' => '', + ], + 'NodeDescription' => [ + 'description' => 'The name of the shard node.', + 'type' => 'string', + 'example' => 'testshard', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'The ID of the shard node.', + 'type' => 'string', + 'example' => 'd-bp16e09d9c5d****', + 'title' => '', + ], + 'NodeStorage' => [ + 'description' => 'The storage space of the shard node. Unit: GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'ReadonlyReplicas' => [ + 'description' => 'The number of read-only nodes in the shard node. Valid values: integers from **0** to **5**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the shard node. For more information, see [Instance states](~~63870~~).', + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'MaxDiskMbps' => [ + 'description' => 'The maximum disk throughput of the shard node.', + 'type' => 'string', + 'example' => '350', + 'title' => '', + ], + 'CurrentKernelVersion' => [ + 'description' => 'The minor engine version of the MongoDB node.', + 'type' => 'string', + 'example' => 'mongodb_20220518_4.0.21', + 'title' => '', + ], + 'ReplicaSetName' => [ + 'description' => 'The name of the shard node.', + 'type' => 'string', + 'example' => 'mgset-xxxx', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'MaintainEndTime' => [ + 'description' => 'The end time of the maintenance window. The time is in the *HH:mm*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '03:00Z', + 'title' => '', + ], + 'DBInstanceStatus' => [ + 'description' => 'The instance status. For more information, see [Instance states](~~63870~~).', + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'VPCId' => [ + 'description' => 'The VPC ID.'."\n" + ."\n" + .'> Returned when the network type is VPC.', + 'type' => 'string', + 'example' => 'vpc-bp1n3i15v90el48nx****', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'DBInstanceStorage' => [ + 'description' => 'The storage space of the instance.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'ReplicaSetName' => [ + 'description' => 'The name of the replica set instance.'."\n" + ."\n" + .'> Returned when the instance is a replica set.', + 'type' => 'string', + 'example' => 'mgset-10ace****', + 'title' => '', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n" + ."\n" + .'> Returned when the network type is VPC.', + 'type' => 'string', + 'example' => 'vsw-bp1oo2a7isyrb8igf****', + 'title' => '', + ], + 'StorageEngine' => [ + 'description' => 'The storage engine of the instance.', + 'type' => 'string', + 'example' => 'WiredTiger', + 'title' => '', + ], + 'ConfigserverList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConfigserverAttribute' => [ + 'description' => 'A list of Configserver node information.'."\n" + ."\n" + .'> Returned when the instance is a sharded cluster.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of Configserver node information.'."\n" + ."\n" + .'> Returned when the instance is a sharded cluster.', + 'type' => 'object', + 'properties' => [ + 'MaxIOPS' => [ + 'description' => 'The maximum IOPS of the Configserver node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + 'title' => '', + ], + 'LockMode' => [ + 'description' => 'The lock status of the instance. Valid values:'."\n" + ."\n" + .'- **Unlock**: The instance is not locked.'."\n" + ."\n" + .'- **ManualLock**: The instance is manually locked.'."\n" + ."\n" + .'- **LockByExpiration**: The instance is automatically locked due to expiration.'."\n" + ."\n" + .'- **LockByRestoration**: The instance is automatically locked before a rollback.'."\n" + ."\n" + .'- **LockByDiskQuota**: The instance is automatically locked because the disk space is exhausted.', + 'type' => 'string', + 'example' => 'Unlock', + 'title' => '', + ], + 'ConnectString' => [ + 'description' => 'The endpoint of the Configserver node.', + 'type' => 'string', + 'example' => 'dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + 'NodeClass' => [ + 'description' => 'The instance type of the Configserver node.', + 'type' => 'string', + 'example' => 'dds.cs.mid', + 'title' => '', + ], + 'MaxConnections' => [ + 'description' => 'The maximum number of connections to the Configserver node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + 'title' => '', + ], + 'Port' => [ + 'description' => 'The port of the Configserver node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3717', + 'title' => '', + ], + 'NodeDescription' => [ + 'description' => 'The name of the Configserver node.', + 'type' => 'string', + 'example' => 'testConfigserver', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'The ID of the Configserver node.', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****-cs', + 'title' => '', + ], + 'NodeStorage' => [ + 'description' => 'The storage space of the Configserver node. Unit: GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the ConfigServer node. For more information, see [Instance states](~~63870~~).', + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'CurrentKernelVersion' => [ + 'description' => 'The minor engine version of the MongoDB node.', + 'type' => 'string', + 'example' => 'mongodb_20220518_4.0.21', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n" + ."\n" + .'> Returned only on the Alibaba Cloud China site (www\\.aliyun.com).', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + 'title' => '', + ], + 'MaxConnections' => [ + 'description' => 'The maximum number of connections to the instance.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + 'title' => '', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****', + 'title' => '', + ], + 'DBInstanceClass' => [ + 'description' => 'The instance type.', + 'type' => 'string', + 'example' => 'dds.mongo.mid', + 'title' => '', + ], + 'Engine' => [ + 'description' => 'The database engine.', + 'type' => 'string', + 'example' => 'MongoDB', + 'title' => '', + ], + 'ReadonlyReplicas' => [ + 'description' => 'The number of read-only nodes in the instance.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'ReplicationFactor' => [ + 'description' => 'The number of nodes in the instance.'."\n" + ."\n" + .'> Returned when the instance is a replica set.', + 'type' => 'string', + 'example' => '3', + 'title' => '', + ], + 'KindCode' => [ + 'description' => 'The type of the instance. Valid values:'."\n" + ."\n" + .'- **0**: an instance that uses local disks.'."\n" + ."\n" + .'- **3**: a standalone instance.'."\n" + ."\n" + .'- **18**: an instance that uses cloud disks.', + 'type' => 'string', + 'example' => '18', + 'title' => '', + ], + 'CapacityUnit' => [ + 'description' => 'The read and write throughput consumed by the instance.', + 'type' => 'string', + 'example' => '100', + 'title' => '', + ], + 'ChargeType' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PrePaid**: subscription.'."\n" + ."\n" + .'- **PostPaid**: pay-as-you-go.', + 'type' => 'string', + 'example' => 'PostPaid', + 'title' => '', + ], + 'StorageType' => [ + 'description' => 'The storage class. Valid values:'."\n" + ."\n" + .'**cloud\\_essd1**: enhanced SSD (ESSD) PL1 disk.'."\n" + .'**cloud\\_essd2**: ESSD PL2 disk.'."\n" + .'**cloud\\_essd3**: ESSD PL3 disk.'."\n" + .'**local\\_ssd**: local SSD.'."\n" + .'**cloud\\_essd\\_dbfs\\_s**: DBFS-based shared storage disk.', + 'type' => 'string', + 'example' => 'cloud_essd1', + 'title' => '', + ], + 'DestroyTime' => [ + 'description' => 'The time when the data of the instance is destroyed. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2021-12-10T16:00:00Z', + 'title' => '', + ], + 'DBInstanceOrderStatus' => [ + 'description' => 'The state of the order that is generated for the instance. Valid values:'."\n" + ."\n" + .'- **all\\_completed**: All orders are being provisioned or are complete.'."\n" + ."\n" + .'- **order\\_unpaid**: The instance has an unpaid order.'."\n" + ."\n" + .'- **order\\_wait\\_for\\_produce**: The order is pending provisioning.'."\n" + ."\n" + .'> The order fulfillment process is as follows: An order is placed and paid, submitted for provisioning, and then the instance is provisioned.'."\n" + ."\n" + .'- If the order status remains **order\\_wait\\_for\\_produce** for a long time, an issue occurred during submission. The system automatically retries.'."\n" + ."\n" + .'- The instance status changes only when the instance is being provisioned or is complete. For example, the status changes to Upgrading or Running.', + 'type' => 'string', + 'example' => 'all_completed', + 'title' => '', + ], + 'Encrypted' => [ + 'description' => 'Indicates whether disk encryption is enabled.', + 'type' => 'boolean', + 'title' => '', + 'example' => 'true', + ], + 'EncryptionKey' => [ + 'description' => 'The ID of the KMS key used for disk encryption.', + 'type' => 'string', + 'title' => '', + 'example' => '07609cc3-3109-408f-a35e-c548e776da0b', + ], + 'SyncPercent' => [ + 'description' => 'The data synchronization progress in percentage. When an instance is undergoing a configuration change, data synchronization is required. You can check this parameter to view the synchronization progress.', + 'type' => 'string', + 'example' => '0.8', + 'title' => '', + ], + 'UseClusterBackup' => [ + 'description' => 'Indicates whether the cluster backup mode is enabled. Valid values:'."\n" + ."\n" + .'- **true**: The cluster backup mode is enabled.'."\n" + ."\n" + .'- **false**: The cluster backup mode is disabled.', + 'type' => 'boolean', + 'default' => 'false', + 'example' => 'true', + 'title' => '', + ], + 'BurstingEnabled' => [ + 'description' => 'Indicates whether the bursting feature is enabled.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ProvisionedIops' => [ + 'description' => 'The provisioned performance.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1960', + 'title' => '', + ], + 'DisasterRecoveryInfo' => [ + 'description' => 'Information about the source and destination instances of a Global Distributed Cache instance.', + 'type' => 'string', + 'example' => '{"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]}', + 'title' => '', + ], + 'SearchNodeClass' => [ + 'description' => 'The specifications of the Search node for the configuration change.', + 'type' => 'string', + 'example' => 'mdb.shard.2x.xlarge.d', + 'title' => '', + ], + 'SearchNodeStorage' => [ + 'description' => 'The storage capacity of the Search node for the configuration change.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'SearchNodeCount' => [ + 'description' => 'The number of Search nodes for the configuration change.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'VpcCloudInstanceIdNumError', + 'errorMessage' => 'Get vpcCloudInstanceId number error.', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A935A8EE-A6CC-53DE-98BA-20ABAA7E632B\\",\\n \\"DBInstances\\": {\\n \\"DBInstance\\": [\\n {\\n \\"CreationTime\\": \\"2022-01-02T07:43:59Z\\",\\n \\"ReplicaSets\\": {\\n \\"ReplicaSet\\": [\\n {\\n \\"VSwitchId\\": \\"vpc-bp1jk5vwkcri27qme****\\",\\n \\"ConnectionPort\\": \\"3717\\",\\n \\"ReplicaSetRole\\": \\"Primary\\",\\n \\"ConnectionDomain\\": \\"dds-bp11483712c1****.mongodb.rds.aliyuncs.com\\",\\n \\"VPCCloudInstanceId\\": \\"dds-bp11483712c1****\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"VPCId\\": \\"vpc-bp1jk5vwkcri27qme****\\"\\n }\\n ]\\n },\\n \\"ReplacateId\\": \\"bls-m****\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test\\",\\n \\"Value\\": \\"api\\"\\n }\\n ]\\n },\\n \\"VpcAuthMode\\": \\"Open\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"EngineVersion\\": \\"4.4\\",\\n \\"MaxIOPS\\": 1000,\\n \\"MaxMBPS\\": 350,\\n \\"VPCCloudInstanceIds\\": \\"dds-bp11483712c1****\\",\\n \\"MongosList\\": {\\n \\"MongosAttribute\\": [\\n {\\n \\"VpcCloudInstanceId\\": \\"s-bp1d8c262a158****\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"MaxIOPS\\": 800,\\n \\"VSwitchId\\": \\"vsw-bp1vj604nj5a9zz74****\\",\\n \\"NodeClass\\": \\"dds.mongos.mid\\",\\n \\"MaxConnections\\": 1000,\\n \\"Port\\": 3717,\\n \\"VPCId\\": \\"vpc-bp1n3i15v90el48nx****\\",\\n \\"ConnectSting\\": \\"s-bp1d8c262a15****.mongodb.rds.aliyuncs.com\\",\\n \\"NodeDescription\\": \\"mongos1\\",\\n \\"NodeId\\": \\"s-bp1d8c262a15****\\",\\n \\"Status\\": \\"Running\\",\\n \\"CurrentKernelVersion\\": \\"mongodb_20220518_4.0.21\\",\\n \\"ConnectString\\": \\"s-bp1d8c262a15****.mongodb.rds.aliyuncs.com\\"\\n }\\n ]\\n },\\n \\"ProtocolType\\": \\"mongodb\\",\\n \\"DBInstanceDescription\\": \\"测试数据库\\",\\n \\"CurrentKernelVersion\\": \\"5.0.5-20220721143518_0\\",\\n \\"DBInstanceReleaseProtection\\": false,\\n \\"ExpireTime\\": \\"2022-02-05T16:00Z\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"DBInstanceType\\": \\"replicate\\",\\n \\"LastDowngradeTime\\": \\"2022-01-08\\",\\n \\"ShardList\\": {\\n \\"ShardAttribute\\": [\\n {\\n \\"LockMode\\": \\"Unlock\\",\\n \\"MaxIOPS\\": 8000,\\n \\"ConnectString\\": \\"d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****\\",\\n \\"NodeClass\\": \\"dds.shard.mid\\",\\n \\"MaxConnections\\": 8000,\\n \\"Port\\": 3717,\\n \\"NodeDescription\\": \\"testshard\\",\\n \\"NodeId\\": \\"d-bp16e09d9c5d****\\",\\n \\"NodeStorage\\": 10,\\n \\"ReadonlyReplicas\\": 0,\\n \\"Status\\": \\"Running\\",\\n \\"MaxDiskMbps\\": \\"350\\",\\n \\"CurrentKernelVersion\\": \\"mongodb_20220518_4.0.21\\",\\n \\"ReplicaSetName\\": \\"mgset-xxxx\\"\\n }\\n ]\\n },\\n \\"MaintainEndTime\\": \\"03:00Z\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"VPCId\\": \\"vpc-bp1n3i15v90el48nx****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstanceStorage\\": 10,\\n \\"ReplicaSetName\\": \\"mgset-10ace****\\",\\n \\"VSwitchId\\": \\"vsw-bp1oo2a7isyrb8igf****\\",\\n \\"StorageEngine\\": \\"WiredTiger\\",\\n \\"ConfigserverList\\": {\\n \\"ConfigserverAttribute\\": [\\n {\\n \\"MaxIOPS\\": 1000,\\n \\"LockMode\\": \\"Unlock\\",\\n \\"ConnectString\\": \\"dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com\\",\\n \\"NodeClass\\": \\"dds.cs.mid\\",\\n \\"MaxConnections\\": 1000,\\n \\"Port\\": 3717,\\n \\"NodeDescription\\": \\"testConfigserver\\",\\n \\"NodeId\\": \\"dds-bp11483712c1****-cs\\",\\n \\"NodeStorage\\": 20,\\n \\"Status\\": \\"Running\\",\\n \\"CurrentKernelVersion\\": \\"mongodb_20220518_4.0.21\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"MaxConnections\\": 500,\\n \\"DBInstanceId\\": \\"dds-bp11483712c1****\\",\\n \\"DBInstanceClass\\": \\"dds.mongo.mid\\",\\n \\"Engine\\": \\"MongoDB\\",\\n \\"ReadonlyReplicas\\": \\"1\\",\\n \\"ReplicationFactor\\": \\"3\\",\\n \\"KindCode\\": \\"18\\",\\n \\"CapacityUnit\\": \\"100\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"StorageType\\": \\"cloud_essd1\\",\\n \\"DestroyTime\\": \\"2021-12-10T16:00:00Z\\",\\n \\"DBInstanceOrderStatus\\": \\"all_completed\\",\\n \\"Encrypted\\": true,\\n \\"EncryptionKey\\": \\"07609cc3-3109-408f-a35e-c548e776da0b\\",\\n \\"SyncPercent\\": \\"0.8\\",\\n \\"UseClusterBackup\\": true,\\n \\"BurstingEnabled\\": true,\\n \\"ProvisionedIops\\": 1960,\\n \\"DisasterRecoveryInfo\\": \\"{\\\\\\"relations\\\\\\":[{\\\\\\"destInsName\\\\\\":\\\\\\"dds-bp11483712c1****\\\\\\",\\\\\\"destRegionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\\\"srcInsName\\\\\\":\\\\\\"dds-7xv054b9c43c****\\\\\\",\\\\\\"srcRegionId\\\\\\":\\\\\\"cn-guangzhou\\\\\\"}]}\\",\\n \\"SearchNodeClass\\": \\"mdb.shard.2x.xlarge.d\\",\\n \\"SearchNodeStorage\\": 20,\\n \\"SearchNodeCount\\": 2\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDBInstanceAttribute', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeDBInstanceEncryptionKey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + 'title' => '', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom key for the instance. You can call the [DescribeUserEncryptionKeyList](~~151729~~) operation to query the list of custom keys for an ApsaraDB for MongoDB instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Origin' => [ + 'description' => 'The source of the key for the instance.'."\n", + 'type' => 'string', + 'example' => 'Aliyun_KMS', + 'title' => '', + ], + 'Description' => [ + 'description' => 'The description of the key for the instance.'."\n", + 'type' => 'string', + 'example' => 'key description example', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '783C2062-A2D3-4EA8-88AD-E43F990C23BB', + 'title' => '', + ], + 'EncryptionKeyStatus' => [ + 'description' => 'Indicates whether the key for the instance is enabled. Valid values:'."\n" + ."\n" + .'* **Enabled**'."\n" + .'* **Disabled**'."\n", + 'type' => 'string', + 'example' => 'Enabled', + 'title' => '', + ], + 'MaterialExpireTime' => [ + 'description' => 'The expiration time of the key for the instance. The time is displayed in UTC. If the parameter is left empty, the key for the instance will not expire.'."\n", + 'type' => 'string', + 'example' => '2020-07-06T18:22:03Z', + 'title' => '', + ], + 'KeyUsage' => [ + 'description' => 'The purpose of the key for the instance.'."\n", + 'type' => 'string', + 'example' => 'ENCRYPT/DECRYPT', + 'title' => '', + ], + 'EncryptionKey' => [ + 'description' => 'The key for the instance.'."\n", + 'type' => 'string', + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + 'title' => '', + ], + 'Creator' => [ + 'description' => 'The UID of the key creator.'."\n", + 'type' => 'string', + 'example' => '123456', + 'title' => '', + ], + 'DeleteDate' => [ + 'description' => 'The scheduled time when the key for the instance will be deleted. If the parameter is left empty, the key will not be deleted.'."\n", + 'type' => 'string', + 'example' => '2020-07-06T18:22:03Z', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'INVALID_INSNAME_REGIONID_EMPTY', + 'errorMessage' => 'The insName and regionId can\'t be all empty', + 'description' => '', + ], + [ + 'errorCode' => 'NO_ACTIVE_BYOK', + 'errorMessage' => 'This custins no active byok.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeDBInstanceEncryptionKey', + 'summary' => 'Queries the details of a key for an ApsaraDB for MongoDB instance.', + 'description' => 'When you call the DescribeDBInstanceEncryptionKey operation, the instance must have transparent data encryption (TDE) enabled in BYOK mode. You can call the [ModifyDBInstanceTDE](~~131267~~) operation to enable TDE.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceEncryptionKey', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Origin\\": \\"Aliyun_KMS\\",\\n \\"Description\\": \\"key description example\\",\\n \\"RequestId\\": \\"783C2062-A2D3-4EA8-88AD-E43F990C23BB\\",\\n \\"EncryptionKeyStatus\\": \\"Enabled\\",\\n \\"MaterialExpireTime\\": \\"2020-07-06T18:22:03Z\\",\\n \\"KeyUsage\\": \\"ENCRYPT/DECRYPT\\",\\n \\"EncryptionKey\\": \\"2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\",\\n \\"Creator\\": \\"123456\\",\\n \\"DeleteDate\\": \\"2020-07-06T18:22:03Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBInstanceEncryptionKeyResponse>\\n <Origin>Aliyun_KMS</Origin>\\n <Description>key description example</Description>\\n <RequestId>783C2062-A2D3-4EA8-88AD-E43F990C23BB</RequestId>\\n <EncryptionKeyStatus>Enabled</EncryptionKeyStatus>\\n <MaterialExpireTime>2020-07-06T18:22:03Z</MaterialExpireTime>\\n <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>\\n <EncryptionKey>2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</EncryptionKey>\\n <Creator>123456</Creator>\\n <DeleteDate>2020-07-06T18:22:03Z</DeleteDate>\\n</DescribeDBInstanceEncryptionKeyResponse>","errorExample":""}]', + ], + 'DescribeDBInstanceMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8271', + 'abilityTreeNodes' => [ + 'FEATUREmongodb4MQMUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1143f90ff3****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'EFD65226-08CC-4C4D-B6A4-CB3C382F67B0', + 'title' => '', + ], + 'Granularity' => [ + 'description' => 'The collection frequency of monitoring data for the instance. Valid value: **5**. Unit: seconds.', + 'type' => 'string', + 'example' => '5', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DescribeDBInstanceMonitor', + 'summary' => 'Queries the collection frequency of monitoring data for an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFD65226-08CC-4C4D-B6A4-CB3C382F67B0\\",\\n \\"Granularity\\": \\"5\\"\\n}","type":"json"}]', + ], + 'DescribeDBInstancePerformance' => [ + 'summary' => 'Queries the performance data of a MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8272', + 'abilityTreeNodes' => [ + 'FEATUREmongodb4MQMUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> **NodeId** is required when specifying a sharded cluster instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2635****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a mongos or shard node in the sharded cluster instance. This parameter lets you query the performance of a single node.'."\n" + ."\n" + .'> Available only when **DBInstanceId** is set to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp2287****', + 'title' => '', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance metrics. For more information, see [Metrics](~~216973~~).'."\n" + ."\n" + .'> To specify multiple metrics, separate them with commas (,).', + 'type' => 'string', + 'required' => true, + 'example' => 'CpuUsage', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.', + 'type' => 'string', + 'required' => true, + 'example' => '2022-06-13T10:58Z', + 'title' => '', + ], + ], + [ + '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.', + 'type' => 'string', + 'required' => true, + 'example' => '2022-06-13T11:58Z', + 'title' => '', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role ID of a node in a standalone or replica set instance. To query the role ID, call the [DescribeReplicaSetRole](~~62134~~) operation.'."\n" + ."\n" + .'> Available only when **DBInstanceId** is set to the ID of a standalone or replica set instance.', + 'type' => 'string', + 'required' => false, + 'example' => '6025****', + 'title' => '', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data granularity of the performance metrics in seconds. Valid values: 5, 30, 60, 600, 1800, 3600, and 86400.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '60', + 'title' => '', + ], + ], + [ + 'name' => 'ReplicaSetRole', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of a node in a standalone or replica set instance. Valid values:'."\n" + ."\n" + .'- **Primary**: The primary node.'."\n" + ."\n" + .'- **Secondary**: A secondary node.'."\n" + ."\n" + .'> * Available only when **DBInstanceId** is set to the ID of a standalone or replica set instance.'."\n" + .'>'."\n" + .'> * If **DBInstanceId** is set to the ID of a standalone instance, this parameter only supports the value **Primary**.', + 'type' => 'string', + 'required' => false, + 'default' => 'Primary', + 'enum' => [ + 'Primary', + 'Secondary', + 'Readonly', + ], + 'example' => 'Primary', + 'title' => '', + ], + ], + [ + 'name' => 'SearchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Search node ID.'."\n" + ."\n" + .'> Available only after the Search feature is enabled for the instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-2zec12675c9e****-search', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceKey' => [ + 'description' => 'The list of performance metrics.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The performance metric.', + 'type' => 'string', + 'example' => 'CpuUsage', + 'title' => '', + ], + 'Unit' => [ + 'description' => 'The unit of the performance metric.', + 'type' => 'string', + 'example' => '%', + 'title' => '', + ], + 'ValueFormat' => [ + 'description' => 'The format of the performance metric values. If a performance metric contains multiple fields, the fields are separated by ampersands (&).'."\n" + ."\n" + .'For example, if you query the disk space usage, the returned **ValueFormat** is **ins\\_size\\&data\\_size\\&log\\_size**.', + 'type' => 'string', + 'example' => 'cpu_usage', + 'title' => '', + ], + 'PerformanceValues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceValue' => [ + 'description' => 'The list of performance metric values.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the performance metric.', + 'type' => 'string', + 'example' => '0.23', + 'title' => '', + ], + 'Date' => [ + 'description' => 'The time when the performance metric value was generated.', + 'type' => 'string', + 'example' => '2022-06-13T10:58:00Z', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EndTime' => [ + 'description' => 'The end of the time range to query. The time is in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2022-06-13T11:58Z', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '4A300BC7-6D8F-527F-A2DB-A7768D26E9AC', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'The beginning of the time range to query. The time is in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2022-06-13T10:58Z', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPerformanceKey.Malformed', + 'errorMessage' => 'The specified parameter Key is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidStartTimeAndEndTime.Malformed', + 'errorMessage' => 'The end time must be greater than the start time', + 'description' => 'The end time cannot be earlier than the start time.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceKey\\": [\\n {\\n \\"Key\\": \\"CpuUsage\\",\\n \\"Unit\\": \\"%\\",\\n \\"ValueFormat\\": \\"cpu_usage\\",\\n \\"PerformanceValues\\": {\\n \\"PerformanceValue\\": [\\n {\\n \\"Value\\": \\"0.23\\",\\n \\"Date\\": \\"2022-06-13T10:58:00Z\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"EndTime\\": \\"2022-06-13T11:58Z\\",\\n \\"RequestId\\": \\"4A300BC7-6D8F-527F-A2DB-A7768D26E9AC\\",\\n \\"StartTime\\": \\"2022-06-13T10:58Z\\"\\n}","type":"json"}]', + 'title' => 'DescribeDBInstancePerformance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstancePerformance', + 'authLevel' => 'resource', + 'actionConditions' => [ + [ + 'conditionKey' => 'dds:ResourceTag', + 'validationType' => 'always', + ], + ], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeDBInstanceSSL' => [ + 'summary' => 'Queries the details of the SSL configuration for a MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmongodbKJCC1K', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SSLExpiredTime' => [ + 'description' => 'The expiration time of the SSL certificate. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.', + 'type' => 'string', + 'example' => '2020-03-11T02:28:25Z', + 'title' => '', + ], + 'SSLStatus' => [ + 'description' => 'The status of the SSL feature.'."\n" + ."\n" + .'- **Open**: The SSL feature is enabled.'."\n" + ."\n" + .'- **Closed**: The SSL feature is disabled.', + 'type' => 'string', + 'example' => 'Open', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '36BB1BC2-789C-4BBA-A519-C5B388E4B0D4', + 'title' => '', + ], + 'CertCommonName' => [ + 'description' => 'The name of the SSL certificate.', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + 'ForceEncryption' => [ + 'description' => 'Specifies whether connections must be encrypted using SSL. Valid values:'."\n" + ."\n" + .'- **1**: Connections must be encrypted using SSL.'."\n" + ."\n" + .'- **0**: Connections do not need to be encrypted using SSL.', + 'enumValueTitles' => [ + '0', + '1', + ], + 'type' => 'string', + 'title' => '', + 'example' => '0', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SSLExpiredTime\\": \\"2020-03-11T02:28:25Z\\",\\n \\"SSLStatus\\": \\"Open\\",\\n \\"RequestId\\": \\"36BB1BC2-789C-4BBA-A519-C5B388E4B0D4\\",\\n \\"CertCommonName\\": \\"dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com\\",\\n \\"ForceEncryption\\": \\"0\\"\\n}","type":"json"}]', + 'title' => 'DescribeDBInstanceSSL', + 'description' => 'The instance must meet the following requirements:'."\n" + ."\n" + .'- The instance status is Running.'."\n" + ."\n" + .'- The instance is a replica set instance or a sharded cluster instance.'."\n" + ."\n" + .' - The replica set instance must be version 3.4 or later.'."\n" + ."\n" + .' - The sharded cluster instance must use Enhanced SSDs (ESSDs).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeDBInstanceSpecInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '268668', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWP8F69', + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The instance type. You can query this parameter by calling the [DescribeDBInstanceAttribute](https://next.api.aliyun.com/api/Dds/2015-12-01/DescribeDBInstanceAttribute) operation.'."\n" + ."\n" + .'For instance types of different instance categories, see the following topics:'."\n" + ."\n" + .'- [Specifications of standalone instances](~~311407~~)'."\n" + ."\n" + .'- [Specifications of replica set instances](~~311410~~)'."\n" + ."\n" + .'- [Specifications of sharded cluster instances](~~311414~~)', + 'type' => 'string', + 'required' => true, + 'example' => 'mdb.shard.4x.large.d', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '6B82A9EF-9961-5A31-A19F-009B709xxxxx', + 'title' => '', + ], + 'CPU' => [ + 'description' => 'The number of CPU cores.', + 'type' => 'string', + 'example' => '2', + 'title' => '', + ], + 'Memory' => [ + 'description' => 'The memory size, in GB.', + 'type' => 'string', + 'example' => '8', + 'title' => '', + ], + 'Description' => [ + 'description' => 'The description of the instance type.', + 'type' => 'string', + 'example' => '2核8GB（独享型）', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DescribeDBInstanceSpecInfo', + 'summary' => 'Gets instance type details.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceSpecInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6B82A9EF-9961-5A31-A19F-009B709xxxxx\\",\\n \\"CPU\\": \\"2\\",\\n \\"Memory\\": \\"8\\",\\n \\"Description\\": \\"2核8GB（独享型）\\"\\n}","type":"json"}]', + ], + 'DescribeDBInstanceSwitchLog' => [ + 'summary' => 'Queries the primary/secondary switching logs of an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmongodb82MXBJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-mm-dd*T*hh:mm*Z format. The time must be in UTC.', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-27T02:46Z', + 'title' => '', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-mm-dd*T*hh:mm*Z format. The time must be in UTC. The end time must be later than the start time.', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-28T02:00Z', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value must be an integer that is greater than 0 and less than or equal to the maximum value supported by the integer data type. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'default' => '1', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **30, 50, and 100**. Default value: **30**.', + 'type' => 'integer', + 'format' => 'int32', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-uf68f1b5a57exxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'ECBCA991-XXXX-XXXX-834C-B3E8007F33AA', + 'title' => '', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-uf68f1b5a57exxxx', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'The number of primary/secondary switching entries.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned on each page.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number returned.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'LogItems' => [ + 'description' => 'The primary/secondary switchover logs.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SwitchStatus' => [ + 'description' => 'The switchover status. Valid values: **1** and **0**. The value 1 indicates a successful primary/secondary switchover and the value 0 indicates a failed primary/secondary switchover.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'SwitchTime' => [ + 'description' => 'The point in time when a primary/secondary switchover was performed. The time follows the ISO 8601 standard in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-02-07T18:00:00Z', + 'title' => '', + ], + 'SwitchCode' => [ + 'description' => 'The code that indicates the reason of a primary/secondary switchover. Valid values:'."\n" + ."\n" + .'- USER\\_CONSOLE\\_OPERATION: The switchover is manually performed.'."\n" + ."\n" + .'- OPERATION\\_AND\\_MAINTENANCE: Potential risks exist.'."\n" + ."\n" + .'- MACHINE\\_DOWNTIME: The host is offline.'."\n" + ."\n" + .'- PRIMARY\\_UNHEALTHY: An exception occurs on the primary node of the instance.'."\n" + ."\n" + .'- SECONDARY\\_UNHEALTHY: An exception occurs on the secondary node of the instance.'."\n" + ."\n" + .'- MULTIPLE\\_NODE\\_FAILURES: An exception occurs on multiple nodes of the instance.', + 'type' => 'string', + 'example' => 'USER_CONSOLE_OPERATION', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'The ID of the replica set instance or the ID of the node on which a primary/secondary switchover is performed.', + 'type' => 'string', + 'example' => '当实例为副本集实例：dds-uf68f1b5a57exxxx。'."\n" + .'当实例为分片集实例：d-uf652b73f554xxxx', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time', + 'description' => 'The start time must be earlier than the end time.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DescribeDBInstanceSwitchLog', + 'description' => 'Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:'."\n" + ."\n" + .'- The instance is a replica set or sharded cluster instance.'."\n" + ."\n" + .'- The instance uses local physical disks to store data.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceSwitchLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ECBCA991-XXXX-XXXX-834C-B3E8007F33AA\\",\\n \\"DBInstanceId\\": \\"dds-uf68f1b5a57exxxx\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"LogItems\\": [\\n {\\n \\"SwitchStatus\\": \\"1\\",\\n \\"SwitchTime\\": \\"2023-02-07T18:00:00Z\\",\\n \\"SwitchCode\\": \\"USER_CONSOLE_OPERATION\\",\\n \\"NodeId\\": \\"当实例为副本集实例：dds-uf68f1b5a57exxxx。\\\\n当实例为分片集实例：d-uf652b73f554xxxx\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDBInstanceTDEInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TDEStatus' => [ + 'description' => 'The TDE status. Valid values:'."\n" + ."\n" + .'- **enabled**'."\n" + ."\n" + .'- **disabled**', + 'type' => 'string', + 'example' => 'enabled', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'F4DD0E29-361B-42F2-9301-B0048CCCE5D6', + 'title' => '', + ], + 'RoleARN' => [ + 'description' => '指定待授权角色的全局资源描述符 ARN（Alibaba Cloud Resource Name）信息。', + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole', + 'title' => '', + ], + 'EncryptionKey' => [ + 'description' => '实例的自定义密钥。'."\n" + ."\n" + .'目前仅以下地域支持 BYOK（Bring Your Own Key，用户可以自行管理和拥有加密密钥）：'."\n" + ."\n" + .'- 华东 1（杭州）'."\n" + ."\n" + .'- 华东 2（上海）'."\n" + ."\n" + .'- 华北 2（北京）'."\n" + ."\n" + .'- 华南 1（深圳）'."\n" + ."\n" + .'- 中国（香港）'."\n" + ."\n" + .'- 新加坡'."\n" + ."\n" + .'- 马来西亚（吉隆坡）'."\n" + ."\n" + .'> 支持 BYOK，用户可以管理且拥有密钥，系统将返回用户的自定义密钥；不支持 BYOK，用户不可管理密钥，系统将返回字符串`NoActiveBYOK`。', + 'type' => 'string', + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + 'title' => '', + ], + 'EncryptorName' => [ + 'description' => '加密算法。', + 'type' => 'string', + 'example' => 'aes-256-cbc', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeDBInstanceTDEInfo', + 'summary' => 'Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.', + 'description' => '> For more information about TDE, see [TDE](~~131048~~).'."\n" + ."\n" + .'Before you call this operation, make sure that the instance meets the following requirements:'."\n" + ."\n" + .'- The instance is a replica set or sharded cluster instance.'."\n" + ."\n" + .'- The storage engine of the instance is WiredTiger.'."\n" + ."\n" + .'- The database engine version of the instance is 4.0 or 4.2. If the database engine version is earlier than 4.0, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceTDEInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TDEStatus\\": \\"enabled\\",\\n \\"RequestId\\": \\"F4DD0E29-361B-42F2-9301-B0048CCCE5D6\\",\\n \\"RoleARN\\": \\"acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole\\",\\n \\"EncryptionKey\\": \\"2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\",\\n \\"EncryptorName\\": \\"aes-256-cbc\\"\\n}","type":"json"}]', + ], + 'DescribeDBInstances' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8273', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~61933~~) operation to query the region ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be greater than 0 and no greater than the maximum value of the integer data type. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- **30** (default)'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp199659b178****', + 'title' => '', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes in the replica set instance. Valid values:'."\n" + ."\n" + .'- **3**'."\n" + ."\n" + .'- **5**'."\n" + ."\n" + .'- **7**', + 'type' => 'string', + 'required' => false, + 'example' => '3', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name. The name must meet the following requirements:'."\n" + ."\n" + .'- It must start with a Chinese character or a letter.'."\n" + ."\n" + .'- It can contain digits, Chinese characters, letters, underscores (\\_), and hyphens (-).'."\n" + ."\n" + .'- It must be 2 to 256 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => '测试数据库', + 'title' => '', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration time of the instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n" + .'This parameter is used to filter instances that expire on or before the specified time.', + 'type' => 'string', + 'required' => false, + 'enum' => [], + 'example' => '2019-12-26T16:00:00Z', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance status. For more information, see [Instance states](~~63870~~).', + 'type' => 'string', + 'required' => false, + 'enum' => [], + 'example' => 'Running', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance architecture. Valid values:'."\n" + ."\n" + .'- **sharding**: sharded cluster instance.'."\n" + ."\n" + .'- **replicate**: replica set or standalone instance. This is the default value.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **serverless**: serverless instance.'."\n" + ."\n" + .'</props>', + 'type' => 'string', + 'required' => false, + 'default' => 'replicate', + 'example' => 'sharding', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type. For more information, see [Instance types](~~57141~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.mongo.mid', + 'title' => '', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine. Set the value to **MongoDB**.', + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'MongoDB', + ], + 'example' => 'MongoDB', + 'title' => '', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine version. Valid values:'."\n" + ."\n" + .'- **7.0**'."\n" + ."\n" + .'- **6.0**'."\n" + ."\n" + .'- **5.0**'."\n" + ."\n" + .'- **4.4**'."\n" + ."\n" + .'- **4.2**'."\n" + ."\n" + .'- **4.0**'."\n" + ."\n" + .'- **3.4**', + 'type' => 'string', + 'required' => false, + 'example' => '4.0', + 'title' => '', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'- **Classic**: classic network.'."\n" + ."\n" + .'- **VPC**: virtual private cloud (VPC).', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + 'title' => '', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The VPC ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1n3i15v90el48nx****', + 'title' => '', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID of the VPC.', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1vj604nj5a9zz74****', + 'title' => '', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PrePaid**: subscription.'."\n" + ."\n" + .'- **PostPaid**: pay-as-you-go.', + 'type' => 'string', + 'required' => false, + 'example' => 'PrePaid', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID. You can call the [DescribeRegions](~~61933~~) operation to query the zone ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + 'title' => '', + ], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration status of the instance. Valid values:'."\n" + ."\n" + .'- **true**: The instance is expired.'."\n" + ."\n" + .'- **false**: The instance is not expired.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'ConnectionDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint of the node. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the endpoint.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags of the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N. The value of N must be in the range of **1** to **20**.'."\n" + ."\n" + .'- The tag key cannot start with `aliyun`, `acs:`, `http://`, or `https://`.'."\n" + ."\n" + .'- The tag key can be up to 64 characters in length.'."\n" + ."\n" + .'- The tag key cannot be an empty string.', + 'type' => 'string', + 'required' => false, + 'example' => 'testdatabase', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The value of tag N. The value of N must be in the range of **1** to **20**.'."\n" + ."\n" + .'- The tag value cannot start with `aliyun`, `acs`:, `http://`, or `https://`.'."\n" + ."\n" + .'- The tag value can be up to 128 characters in length.'."\n" + ."\n" + .'- The tag value can be an empty string.', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + 'title' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'DBNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filters instances by type. Valid values:'."\n" + ."\n" + .'1. customized: standalone instances and DBFS instances.'."\n" + ."\n" + .'2. standard: standard instances, which include replica set and sharded cluster instances.'."\n" + ."\n" + .'3. default: all instances.', + 'type' => 'string', + 'required' => false, + 'default' => 'default', + 'example' => 'default', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The number of instances returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '0E4FE33F-5510-5758-8FA7-A6672CDE****', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'DBInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => 'The details of the instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the instance was created. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2021-03-25T02:18:00Z', + 'title' => '', + ], + 'ChargeType' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PrePaid**: subscription.'."\n" + ."\n" + .'- **PostPaid**: pay-as-you-go.', + 'type' => 'string', + 'example' => 'PrePaid', + 'title' => '', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The details of the resource tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the resource tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The tag value.', + 'type' => 'string', + 'example' => 'api', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'VpcAuthMode' => [ + 'description' => 'Indicates whether password-free access over a VPC is enabled. Valid values:'."\n" + ."\n" + .'- **Open**: enabled.'."\n" + ."\n" + .'- **Close**: disabled.', + 'type' => 'string', + 'example' => 'Close', + 'title' => '', + ], + 'NetworkType' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'- **Classic**: classic network.'."\n" + ."\n" + .'- **VPC**: VPC.', + 'type' => 'string', + 'example' => 'Classic', + 'title' => '', + ], + 'LockMode' => [ + 'description' => 'The lock status of the instance. Valid values:'."\n" + ."\n" + .'- **Unlock**: The instance is not locked.'."\n" + ."\n" + .'- **ManualLock**: The instance is manually locked.'."\n" + ."\n" + .'- **LockByExpiration**: The instance is automatically locked due to expiration.'."\n" + ."\n" + .'- **LockByRestoration**: The instance is automatically locked before a rollback.'."\n" + ."\n" + .'- **LockByDiskQuota**: The instance is automatically locked because the storage space is full.'."\n" + ."\n" + .'- **Released**: The instance is released. In this state, the instance cannot be unlocked. You can only create a new instance from a backup file. The restoration process may take a long time.', + 'type' => 'string', + 'example' => 'Unlock', + 'title' => '', + ], + 'EngineVersion' => [ + 'description' => 'The database engine version. Valid values:'."\n" + ."\n" + .'- **7.0**'."\n" + ."\n" + .'- **6.0**'."\n" + ."\n" + .'- **5.0**'."\n" + ."\n" + .'- **4.4**'."\n" + ."\n" + .'- **4.2**'."\n" + ."\n" + .'- **4.0**'."\n" + ."\n" + .'- **3.4**', + 'type' => 'string', + 'example' => '4.2', + 'title' => '', + ], + 'MongosList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MongosAttribute' => [ + 'description' => 'The details of the Mongos nodes.'."\n" + ."\n" + .'> This parameter is returned only for sharded cluster instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the Mongos nodes.'."\n" + ."\n" + .'> This parameter is returned only for sharded cluster instances.', + 'type' => 'object', + 'properties' => [ + 'NodeClass' => [ + 'description' => 'The instance type of the Mongos node.', + 'type' => 'string', + 'example' => 'dds.mongos.standard', + 'title' => '', + ], + 'NodeDescription' => [ + 'description' => 'The description of the Mongos node.', + 'type' => 'string', + 'example' => '测试mongos节点', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'The ID of the Mongos node.', + 'type' => 'string', + 'example' => 's-bp10e3b0d02f****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DBInstanceDescription' => [ + 'description' => 'The description of the instance.', + 'type' => 'string', + 'example' => '测试数据库', + 'title' => '', + ], + 'ExpireTime' => [ + 'description' => 'The time when the instance expires. The time is in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2021-11-25T16:00Z', + 'title' => '', + ], + 'DBInstanceType' => [ + 'description' => 'The instance architecture. Valid values:'."\n" + ."\n" + .'- **sharding**: sharded cluster instance.'."\n" + ."\n" + .'- **replicate**: replica set or standalone instance.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **serverless**: serverless instance.'."\n" + ."\n" + .'</props>', + 'type' => 'string', + 'example' => 'sharding', + 'title' => '', + ], + 'LastDowngradeTime' => [ + 'description' => 'The last time when the instance was downgraded.', + 'type' => 'string', + 'example' => '2021-05-08', + 'title' => '', + ], + 'ShardList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ShardAttribute' => [ + 'description' => 'The details of the shard nodes.'."\n" + ."\n" + .'> This parameter is returned only for sharded cluster instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the shard nodes.'."\n" + ."\n" + .'> This parameter is returned only for sharded cluster instances.', + 'type' => 'object', + 'properties' => [ + 'NodeClass' => [ + 'description' => 'The instance type of the shard node.', + 'type' => 'string', + 'example' => 'dds.shard.mid', + 'title' => '', + ], + 'NodeDescription' => [ + 'description' => 'The description of the shard node.', + 'type' => 'string', + 'example' => '测试shard节点', + 'title' => '', + ], + 'NodeStorage' => [ + 'description' => 'The storage space of the shard node. Unit: GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'The ID of the shard node.', + 'type' => 'string', + 'example' => 'd-bp1cac6f2083****', + 'title' => '', + ], + 'ReadonlyReplicas' => [ + 'description' => 'The number of read-only nodes in the shard node. The value can be an integer from **0** to **5**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DestroyTime' => [ + 'description' => 'The time when the data of the instance is destroyed. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" + ."\n" + .'> - For a subscription instance, its computing resources are released on the 16th day after the instance expires. The data is retained for another 7 days. On the 23rd day, the data is deleted and cannot be recovered.'."\n" + .'>'."\n" + .'> - For a pay-as-you-go instance, its computing resources are released on the 16th day after its payment becomes overdue. The data is retained for another 7 days. On the 23rd day, the data is deleted and cannot be recovered.', + 'type' => 'string', + 'example' => '2021-12-10T16:00:00Z', + 'title' => '', + ], + 'DBInstanceStatus' => [ + 'description' => 'The instance status. For more information, see [Instance states](~~63870~~).', + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'DBInstanceStorage' => [ + 'description' => 'The storage space of the instance.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + 'title' => '', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-bp18b0934e70****', + 'title' => '', + ], + 'DBInstanceClass' => [ + 'description' => 'The instance type.', + 'type' => 'string', + 'example' => 'dds.mongo.mid', + 'title' => '', + ], + 'Engine' => [ + 'description' => 'The database engine.', + 'type' => 'string', + 'example' => 'MongoDB', + 'title' => '', + ], + 'ReplicationFactor' => [ + 'description' => 'The number of nodes in the instance.'."\n" + ."\n" + .'> This parameter is returned only for replica set instances.', + 'type' => 'string', + 'example' => '3', + 'title' => '', + ], + 'KindCode' => [ + 'description' => 'The type of the instance. Valid values:'."\n" + ."\n" + .'- **0**: physical server.'."\n" + ."\n" + .'- **1**: ECS.'."\n" + ."\n" + .'- **2**: Docker.'."\n" + ."\n" + .'- **18**: instance on the new Kubernetes-based architecture.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'CapacityUnit' => [ + 'description' => 'The read and write throughput consumed by the instance.'."\n" + ."\n" + .'> This parameter is returned only for serverless instances.', + 'type' => 'string', + 'example' => '100', + 'title' => '', + ], + 'StorageType' => [ + 'description' => 'The storage type. Valid values:'."\n" + ."\n" + .'- **cloud\\_essd**: ESSD cloud disk.'."\n" + ."\n" + .'- **local\\_ssd**: local SSD.', + 'type' => 'string', + 'example' => 'local_ssd', + 'title' => '', + ], + 'BackupRetentionPolicy' => [ + 'description' => 'The backup retention policy. Valid values:'."\n" + ."\n" + .'- **0**: All backup sets are immediately deleted when the instance is released.'."\n" + ."\n" + .'- **1**: An automatic backup is performed when the instance is released, and this backup set is retained for a long time.'."\n" + ."\n" + .'- **2**: An automatic backup is performed when the instance is released, and all backup sets of the cluster are retained for a long time.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ReleaseTime' => [ + 'description' => 'The release time of the instance.', + 'type' => 'string', + 'example' => '2024-06-17T07:01Z', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeDBInstances', + 'summary' => 'Queries a list of MongoDB instances.', + 'description' => '<props="china">By default, this operation queries a list of replica set instances, which includes standalone instances. If you do not specify the **DBInstanceType** request parameter, the default value is **replicate**. To query a list of sharded cluster instances, set **DBInstanceType** to **sharding**. To query a list of serverless instances, set **DBInstanceType** to **serverless**.</props>'."\n" + .'<props="intl">By default, this operation queries a list of replica set instances, which includes standalone instances. If you do not specify the **DBInstanceType** request parameter, the default value is **replicate**. To query a list of sharded cluster instances, set **DBInstanceType** to **sharding**.</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5,\\n \\"RequestId\\": \\"0E4FE33F-5510-5758-8FA7-A6672CDE****\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBInstances\\": {\\n \\"DBInstance\\": [\\n {\\n \\"CreationTime\\": \\"2021-03-25T02:18:00Z\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test\\",\\n \\"Value\\": \\"api\\"\\n }\\n ]\\n },\\n \\"VpcAuthMode\\": \\"Close\\",\\n \\"NetworkType\\": \\"Classic\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"EngineVersion\\": \\"4.2\\",\\n \\"MongosList\\": {\\n \\"MongosAttribute\\": [\\n {\\n \\"NodeClass\\": \\"dds.mongos.standard\\",\\n \\"NodeDescription\\": \\"测试mongos节点\\",\\n \\"NodeId\\": \\"s-bp10e3b0d02f****\\"\\n }\\n ]\\n },\\n \\"DBInstanceDescription\\": \\"测试数据库\\",\\n \\"ExpireTime\\": \\"2021-11-25T16:00Z\\",\\n \\"DBInstanceType\\": \\"sharding\\",\\n \\"LastDowngradeTime\\": \\"2021-05-08\\",\\n \\"ShardList\\": {\\n \\"ShardAttribute\\": [\\n {\\n \\"NodeClass\\": \\"dds.shard.mid\\",\\n \\"NodeDescription\\": \\"测试shard节点\\",\\n \\"NodeStorage\\": 10,\\n \\"NodeId\\": \\"d-bp1cac6f2083****\\",\\n \\"ReadonlyReplicas\\": 2\\n }\\n ]\\n },\\n \\"DestroyTime\\": \\"2021-12-10T16:00:00Z\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstanceStorage\\": 20,\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"DBInstanceId\\": \\"dds-bp18b0934e70****\\",\\n \\"DBInstanceClass\\": \\"dds.mongo.mid\\",\\n \\"Engine\\": \\"MongoDB\\",\\n \\"ReplicationFactor\\": \\"3\\",\\n \\"KindCode\\": \\"1\\",\\n \\"CapacityUnit\\": \\"100\\",\\n \\"StorageType\\": \\"local_ssd\\",\\n \\"BackupRetentionPolicy\\": 1,\\n \\"ReleaseTime\\": \\"2024-06-17T07:01Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstancesOverview' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '117002', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWP8F69', + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Call [DescribeRegions](~~61933~~) to query the latest region list.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance whose overview you want to query.'."\n" + ."\n" + .'> - If you do not specify this parameter, an overview of all instances in your Alibaba Cloud account is returned.'."\n" + .'>'."\n" + .'> - You can specify multiple instance IDs. Separate the IDs with commas (,).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'dds-bp12c5b040dc****', + ], + ], + [ + 'name' => 'InstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the instance. For more information, see [Instance states](~~63870~~).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'Running', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PrePaid**: subscription'."\n" + ."\n" + .'- **PostPaid**: pay-as-you-go', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'PostPaid', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'- **Classic**: classic network'."\n" + ."\n" + .'- **VPC**: virtual private cloud (VPC)', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'Classic', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine version of the instance. Valid values: **5.0**, **4.4**, **4.2**, **4.0**, and **3.4**.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '4.0', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type. For more information about the instance types available for different instance architectures, see:'."\n" + ."\n" + .'- [Standalone instance types](~~311407~~)'."\n" + ."\n" + .'- [Replica set instance types](~~311410~~)'."\n" + ."\n" + .'- [Sharded cluster instance types](~~311414~~)'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'> This parameter is not required for Serverless instances.'."\n" + ."\n" + .'</props>', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'dds.mongo.2xlarge', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance architecture. Valid values:'."\n" + ."\n" + .'- **sharding**: sharded cluster instance'."\n" + ."\n" + .'- **replicate**: replica set or standalone instance'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **serverless**: Serverless instance'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'> * Set this parameter as needed. For example, to query the overview of a sharded cluster instance, set this parameter to **sharding**.'."\n" + .'>'."\n" + .'> * If you do not specify this parameter, an overview of all instances is returned.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'replicate', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. For more information about resource groups, see [View basic information about a resource group](~~151181~~).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'ShowTags', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return instance tags. The default value is false.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + 'title' => '', + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The number of instances returned.', + 'type' => 'string', + 'title' => '', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA', + ], + 'DBInstances' => [ + 'description' => 'A list of instance details.', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of instance details.', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the instance was created. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is in UTC.', + 'type' => 'string', + 'title' => '', + 'example' => '2022-01-05T03:18:53Z', + ], + 'ExpireTime' => [ + 'description' => 'The expiration time of the subscription instance. The time is in the *yyyy-MM-dd*T*HH:mm*Z format. The time is in UTC.', + 'type' => 'string', + 'title' => '', + 'example' => '2022-02-05T16:00Z', + ], + 'Tags' => [ + 'description' => 'The tags of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags of the instance.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n" + ."\n" + .'- The key cannot start with `aliyun`, `acs:`, `http://`, or `https://`.'."\n" + ."\n" + .'- The key can be up to 64 characters in length.'."\n" + ."\n" + .'- The key cannot be an empty string.', + 'type' => 'string', + 'title' => '', + 'example' => 'testdatabase', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n" + ."\n" + .'- The value cannot start with `aliyun`, `acs`:, `http://`, or `https://`.'."\n" + ."\n" + .'- The value can be up to 128 characters in length.'."\n" + ."\n" + .'- The value can be an empty string.', + 'type' => 'string', + 'title' => '', + 'example' => 'apitest', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'LastDowngradeTime' => [ + 'description' => 'The time when the instance was last downgraded.', + 'type' => 'string', + 'title' => '', + 'example' => '2021-05-08', + ], + 'ShardList' => [ + 'description' => 'The details of the shard nodes.'."\n" + ."\n" + .'> This parameter is returned only for sharded cluster instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the shard nodes.'."\n" + ."\n" + .'> This parameter is returned only for sharded cluster instances.', + 'type' => 'object', + 'properties' => [ + 'NodeClass' => [ + 'description' => 'The instance type of the shard node.', + 'type' => 'string', + 'title' => '', + 'example' => 'dds.shard.mid', + ], + 'NodeDescription' => [ + 'description' => 'The description of the shard node.', + 'type' => 'string', + 'title' => '', + 'example' => '测试shard节点', + ], + 'NodeStorage' => [ + 'description' => 'The storage capacity of the shard node, in GB.', + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'example' => '10', + ], + 'NodeId' => [ + 'description' => 'The ID of the shard node.', + 'type' => 'string', + 'title' => '', + 'example' => 'd-bp1cac6f2083****', + ], + 'ReadonlyReplicas' => [ + 'description' => 'The number of read-only nodes in the shard. Valid values: **0** to **5**.', + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'example' => '2', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DBInstanceType' => [ + 'description' => 'The instance architecture. Valid values:'."\n" + ."\n" + .'- **sharding**: sharded cluster instance'."\n" + ."\n" + .'- **replicate**: replica set or standalone instance'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **serverless**: Serverless instance'."\n" + ."\n" + .'</props>', + 'type' => 'string', + 'title' => '', + 'example' => 'replicate', + ], + 'DestroyTime' => [ + 'description' => 'The time when the data of the instance was destroyed. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.', + 'type' => 'string', + 'title' => '', + 'example' => '2021-12-10T16:00:00Z', + ], + 'ChargeType' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PrePaid**: subscription'."\n" + ."\n" + .'- **PostPaid**: pay-as-you-go', + 'type' => 'string', + 'title' => '', + 'example' => 'PrePaid', + ], + 'CapacityUnit' => [ + 'description' => 'The read/write throughput of the instance.'."\n" + ."\n" + .'> - This parameter is returned only for Serverless instances.'."\n" + .'>'."\n" + .'> - Serverless instances are available only on the China site (aliyun.com).', + 'type' => 'string', + 'title' => '', + 'example' => '100', + ], + 'VpcAuthMode' => [ + 'description' => 'Indicates whether password-free access over a VPC is enabled. Valid values:'."\n" + ."\n" + .'- **Open**: enabled'."\n" + ."\n" + .'- **Close**: disabled', + 'type' => 'string', + 'title' => '', + 'example' => 'Open', + ], + 'DBInstanceStatus' => [ + 'description' => 'The status of the instance. For more information, see [Instance states](~~63870~~).', + 'type' => 'string', + 'title' => '', + 'example' => 'Running', + ], + 'NetworkType' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'- **Classic**: classic network'."\n" + ."\n" + .'- **VPC**: virtual private cloud (VPC)', + 'type' => 'string', + 'title' => '', + 'example' => 'VPC', + ], + 'LockMode' => [ + 'description' => 'The lock mode of the instance.'."\n" + ."\n" + .'- **Unlock**: The instance is not locked.'."\n" + ."\n" + .'- **ManualLock**: The instance is manually locked.'."\n" + ."\n" + .'- **LockByExpiration**: The instance is automatically locked after it expires.'."\n" + ."\n" + .'- **LockByRestoration**: The instance is automatically locked before a rollback.'."\n" + ."\n" + .'- **LockByDiskQuota**: The instance is automatically locked after its storage space is exhausted.'."\n" + ."\n" + .'- **Released**: The instance is released. You cannot unlock a released instance. You can only restore the data of the instance to a new instance. The restoration may take a long time.', + 'type' => 'string', + 'title' => '', + 'example' => 'Unlock', + ], + 'EngineVersion' => [ + 'description' => 'The database engine version of the instance.', + 'type' => 'string', + 'title' => '', + 'example' => '4.2', + ], + 'MongosList' => [ + 'description' => 'The details of the mongos nodes.'."\n" + ."\n" + .'> This parameter is returned only for sharded cluster instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the mongos nodes.'."\n" + ."\n" + .'> This parameter is returned only for sharded cluster instances.', + 'type' => 'object', + 'properties' => [ + 'NodeClass' => [ + 'description' => 'The instance type of the mongos node.', + 'type' => 'string', + 'title' => '', + 'example' => 'dds.mongos.standard', + ], + 'NodeDescription' => [ + 'description' => 'The description of the mongos node.', + 'type' => 'string', + 'title' => '', + 'example' => '测试mongos节点', + ], + 'NodeId' => [ + 'description' => 'The ID of the mongos node.', + 'type' => 'string', + 'title' => '', + 'example' => 's-bp10e3b0d02f****', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.', + 'type' => 'string', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + 'DBInstanceStorage' => [ + 'description' => 'The storage capacity of the instance, in GB.', + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'example' => '20', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs.', + 'type' => 'string', + 'title' => '', + 'example' => 'rg-acfm22cdcgc****', + ], + 'ZoneId' => [ + 'description' => 'The zone of the instance.', + 'type' => 'string', + 'title' => '', + 'example' => 'cn-hangzhou-i', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'dds-bp12c5b040dc****', + ], + 'DBInstanceClass' => [ + 'description' => 'The instance type. For more information about the instance types available for different instance architectures, see:'."\n" + ."\n" + .'- [Standalone instance types](~~311407~~)'."\n" + ."\n" + .'- [Replica set instance types](~~311410~~)'."\n" + ."\n" + .'- [Sharded cluster instance types](~~311414~~)'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'> This parameter is not required for Serverless instances.'."\n" + ."\n" + .'</props>', + 'type' => 'string', + 'title' => '', + 'example' => 'dds.mongo.mid', + ], + 'Engine' => [ + 'description' => 'The database engine. The value is **MongoDB**.', + 'type' => 'string', + 'title' => '', + 'example' => 'MongoDB', + ], + 'ReplicationFactor' => [ + 'description' => 'The number of nodes in the instance.'."\n" + ."\n" + .'> This parameter is returned only for replica set instances.', + 'type' => 'string', + 'title' => '', + 'example' => '3', + ], + 'DBInstanceDescription' => [ + 'description' => 'The description of the instance.', + 'type' => 'string', + 'title' => '', + 'example' => '测试数据库', + ], + 'KindCode' => [ + 'description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- **0**: physical server'."\n" + ."\n" + .'- **1**: ECS'."\n" + ."\n" + .'- **2**: DOCKER'."\n" + ."\n" + .'- **18**: instance on the new Kubernetes-based architecture', + 'type' => 'string', + 'title' => '', + 'example' => '0', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeDBInstancesOverview', + 'summary' => 'Queries the overview of one or more ApsaraDB for MongoDB instances.', + 'description' => '- If you do not specify any instances, the operation returns overview information for all instances in the destination region associated with your Alibaba Cloud account.'."\n" + .'- The results of this operation are not paginated.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstancesOverview', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"RequestId\\": \\"52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA\\",\\n \\"DBInstances\\": [\\n {\\n \\"CreationTime\\": \\"2022-01-05T03:18:53Z\\",\\n \\"ExpireTime\\": \\"2022-02-05T16:00Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"testdatabase\\",\\n \\"Value\\": \\"apitest\\"\\n }\\n ],\\n \\"LastDowngradeTime\\": \\"2021-05-08\\",\\n \\"ShardList\\": [\\n {\\n \\"NodeClass\\": \\"dds.shard.mid\\",\\n \\"NodeDescription\\": \\"测试shard节点\\",\\n \\"NodeStorage\\": 10,\\n \\"NodeId\\": \\"d-bp1cac6f2083****\\",\\n \\"ReadonlyReplicas\\": 2\\n }\\n ],\\n \\"DBInstanceType\\": \\"replicate\\",\\n \\"DestroyTime\\": \\"2021-12-10T16:00:00Z\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"CapacityUnit\\": \\"100\\",\\n \\"VpcAuthMode\\": \\"Open\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"EngineVersion\\": \\"4.2\\",\\n \\"MongosList\\": [\\n {\\n \\"NodeClass\\": \\"dds.mongos.standard\\",\\n \\"NodeDescription\\": \\"测试mongos节点\\",\\n \\"NodeId\\": \\"s-bp10e3b0d02f****\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstanceStorage\\": 20,\\n \\"ResourceGroupId\\": \\"rg-acfm22cdcgc****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBInstanceId\\": \\"dds-bp12c5b040dc****\\",\\n \\"DBInstanceClass\\": \\"dds.mongo.mid\\",\\n \\"Engine\\": \\"MongoDB\\",\\n \\"ReplicationFactor\\": \\"3\\",\\n \\"DBInstanceDescription\\": \\"测试数据库\\",\\n \\"KindCode\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeErrorLogRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the mongos node or shard node whose error logs you want to query in the instance. If the instance is a sharded cluster instance, you must specify this parameter.'."\n" + ."\n" + .'> This parameter is valid only when **DBInstanceId** is set to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp128a003436****', + 'title' => '', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of the node whose error logs you want to query in the instance. Valid values:'."\n" + ."\n" + .'- **primary**'."\n" + ."\n" + .'- **secondary**'."\n" + ."\n" + .'> If you set the **NodeId** parameter to the ID of a mongos node, the RoleType parameter must be set to **primary**.', + 'type' => 'string', + 'required' => false, + 'default' => 'primary', + 'enum' => [ + 'primary', + 'secondary', + ], + 'example' => 'primary', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-01T12:10Z', + 'title' => '', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end time must be later than the start time and within 24 hours from the start time. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-02T12:10Z', + 'title' => '', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodbtest', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **30** to **100**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'default' => '30', + 'example' => '30', + 'title' => '', + ], + ], + [ + '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**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. For more information, see [View basic information of a resource group](~~151181~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces.', + 'type' => 'string', + 'required' => false, + 'example' => 'test test1', + 'title' => '', + ], + ], + [ + 'name' => 'LogicalOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logical relationship between multiple keywords. Valid values:'."\n" + ."\n" + .'- **or**'."\n" + ."\n" + .'- **and** (default value)', + 'type' => 'string', + 'default' => 'and', + 'enum' => [ + 'and', + 'or', + ], + 'required' => false, + 'example' => 'and', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of entries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageRecordCount' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '68BCBEC2-1E66-471F-A1A8-E3C60C0A80B0', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogRecords' => [ + 'description' => 'Details about the log entries returned.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnInfo' => [ + 'description' => 'The connection information of the log entry.', + 'type' => 'string', + 'example' => 'conn18xxxxxx', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'The time when the log entry was generated. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2019-02-26T12:09:34Z', + 'title' => '', + ], + 'Category' => [ + 'description' => 'The category of the log entry. Valid values:'."\n" + ."\n" + .'- NETWORK: network connection log'."\n" + ."\n" + .'- ACCESS: access control log'."\n" + ."\n" + .'- \\-: general log'."\n" + ."\n" + .'- COMMAND: slow query log'."\n" + ."\n" + .'- SHARDING: sharded cluster log'."\n" + ."\n" + .'- STORAGE: storage engine log'."\n" + ."\n" + .'- CONNPOOL: connection pool log'."\n" + ."\n" + .'- ASIO: asynchronous I/O operation log'."\n" + ."\n" + .'- WRITE: slow update log', + 'type' => 'string', + 'example' => 'NETWORK', + 'title' => '', + ], + 'Content' => [ + 'description' => 'The content of the log entry.', + 'type' => 'string', + 'example' => 'xxxxxxxx', + 'title' => '', + ], + 'Id' => [ + 'description' => 'The ID of the log entry.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1111111111', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Engine' => [ + 'description' => 'The database engine.', + 'type' => 'string', + 'example' => 'MongoDB', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time', + 'description' => 'The start time must be earlier than the end time.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The Specified parameter StartTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The Specified parameter EndTime is not valid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'LogApiFrequencyExceeded', + 'errorMessage' => 'Exceeding the allowed frequency of log api.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeErrorLogRecords', + 'summary' => 'Queries entries in error logs of an ApsaraDB for MongoDB instance.', + 'description' => '- This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.'."\n" + ."\n" + .'- You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeErrorLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"68BCBEC2-1E66-471F-A1A8-E3C60C0A80B0\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"LogRecords\\": [\\n {\\n \\"ConnInfo\\": \\"conn18xxxxxx\\",\\n \\"CreateTime\\": \\"2019-02-26T12:09:34Z\\",\\n \\"Category\\": \\"NETWORK\\",\\n \\"Content\\": \\"xxxxxxxx\\",\\n \\"Id\\": 1111111111\\n }\\n ]\\n },\\n \\"Engine\\": \\"MongoDB\\"\\n}","type":"json"}]', + ], + 'DescribeGlobalSecurityIPGroup' => [ + 'summary' => 'Queries the global IP whitelist template of an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '168604', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the IP whitelist template.', + 'type' => 'string', + 'required' => false, + 'example' => 'g-hedmu8kg9nsabw6u42rv', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure.', + 'type' => 'string', + 'example' => '72651AF9-7897-41A7-8B67-6C15C7F26A0A', + 'title' => '', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'The global IP whitelist templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The global IP whitelist template.', + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the IP whitelist template.', + 'type' => 'string', + 'example' => 'g-sdgwqyp4f5j1x3qk7yvm', + 'title' => '', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the IP whitelist template.', + 'type' => 'string', + 'example' => 'dev_baoxian_k8s_bj', + 'title' => '', + ], + 'GIpList' => [ + 'description' => 'The IP addresses in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP address whitelists.', + 'type' => 'string', + 'example' => '117.12.202.19', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'DBInstances' => [ + 'description' => 'The instances associated with the global whitelist template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => '[dds-asdxxxx,dds-afrexxxxxx]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidAction', + 'errorMessage' => 'Specified action is not valid.', + 'description' => 'Service exception.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'Specified user does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DescribeGlobalSecurityIPGroup', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72651AF9-7897-41A7-8B67-6C15C7F26A0A\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-sdgwqyp4f5j1x3qk7yvm\\",\\n \\"GlobalIgName\\": \\"dev_baoxian_k8s_bj\\",\\n \\"GIpList\\": \\"117.12.202.19\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstances\\": [\\n \\"[dds-asdxxxx,dds-afrexxxxxx]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeGlobalSecurityIPGroupRelation' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmongodbMMIA04', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call [DescribeRegions](~~61933~~) to query the available regions.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze6069764423m0l', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-2ze6069764423m0l', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request. If you encounter a problem, provide this ID to our support staff for troubleshooting.', + 'type' => 'string', + 'example' => 'F8CA8312-530A-413A-9129-F2BB32A8D404', + 'title' => '', + ], + 'GlobalSecurityIPGroupRel' => [ + 'description' => 'The mapping of the global IP address whitelist template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The mapping of the global IP address whitelist template.', + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the IP address whitelist template.', + 'type' => 'string', + 'example' => 'g-gfurfpsh4ycbrm2avst7', + 'title' => '', + ], + 'GIpList' => [ + 'description' => 'The IP addresses in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas. A maximum of 1,000 IP addresses or CIDR blocks can be added across all IP address whitelists.', + 'type' => 'string', + 'example' => '27.16.214.10,111.60.117.181', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'example' => 'cn-hongkong', + 'title' => '', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the IP address whitelist template.', + 'type' => 'string', + 'example' => 'dev_baoxian_k8s_bj', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DescribeGlobalSecurityIPGroupRelation', + 'summary' => 'Queries the mapping between an instance and a global IP address whitelist template.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeGlobalSecurityIPGroupRelation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"dds-2ze6069764423m0l\\",\\n \\"RequestId\\": \\"F8CA8312-530A-413A-9129-F2BB32A8D404\\",\\n \\"GlobalSecurityIPGroupRel\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-gfurfpsh4ycbrm2avst7\\",\\n \\"GIpList\\": \\"27.16.214.10,111.60.117.181\\",\\n \\"RegionId\\": \\"cn-hongkong\\",\\n \\"GlobalIgName\\": \\"dev_baoxian_k8s_bj\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeHistoryTasks' => [ + 'summary' => 'Queries a list of tasks in the task center.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '137675', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The region ID of the pending event. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 10 to 100. Default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value must be a positive integer. Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the instance. Set the value to Instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + 'title' => '', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'- Scheduled: The task is waiting to be executed.'."\n" + ."\n" + .'- Running: The task is running.'."\n" + ."\n" + .'- Succeed: The task is successful.'."\n" + ."\n" + .'- Failed: The task failed.'."\n" + ."\n" + .'- Cancelling: The task is being terminated.'."\n" + ."\n" + .'- Canceled: The task has been terminated.'."\n" + ."\n" + .'- Waiting: The task is waiting for scheduled time.'."\n" + ."\n" + .'Separate multiple states with commas (,). This parameter is empty by default, which indicates that tasks in all states are queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeed,Running,Waiting', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID. Separate multiple instance IDs with commas (,). You can specify up to 30 instance IDs. This parameter is empty by default, which indicates that tasks of all instances are queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-8vb38f0e7933xxxx', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID. Separate multiple task IDs with commas (,). You can specify up to 30 task IDs. This parameter is empty by default, which indicates that all tasks are queried.', + 'type' => 'string', + 'required' => false, + 'example' => 't-0mq1yyhm3ffl2bxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task type. This parameter is left empty by default, which indicates that all types of tasks are queried. Valid values:'."\n" + ."\n" + .'- CreateIns: Create an instance.'."\n" + ."\n" + .'- DeleteIns: Delete an instance.'."\n" + ."\n" + .'- ChangeVariable: Modify parameter settings for an instance.'."\n" + ."\n" + .'- ModifyInsConfig: Change the configurations of an instance.'."\n" + ."\n" + .'- RestartIns: Restart an instance.'."\n" + ."\n" + .'- HaSwitch: Perform a primary/secondary switchover on an instance.'."\n" + ."\n" + .'- CloneIns: Clone an instance.'."\n" + ."\n" + .'- KernelVersionUpgrade: Update the minor version of an instance.'."\n" + ."\n" + .'- ProxyVersionUpgrade: Upgrade the agent version of an instance.'."\n" + ."\n" + .'- ModifyAccount: Change the account of an instance.'."\n" + ."\n" + .'- ModifyInsSpec: Change the specifications of an instance or perform a data migration on the instance.'."\n" + ."\n" + .'- CreateReadIns: Create a read-only instance.'."\n" + ."\n" + .'- StartIns: Start an instance.'."\n" + ."\n" + .'- StopIns: Stop an instance.'."\n" + ."\n" + .'- ModifyNetwork: Modify the network type for an instance.'."\n" + ."\n" + .'- LockIns: Lock an instance.'."\n" + ."\n" + .'- UnlockIns: Unlock an instance.'."\n" + ."\n" + .'- DiskOnlineExpansion: Scale out the disks of an instance online.'."\n" + ."\n" + .'- StorageOnlineExpansion: Expend the storage capacity of an instance online.'."\n" + ."\n" + .'- AddInsNode: Add a node to an instance.'."\n" + ."\n" + .'- DeleteInsNode: Delete a node from an instance.'."\n" + ."\n" + .'- ManualBackupIns: Manually back up an instance.'."\n" + ."\n" + .'- ModifyInsStorageType: Modify the storage type for an instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'DeleteInsNode', + 'title' => '', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the O\\&M task to perform. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. You can query data within the last 30 days.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-03-15T03:41:26Z', + 'title' => '', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the O\\&M task to perform. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. You can query data within the last 30 days.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-03-16T07:21:31Z', + 'title' => '', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum execution duration of the task. This parameter is used to filter tasks whose execution duration is longer than the minimum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed for the query.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum execution duration of the task. This parameter is used to filter tasks whose execution duration is shorter than or equal to the maximum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed for the query.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2inrfrnw3xby', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '3C4A2494-XXXX-XXXX-93CF-548DB3375193', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The maximum number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'The total number of tasks that meet these conditions without taking pagination into account.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'Items' => [ + 'description' => 'The task objects.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'- Scheduled: The task is waiting to be executed.'."\n" + ."\n" + .'- Running: The task is running.'."\n" + ."\n" + .'- Succeed: The task is successful.'."\n" + ."\n" + .'- Failed: The task failed.'."\n" + ."\n" + .'- Cancelling: The task is being terminated.'."\n" + ."\n" + .'- Canceled: The task has been terminated.'."\n" + ."\n" + .'- Waiting: The task is waiting for scheduled time.', + 'type' => 'string', + 'example' => 'Succeed', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'The task ID.', + 'type' => 'string', + 'example' => 't-0mq1yyhm3ffl2bxxxx', + 'title' => '', + ], + 'CurrentStepName' => [ + 'description' => 'The name of the current step. If this parameter is left empty, the task is not started.', + 'type' => 'string', + 'example' => 'exec_task', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'The start time of the performed O\\&M task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-02-11T02:33Z', + 'title' => '', + ], + 'EndTime' => [ + 'description' => 'The end time of the performed O\\&M task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2023-03-16T02:59Z', + 'title' => '', + ], + 'TaskType' => [ + 'description' => 'The task type.'."\n" + ."\n" + .'- CreateIns: Create an instance.'."\n" + ."\n" + .'- DeleteIns: Delete an instance.'."\n" + ."\n" + .'- ChangeVariable: Modify parameter settings for an instance.'."\n" + ."\n" + .'- ModifyInsConfig: Change the configurations of an instance.'."\n" + ."\n" + .'- RestartIns: Restart an instance.'."\n" + ."\n" + .'- HaSwitch: Perform a primary/secondary switchover on an instance.'."\n" + ."\n" + .'- CloneIns: Clone an instance.'."\n" + ."\n" + .'- KernelVersionUpgrade: Update the minor version of an instance.'."\n" + ."\n" + .'- ProxyVersionUpgrade: Upgrade the agent version of an instance.'."\n" + ."\n" + .'- ModifyAccount: Change the account of an instance.'."\n" + ."\n" + .'- ModifyInsSpec: Change the specifications of an instance or perform a data migration on the instance.'."\n" + ."\n" + .'- CreateReadIns: Create a read-only instance.'."\n" + ."\n" + .'- StartIns: Start an instance.'."\n" + ."\n" + .'- StopIns: Stop an instance.'."\n" + ."\n" + .'- ModifyNetwork: Modify the network type for an instance.'."\n" + ."\n" + .'- LockIns: Lock an instance.'."\n" + ."\n" + .'- UnlockIns: Unlock an instance.'."\n" + ."\n" + .'- DiskOnlineExpansion: Scale out the disks of an instance online.'."\n" + ."\n" + .'- StorageOnlineExpansion: Expend the storage capacity of an instance online.'."\n" + ."\n" + .'- AddInsNode: Add a node to an instance.'."\n" + ."\n" + .'- DeleteInsNode: Delete a node from an instance.'."\n" + ."\n" + .'- ManualBackupIns: Manually back up an instance.'."\n" + ."\n" + .'- ModifyInsStorageType: Modify the storage type for an instance.', + 'type' => 'string', + 'example' => 'CreateIns', + 'title' => '', + ], + 'RemainTime' => [ + 'description' => 'The estimated remaining execution time. Unit: seconds. The value 0 indicates that the task is completed.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000'."\n", + 'title' => '', + ], + 'Progress' => [ + 'description' => 'The current progress of the task. The valid values range from 0 to 100.', + 'type' => 'number', + 'format' => 'float', + 'example' => '100.0', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the instance. The value is fixed to Instance.', + 'type' => 'string', + 'example' => 'Instance', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'The instance ID', + 'type' => 'string', + 'example' => 'dds-t4n18194768fxxxx', + 'title' => '', + ], + 'InstanceName' => [ + 'description' => 'The name of the instance.', + 'type' => 'string', + 'example' => 'test-dds', + 'title' => '', + ], + 'DbType' => [ + 'description' => 'The database type. The value is fixed to mongodb.', + 'type' => 'string', + 'example' => 'mongodb', + 'title' => '', + ], + 'Product' => [ + 'description' => 'The product. The value is fixed to dds.', + 'type' => 'string', + 'example' => 'dds', + 'title' => '', + ], + 'TaskDetail' => [ + 'description' => 'The details of the task. The task details vary based on the value of the taskType parameter.', + 'type' => 'string', + 'example' => '{\\"callerUid\\":\\"test\\"}', + 'title' => '', + ], + 'ReasonCode' => [ + 'description' => 'The reason why the current task was initiated.', + 'type' => 'string', + 'example' => '小版本升级', + 'title' => '', + ], + 'ActionInfo' => [ + 'description' => 'A set of allowed actions that can be taken on the task. The system matches the current step name and status of the task to the available actions specified by ActionInfo. If no matching action is found, the current status of the task does not support any action. Example:'."\n" + ."\n" + .'```'."\n" + .' "steps": ['."\n" + .' {'."\n" + .' "step_name": "exec_task", // The name of the step, which matches the value of CurrentStepName.'."\n" + .' "action_info": { // The actions supported for this step.'."\n" + .' "Waiting": [ // The status, which matches the value of Status.'."\n" + .' "modifySwitchTime" // The action. Multiple actions are supported.'."\n" + .' ]'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "step_name": "init_task", // The name of the step.'."\n" + .' "action_info": { // The actions supported for this step.'."\n" + .' "Running": [ // The status.'."\n" + .' "cancel", // The action.'."\n" + .' "pause"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'The system may support the following actions:'."\n" + ."\n" + .'- retry: makes another attempt.'."\n" + ."\n" + .'- cancel: makes a cancellation.'."\n" + ."\n" + .'- modifySwitchTime: changes the switching or restoration time.', + 'type' => 'string', + 'example' => '`{\\"steps\\":[{\\"action_info\\":{\\"Waiting\\":[\\"modifySwitchTime\\"]},\\"step_name\\":\\"exec_task\\"}]}`', + 'title' => '', + ], + 'Uid' => [ + 'description' => 'The ID of the user to which the resource belongs.', + 'type' => 'string', + 'example' => '141345906006****', + 'title' => '', + ], + 'CallerSource' => [ + 'description' => 'The request source. Valid values: System and User.', + 'type' => 'string', + 'example' => 'System', + 'title' => '', + ], + 'CallerUid' => [ + 'description' => 'The ID of the user who made the request. If CallerSource is set to User, CallerUid indicates the unique ID (UID) of the user.', + 'type' => 'string', + 'example' => '141345906006****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Param.Invalid', + 'errorMessage' => 'Param invalid', + 'description' => '', + ], + [ + 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', + 'errorMessage' => 'Param invalid. End time before start time', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeHistoryTasks', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeHistoryTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#InstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"3C4A2494-XXXX-XXXX-93CF-548DB3375193\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 5,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Succeed\\",\\n \\"TaskId\\": \\"t-0mq1yyhm3ffl2bxxxx\\",\\n \\"CurrentStepName\\": \\"exec_task\\",\\n \\"StartTime\\": \\"2023-02-11T02:33Z\\",\\n \\"EndTime\\": \\"2023-03-16T02:59Z\\",\\n \\"TaskType\\": \\"CreateIns\\",\\n \\"RemainTime\\": 1000,\\n \\"Progress\\": 100,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceType\\": \\"Instance\\",\\n \\"InstanceId\\": \\"dds-t4n18194768fxxxx\\",\\n \\"InstanceName\\": \\"test-dds\\",\\n \\"DbType\\": \\"mongodb\\",\\n \\"Product\\": \\"dds\\",\\n \\"TaskDetail\\": \\"{\\\\\\\\\\\\\\"callerUid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}\\",\\n \\"ReasonCode\\": \\"小版本升级\\",\\n \\"ActionInfo\\": \\"`{\\\\\\\\\\\\\\"steps\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"action_info\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Waiting\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"modifySwitchTime\\\\\\\\\\\\\\"]},\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec_task\\\\\\\\\\\\\\"}]}`\\",\\n \\"Uid\\": \\"141345906006****\\",\\n \\"CallerSource\\": \\"System\\",\\n \\"CallerUid\\": \\"141345906006****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeHistoryTasksStat' => [ + 'summary' => 'Queries the overview of a task in the task center.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '137676', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The region ID of the pending event. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'* Scheduled: The task is waiting to be executed.'."\n" + .'* Running: The task is running.'."\n" + .'* Succeed: The task is successful.'."\n" + .'* Failed: The task failed.'."\n" + .'* Cancelling: The task is being terminated.'."\n" + .'* Canceled: The task has been terminated.'."\n" + .'* Waiting: The task is waiting for scheduled time.'."\n" + ."\n" + .'Separate multiple states with commas (,). This parameter is empty by default, which indicates that tasks in all states are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Succeed', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID. Separate multiple instance IDs with commas (,). You can specify up to 30 instance IDs. This parameter is empty by default, which indicates that the tasks of all instances are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dds-8vb38f0e7933xxxx', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID. Separate multiple task IDs with commas (,). You can specify up to 30 task IDs. This parameter is empty by default, which indicates that all tasks are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 't-0mq1yyhm3ffl2bxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task type. This parameter is left empty by default, which indicates that all types of tasks are queried. Valid values:'."\n" + ."\n" + .'* CreateIns: Create an instance.'."\n" + .'* DeleteIns: Delete an instance.'."\n" + .'* ChangeVariable: Modify parameter settings for an instance.'."\n" + .'* ModifyInsConfig: Change the configurations of an instance.'."\n" + .'* RestartIns: Restart an instance.'."\n" + .'* HaSwitch: Perform a primary/secondary switchover on an instance.'."\n" + .'* CloneIns: Clone an instance.'."\n" + .'* KernelVersionUpgrade: Update the minor version of an instance.'."\n" + .'* ProxyVersionUpgrade: Upgrade the agent version of an instance.'."\n" + .'* ModifyAccount: Change the account of an instance.'."\n" + .'* ModifyInsSpec: Change the specifications of an instance or perform a data migration on the instance.'."\n" + .'* CreateReadIns: Create a read-only instance.'."\n" + .'* StartIns: Start an instance.'."\n" + .'* StopIns: Stop an instance.'."\n" + .'* ModifyNetwork: Modify the network type for an instance.'."\n" + .'* LockIns: Lock an instance.'."\n" + .'* UnlockIns: Unlock an instance.'."\n" + .'* DiskOnlineExpansion: Scale out the disks of an instance online.'."\n" + .'* StorageOnlineExpansion: Expend the storage capacity of an instance online.'."\n" + .'* AddInsNode: Add a node to an instance.'."\n" + .'* DeleteInsNode: Delete a node from an instance.'."\n" + .'* ManualBackupIns: Manually back up an instance.'."\n" + .'* ModifyInsStorageType: Modify the storage type for an instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DeleteIns', + 'title' => '', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The start time of the O\\&M task to perform. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. You can query data within the last 30 days.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-16T02:46:21Z', + 'title' => '', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The end time of the O\\&M task to perform. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. You can query data within the last 30 days.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-05-16T02:15:52Z', + 'title' => '', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum execution duration of the task. This parameter is used to filter tasks whose execution duration is longer than the minimum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed for the query.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum execution duration of the task. This parameter is used to filter tasks whose execution duration is shorter than or equal to the maximum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed for the query.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The ID of the resource group.', + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FC724D23-XXXX-XXXX-ABB1-606C935AE7FD', + 'title' => '', + ], + 'Items' => [ + 'description' => 'The task objects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'* Scheduled: The task is waiting to be executed.'."\n" + .'* Running: The task is running.'."\n" + .'* Succeed: The task is successful.'."\n" + .'* Failed: The task failed.'."\n" + .'* Cancelling: The task is being terminated.'."\n" + .'* Canceled: The task has been terminated.'."\n" + .'* Waiting: The task is waiting for scheduled time.'."\n", + 'type' => 'string', + 'example' => 'Succeed', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'The number of tasks in a specified state.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Param.Invalid', + 'errorMessage' => 'Param invalid', + 'description' => '', + ], + [ + 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', + 'errorMessage' => 'Param invalid. End time before start time', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeHistoryTasksStat', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeHistoryTasksStat', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#InstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC724D23-XXXX-XXXX-ABB1-606C935AE7FD\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Succeed\\",\\n \\"TotalCount\\": 2\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInstanceAutoRenewalAttribute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmongodb1FWAFI', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the region ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp567b****', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the instance. Valid values:'."\n" + ."\n" + .'- **replicate**: the standalone or replica set instance'."\n" + ."\n" + .'- **sharding**: the sharded cluster instance'."\n" + ."\n" + .'Default value: **replicate**.', + 'type' => 'string', + 'required' => false, + 'example' => 'replicate', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**.'."\n" + ."\n" + .'> Default value: **30**.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value must be a positive integer that does not exceed the maximum value of the Integer parameter. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ItemsNumbers' => [ + 'description' => 'The total number of entries returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'PageRecordCount' => [ + 'description' => 'The number of entries that were returned on the current page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'Details about returned entries.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceType' => [ + 'description' => 'The category of the instance. Valid values:'."\n" + ."\n" + .'- **replicate**: the standalone or replica set instance'."\n" + ."\n" + .'- **sharding**: the sharded cluster instance', + 'type' => 'string', + 'example' => 'replicate', + 'title' => '', + ], + 'AutoRenew' => [ + 'description' => 'Indicates whether auto-renewal is enabled for the instance. Valid values:'."\n" + ."\n" + .'- **true**: Auto-renewal is enabled for the instance.'."\n" + ."\n" + .'- **false**: Auto-renewal is disabled for the instance.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'Duration' => [ + 'description' => 'The auto-renewal period. Unit: months.'."\n" + ."\n" + .'> - This parameter is ruturned only when the returned value of the **AutoRenew** parameter is **true**.'."\n" + .'>'."\n" + .'> - You can call the [ModifyInstanceAutoRenewalAttribute](~~145979~~) operation to modify the auto-renewal period.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'DbInstanceId' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'example' => 'dds-bp2568*****', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + 'description' => 'An internal error occurred. Please try again later.', + ], + ], + ], + 'title' => 'DescribeInstanceAutoRenewalAttribute', + 'summary' => 'You can call this operation to query whether auto-renewal is enabled for an ApsaraDB for MongoDB instance.', + 'description' => 'This operation is applicable to subscription instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeInstanceAutoRenewalAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'conditional', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ItemsNumbers\\": 2,\\n \\"PageRecordCount\\": 2,\\n \\"RequestId\\": \\"FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"DBInstanceType\\": \\"replicate\\",\\n \\"AutoRenew\\": \\"true\\",\\n \\"Duration\\": \\"1\\",\\n \\"DbInstanceId\\": \\"dds-bp2568*****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeInstanceRecoverTime' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203778', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The region where the geo-redundant backup set is stored.'."\n" + ."\n" + .'> - Required for geo-redundant backups.', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The region where the source instance of the geo-redundant backup is located.'."\n" + ."\n" + .'> - Required for geo-redundant backups.', + 'required' => false, + 'title' => '', + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'title' => '', + 'description' => 'The ID of the resource group.', + 'required' => false, + 'example' => 'rg-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'F8CA8312-530A-413A-9129-F2BB32A8D404', + ], + 'RestoreRanges' => [ + 'title' => '', + 'description' => 'A list of time ranges available for point-in-time recovery.', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of time ranges available for point-in-time recovery.', + 'type' => 'object', + 'properties' => [ + 'RestoreBeginTime' => [ + 'title' => '', + 'description' => 'The beginning of the recoverable time range.', + 'type' => 'string', + 'example' => '2023-10-16T19:33:20Z', + ], + 'RestoreEndTime' => [ + 'title' => '', + 'description' => 'The end of the recoverable time range.', + 'type' => 'string', + 'example' => '2023-10-16T19:43:20Z', + ], + 'RestoreType' => [ + 'description' => 'The restoration method. Valid value:'."\n" + ."\n" + .'- PointInTime (default): point-in-time recovery.', + 'type' => 'string', + 'title' => '', + 'example' => 'PointInTime', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'DescribeInstanceRecoverTime', + 'summary' => 'Queries the recoverable time range for an ApsaraDB for MongoDB replica set instance with disk storage.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:DescribeInstanceRecoverTime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8CA8312-530A-413A-9129-F2BB32A8D404\\",\\n \\"RestoreRanges\\": [\\n {\\n \\"RestoreBeginTime\\": \\"2023-10-16T19:33:20Z\\",\\n \\"RestoreEndTime\\": \\"2023-10-16T19:43:20Z\\",\\n \\"RestoreType\\": \\"PointInTime\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeKernelReleaseNotes' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8279', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'KernelVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minor version number of the instance. Example: **mongodb\\_20180522\\_0.4.8**.'."\n" + ."\n" + .'- This parameter is required. After you specify a version number for this parameter in a request, the release notes of the versions later than this version are returned.', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodb_20180522_0.4.8', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'F01D4DDA-CB72-4083-B399-AF4642294FE6', + 'title' => '', + ], + 'ReleaseNotes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReleaseNote' => [ + 'description' => 'The list of the version release notes.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseNote' => [ + 'description' => 'The release notes.', + 'type' => 'string', + 'example' => '放开sharding某集合开关balancer的限制', + 'title' => '', + ], + 'KernelVersion' => [ + 'description' => 'The version number.', + 'type' => 'string', + 'example' => 'mongodb_20180619_0.4.9', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidKernelReleaseNotes', + 'errorMessage' => 'The format of specified KernelVersion is invalid.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeKernelReleaseNotes', + 'summary' => 'Queries the release notes of the minor versions of an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F01D4DDA-CB72-4083-B399-AF4642294FE6\\",\\n \\"ReleaseNotes\\": {\\n \\"ReleaseNote\\": [\\n {\\n \\"ReleaseNote\\": \\"放开sharding某集合开关balancer的限制\\",\\n \\"KernelVersion\\": \\"mongodb_20180619_0.4.9\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeKmsKeys' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '179335', + 'abilityTreeNodes' => [ + 'FEATUREmongodb2XLO11', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '60EEBD77-227C-5B39-86EA-D89163C5****', + ], + 'KmsKeys' => [ + 'description' => 'The KMS keys.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'KeyAlias' => [ + 'description' => 'The alias of the key.', + 'type' => 'string', + 'title' => '', + 'example' => 'key-shh656820f4mh9qxxxxx alias/test1', + ], + 'KeyId' => [ + 'description' => 'The key ID.', + 'type' => 'string', + 'title' => '', + 'example' => '37291352-xxxx-xxxx-adbf-fd0630a95583', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExistUser', + 'errorMessage' => 'The User does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'EntityNotExistService', + 'errorMessage' => 'The Service mongodb.aliyuncs.com does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'NoPermissionService', + 'errorMessage' => 'The Account NoPermission Error! Please Authorize The Account! Service Name: mongodb.aliyuncs.com, SLR Role:AliyunServiceRoleForMongoDB.', + 'description' => '', + ], + ], + 409 => [ + [ + 'errorCode' => 'EntityAlreadyExistsRole', + 'errorMessage' => 'The Role already exists:AliyunServiceRoleForMongoDB.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeKmsKeys', + 'summary' => 'Queries Key Management Service (KMS) keys that are available for disk encryption.', + 'description' => 'Queried keys are available only for disk encryption.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeKmsKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60EEBD77-227C-5B39-86EA-D89163C5****\\",\\n \\"KmsKeys\\": [\\n {\\n \\"KeyAlias\\": \\"key-shh656820f4mh9qxxxxx alias/test1\\",\\n \\"KeyId\\": \\"37291352-xxxx-xxxx-adbf-fd0630a95583\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeMongoDBLogConfig' => [ + 'summary' => 'You can view the configuration of MongoDB Log Service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmongodb42P3EC', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID. Call [DescribeDBInstances](~~61939~~) to query the instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The audit log configuration.', + 'type' => 'object', + 'properties' => [ + 'UserProjectName' => [ + 'description' => 'The name of the Simple Log Service project for the audit logs.', + 'type' => 'string', + 'example' => 'nosql-176498472570****-cn-hangzhou', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '664ECE26-658A-47C5-88F6-870B0132E8D2', + 'title' => '', + ], + 'IsUserProjectLogstoreExist' => [ + 'description' => 'Indicates whether a Simple Log Service project for audit logs exists in the current region. Valid values:'."\n" + ."\n" + .'- **1**: The project exists.'."\n" + ."\n" + .'- **0** or **null**: The project does not exist.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'IsEtlMetaExist' => [ + 'description' => 'Indicates whether a rule is created to ship audit logs to Logtail. For more information about Logtail, see [What is Logtail?](~~28979~~). Valid values:'."\n" + ."\n" + .'- **1**: A rule is created.'."\n" + ."\n" + .'- **0** or **null**: No rule is created.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ServiceType' => [ + 'description' => 'The version of the audit log feature.'."\n" + ."\n" + .'- **Trial**: Free trial version.'."\n" + ."\n" + .'- **Standard**: Official version.'."\n" + ."\n" + .'- **V2\\_Standard**: DAS Enterprise Edition (NoSQL-compatible) version.', + 'type' => 'string', + 'example' => 'Standard', + 'title' => '', + ], + 'EnableAudit' => [ + 'description' => 'Indicates whether the audit log feature is enabled for the ApsaraDB for MongoDB instance.'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + ."\n" + .'- **false**: Disabled.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'TtlForTrail' => [ + 'description' => 'The retention period of audit logs for the free trial version. Unit: days.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'UsedStorageForTrail' => [ + 'description' => 'The storage capacity that is used by audit logs for the free trial version. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12548178759', + 'title' => '', + ], + 'PreserveStorageForTrail' => [ + 'description' => 'The maximum storage capacity for the free trial version of audit logs. Unit: bytes. The maximum value is 107374182400 bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '107374182400', + 'title' => '', + ], + 'TtlForStandard' => [ + 'description' => 'The retention period of audit logs for the official version. The value ranges from 1 to 365. Unit: days.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'title' => '', + ], + 'UsedStorageForStandard' => [ + 'description' => 'The storage capacity that is used by audit logs for the official version. Unit: bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20163', + 'title' => '', + ], + 'PreserveStorageForStandard' => [ + 'description' => 'The maximum storage capacity for the official version of audit logs. A value of -1 indicates that no upper limit is set.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + 'title' => '', + ], + 'HotTtlForV2Standard' => [ + 'description' => 'The retention period of hot storage for the V2\\_Standard (DAS Enterprise Edition (NoSQL-compatible)) version of audit logs. Unit: days.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + 'title' => '', + ], + 'TtlForV2Standard' => [ + 'description' => 'The retention period of cold storage for the V2\\_Standard (DAS Enterprise Edition (NoSQL-compatible)) version of audit logs. Unit: days.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UserProjectName\\": \\"nosql-176498472570****-cn-hangzhou\\",\\n \\"RequestId\\": \\"664ECE26-658A-47C5-88F6-870B0132E8D2\\",\\n \\"IsUserProjectLogstoreExist\\": 1,\\n \\"IsEtlMetaExist\\": 1,\\n \\"ServiceType\\": \\"Standard\\",\\n \\"EnableAudit\\": true,\\n \\"TtlForTrail\\": 1,\\n \\"UsedStorageForTrail\\": 12548178759,\\n \\"PreserveStorageForTrail\\": 107374182400,\\n \\"TtlForStandard\\": 30,\\n \\"UsedStorageForStandard\\": 20163,\\n \\"PreserveStorageForStandard\\": -1,\\n \\"HotTtlForV2Standard\\": 7,\\n \\"TtlForV2Standard\\": 30\\n}","type":"json"}]', + 'title' => 'DescribeMongoDBLogConfig', + 'description' => 'This API applies to General-purpose and Dedicated instances that use local disks.'."\n" + ."\n" + .'You can enable the audit log feature for ApsaraDB for MongoDB as needed. For more information, see [Enable audit logs](~~59903~~).'."\n" + ."\n" + .'- As of January 6, 2022, the official version of the audit log feature is being rolled out to all regions. New requests for the free trial version are no longer accepted. For more information, see [\\[Notice\\] ApsaraDB for MongoDB launches pay-as-you-go audit logs and discontinues the free trial](~~377480~~).'."\n" + ."\n" + .'- The official version of the audit log feature is pay-as-you-go. Charges are based on storage usage and retention period. For pricing details, see <props="china">[ApsaraDB for MongoDB pricing](https://www.aliyun.com/price/product?#/mongodb/detail/badds)</props><props="intl">[ApsaraDB for MongoDB pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeMongoDBLogConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeParameterModificationHistory' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the mongos node or shard node whose parameter modification records you want to query in the instance.'."\n" + ."\n" + .'> This parameter is valid only when **DBInstanceId** is set to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp1158****', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-01T12:10Z', + 'title' => '', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-02T12:10Z', + 'title' => '', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of the instance. Valid values:'."\n" + ."\n" + .'- **db**: shard'."\n" + ."\n" + .'- **cs**: Configserver'."\n" + ."\n" + .'- **mongos**: mongos'."\n" + ."\n" + .'- **logic**: sharded cluster instance', + 'type' => 'string', + 'required' => false, + 'example' => 'mongos', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'B1BB6E0E-B4EF-4145-81FA-A07719860248', + 'title' => '', + ], + 'HistoricalParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'HistoricalParameter' => [ + 'description' => 'Details about the parameter modification records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => 'The name of the modified parameter.', + 'type' => 'string', + 'example' => 'operationProfiling.slowOpThresholdMs', + 'title' => '', + ], + 'OldParameterValue' => [ + 'description' => 'The parameter value before modification.', + 'type' => 'string', + 'example' => '100', + 'title' => '', + ], + 'NewParameterValue' => [ + 'description' => 'The parameter value after modification.', + 'type' => 'string', + 'example' => '200', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'The time when the parameter was modified. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2019-03-12T07:58:24Z', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The Specified parameter StartTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The Specified parameter EndTime is not valid.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeParameterModificationHistory', + 'summary' => 'Queries the parameter modification records of an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeParameterModificationHistory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B1BB6E0E-B4EF-4145-81FA-A07719860248\\",\\n \\"HistoricalParameters\\": {\\n \\"HistoricalParameter\\": [\\n {\\n \\"ParameterName\\": \\"operationProfiling.slowOpThresholdMs\\",\\n \\"OldParameterValue\\": \\"100\\",\\n \\"NewParameterValue\\": \\"200\\",\\n \\"ModifyTime\\": \\"2019-03-12T07:58:24Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeParameterTemplates' => [ + 'summary' => 'Queries the default parameter templates for MongoDB instances.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8283', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine. Set the value to **mongodb**.', + 'type' => 'string', + 'required' => true, + 'example' => 'mongodb', + 'title' => '', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database version number. Valid values:'."\n" + ."\n" + .'- **7.0**'."\n" + ."\n" + .'- **6.0**'."\n" + ."\n" + .'- **5.0**'."\n" + ."\n" + .'- **4.4**'."\n" + ."\n" + .'- **4.2**'."\n" + ."\n" + .'- **4.0**'."\n" + ."\n" + .'- **3.4**', + 'type' => 'string', + 'required' => true, + 'example' => '5.0', + 'title' => '', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of the instance. Valid values:'."\n" + ."\n" + .'- db: the shard role of a sharded cluster instance.'."\n" + ."\n" + .'- cs: the config server role of a sharded cluster instance.'."\n" + ."\n" + .'- mongos: the mongos role of a sharded cluster instance.'."\n" + ."\n" + .'- normal: the role of a replica set instance.'."\n" + ."\n" + .'- physical: the role of a single node instance.'."\n" + ."\n" + .'The default value is normal.', + 'type' => 'string', + 'default' => 'normal', + 'enum' => [ + 'normal', + 'db', + 'cs', + 'physical', + 'mongos', + ], + 'required' => false, + 'example' => 'normal', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterCount' => [ + 'description' => 'The number of parameters.', + 'type' => 'string', + 'example' => '10', + 'title' => '', + ], + 'EngineVersion' => [ + 'description' => 'The database version number.', + 'type' => 'string', + 'example' => '5.0', + 'title' => '', + ], + 'Parameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateRecord' => [ + 'itemNode' => true, + 'description' => 'A list of parameter templates.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => 'The valid values of the parameter.', + 'type' => 'string', + 'example' => '[0-65536]', + 'title' => '', + ], + 'ParameterName' => [ + 'description' => 'The name of the parameter.'."\n" + ."\n" + .'For more information, see [the official MongoDB documentation](https://www.mongodb.com/docs/manual/tutorial/manage-the-database-profiler/).', + 'type' => 'string', + 'example' => 'net.compression.compressors', + 'title' => '', + ], + 'ParameterValue' => [ + 'description' => 'The default value of the parameter.', + 'type' => 'string', + 'example' => '100', + 'title' => '', + ], + 'ForceModify' => [ + 'description' => 'Indicates whether the parameter can be modified.'."\n" + ."\n" + .'- **false**: The parameter cannot be modified.'."\n" + ."\n" + .'- **true**: The parameter can be modified.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ForceRestart' => [ + 'description' => 'Indicates whether a restart is required for the parameter modification to take effect.'."\n" + ."\n" + .'- **false**: A restart is not required. The modification takes effect after you submit the modification.'."\n" + ."\n" + .'- **true**: A restart is required for the modification to take effect.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'ParameterDescription' => [ + 'description' => 'The description of the parameter.', + 'type' => 'string', + 'example' => 'The threshold in milliseconds at which the database profiler considers a query slow, default is 100.', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'BDA54203-9D61-54A3-A568-D281F785****', + 'title' => '', + ], + 'Engine' => [ + 'description' => 'The database engine.', + 'type' => 'string', + 'example' => 'mongodb', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEngineVersion.Malformed', + 'errorMessage' => 'Specified engine version is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEngine.Malformed', + 'errorMessage' => 'Specified engine is not valid.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeParameterTemplates', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ParameterCount\\": \\"10\\",\\n \\"EngineVersion\\": \\"5.0\\",\\n \\"Parameters\\": {\\n \\"TemplateRecord\\": [\\n {\\n \\"CheckingCode\\": \\"[0-65536]\\",\\n \\"ParameterName\\": \\"net.compression.compressors\\",\\n \\"ParameterValue\\": \\"100\\",\\n \\"ForceModify\\": true,\\n \\"ForceRestart\\": false,\\n \\"ParameterDescription\\": \\"The threshold in milliseconds at which the database profiler considers a query slow, default is 100.\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"BDA54203-9D61-54A3-A568-D281F785****\\",\\n \\"Engine\\": \\"mongodb\\"\\n}","type":"json"}]', + ], + 'DescribeParameters' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the mongos or shard node in the specified sharded cluster instance.'."\n" + ."\n" + .'> This parameter is valid when the **DBInstanceId** parameter is set to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of the instance. Valid values:'."\n" + ."\n" + .'- db: a shard node.'."\n" + ."\n" + .'- cs: a Configserver node.'."\n" + ."\n" + .'- mongos: a mongos node.', + 'type' => 'string', + 'required' => false, + 'example' => 'mongos', + 'title' => '', + ], + ], + [ + 'name' => 'ExtraParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parameter that is available in the future.', + 'type' => 'string', + 'required' => false, + 'example' => 'terrform', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RunningParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameter' => [ + 'description' => 'The settings of the parameters that have taken effect.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => 'The valid values of the parameter.', + 'type' => 'string', + 'example' => '[33554432-268435456]', + 'title' => '', + ], + 'ParameterName' => [ + 'description' => 'The name of the parameter.', + 'type' => 'string', + 'example' => 'setParameter.internalQueryExecMaxBlockingSortBytes', + 'title' => '', + ], + 'ParameterValue' => [ + 'description' => 'The value of the parameter.', + 'type' => 'string', + 'example' => '33554432', + 'title' => '', + ], + 'ForceRestart' => [ + 'description' => 'Indicates whether a restart is required for parameter modifications to take effect. Valid values:'."\n" + ."\n" + .'- **false**: A restart is not required. Modifications take effect immediately.'."\n" + ."\n" + .'- **true**: A restart is required for parameter modifications to take effect.', + 'type' => 'string', + 'example' => 'false', + 'title' => '', + ], + 'ParameterDescription' => [ + 'description' => 'The description of the parameter.', + 'type' => 'string', + 'example' => 'The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)', + 'title' => '', + ], + 'ModifiableStatus' => [ + 'description' => 'Indicates whether the parameter value can be modified. Valid values:'."\n" + ."\n" + .'- **false**: The parameter value cannot be modified.'."\n" + ."\n" + .'- **true**: The parameter value can be modified.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'CharacterType' => [ + 'description' => '实例的角色类型，取值说明：'."\n" + ."\n" + .'- **db**：shard 角色。'."\n" + ."\n" + .'- **cs**：config server 角色。'."\n" + ."\n" + .'- **mongos**：mongos 角色。', + 'type' => 'string', + 'example' => 'db', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EngineVersion' => [ + 'description' => 'The database engine version of the instance.', + 'type' => 'string', + 'example' => '4.0', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8', + 'title' => '', + ], + 'ConfigParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameter' => [ + 'description' => 'The parameter settings in the configuration template.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => 'The valid values of the parameter.', + 'type' => 'string', + 'example' => '[0-65536]', + 'title' => '', + ], + 'ParameterName' => [ + 'description' => 'The name of the parameter.', + 'type' => 'string', + 'example' => 'operationProfiling.slowOpThresholdMs', + 'title' => '', + ], + 'ParameterValue' => [ + 'description' => 'The value of the parameter.', + 'type' => 'string', + 'example' => '200', + 'title' => '', + ], + 'ForceRestart' => [ + 'description' => 'Indicates whether a restart is required for parameter modifications to take effect. Valid values:'."\n" + ."\n" + .'- **false**: A restart is not required. Modifications take effect immediately.'."\n" + ."\n" + .'- **true**: A restart is required for parameter modifications to take effect.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ParameterDescription' => [ + 'description' => 'The description of the parameter.', + 'type' => 'string', + 'example' => 'The threshold in milliseconds at which the database profiler considers a query slow, default is 100.', + 'title' => '', + ], + 'ModifiableStatus' => [ + 'description' => 'Indicates whether the parameter value can be modified. Valid values:'."\n" + ."\n" + .'- **false**: The parameter value cannot be modified.'."\n" + ."\n" + .'- **true**: The parameter value can be modified.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Engine' => [ + 'description' => 'The database engine of the instance. Default value: **mongodb**.', + 'type' => 'string', + 'example' => 'mongodb', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'IncorrectDBInstanceType', + 'errorMessage' => 'Current DB instance type does not support this operation.', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceClass.NotFound', + 'errorMessage' => 'The specified DB instance type is not found.', + 'description' => 'Invalid instance type. Specify another instance type.', + ], + ], + ], + 'title' => 'DescribeParameters', + 'summary' => 'Queries the parameter settings of an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RunningParameters\\": {\\n \\"Parameter\\": [\\n {\\n \\"CheckingCode\\": \\"[33554432-268435456]\\",\\n \\"ParameterName\\": \\"setParameter.internalQueryExecMaxBlockingSortBytes\\",\\n \\"ParameterValue\\": \\"33554432\\",\\n \\"ForceRestart\\": \\"false\\",\\n \\"ParameterDescription\\": \\"The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)\\",\\n \\"ModifiableStatus\\": \\"true\\",\\n \\"CharacterType\\": \\"db\\"\\n }\\n ]\\n },\\n \\"EngineVersion\\": \\"4.0\\",\\n \\"RequestId\\": \\"3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8\\",\\n \\"ConfigParameters\\": {\\n \\"Parameter\\": [\\n {\\n \\"CheckingCode\\": \\"[0-65536]\\",\\n \\"ParameterName\\": \\"operationProfiling.slowOpThresholdMs\\",\\n \\"ParameterValue\\": \\"200\\",\\n \\"ForceRestart\\": true,\\n \\"ParameterDescription\\": \\"The threshold in milliseconds at which the database profiler considers a query slow, default is 100.\\",\\n \\"ModifiableStatus\\": true\\n }\\n ]\\n },\\n \\"Engine\\": \\"mongodb\\"\\n}","type":"json"}]', + ], + 'DescribePrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8284', + 'abilityTreeNodes' => [ + 'FEATUREmongodb1FWAFI', + 'FEATUREmongodb1YU4BW', + 'FEATUREmongodbWLAP0U', + 'FEATUREmongodbL6DGXW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Call the [DescribeRegions](~~61933~~) operation to query the region ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order type. Valid values:'."\n" + ."\n" + .'- **BUY**: Create an instance.'."\n" + ."\n" + .'- **UPGRADE**: Change the configuration of an instance.'."\n" + ."\n" + .'- **RENEW**: Renew an instance.', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'BUY', + 'UPGRADE', + 'RENEW', + 'DOWNGRADE', + ], + 'example' => 'BUY', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstances', + 'in' => 'query', + 'schema' => [ + 'description' => 'A JSON string that contains information about the instance. For parameter details and more examples, see [DBInstances parameter in the DescribePrice operation](~~197291~~).', + 'type' => 'string', + 'required' => true, + 'example' => '[ { "DBInstanceId":"dds-bp1b6e54e7cc****", "RegionId":"cn-hangzhou", "ZoneId":"cn-hangzhou-h", "Engine":"MongoDB", "EngineVersion":" 5.0", "DBInstanceClass":"mdb.shard.2x.xlarge.d", "DBInstanceStorage":30, "ChargeType":"PrePaid", "Period":1, "StorageType":"cloud_essd1" } ]', + 'title' => '', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The commodity code of the instance. Valid values:'."\n" + ."\n" + .'- **dds**: pay-as-you-go replica set instance.'."\n" + ."\n" + .'- **badds**: subscription replica set instance.'."\n" + ."\n" + .'- **dds\\_sharding**: pay-as-you-go sharded cluster instance.'."\n" + ."\n" + .'- **badds\\_sharding**: subscription sharded cluster instance.'."\n" + ."\n" + .'- **badds\\_sharding\\_intl**: subscription sharded cluster instance on the international site (alibabacloud.com).'."\n" + ."\n" + .'- **dds\\_sharding\\_intl**: pay-as-you-go sharded cluster instance on the international site (alibabacloud.com).'."\n" + ."\n" + .'- **badds\\_sharding\\_jp**: subscription sharded cluster instance on the Japan site.'."\n" + ."\n" + .'- **badds\\_intl**: subscription replica set instance on the international site (alibabacloud.com).'."\n" + ."\n" + .'- **dds\\_intl**: pay-as-you-go replica set instance on the international site (alibabacloud.com).', + 'type' => 'string', + 'required' => false, + 'example' => 'badds', + 'title' => '', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product code. The default value is **dds**.', + 'type' => 'string', + 'required' => false, + 'default' => 'dds', + 'example' => 'dds', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Additional business information.', + 'type' => 'string', + 'required' => false, + 'example' => '{"AccountPassword":"Pw123456","DBInstanceDescription":"test"}', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" + ."\n" + .'- **default** or **null** (default): A coupon is used.'."\n" + ."\n" + .'- **youhuiquan\\_promotion\\_option\\_id\\_for\\_blank**: No coupon is used.', + 'type' => 'string', + 'required' => false, + 'default' => 'youhuiquan_promotion_option_id_for_blank', + 'example' => 'default', + 'title' => '', + ], + ], + [ + 'name' => 'OrderParamOut', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return order parameters. Valid values:'."\n" + ."\n" + .'- **false** (default): The order parameters are not returned.'."\n" + ."\n" + .'- **true**: The order parameters are returned.', + 'type' => 'string', + 'required' => false, + 'default' => 'false', + 'enum' => [ + 'false', + 'true', + ], + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID. For more information about resource groups, see [View basic information of a resource group](~~151181~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The order details.', + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'description' => 'The order details.', + 'type' => 'object', + 'properties' => [ + 'Coupons' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Coupon' => [ + 'itemNode' => true, + 'description' => 'A list of coupons.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The coupon details.', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The description.', + 'type' => 'string', + 'example' => 'ceshi', + 'title' => '', + ], + 'IsSelected' => [ + 'description' => 'Indicates whether the coupon is selected. Valid values:'."\n" + ."\n" + .'- **true**: The coupon is selected.'."\n" + ."\n" + .'- **false**: The coupon is not selected.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'CouponNo' => [ + 'description' => 'The coupon code.', + 'type' => 'string', + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'title' => '', + ], + 'Name' => [ + 'description' => 'The name of the coupon.', + 'type' => 'string', + 'example' => 'youhuiquan111', + 'title' => '', + ], + 'PromotionRuleIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromotionRuleId' => [ + 'description' => 'A list of rule IDs for the coupon.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule ID for the coupon.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18772041****', + 'title' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PromotionOptionCode' => [ + 'description' => 'The code of the promotion option.', + 'type' => 'string', + 'example' => 'youhui_quan', + 'title' => '', + ], + 'OptionCode' => [ + 'description' => 'The coupon code.', + 'type' => 'string', + 'example' => 'youhui_quan', + 'title' => '', + ], + 'ActivityCategory' => [ + 'description' => 'The type of the promotion. Valid values:'."\n" + ."\n" + .'- **payondemand**: subscription.'."\n" + ."\n" + .'- **payasyougo**: pay-as-you-go.', + 'type' => 'string', + 'example' => 'payondemand', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'OriginalAmount' => [ + 'description' => 'The original price of the order.', + 'type' => 'string', + 'example' => '322.4', + 'title' => '', + ], + 'DiscountAmount' => [ + 'description' => 'The discount amount for the order.', + 'type' => 'string', + 'example' => '322.4', + 'title' => '', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'itemNode' => true, + 'description' => 'The rule information for the order.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'A collection of promotion rule IDs.', + 'type' => 'string', + 'example' => '{ "RuleId": [ 2075**** ] }', + 'title' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TradeAmount' => [ + 'description' => 'The final price of the order.', + 'type' => 'string', + 'example' => '0', + 'title' => '', + ], + 'Currency' => [ + 'description' => 'The currency.', + 'type' => 'string', + 'example' => 'USD', + 'title' => '', + ], + 'ShowDiscountInfo' => [ + 'description' => 'Indicates whether to show the discount information.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'OptionalPromotions' => [ + 'description' => 'A list of promotions.', + 'type' => 'string', + 'example' => '"[{\\"activityCategory\\":\\"discount\\",\\"activityExtInfo\\":{\\"noUseYouhuiquan\\":\\"true\\",\\"activityId\\":\\"191156098xxxx\\",\\"activityExtraAttr\\":\\"{\\\\\\"forbiddenCpsProfit\\\\\\":\\\\\\"true\\\\\\",\\\\\\"forbiddenCouponsRestricted\\\\\\":\\\\\\"true\\\\\\",\\\\\\"forbiddenAmbassadorProfit\\\\\\":\\\\\\"true\\\\\\"}\\",\\"isActivityIdFromWanHuaTong\\":\\"true\\",\\"isContractActivity\\":\\"false\\"},\\"canPromFee\\":906130,\\"optionCode\\":\\"wanhua_activity\\",\\"promotionName\\":\\"FY24--MongoDB 副本集--首购--1年*折--ft首购权益\\",\\"promotionOptionNo\\":\\"19115609882xxxx\\",\\"promotionRuleIdList\\":[2091xxxx],\\"selected\\":true,\\"targetArticleItemCodes\\":[]},{\\"activityCategory\\":\\"discount\\",\\"activityExtInfo\\":{\\"activityId\\":\\"1018040010xxxxx\\",\\"wanHuaOrderExpireSec\\":\\"604800\\",\\"isActivityIdFromWanHuaTong\\":\\"true\\",\\"isContractActivity\\":\\"false\\"},\\"canPromFee\\":339799,\\"optionCode\\":\\"wanhua_activity\\",\\"promotionName\\":\\"FY24--MongoDB年付折扣\\",\\"promotionOptionNo\\":\\"10180400107xxxxx\\",\\"promotionRuleIdList\\":[xxxxx],\\"selected\\":false,\\"targetArticleItemCodes\\":[]}]"', + 'title' => '', + ], + 'PromDetailList' => [ + 'description' => 'The matched promotions.', + 'type' => 'string', + 'example' => '[{\\"finalPromFee\\":90xxx,\\"optionCode\\":\\"wanhua_activity\\",\\"promType\\":\\"discount\\",\\"promotionId\\":2091xxxx,\\"promotionName\\":\\"新用户购买云数据库 MongoDB 副本集1年享*折优惠，限1台\\"}]"', + 'title' => '', + ], + 'DepreciateInfo' => [ + 'description' => 'The price reduction details.', + 'type' => 'object', + 'properties' => [ + 'ListPrice' => [ + 'description' => 'The list price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1*', + 'title' => '', + ], + 'OriginalStandAmount' => [ + 'description' => 'The original total price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '12*', + 'title' => '', + ], + 'CheapStandAmount' => [ + 'description' => 'The total price after the price reduction.', + 'type' => 'number', + 'format' => 'double', + 'example' => '9*', + 'title' => '', + ], + 'CheapRate' => [ + 'description' => 'The price reduction percentage.', + 'type' => 'number', + 'format' => 'double', + 'example' => '30%', + 'title' => '', + ], + 'Differential' => [ + 'description' => 'The price difference discount, which is reflected in the total price of the order.', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + 'title' => '', + ], + 'DifferentialName' => [ + 'description' => 'The name of the price difference discount.', + 'type' => 'string', + 'example' => 'XXXXX', + 'title' => '', + ], + 'MonthPrice' => [ + 'description' => 'The monthly price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + 'title' => '', + ], + 'IsContractActivity' => [ + 'description' => 'Indicates whether a contract-based promotion is matched.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'IsShow' => [ + 'description' => 'Indicates whether to show the price reduction.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ContractActivity' => [ + 'description' => 'The contract-based promotion.', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => 'The total discount amount.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3621.6', + 'title' => '', + ], + 'FinalFee' => [ + 'description' => 'The discounted price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '20522.4', + 'title' => '', + ], + 'ProdFee' => [ + 'description' => 'The original price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '24144.0', + 'title' => '', + ], + 'ActivityId' => [ + 'description' => 'The promotion ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41120065996xxxxx', + 'title' => '', + ], + 'OptionCode' => [ + 'description' => 'The option code.', + 'type' => 'string', + 'example' => 'wanhua_activity', + 'title' => '', + ], + 'ActivityName' => [ + 'description' => 'The name of the promotion.', + 'type' => 'string', + 'example' => '合同优惠_整单_xxx折', + 'title' => '', + ], + 'OptionIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OptionId' => [ + 'itemNode' => true, + 'description' => 'A list of option IDs.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The option ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200000614xxxx', + 'title' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'StandDiscountPrice' => [ + 'description' => 'The discount.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + 'title' => '', + ], + 'StandPrice' => [ + 'description' => 'The discounted price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + 'title' => '', + ], + 'ContractActivity' => [ + 'description' => 'Indicates whether a contract-based promotion is matched.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The order code.', + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The order message.', + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + 'IsContractActivity' => [ + 'description' => 'Indicates whether a contract-based promotion is matched.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'TotalCostAmount' => [ + 'description' => 'The total cost of the order.', + 'type' => 'number', + 'format' => 'double', + 'example' => '483.14', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '27227A3D-6B86-56F3-9E03-9E60F001CE12', + 'title' => '', + ], + 'SubOrders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubOrder' => [ + 'itemNode' => true, + 'description' => 'A list of rules that correspond to the coupon.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule information for the coupon.', + 'type' => 'object', + 'properties' => [ + 'OriginalAmount' => [ + 'description' => 'The original price of the order.', + 'type' => 'string', + 'example' => '322.4', + 'title' => '', + ], + 'DiscountAmount' => [ + 'description' => 'The discount amount for the order.', + 'type' => 'string', + 'example' => '322.4', + 'title' => '', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => 'A list of promotion rules.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'A collection of promotion rule IDs.', + 'type' => 'string', + 'example' => '{ "RuleId": [ 2075**** ] }', + 'title' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TradeAmount' => [ + 'description' => 'The final price of the order.', + 'type' => 'string', + 'example' => '0', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-bp1b6e54e7cc****', + 'title' => '', + ], + 'DepreciateInfo' => [ + 'description' => 'The price reduction details.', + 'type' => 'object', + 'properties' => [ + 'ListPrice' => [ + 'description' => 'The list price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1*', + 'title' => '', + ], + 'OriginalStandAmount' => [ + 'description' => 'The original total price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '12*', + 'title' => '', + ], + 'CheapStandAmount' => [ + 'description' => 'The total price after the price reduction.', + 'type' => 'number', + 'format' => 'double', + 'example' => '9*', + 'title' => '', + ], + 'CheapRate' => [ + 'description' => 'The price reduction percentage.', + 'type' => 'number', + 'format' => 'double', + 'example' => '30%', + 'title' => '', + ], + 'Differential' => [ + 'description' => 'The price difference discount, which is reflected in the total price of the order.', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + 'title' => '', + ], + 'DifferentialName' => [ + 'description' => 'The name of the price difference discount.', + 'type' => 'string', + 'example' => 'XXXXX', + 'title' => '', + ], + 'MonthPrice' => [ + 'description' => 'The monthly price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + 'title' => '', + ], + 'IsContractActivity' => [ + 'description' => 'Indicates whether a contract-based promotion is matched.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'IsShow' => [ + 'description' => 'Indicates whether to show the price reduction.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'ContractActivity' => [ + 'description' => 'The promotion information.', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => 'The total discount amount.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3621.6', + 'title' => '', + ], + 'FinalFee' => [ + 'description' => 'The discounted price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '20522.4', + 'title' => '', + ], + 'ProdFee' => [ + 'description' => 'The original price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '24144.0', + 'title' => '', + ], + 'ActivityId' => [ + 'description' => 'The promotion ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41120065996xxxxx'."\n", + 'title' => '', + ], + 'OptionCode' => [ + 'description' => 'The option code.', + 'type' => 'string', + 'example' => 'wanhua_activity', + 'title' => '', + ], + 'ActivityName' => [ + 'description' => 'The name of the promotion.', + 'type' => 'string', + 'example' => '合同优惠_整单_xxx折', + 'title' => '', + ], + 'OptionIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OptionId' => [ + 'description' => 'A list of option IDs.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The option ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2388xxxx', + 'title' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'StartTime' => [ + 'description' => 'The start time of the promotion.', + 'type' => 'string', + 'example' => '2024-02-29 10:30:00', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'IsNewOfficialActivity' => [ + 'description' => 'Indicates whether a price reduction promotion is matched.', + 'type' => 'string', + 'example' => '命中降价优惠。', + 'title' => '', + ], + 'ModuleInstance' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModuleInstance' => [ + 'description' => 'The instance configurations for the order item.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The sub-object of the instance configuration for the order item.', + 'type' => 'object', + 'properties' => [ + 'CycleFee' => [ + 'description' => 'The cycle fee of the module.', + 'type' => 'string', + 'example' => '0.0', + 'title' => '', + ], + 'PromDetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromDetail' => [ + 'description' => 'The discount details.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The discount information.', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => 'The discount amount.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + 'title' => '', + ], + 'ActivityExtInfo' => [ + 'description' => 'The extended information about the discount.', + 'type' => 'object', + 'example' => '{'."\n" + .' "activityId": "1512010241743170"'."\n" + .'}', + 'title' => '', + ], + 'OptionCode' => [ + 'description' => 'The commodity code of the coupon.', + 'type' => 'string', + 'example' => 'wanhua_activity', + 'title' => '', + ], + 'PromType' => [ + 'description' => 'The sub-type of the discount.', + 'type' => 'string', + 'example' => 'discount', + 'title' => '', + ], + 'PromotionId' => [ + 'description' => 'The promotion ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8105187xxxx', + 'title' => '', + ], + 'PromotionName' => [ + 'description' => 'The name of the promotion.', + 'type' => 'string', + 'example' => '【xxxx-x月降价项目】MongoDB全规格--xxxxx', + 'title' => '', + ], + 'PromotionCode' => [ + 'description' => 'The coupon code.', + 'type' => 'string', + 'example' => 'aliwood-xxx', + 'title' => '', + ], + 'DerivedPromType' => [ + 'description' => 'The sub-type of the discount.', + 'type' => 'string', + 'example' => 'subPrice', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DepreciateInfo' => [ + 'description' => 'The promotion information.', + 'type' => 'object', + 'properties' => [ + 'ListPrice' => [ + 'description' => 'The list price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1*', + 'title' => '', + ], + 'OriginalStandAmount' => [ + 'description' => 'The original total price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '12*', + 'title' => '', + ], + 'CheapStandAmount' => [ + 'description' => 'The total price after the price reduction.', + 'type' => 'number', + 'format' => 'double', + 'example' => '9*', + 'title' => '', + ], + 'CheapRate' => [ + 'description' => 'The price reduction percentage.', + 'type' => 'number', + 'format' => 'double', + 'example' => '30%', + 'title' => '', + ], + 'Differential' => [ + 'description' => 'The price difference discount, which is reflected in the total price of the order.', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + 'title' => '', + ], + 'DifferentialName' => [ + 'description' => 'The name of the price difference discount.', + 'type' => 'string', + 'example' => 'XXXXX', + 'title' => '', + ], + 'MonthPrice' => [ + 'description' => 'The monthly price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + 'title' => '', + ], + 'IsContractActivity' => [ + 'description' => 'Indicates whether a contract-based promotion is matched.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'IsShow' => [ + 'description' => 'Indicates whether to show the price reduction.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'DiscountFee' => [ + 'description' => 'The discount amount.', + 'type' => 'string', + 'example' => '0.0', + 'title' => '', + ], + 'ModuleAttrs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'moduleAttr' => [ + 'description' => 'The module attributes.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'Order parameters.', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The property code.', + 'type' => 'string', + 'example' => 'dds_dbtype', + 'title' => '', + ], + 'Name' => [ + 'description' => 'The name of the property.', + 'type' => 'string', + 'example' => 'MongoDB', + 'title' => '', + ], + 'Type' => [ + 'description' => 'The property type.', + 'type' => 'string', + 'example' => '3', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The value of the property.', + 'type' => 'string', + 'example' => 'MongoDB', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ModuleCode' => [ + 'description' => 'The module code.', + 'type' => 'string', + 'example' => 'dds_dbtype', + 'title' => '', + ], + 'ModuleId' => [ + 'description' => 'The module ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1017110000415xxx', + 'title' => '', + ], + 'ModuleName' => [ + 'description' => 'The name of the module.', + 'type' => 'string', + 'example' => '数据库类型', + 'title' => '', + ], + 'NeedOrderPay' => [ + 'description' => 'Indicates whether the order must be paid.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'PayFee' => [ + 'description' => 'The amount paid.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + 'title' => '', + ], + 'PricingModule' => [ + 'description' => 'Indicates if you are charged for the item.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'StandPrice' => [ + 'description' => 'The discount price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + 'title' => '', + ], + 'TotalProductFee' => [ + 'description' => 'The original price of the product.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + 'title' => '', + ], + 'ContractActivity' => [ + 'description' => 'A contract discount was hit.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'StandDiscountPrice' => [ + 'description' => 'The discount price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '451.00', + 'title' => '', + ], + 'priceUnit' => [ + 'description' => 'The unit of the price.', + 'type' => 'string', + 'example' => 'xxxx', + 'title' => '', + ], + 'priceType' => [ + 'description' => 'The price type.', + 'type' => 'string', + 'example' => 'monthPrice', + 'title' => '', + ], + 'UnitPriceUnit4Buy' => [ + 'description' => 'The unit of the price.', + 'type' => 'string', + 'example' => 'CNY/Hour', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ContractActivity' => [ + 'description' => 'The contract discount was applied.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'OptionalPromotions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OptionalPromotion' => [ + 'description' => 'A list of selectable promotion options.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActivityCategory' => [ + 'description' => 'The activity type.', + 'type' => 'string', + 'example' => 'discount', + 'title' => '', + ], + 'ActivityExtInfo' => [ + 'description' => 'Additional information about the activity.', + 'type' => 'object', + 'example' => '{'."\n" + .' "activityId": "1512010241743170"'."\n" + .'}', + 'title' => '', + ], + 'CanPromFee' => [ + 'description' => 'The discount amount.', + 'type' => 'number', + 'format' => 'double', + 'example' => '4560789', + 'title' => '', + ], + 'OptionCode' => [ + 'description' => 'The promotion type.', + 'type' => 'string', + 'example' => 'wanhua_activity', + 'title' => '', + ], + 'PromotionName' => [ + 'description' => 'The name of the promotion.', + 'type' => 'string', + 'example' => '【xxx月降价项目】MongoDB全规格--xxx', + 'title' => '', + ], + 'PromotionOptionNo' => [ + 'description' => 'The promotion ID.', + 'type' => 'string', + 'example' => '1512010241xxxxx', + 'title' => '', + ], + 'Selected' => [ + 'description' => 'Indicates whether the promotion is selected externally.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'Show' => [ + 'description' => 'Indicates whether the promotion is displayed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'TargetArticleItemCodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'targetArticleItemCode' => [ + 'description' => 'A list of specification codes for the target articles.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The specification code for the target article item.', + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PromotionRuleIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'promotionRuleId' => [ + 'description' => 'A list of promotion IDs.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the promotion rule.', + 'type' => 'string', + 'example' => '43289909', + 'title' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PromDetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromDetail' => [ + 'description' => 'The promotion details.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The promotional information.', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => 'The discount amount.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + 'title' => '', + ], + 'ActivityExtInfo' => [ + 'description' => 'Additional information about the activity.', + 'type' => 'object', + 'example' => '{'."\n" + .' "activityId": "1512010241743170"'."\n" + .'}', + 'title' => '', + ], + 'OptionCode' => [ + 'description' => 'The coupon code.', + 'type' => 'string', + 'example' => 'youhui_quan', + 'title' => '', + ], + 'PromType' => [ + 'description' => 'The subtype of the promotion.', + 'type' => 'string', + 'example' => 'discount', + 'title' => '', + ], + 'PromotionId' => [ + 'description' => 'The ID of the promotion.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '233xxxxx', + 'title' => '', + ], + 'PromotionName' => [ + 'description' => 'The name of the promotion.', + 'type' => 'string', + 'example' => '【xxxx-x月降价项目】MongoDB全规格--xxxxx', + 'title' => '', + ], + 'PromotionCode' => [ + 'description' => 'The coupon code.', + 'type' => 'string', + 'example' => 'ali-wood', + 'title' => '', + ], + 'DerivedPromType' => [ + 'description' => 'The promotion subtype.', + 'type' => 'string', + 'example' => 'subPrice', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'StandDiscountPrice' => [ + 'description' => 'The discount price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '8687', + 'title' => '', + ], + 'StandPrice' => [ + 'description' => 'The discounted price.', + 'type' => 'number', + 'format' => 'double', + 'example' => '62982', + 'title' => '', + ], + 'IsContractActivity' => [ + 'description' => 'Indicates whether a contract discount is hit.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TraceId' => [ + 'description' => 'The trace ID.', + 'type' => 'string', + 'example' => '27227A3D-6B87-56F3-9E03-9E60F001****', + 'title' => '', + ], + 'OrderParams' => [ + 'description' => 'The order parameters.'."\n" + ."\n" + .'> This parameter is returned only when the **OrderParamOut** parameter is set to **true**.', + 'type' => 'string', + 'example' => '{\\"autoPay\\":false}"', + 'title' => '', + ], + 'Rules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Rule' => [ + 'itemNode' => true, + 'description' => 'The list of promotional rules.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the promotional rule.', + 'type' => 'object', + 'properties' => [ + 'RuleDescId' => [ + 'description' => 'The policy ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2075****', + 'title' => '', + ], + 'Title' => [ + 'description' => 'The title of the rule.', + 'type' => 'string', + 'example' => 'demo', + 'title' => '', + ], + 'Name' => [ + 'description' => 'The name of the rule.', + 'type' => 'string', + 'example' => 'demoname', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Period is mandatory for this action.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Specified parameter Period is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'OriginPriceError', + 'errorMessage' => 'Origin price error.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribePrice', + 'summary' => 'Queries the price of an instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribePrice', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Order\\": {\\n \\"Coupons\\": {\\n \\"Coupon\\": [\\n {\\n \\"Description\\": \\"ceshi\\",\\n \\"IsSelected\\": \\"true\\",\\n \\"CouponNo\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"Name\\": \\"youhuiquan111\\",\\n \\"PromotionRuleIdList\\": {\\n \\"PromotionRuleId\\": [\\n 0\\n ]\\n },\\n \\"PromotionOptionCode\\": \\"youhui_quan\\",\\n \\"OptionCode\\": \\"youhui_quan\\",\\n \\"ActivityCategory\\": \\"payondemand\\"\\n }\\n ]\\n },\\n \\"OriginalAmount\\": \\"322.4\\",\\n \\"DiscountAmount\\": \\"322.4\\",\\n \\"RuleIds\\": {\\n \\"RuleId\\": [\\n \\"{ \\\\\\"RuleId\\\\\\": [ 2075**** ] }\\"\\n ]\\n },\\n \\"TradeAmount\\": \\"0\\",\\n \\"Currency\\": \\"USD\\",\\n \\"ShowDiscountInfo\\": true,\\n \\"OptionalPromotions\\": \\"\\\\\\"[{\\\\\\\\\\\\\\"activityCategory\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"discount\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"activityExtInfo\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"noUseYouhuiquan\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"activityId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"191156098xxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"activityExtraAttr\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"forbiddenCpsProfit\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"forbiddenCouponsRestricted\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"forbiddenAmbassadorProfit\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isActivityIdFromWanHuaTong\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isContractActivity\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"false\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"canPromFee\\\\\\\\\\\\\\":906130,\\\\\\\\\\\\\\"optionCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"wanhua_activity\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"promotionName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"FY24--MongoDB 副本集--首购--1年*折--ft首购权益\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"promotionOptionNo\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"19115609882xxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"promotionRuleIdList\\\\\\\\\\\\\\":[2091xxxx],\\\\\\\\\\\\\\"selected\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"targetArticleItemCodes\\\\\\\\\\\\\\":[]},{\\\\\\\\\\\\\\"activityCategory\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"discount\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"activityExtInfo\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"activityId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1018040010xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"wanHuaOrderExpireSec\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"604800\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isActivityIdFromWanHuaTong\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isContractActivity\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"false\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"canPromFee\\\\\\\\\\\\\\":339799,\\\\\\\\\\\\\\"optionCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"wanhua_activity\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"promotionName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"FY24--MongoDB年付折扣\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"promotionOptionNo\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10180400107xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"promotionRuleIdList\\\\\\\\\\\\\\":[xxxxx],\\\\\\\\\\\\\\"selected\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"targetArticleItemCodes\\\\\\\\\\\\\\":[]}]\\\\\\"\\",\\n \\"PromDetailList\\": \\"[{\\\\\\\\\\\\\\"finalPromFee\\\\\\\\\\\\\\":90xxx,\\\\\\\\\\\\\\"optionCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"wanhua_activity\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"promType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"discount\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"promotionId\\\\\\\\\\\\\\":2091xxxx,\\\\\\\\\\\\\\"promotionName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"新用户购买云数据库 MongoDB 副本集1年享*折优惠，限1台\\\\\\\\\\\\\\"}]\\\\\\"\\",\\n \\"DepreciateInfo\\": {\\n \\"ListPrice\\": 0,\\n \\"OriginalStandAmount\\": 0,\\n \\"CheapStandAmount\\": 0,\\n \\"CheapRate\\": 0,\\n \\"Differential\\": 0,\\n \\"DifferentialName\\": \\"XXXXX\\",\\n \\"MonthPrice\\": 0,\\n \\"IsContractActivity\\": false,\\n \\"IsShow\\": \\"true\\",\\n \\"ContractActivity\\": {\\n \\"FinalPromFee\\": 3621.6,\\n \\"FinalFee\\": 20522.4,\\n \\"ProdFee\\": 24144,\\n \\"ActivityId\\": 0,\\n \\"OptionCode\\": \\"wanhua_activity\\",\\n \\"ActivityName\\": \\"合同优惠_整单_xxx折\\",\\n \\"OptionIds\\": {\\n \\"OptionId\\": [\\n 0\\n ]\\n }\\n }\\n },\\n \\"StandDiscountPrice\\": 0,\\n \\"StandPrice\\": 0,\\n \\"ContractActivity\\": false,\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IsContractActivity\\": false,\\n \\"TotalCostAmount\\": 483.14\\n },\\n \\"RequestId\\": \\"27227A3D-6B86-56F3-9E03-9E60F001CE12\\",\\n \\"SubOrders\\": {\\n \\"SubOrder\\": [\\n {\\n \\"OriginalAmount\\": \\"322.4\\",\\n \\"DiscountAmount\\": \\"322.4\\",\\n \\"RuleIds\\": {\\n \\"RuleId\\": [\\n \\"{ \\\\\\"RuleId\\\\\\": [ 2075**** ] }\\"\\n ]\\n },\\n \\"TradeAmount\\": \\"0\\",\\n \\"InstanceId\\": \\"dds-bp1b6e54e7cc****\\",\\n \\"DepreciateInfo\\": {\\n \\"ListPrice\\": 0,\\n \\"OriginalStandAmount\\": 0,\\n \\"CheapStandAmount\\": 0,\\n \\"CheapRate\\": 0,\\n \\"Differential\\": 0,\\n \\"DifferentialName\\": \\"XXXXX\\",\\n \\"MonthPrice\\": 0,\\n \\"IsContractActivity\\": false,\\n \\"IsShow\\": \\"true\\",\\n \\"ContractActivity\\": {\\n \\"FinalPromFee\\": 3621.6,\\n \\"FinalFee\\": 20522.4,\\n \\"ProdFee\\": 24144,\\n \\"ActivityId\\": 0,\\n \\"OptionCode\\": \\"wanhua_activity\\",\\n \\"ActivityName\\": \\"合同优惠_整单_xxx折\\",\\n \\"OptionIds\\": {\\n \\"OptionId\\": [\\n 0\\n ]\\n }\\n },\\n \\"StartTime\\": \\"2024-02-29 10:30:00\\"\\n },\\n \\"IsNewOfficialActivity\\": \\"命中降价优惠。\\",\\n \\"ModuleInstance\\": {\\n \\"ModuleInstance\\": [\\n {\\n \\"CycleFee\\": \\"0.0\\",\\n \\"PromDetailList\\": {\\n \\"PromDetail\\": [\\n {\\n \\"FinalPromFee\\": 0,\\n \\"ActivityExtInfo\\": {\\n \\"activityId\\": \\"1512010241743170\\"\\n },\\n \\"OptionCode\\": \\"wanhua_activity\\",\\n \\"PromType\\": \\"discount\\",\\n \\"PromotionId\\": 0,\\n \\"PromotionName\\": \\"【xxxx-x月降价项目】MongoDB全规格--xxxxx\\",\\n \\"PromotionCode\\": \\"aliwood-xxx\\",\\n \\"DerivedPromType\\": \\"subPrice\\"\\n }\\n ]\\n },\\n \\"DepreciateInfo\\": {\\n \\"ListPrice\\": 0,\\n \\"OriginalStandAmount\\": 0,\\n \\"CheapStandAmount\\": 0,\\n \\"CheapRate\\": 0,\\n \\"Differential\\": 0,\\n \\"DifferentialName\\": \\"XXXXX\\",\\n \\"MonthPrice\\": 0,\\n \\"IsContractActivity\\": false,\\n \\"IsShow\\": \\"true\\"\\n },\\n \\"DiscountFee\\": \\"0.0\\",\\n \\"ModuleAttrs\\": {\\n \\"moduleAttr\\": [\\n {\\n \\"Code\\": \\"dds_dbtype\\",\\n \\"Name\\": \\"MongoDB\\",\\n \\"Type\\": \\"3\\",\\n \\"Value\\": \\"MongoDB\\"\\n }\\n ]\\n },\\n \\"ModuleCode\\": \\"dds_dbtype\\",\\n \\"ModuleId\\": 0,\\n \\"ModuleName\\": \\"数据库类型\\",\\n \\"NeedOrderPay\\": true,\\n \\"PayFee\\": 0,\\n \\"PricingModule\\": false,\\n \\"StandPrice\\": 0,\\n \\"TotalProductFee\\": 0,\\n \\"ContractActivity\\": false,\\n \\"StandDiscountPrice\\": 451,\\n \\"priceUnit\\": \\"xxxx\\",\\n \\"priceType\\": \\"monthPrice\\",\\n \\"UnitPriceUnit4Buy\\": \\"CNY/Hour\\"\\n }\\n ]\\n },\\n \\"ContractActivity\\": false,\\n \\"OptionalPromotions\\": {\\n \\"OptionalPromotion\\": [\\n {\\n \\"ActivityCategory\\": \\"discount\\",\\n \\"ActivityExtInfo\\": {\\n \\"activityId\\": \\"1512010241743170\\"\\n },\\n \\"CanPromFee\\": 4560789,\\n \\"OptionCode\\": \\"wanhua_activity\\",\\n \\"PromotionName\\": \\"【xxx月降价项目】MongoDB全规格--xxx\\",\\n \\"PromotionOptionNo\\": \\"1512010241xxxxx\\",\\n \\"Selected\\": false,\\n \\"Show\\": true,\\n \\"TargetArticleItemCodes\\": {\\n \\"targetArticleItemCode\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ]\\n },\\n \\"PromotionRuleIdList\\": {\\n \\"promotionRuleId\\": [\\n \\"43289909\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"PromDetailList\\": {\\n \\"PromDetail\\": [\\n {\\n \\"FinalPromFee\\": 0,\\n \\"ActivityExtInfo\\": {\\n \\"activityId\\": \\"1512010241743170\\"\\n },\\n \\"OptionCode\\": \\"youhui_quan\\",\\n \\"PromType\\": \\"discount\\",\\n \\"PromotionId\\": 0,\\n \\"PromotionName\\": \\"【xxxx-x月降价项目】MongoDB全规格--xxxxx\\",\\n \\"PromotionCode\\": \\"ali-wood\\",\\n \\"DerivedPromType\\": \\"subPrice\\"\\n }\\n ]\\n },\\n \\"StandDiscountPrice\\": 8687,\\n \\"StandPrice\\": 62982,\\n \\"IsContractActivity\\": false\\n }\\n ]\\n },\\n \\"TraceId\\": \\"27227A3D-6B87-56F3-9E03-9E60F001****\\",\\n \\"OrderParams\\": \\"{\\\\\\\\\\\\\\"autoPay\\\\\\\\\\\\\\":false}\\\\\\"\\",\\n \\"Rules\\": {\\n \\"Rule\\": [\\n {\\n \\"RuleDescId\\": 0,\\n \\"Title\\": \\"demo\\",\\n \\"Name\\": \\"demoname\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRdsVSwitchs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of VPC.', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp*******************'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm4ojaksxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '60EEBD77-227C-5B39-86EA-D89163C5****', + 'title' => '', + ], + 'VSwitches' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the vSwitch. A value of **Available** indicates that the vSwitch is active.', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" + ."\n" + .'- **true**: The vSwitch is the default vSwitch.'."\n" + ."\n" + .'- **false**: The vSwitch is not the default vSwitch.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.', + 'type' => 'string', + 'example' => 'vsw-bp*******************'."\n", + 'title' => '', + ], + 'CidrBlock' => [ + 'description' => 'The CIDR block of the vSwitch.', + 'type' => 'string', + 'example' => '192.**.**.0/24'."\n", + 'title' => '', + ], + 'RegionNo' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'GmtCreate' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'AliUid' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'GmtModified' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'Bid' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'IzNo' => [ + 'description' => 'The zone ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h'."\n", + 'title' => '', + ], + 'VSwitchName' => [ + 'description' => 'The name of the vSwitch.', + 'type' => 'string', + 'example' => 'vsw-name'."\n", + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The vSwitch information.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The list of vSwitches.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeRdsVSwitchs', + 'summary' => 'Queries a list of vSwitches.', + 'description' => 'Call this operation to query the vSwitches that are available in the destination region and zone when you create an ApsaraDB for MongoDB instance.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60EEBD77-227C-5B39-86EA-D89163C5****\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": true,\\n \\"VSwitchId\\": \\"vsw-bp*******************\\\\n\\",\\n \\"CidrBlock\\": \\"192.**.**.0/24\\\\n\\",\\n \\"RegionNo\\": \\"null\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"AliUid\\": \\"null\\",\\n \\"GmtModified\\": \\"null\\",\\n \\"Bid\\": \\"null\\",\\n \\"IzNo\\": \\"cn-hangzhou-h\\\\n\\",\\n \\"VSwitchName\\": \\"vsw-name\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRdsVpcs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8286', + 'abilityTreeNodes' => [ + 'FEATUREmongodbP55RS0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-l', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Vpcs' => [ + 'type' => 'object', + 'properties' => [ + 'Vpc' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the VPC. A value of **Available** indicates that the VPC is available.', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'VpcName' => [ + 'description' => 'The name of the VPC.', + 'type' => 'string', + 'example' => 'vpc-name'."\n", + 'title' => '', + ], + 'VpcId' => [ + 'description' => 'The ID of the VPC.', + 'type' => 'string', + 'example' => 'vpc-bp*******************'."\n", + 'title' => '', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the VPC is the default VPC. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'CidrBlock' => [ + 'description' => 'The CIDR block of the VPC.', + 'type' => 'string', + 'example' => '10.**.**.0/8'."\n", + 'title' => '', + ], + 'RegionNo' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou'."\n", + 'title' => '', + ], + 'GmtCreate' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'AliUid' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'VSwitchs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the vSwitch. A value of **Available** indicates that the vSwitch is available.', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch.', + 'type' => 'string', + 'example' => 'vsw-bp*******************'."\n", + 'title' => '', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" + ."\n" + .'- **true**: The vSwitch is the default vSwitch.'."\n" + ."\n" + .'- **false**: The vSwitch is not the default vSwitch.', + 'type' => 'boolean', + 'example' => 'true'."\n", + 'title' => '', + ], + 'CidrBlock' => [ + 'description' => 'The CIDR block of the vSwitch.', + 'type' => 'string', + 'example' => '10.**.**.0/24'."\n", + 'title' => '', + ], + 'GmtCreate' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null'."\n", + 'title' => '', + ], + 'GmtModified' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'IzNo' => [ + 'description' => 'The ID of the zone where the vSwitch is located.', + 'type' => 'string', + 'example' => 'cn-hangzhou-i'."\n", + 'title' => '', + ], + 'VSwitchName' => [ + 'description' => 'The name of the vSwitch.', + 'type' => 'string', + 'example' => 'vsw-name'."\n", + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of vSwitches.', + 'title' => '', + 'example' => '', + ], + 'GmtModified' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null'."\n", + 'title' => '', + ], + 'Bid' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null'."\n", + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'VPC details.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A list of VPCs.', + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '53924AF0-1628-5AA2-9C95-D4**********'."\n", + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeRdsVpcs', + 'summary' => 'Queries a list of VPCs.', + 'description' => 'Call this operation to query available VPCs in a destination region and zone when you create an ApsaraDB for MongoDB instance.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"vpc-name\\\\n\\",\\n \\"VpcId\\": \\"vpc-bp*******************\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.0/8\\\\n\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\\\n\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"AliUid\\": \\"null\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-bp*******************\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.0/24\\\\n\\",\\n \\"GmtCreate\\": \\"null\\\\n\\",\\n \\"GmtModified\\": \\"null\\",\\n \\"IzNo\\": \\"cn-hangzhou-i\\\\n\\",\\n \\"VSwitchName\\": \\"vsw-name\\\\n\\"\\n }\\n ],\\n \\"GmtModified\\": \\"null\\\\n\\",\\n \\"Bid\\": \\"null\\\\n\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"53924AF0-1628-5AA2-9C95-D4**********\\\\n\\"\\n}","type":"json"}]', + ], + 'DescribeRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8288', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWP8F69', + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> If you do not specify this parameter, all supported regions are queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the values of the returned **RegionName** and **ZoneName** parameters. Valid values:'."\n" + ."\n" + .'- **zh** (default)'."\n" + ."\n" + .'- **en**', + 'type' => 'string', + 'default' => 'zh', + 'required' => false, + 'example' => 'zh', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The regions and zones.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '4E46C22C-D3B7-4DB8-9C76-63851BE68E20', + 'title' => '', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DdsRegion' => [ + 'description' => 'The regions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The region.', + 'type' => 'object', + 'properties' => [ + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => 'The zones.', + 'type' => 'array', + 'items' => [ + 'description' => 'The zone.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + 'VpcEnabled' => [ + 'description' => 'Indicates whether a virtual private cloud (VPC) is supported. Valid values:'."\n" + ."\n" + .'- **true**: VPC is supported.'."\n" + ."\n" + .'- **false**: VPC is not supported.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ZoneName' => [ + 'description' => 'The name of the zone.'."\n" + ."\n" + .'The value of the ZoneName parameter is in the language that is specified by the **AcceptLanguage** parameter. For example, if the value of the ZoneId parameter in the response is **cn-hangzhou-h**, the following values are returned for the ZoneName parameter:'."\n" + ."\n" + .'- If the value of the **AcceptLanguage** parameter is **zh**, the value **H** is returned for the ZoneName parameter.'."\n" + ."\n" + .'- If the value of the **AcceptLanguage** parameter is **en**, the value **Hangzhou Zone H** is returned for the ZoneName parameter.', + 'type' => 'string', + 'example' => '杭州 可用区H', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'RegionName' => [ + 'description' => 'The name of the region.'."\n" + ."\n" + .'The value of the LocalName parameter is in the language that is specified by the **AcceptLanguage** parameter. For example, if the value of the RegionId parameter in the response is **cn-hangzhou**, the following values are returned for the LocalName parameter:'."\n" + ."\n" + .'- If the value of the **AcceptLanguage** parameter is **zh**, the value **华东 1（杭州）** is returned for the LocalName parameter.'."\n" + ."\n" + .'- If the value of the **AcceptLanguage** parameter is **en**, the value **China (Hangzhou)** is returned for the LocalName parameter.', + 'type' => 'string', + 'example' => '华东1（杭州）', + 'title' => '', + ], + 'EndPoint' => [ + 'description' => 'The public endpoint of the region.'."\n" + ."\n" + .'For example, if the value of the RegionId parameter in the response is cn-hangzhou, the following value is returned for the EndPoint parameter:'."\n" + ."\n" + .'- mongodb.aliyuncs.com', + 'type' => 'string', + 'example' => 'mongodb.aliyuncs.com', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeRegions', + 'summary' => 'Queries all regions and zones supported for an ApsaraDB for MongoDB instance.', + 'description' => '> To query available regions and zones in which an ApsaraDB for MongoDB instance can be created, call the [DescribeAvailableResource](~~149719~~) operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E46C22C-D3B7-4DB8-9C76-63851BE68E20\\",\\n \\"Regions\\": {\\n \\"DdsRegion\\": [\\n {\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"VpcEnabled\\": true,\\n \\"ZoneName\\": \\"杭州 可用区H\\"\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionName\\": \\"华东1（杭州）\\",\\n \\"EndPoint\\": \\"mongodb.aliyuncs.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRenewalPrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information. This is an additional parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The coupon code. Default value: **youhuiquan\\_promotion\\_option\\_id\\_for\\_blank**.', + 'type' => 'string', + 'required' => false, + 'default' => 'youhuiquan_promotion_option_id_for_blank', + 'example' => 'default', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'description' => 'The list of orders.', + 'type' => 'object', + 'properties' => [ + 'Coupons' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Coupon' => [ + 'description' => 'Details about the coupons.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The description of the coupon.', + 'type' => 'string', + 'example' => 'coupondemo', + 'title' => '', + ], + 'IsSelected' => [ + 'description' => 'Indicates whether the coupon was selected.', + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'CouponNo' => [ + 'description' => 'The coupon number.', + 'type' => 'string', + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'title' => '', + ], + 'Name' => [ + 'description' => 'The name of the coupon.', + 'type' => 'string', + 'example' => 'youhuiquan111', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'OriginalAmount' => [ + 'description' => 'The original price of the order.', + 'type' => 'number', + 'format' => 'float', + 'example' => '1144.8', + 'title' => '', + ], + 'DiscountAmount' => [ + 'description' => 'The discount amount of the order.', + 'type' => 'number', + 'format' => 'float', + 'example' => '1144.8', + 'title' => '', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => 'The IDs of the matched rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the matched rule.', + 'type' => 'string', + 'example' => '11111111', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TradeAmount' => [ + 'description' => 'The actual price of the order.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + 'title' => '', + ], + 'Currency' => [ + 'description' => 'The type of the currency. Valid values:'."\n" + ."\n" + .'- USD: United States dollar'."\n" + ."\n" + .'- JPY: Japanese Yen', + 'type' => 'string', + 'example' => 'USD', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EFD65226-08CC-4C4D-B6A4-CB3C382F67B0', + 'title' => '', + ], + 'SubOrders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubOrder' => [ + 'description' => 'The rules matching the coupons.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OriginalAmount' => [ + 'description' => 'The original price of the order.', + 'type' => 'number', + 'format' => 'float', + 'example' => '1144.8', + 'title' => '', + ], + 'DiscountAmount' => [ + 'description' => 'The discount amount of the order.', + 'type' => 'number', + 'format' => 'float', + 'example' => '1144.8', + 'title' => '', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => 'The IDs of the matched rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the matched rule.', + 'type' => 'string', + 'example' => '{"RuleId": [11111111,11111111,11111111]}', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TradeAmount' => [ + 'description' => 'The actual price of the order.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'example' => 'dds-bp12c5b040dc****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Rules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Rule' => [ + 'description' => 'Details about the promotion rules.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RuleDescId' => [ + 'description' => 'The ID of the rule.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11111111', + 'title' => '', + ], + 'Title' => [ + 'description' => 'The title of the rule.', + 'type' => 'string', + 'example' => 'demo', + 'title' => '', + ], + 'Name' => [ + 'description' => 'The name of the rule.', + 'type' => 'string', + 'example' => 'demoname', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'DBInstanceId is mandatory for this action.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeRenewalPrice', + 'summary' => 'Queries the monthly renewal price of an ApsaraDB for MongoDB instance.', + 'description' => 'This operation is applicable to subscription instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeRenewalPrice', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Order\\": {\\n \\"Coupons\\": {\\n \\"Coupon\\": [\\n {\\n \\"Description\\": \\"coupondemo\\",\\n \\"IsSelected\\": \\"true\\",\\n \\"CouponNo\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"Name\\": \\"youhuiquan111\\"\\n }\\n ]\\n },\\n \\"OriginalAmount\\": 1144.8,\\n \\"DiscountAmount\\": 1144.8,\\n \\"RuleIds\\": {\\n \\"RuleId\\": [\\n \\"11111111\\"\\n ]\\n },\\n \\"TradeAmount\\": 0,\\n \\"Currency\\": \\"USD\\"\\n },\\n \\"RequestId\\": \\"EFD65226-08CC-4C4D-B6A4-CB3C382F67B0\\",\\n \\"SubOrders\\": {\\n \\"SubOrder\\": [\\n {\\n \\"OriginalAmount\\": 1144.8,\\n \\"DiscountAmount\\": 1144.8,\\n \\"RuleIds\\": {\\n \\"RuleId\\": [\\n \\"{\\\\\\"RuleId\\\\\\": [11111111,11111111,11111111]}\\"\\n ]\\n },\\n \\"TradeAmount\\": 0,\\n \\"InstanceId\\": \\"dds-bp12c5b040dc****\\"\\n }\\n ]\\n },\\n \\"Rules\\": {\\n \\"Rule\\": [\\n {\\n \\"RuleDescId\\": 11111111,\\n \\"Title\\": \\"demo\\",\\n \\"Name\\": \\"demoname\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeReplicaSetRole' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8294', + 'abilityTreeNodes' => [ + 'FEATUREmongodbORMA6Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'DB4A0595-FCA9-437F-B2BB-25DBFC009D3E', + 'title' => '', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + 'ReplicaSets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReplicaSet' => [ + 'description' => 'The details of the roles of the replica set instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionPort' => [ + 'description' => 'The port number that is used to connect to the node.', + 'type' => 'string', + 'example' => '3717', + 'title' => '', + ], + 'ReplicaSetRole' => [ + 'description' => 'The role of the node in the replica set instance. Valid values:'."\n" + ."\n" + .'- **Primary**'."\n" + ."\n" + .'- **Secondary**', + 'type' => 'string', + 'example' => 'Primary', + 'title' => '', + ], + 'ExpiredTime' => [ + 'description' => 'The remaining duration of the classic network endpoint. Unit: seconds.', + 'type' => 'string', + 'example' => '1209582', + 'title' => '', + ], + 'ConnectionDomain' => [ + 'description' => 'The endpoint of the node.', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + 'NetworkType' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'- **VPC**: the virtual private cloud (VPC)'."\n" + ."\n" + .'- **Classic**: the classic network'."\n" + ."\n" + .'- **Public**: the Internet', + 'type' => 'string', + 'example' => 'VPC', + 'title' => '', + ], + 'RoleId' => [ + 'description' => 'The role ID of the node.', + 'type' => 'string', + 'example' => '651xxxxx', + 'title' => '', + ], + 'ConnectionType' => [ + 'description' => 'The connection type of the node.', + 'type' => 'string', + 'example' => 'SRV', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeReplicaSetRole', + 'summary' => 'Queries the role and connection information of an ApsaraDB for MongoDB instance.', + 'description' => 'This operation is applicable to replica set instances and standalone instances, but not to sharded cluster instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeReplicaSetRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB4A0595-FCA9-437F-B2BB-25DBFC009D3E\\",\\n \\"DBInstanceId\\": \\"dds-bpxxxxxxxx\\",\\n \\"ReplicaSets\\": {\\n \\"ReplicaSet\\": [\\n {\\n \\"ConnectionPort\\": \\"3717\\",\\n \\"ReplicaSetRole\\": \\"Primary\\",\\n \\"ExpiredTime\\": \\"1209582\\",\\n \\"ConnectionDomain\\": \\"dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"RoleId\\": \\"651xxxxx\\",\\n \\"ConnectionType\\": \\"SRV\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRestoreDBInstanceList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '237657', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + '5', + ], + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp114f14849d****', + 'title' => '', + ], + ], + [ + 'name' => 'CreationTimeAfter', + 'in' => 'query', + 'schema' => [ + 'description' => 'Find instances created after the specified time, formatted as *yyyy-MM-dd*T*HH:00:00*Z (UTC time).'."\n" + ."\n" + .'> - The time must be on the hour.'."\n" + .'>'."\n" + .'> - The time cannot be earlier than 7 days before the current time.', + 'type' => 'string', + 'required' => true, + 'example' => '2024-07-24T14:00:00Z', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The number of instances in the query results.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'DBInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => 'DB instances list.', + 'type' => 'array', + 'items' => [ + 'description' => 'DB instances list.', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time of instance creation, formatted as *yyyy-MM-dd*T*HH:00:00*Z (UTC time).', + 'type' => 'string', + 'example' => '2022-01-02T07:43:59Z', + 'title' => '', + ], + 'LockMode' => [ + 'description' => 'The locked state of the instance, value description:'."\n" + ."\n" + .'- Unlock: Normal.'."\n" + ."\n" + .'- ManualLock: Manually triggered lock.'."\n" + ."\n" + .'- LockByExpiration: Automatically locked due to expiration.'."\n" + ."\n" + .'- LockByRestoration: Automatically locked before restoration.'."\n" + ."\n" + .'- LockByDiskQuota: Automatically locked due to disk quota exceeded.', + 'type' => 'string', + 'example' => 'Unlock', + 'title' => '', + ], + 'EngineVersion' => [ + 'description' => 'The database engine version of the instance. Valid values:'."\n" + ."\n" + .'- **7.0**'."\n" + ."\n" + .'- **6.0**'."\n" + ."\n" + .'- **5.0**'."\n" + ."\n" + .'- **4.4**'."\n" + ."\n" + .'- **4.2**'."\n" + ."\n" + .'- **4.0**'."\n" + ."\n" + .'- **3.4**', + 'type' => 'string', + 'example' => '4.2', + 'title' => '', + ], + 'DBInstanceDescription' => [ + 'description' => 'The description of the instance.', + 'type' => 'string', + 'example' => '测试数据库', + 'title' => '', + ], + 'DBInstanceType' => [ + 'description' => 'The architecture of the instance. Valid values:'."\n" + ."\n" + .'- **sharding**: sharded cluster instance'."\n" + ."\n" + .'- **replicate**: replica set or standalone instance', + 'type' => 'string', + 'example' => 'replicate', + 'title' => '', + ], + 'DBInstanceStatus' => [ + 'description' => 'The status of the instance. For more information, see [Instance states](~~63870~~).', + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + 'title' => '', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'example' => 'dds-bp12c5b040dc****', + 'title' => '', + ], + 'IsDeleted' => [ + 'description' => 'Specifies whether the instance is deleted. Valid values:'."\n" + ."\n" + .'- **0**: not deleted'."\n" + ."\n" + .'- **1**: deleted', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter %s is not valid.', + 'description' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => 'Instance not found. Refresh the page to check whether the instance has been released.', + ], + ], + ], + 'title' => 'DescribeRestoreDBInstanceList', + 'summary' => 'Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeRestoreDBInstanceList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5,\\n \\"RequestId\\": \\"1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBInstances\\": {\\n \\"DBInstance\\": [\\n {\\n \\"CreationTime\\": \\"2022-01-02T07:43:59Z\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"EngineVersion\\": \\"4.2\\",\\n \\"DBInstanceDescription\\": \\"测试数据库\\",\\n \\"DBInstanceType\\": \\"replicate\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"DBInstanceId\\": \\"dds-bp12c5b040dc****\\",\\n \\"IsDeleted\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRoleTagStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '226297', + 'abilityTreeNodes' => [ + 'FEATUREmongodbX5X8MM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-wz9760547de1****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '69D55DEC-B219-569F-A686-AC2F67A1****', + 'title' => '', + ], + 'RoleTagStatus' => [ + 'description' => 'The tag status of the ReplicaSet node. Valid values:'."\n" + ."\n" + .'- **true**: The tag is created.'."\n" + ."\n" + .'- **false**: The tag is not created.'."\n" + ."\n" + .'> If the instance is a sharded cluster, this parameter returns false.', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'type' => 'string', + 'example' => 'false', + 'title' => '', + ], + 'ShardRoleTagStatus' => [ + 'description' => 'The tag status of each node in the sharded cluster. Valid values:'."\n" + ."\n" + .'- **true**: The tag is created.'."\n" + ."\n" + .'- **false**: The tag is not created.', + 'type' => 'object', + 'example' => '{'."\n" + .' "d-2ze204b4db58****": "false",'."\n" + .' "d-2zeb9716646e***": "false"'."\n" + .'}', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeRoleTagStatus', + 'summary' => 'Describes the status of a tag for a node.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69D55DEC-B219-569F-A686-AC2F67A1****\\",\\n \\"RoleTagStatus\\": \\"false\\",\\n \\"ShardRoleTagStatus\\": {\\n \\"d-2ze204b4db58****\\": \\"false\\",\\n \\"d-2zeb9716646e***\\": \\"false\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeRoleZoneInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8297', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWP8F69', + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '728B9A96-E262-4AE5-915E-3A51CCE2FDA9', + 'title' => '', + ], + 'ZoneInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ZoneInfo' => [ + 'description' => 'The information of nodes in the zone.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InsName' => [ + 'description' => 'The ID of the node.', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + 'NodeType' => [ + 'description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'- **normal**'."\n" + ."\n" + .'- **configServer**'."\n" + ."\n" + .'- **shard**'."\n" + ."\n" + .'- **mongos**'."\n" + ."\n" + .'> Valid value for replica set instances: **normal**. Valid values for sharded cluster instances: **configServer**, **shard**, and **mongos**.', + 'type' => 'string', + 'example' => 'normal', + 'title' => '', + ], + 'RoleType' => [ + 'description' => 'The role of the node. Valid values:'."\n" + ."\n" + .'- **Primary**'."\n" + ."\n" + .'- **Secondary**'."\n" + ."\n" + .'- **Hidden**', + 'type' => 'string', + 'example' => 'Primary', + 'title' => '', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the node.', + 'type' => 'string', + 'example' => 'cn-hangzhou-e', + 'title' => '', + ], + 'RoleId' => [ + 'description' => 'The role ID.', + 'type' => 'string', + 'example' => '83xxxxx', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeRoleZoneInfo', + 'summary' => 'Queries the role and zone of each node in an ApsaraDB for MongoDB instance.', + 'description' => '> For more information, see [View the zone of a node](~~123825~~).'."\n" + ."\n" + .'This operation is applicable to replica set instances and sharded cluster instances, but cannot be performed on standalone instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeRoleZoneInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728B9A96-E262-4AE5-915E-3A51CCE2FDA9\\",\\n \\"ZoneInfos\\": {\\n \\"ZoneInfo\\": [\\n {\\n \\"InsName\\": \\"dds-bpxxxxxxxx\\",\\n \\"NodeType\\": \\"normal\\",\\n \\"RoleType\\": \\"Primary\\",\\n \\"ZoneId\\": \\"cn-hangzhou-e\\",\\n \\"RoleId\\": \\"83xxxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRunningLogRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the mongos node or shard node whose operational logs you want to query in the instance. If the instance is a sharded cluster instance, you must specify this parameter.'."\n" + ."\n" + .'> This parameter is valid only when **DBInstanceId** is set to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-01T12:10Z', + 'title' => '', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time and within 24 hours from the start time. Otherwise, the query fails.', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-01T13:10Z', + 'title' => '', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodbtest', + 'title' => '', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of the node whose error logs you want to query in the instance. Valid values:'."\n" + ."\n" + .'- **primary**'."\n" + ."\n" + .'- **secondary**'."\n" + ."\n" + .'> If you set the **NodeId** parameter to the ID of a mongos node, the **RoleType** parameter must be set to **primary**.', + 'type' => 'string', + 'required' => false, + 'default' => 'primary', + 'enum' => [ + 'primary', + 'secondary', + ], + 'example' => 'primary', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **30** to **100**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'default' => '30', + 'example' => '30', + 'title' => '', + ], + ], + [ + '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**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order of time in which the operational log entries to return are sorted. Valid values:'."\n" + ."\n" + .'- asc: The log entries are sorted by time in ascending order.'."\n" + ."\n" + .'- desc: The log entries are sorted by time in descending order.', + 'type' => 'string', + 'required' => false, + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + 'example' => 'asc', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bpxxxxxxxxxxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role ID of the node. You can call the [DescribeReplicaSetRole](~~62134~~) operation to query the role ID.', + 'type' => 'string', + 'required' => false, + 'example' => '651xxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces.', + 'type' => 'string', + 'required' => false, + 'example' => 'test test2', + 'title' => '', + ], + ], + [ + 'name' => 'LogicalOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logical relationship among multiple keywords.'."\n" + ."\n" + .'- **or**'."\n" + ."\n" + .'- **and** (default value)', + 'type' => 'string', + 'default' => 'and', + 'enum' => [ + 'and', + 'or', + ], + 'required' => false, + 'example' => 'and', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of entries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'PageRecordCount' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '45D2B592-DEBA-4347-BBF3-47FF6C97DBBC', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The number of the page to return.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogRecords' => [ + 'description' => 'Details about the operational log entries.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnInfo' => [ + 'description' => 'The connection information of the log entry.', + 'type' => 'string', + 'example' => 'conn18xxxxxx', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'The time when the log entry was generated. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2019-02-26T12:09:34Z', + 'title' => '', + ], + 'Category' => [ + 'description' => 'The category of the log entry.', + 'type' => 'string', + 'example' => 'NETWORK', + 'title' => '', + ], + 'Content' => [ + 'description' => 'The content of the log entry.', + 'type' => 'string', + 'example' => ' end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\\n', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Engine' => [ + 'description' => 'The database engine.', + 'type' => 'string', + 'example' => 'MongoDB', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time', + 'description' => 'The start time must be earlier than the end time.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The Specified parameter StartTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The Specified parameter EndTime is not valid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'LogApiFrequencyExceeded', + 'errorMessage' => 'Exceeding the allowed frequency of log api.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeRunningLogRecords', + 'summary' => 'Queries the operational logs of an ApsaraDB for MongoDB instance.', + 'description' => '- This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.'."\n" + ."\n" + .'- You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeRunningLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 2,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"45D2B592-DEBA-4347-BBF3-47FF6C97DBBC\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"LogRecords\\": [\\n {\\n \\"ConnInfo\\": \\"conn18xxxxxx\\",\\n \\"CreateTime\\": \\"2019-02-26T12:09:34Z\\",\\n \\"Category\\": \\"NETWORK\\",\\n \\"Content\\": \\" end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\\\\\\\\n\\"\\n }\\n ]\\n },\\n \\"Engine\\": \\"MongoDB\\"\\n}","type":"json"}]', + ], + 'DescribeSecurityGroupConfiguration' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '3C4A2494-85C4-45C5-93CF-548DB3375193', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RdsEcsSecurityGroupRel' => [ + 'description' => 'Details about the ECS security groups.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => 'The ID of the ECS security group.'."\n", + 'type' => 'string', + 'example' => 'sg-bpxxxxxxxx', + 'title' => '', + ], + 'NetType' => [ + 'description' => 'The network type of the ECS security group. Valid values:'."\n" + ."\n" + .'* **vpc**'."\n" + .'* **classic**'."\n", + 'type' => 'string', + 'example' => 'vpc', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the ECS security group.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeSecurityGroupConfiguration', + 'summary' => 'Queries the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeSecurityGroupConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3C4A2494-85C4-45C5-93CF-548DB3375193\\",\\n \\"Items\\": {\\n \\"RdsEcsSecurityGroupRel\\": [\\n {\\n \\"SecurityGroupId\\": \\"sg-bpxxxxxxxx\\",\\n \\"NetType\\": \\"vpc\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Items>\\n <RdsEcsSecurityGroupRel>\\n <SecurityGroupId>sg-bpxxxxxxxx</SecurityGroupId>\\n <RegionId>cn-hangzhou</RegionId>\\n <NetType>classic</NetType>\\n </RdsEcsSecurityGroupRel>\\n</Items>\\n<RequestId>D18F5B88-ACA6-470E-9493-384412EDD902</RequestId>","errorExample":""}]', + ], + 'DescribeSecurityIps' => [ + 'summary' => 'You can call this operation to query the IP whitelists of an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ShowHDMIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to display DAS whitelist information.', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityIps' => [ + 'description' => 'The IP addresses in the default whitelist.', + 'type' => 'string', + 'example' => '47.xxx.xxx.xx,100.xxx.xxx.0/24', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'FC724D23-2962-479E-ABB1-606C935AE7FD', + 'title' => '', + ], + 'SecurityIpGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecurityIpGroup' => [ + 'description' => 'An array that consists of the information of IP whitelists.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityIpGroupName' => [ + 'description' => 'The name of the IP whitelist.', + 'type' => 'string', + 'example' => 'default', + 'title' => '', + ], + 'SecurityIpGroupAttribute' => [ + 'description' => 'The attribute of the IP address whitelist.', + 'type' => 'string', + 'example' => ' hidden', + 'title' => '', + ], + 'SecurityIpList' => [ + 'description' => 'The name of the IP whitelist.', + 'type' => 'string', + 'example' => '47.xxx.xxx.xx,100.xxx.xxx.0/24', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBInstance.Malformed', + 'errorMessage' => 'Too many instance ids or instance id format is invalid.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeSecurityIps', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeSecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SecurityIps\\": \\"47.xxx.xxx.xx,100.xxx.xxx.0/24\\",\\n \\"RequestId\\": \\"FC724D23-2962-479E-ABB1-606C935AE7FD\\",\\n \\"SecurityIpGroups\\": {\\n \\"SecurityIpGroup\\": [\\n {\\n \\"SecurityIpGroupName\\": \\"default\\",\\n \\"SecurityIpGroupAttribute\\": \\" hidden\\",\\n \\"SecurityIpList\\": \\"47.xxx.xxx.xx,100.xxx.xxx.0/24\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeShardingNetworkAddress' => [ + 'summary' => 'Retrieves the connection information for a MongoDB sharded cluster instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8303', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWP8F69', + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Mongos, shard, or Configserver node in the sharded cluster instance.'."\n" + ."\n" + .'> You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the IDs of Mongos, shard, and Configserver nodes.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'- **VPC**: virtual private cloud (VPC).'."\n" + ."\n" + .'- **Classic**: classic network.'."\n" + ."\n" + .'- **Public**: public network.', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CompatibleConnections' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CompatibleConnection' => [ + 'description' => 'A list of connection addresses for an instance that is compatible with the DynamoDB protocol.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VswitchId' => [ + 'description' => 'The vSwitch ID in the VPC.'."\n" + ."\n" + .'> This parameter is returned when the network type is **VPC**.', + 'type' => 'string', + 'example' => 'vsw-bpxxxxxxxx', + 'title' => '', + ], + 'ExpiredTime' => [ + 'description' => 'The remaining validity period of the classic network endpoint. Unit: seconds.', + 'type' => 'string', + 'example' => '2591963', + 'title' => '', + ], + 'NetworkType' => [ + 'description' => 'The network type.'."\n" + ."\n" + .'- **VPC**: virtual private cloud.'."\n" + ."\n" + .'- **Classic**: classic network.'."\n" + ."\n" + .'- **Public**: public network.', + 'type' => 'string', + 'example' => 'VPC', + 'title' => '', + ], + 'Port' => [ + 'description' => 'The connection port.', + 'type' => 'string', + 'example' => '3717', + 'title' => '', + ], + 'NetworkAddress' => [ + 'description' => 'The endpoint.', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + 'VPCId' => [ + 'description' => 'The VPC ID.'."\n" + ."\n" + .'> This parameter is returned when the network type is **VPC**.', + 'type' => 'string', + 'example' => 'vpc-bpxxxxxxxx', + 'title' => '', + ], + 'IPAddress' => [ + 'description' => 'The IP address.', + 'type' => 'string', + 'example' => '10.140.xxx.xx', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '18D8AAFD-6BEB-420F-8164-810CB0C0AA39', + 'title' => '', + ], + 'NetworkAddresses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NetworkAddress' => [ + 'description' => 'A list of connection addresses for an instance that is compatible with the MongoDB protocol.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'description' => 'The node type. The return value is:'."\n" + ."\n" + .'- **mongos**: Mongos node.'."\n" + ."\n" + .'- **shard**: shard node.'."\n" + ."\n" + .'- **configserver**: Configserver node.', + 'type' => 'string', + 'example' => 'mongos', + 'title' => '', + ], + 'VswitchId' => [ + 'description' => 'The vSwitch ID in the VPC.'."\n" + ."\n" + .'> This parameter is returned when the network type is **VPC**.', + 'type' => 'string', + 'example' => 'vsw-bpxxxxxxxx', + 'title' => '', + ], + 'ExpiredTime' => [ + 'description' => 'The remaining validity period of the classic network endpoint. Unit: seconds.', + 'type' => 'string', + 'example' => '2591963', + 'title' => '', + ], + 'NetworkType' => [ + 'description' => 'The network type.'."\n" + ."\n" + .'- **VPC**: virtual private cloud.'."\n" + ."\n" + .'- **Classic**: classic network.'."\n" + ."\n" + .'- **Public**: public network.', + 'type' => 'string', + 'example' => 'VPC', + 'title' => '', + ], + 'Role' => [ + 'description' => 'The node role. Valid values:'."\n" + ."\n" + .'- Primary: The primary node.'."\n" + ."\n" + .'- Secondary: The secondary node.', + 'type' => 'string', + 'example' => 'Primary', + 'title' => '', + ], + 'Port' => [ + 'description' => 'The connection port.', + 'type' => 'string', + 'example' => '3717', + 'title' => '', + ], + 'VPCId' => [ + 'description' => 'The VPC ID.'."\n" + ."\n" + .'> This parameter is returned when the network type is **VPC**.', + 'type' => 'string', + 'example' => 'vpc-bpxxxxxxxx', + 'title' => '', + ], + 'NetworkAddress' => [ + 'description' => 'The endpoint.', + 'type' => 'string', + 'example' => 's-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'The Mongos node ID.', + 'type' => 'string', + 'example' => 's-bpxxxxxxxx', + 'title' => '', + ], + 'IPAddress' => [ + 'description' => 'The IP address.', + 'type' => 'string', + 'example' => '10.140.xxx.xx', + 'title' => '', + ], + 'ConnectionType' => [ + 'description' => 'The type of the public endpoint. Valid values:'."\n" + ."\n" + .'- **SRV**'."\n" + ."\n" + .'- **Normal**', + 'type' => 'string', + 'example' => 'SRV', + 'title' => '', + ], + 'TxtRecord' => [ + 'description' => 'The TXT record. This record stores MongoDB-related metadata, such as version information and configuration parameters. It can be used with other technologies, such as SRV records, to implement complex features like service discovery and configuration delivery.', + 'type' => 'string', + 'example' => 'mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CompatibleConnections\\": {\\n \\"CompatibleConnection\\": [\\n {\\n \\"VswitchId\\": \\"vsw-bpxxxxxxxx\\",\\n \\"ExpiredTime\\": \\"2591963\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": \\"3717\\",\\n \\"NetworkAddress\\": \\"dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com\\",\\n \\"VPCId\\": \\"vpc-bpxxxxxxxx\\",\\n \\"IPAddress\\": \\"10.140.xxx.xx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"18D8AAFD-6BEB-420F-8164-810CB0C0AA39\\",\\n \\"NetworkAddresses\\": {\\n \\"NetworkAddress\\": [\\n {\\n \\"NodeType\\": \\"mongos\\",\\n \\"VswitchId\\": \\"vsw-bpxxxxxxxx\\",\\n \\"ExpiredTime\\": \\"2591963\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Role\\": \\"Primary\\",\\n \\"Port\\": \\"3717\\",\\n \\"VPCId\\": \\"vpc-bpxxxxxxxx\\",\\n \\"NetworkAddress\\": \\"s-bpxxxxxxxx.mongodb.rds.aliyuncs.com\\",\\n \\"NodeId\\": \\"s-bpxxxxxxxx\\",\\n \\"IPAddress\\": \\"10.140.xxx.xx\\",\\n \\"ConnectionType\\": \\"SRV\\",\\n \\"TxtRecord\\": \\"mongo.example.com. IN TXT \\\\\\"config=replicaSet=myReplicaSet\\\\\\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeShardingNetworkAddress', + 'description' => 'This operation applies only to sharded cluster instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeShardingNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeSlowLogRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> If you set this parameter to the ID of a sharded cluster instance, you must also specify the `NodeId` parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1fc7e65108****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard node.'."\n" + ."\n" + .'> This parameter is required only when you specify the `DBInstanceId` parameter to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp18b06ebc21****', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.', + 'type' => 'string', + 'required' => true, + 'example' => '2021-08-15T14:13Z', + 'title' => '', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- The end time must be later than the start time.'."\n" + ."\n" + .'- The end time must be within 24 hours from the start time. Otherwise, the query fails.', + 'type' => 'string', + 'required' => true, + 'example' => '2021-08-16T14:13Z', + 'title' => '', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodbtest', + 'title' => '', + ], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces.', + 'type' => 'string', + 'required' => false, + 'example' => 'test test1', + 'title' => '', + ], + ], + [ + 'name' => 'LogicalOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logical relationship among multiple keywords.'."\n" + ."\n" + .'- **or**'."\n" + ."\n" + .'- **and** (default value)', + 'type' => 'string', + 'default' => 'and', + 'enum' => [ + 'and', + 'or', + ], + 'required' => false, + 'example' => 'and', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **30** to **100**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'default' => '30', + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order of time in which the log entries to return are sorted. Valid values:'."\n" + ."\n" + .'- asc: The log entries are sorted by time in ascending order.'."\n" + ."\n" + .'- desc: The log entries are sorted by time in descending order.', + 'type' => 'string', + 'required' => false, + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + 'example' => 'asc', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the instances you want to query belong.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageRecordCount' => [ + 'description' => 'The number of slow query log entries returned on the page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '8076C4BA-DDBD-529C-BFF4-D8620C3F****', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page. The value is a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogRecords' => [ + 'description' => 'An array that consists of the information about each slow query.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExecutionStartTime' => [ + 'description' => 'The start time of the operation. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2019-02-25T 01:41:28Z', + 'title' => '', + ], + 'HostAddress' => [ + 'description' => 'The host IP address that is used to connect to the database.', + 'type' => 'string', + 'example' => '192.168.XX.XX', + 'title' => '', + ], + 'QueryTimes' => [ + 'description' => 'The execution time of the statement. Unit: milliseconds.', + 'type' => 'string', + 'example' => '600', + 'title' => '', + ], + 'TableName' => [ + 'description' => 'The name of the collection.', + 'type' => 'string', + 'example' => 'C1', + 'title' => '', + ], + 'SQLText' => [ + 'description' => 'The SQL statement that is executed during the slow operation.', + 'type' => 'string', + 'example' => '{\\"op\\":\\"query\\",\\"ns\\":\\"mongodbtest.customer\\",\\"query\\":{\\"find\\":\\"customer\\",\\"filter\\":{\\"name\\":\\"jack\\"}}}', + 'title' => '', + ], + 'ReturnRowCounts' => [ + 'description' => 'The number of rows returned by the SQL statement.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '', + ], + 'KeysExamined' => [ + 'description' => 'The number of rows involved in index scans.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '', + ], + 'DBName' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'example' => 'mongodbtest', + 'title' => '', + ], + 'DocsExamined' => [ + 'description' => 'The number of documents that are scanned during the operation.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000', + 'title' => '', + ], + 'AccountName' => [ + 'description' => 'The username of the database account that performs the operation.', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Engine' => [ + 'description' => 'The database engine.', + 'type' => 'string', + 'example' => 'MongoDB', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectCharacterType', + 'errorMessage' => 'Current DB instance CharacterType does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time', + 'description' => 'The start time must be earlier than the end time.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The Specified parameter StartTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The Specified parameter EndTime is not valid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'LogApiFrequencyExceeded', + 'errorMessage' => 'Exceeding the allowed frequency of log api.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeSlowLogRecords', + 'summary' => 'Queries the details of entries in slow query logs of an ApsaraDB for MongoDB instance.', + 'description' => '- This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.'."\n" + ."\n" + .'- You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeSlowLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"8076C4BA-DDBD-529C-BFF4-D8620C3F****\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"LogRecords\\": [\\n {\\n \\"ExecutionStartTime\\": \\"2019-02-25T 01:41:28Z\\",\\n \\"HostAddress\\": \\"192.168.XX.XX\\",\\n \\"QueryTimes\\": \\"600\\",\\n \\"TableName\\": \\"C1\\",\\n \\"SQLText\\": \\"{\\\\\\\\\\\\\\"op\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"query\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ns\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mongodbtest.customer\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"query\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"find\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"customer\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"filter\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jack\\\\\\\\\\\\\\"}}}\\",\\n \\"ReturnRowCounts\\": 0,\\n \\"KeysExamined\\": 0,\\n \\"DBName\\": \\"mongodbtest\\",\\n \\"DocsExamined\\": 1000000,\\n \\"AccountName\\": \\"test\\"\\n }\\n ]\\n },\\n \\"Engine\\": \\"MongoDB\\"\\n}","type":"json"}]', + ], + 'DescribeTags' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to **INSTANCE**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE', + 'default' => 'INSTANCE', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp17e7a04960****', + 'title' => '', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token used to start the next query to retrieve more results.'."\n" + ."\n" + .'> This parameter is not required in the first query. If not all results are returned in one query, you can pass in the NextToken value returned in the previous query to perform the query again.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '212db86****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token used to start the next query.'."\n" + ."\n" + .'> If not all results are returned in the first query, this parameter is returned. You can pass in the value of this parameter in the next query.'."\n", + 'type' => 'string', + 'example' => '212db86****', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EEDBE38F-5CF5-4316-AAC2-35817BA60D68', + 'title' => '', + ], + 'Tags' => [ + 'description' => 'Details about the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagValues' => [ + 'description' => 'The values of the tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the tag.', + 'type' => 'string', + 'example' => '3.4环境', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TagKey' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => '测试组', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidTagValue.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Value\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceId', + 'errorMessage' => 'The specified parameter \'ResourceId.n\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'MissParameter.TagOrResourceId', + 'errorMessage' => 'The parameter \'Tag.n\'\' or \'ResourceId.n\' is needed.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.Scope', + 'errorMessage' => 'The specified parameter \'Scope\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', + 'description' => '', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed.', + 'description' => '', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' is duplicated.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The specified parameter \'ResourceType\' is not valid.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeTags', + 'summary' => 'Queries all tags in a specified region.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86****\\",\\n \\"RequestId\\": \\"EEDBE38F-5CF5-4316-AAC2-35817BA60D68\\",\\n \\"Tags\\": [\\n {\\n \\"TagValues\\": [\\n \\"3.4环境\\"\\n ],\\n \\"TagKey\\": \\"测试组\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'DescribeUserEncryptionKeyList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmongodbQ7EXOR', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'TargetRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination region. You can call the [DescribeRegions](~~61933~~) operation to query available regions.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'title' => '', + ], + ], + [ + 'name' => 'RoleARN', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role. Format: `acs:ram::$accountID:role/$roleName`. The default value is `acs:ram::$accountID:role/aliyunrdsinstanceencryptiondefaultrole`.'."\n" + ."\n" + .'> - `$accountID`: The ID of your Alibaba Cloud account. To view the ID, log on to the Alibaba Cloud Management Console, move the pointer over your profile picture in the upper-right corner, and then click Security Settings.'."\n" + .'>'."\n" + .'> - `$roleName`: The name of the RAM role. To view the role name, log on to the RAM console. In the navigation pane on the left, click RAM Role Management. Find the role name in the RAM Role Name list.', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '7CD51DA4-A499-43CE-B9B5-20CD4FDC648E', + 'title' => '', + ], + 'KeyIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'KeyId' => [ + 'description' => 'A list of instance keys.', + 'type' => 'array', + 'items' => [ + 'description' => 'The instance key.', + 'type' => 'string', + 'example' => '2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'INVALID_INSNAME_REGIONID_EMPTY', + 'errorMessage' => 'The insName and regionId can\'t be all empty', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeUserEncryptionKeyList', + 'summary' => 'Queries the custom keys for an instance.', + 'description' => 'You can use the custom keys returned by this operation to enable transparent data encryption (TDE). For more information, see [ModifyDBInstanceTDE](~~131267~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeUserEncryptionKeyList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CD51DA4-A499-43CE-B9B5-20CD4FDC648E\\",\\n \\"KeyIds\\": {\\n \\"KeyId\\": [\\n \\"2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeVpcsForMongoDB' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => false, + 'default' => 'cn-hangzhou', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be an integer greater than 0. The default value is **1**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. The value must be an integer greater than 0. The default value is **50**.', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '30', + 'enum' => [ + '30', + '50', + ], + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'title' => '', + ], + 'Vpcs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the VPC. A value of **Available** indicates that the VPC is active.', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'VpcName' => [ + 'description' => 'The name of the VPC.', + 'type' => 'string', + 'example' => 'vpc-name', + 'title' => '', + ], + 'VpcId' => [ + 'description' => 'The VPC ID.', + 'type' => 'string', + 'example' => 'vpc-2zep2pepkthg5ueal****', + 'title' => '', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the VPC is the default one. Valid values:'."\n" + ."\n" + .'- **true**: The VPC is the default one.'."\n" + ."\n" + .'- **false**: The VPC is not the default one.', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'CidrBlock' => [ + 'description' => 'The CIDR block of the VPC.', + 'type' => 'string', + 'example' => '10.**.**.**/24', + 'title' => '', + ], + 'RegionNo' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'GmtCreate' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'AliUid' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'VSwitchs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the vSwitch. A value of **Available** indicates that the vSwitch is active.', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.', + 'type' => 'string', + 'example' => 'vsw-bp*******************', + 'title' => '', + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" + ."\n" + .'- **true**: The vSwitch is the default vSwitch.'."\n" + ."\n" + .'- **false**: The vSwitch is not the default vSwitch.', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'CidrBlock' => [ + 'description' => 'The CIDR block of the vSwitch.', + 'type' => 'string', + 'example' => '10.**.**.**/28', + 'title' => '', + ], + 'GmtCreate' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'GmtModified' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'IzNo' => [ + 'description' => 'The zone to which the vSwitch belongs.', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + 'title' => '', + ], + 'VSwitchName' => [ + 'description' => 'The name of the vSwitch.', + 'type' => 'string', + 'example' => 'vsw-name', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of vSwitches.', + 'title' => '', + 'example' => '', + ], + 'GmtModified' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + 'Bid' => [ + 'description' => 'This parameter is deprecated. No value is returned.', + 'type' => 'string', + 'example' => 'null', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of VPCs.', + 'title' => '', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '53924AF0-1628-5AA2-9C95-D4**********', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeVpcsForMongoDB', + 'summary' => 'Queries a paginated list of VPCs.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 4,\\n \\"Vpcs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"vpc-name\\",\\n \\"VpcId\\": \\"vpc-2zep2pepkthg5ueal****\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.**/24\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"AliUid\\": \\"null\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-bp*******************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.**.**.**/28\\",\\n \\"GmtCreate\\": \\"null\\",\\n \\"GmtModified\\": \\"null\\",\\n \\"IzNo\\": \\"cn-hangzhou-i\\",\\n \\"VSwitchName\\": \\"vsw-name\\"\\n }\\n ],\\n \\"GmtModified\\": \\"null\\",\\n \\"Bid\\": \\"null\\"\\n }\\n ],\\n \\"RequestId\\": \\"53924AF0-1628-5AA2-9C95-D4**********\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n}","type":"json"}]', + ], + 'DestroyInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '8311', + 'abilityTreeNodes' => [ + 'FEATUREmongodbXNNG5O', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> **InstanceId** and **DBInstanceId** serve the same function. You need only to specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp147acd4783****', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> **InstanceId** and **DBInstanceId** serve the same function. You need only to specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp147acd4783****', + 'title' => '', + ], + ], + [ + '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 ensure that it 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' => 'ETnLKlblzczshOTUbOCz****', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '65BDA532-28AF-4122-AA39-B382721E****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ChargeTypeViolation', + 'errorMessage' => 'The operation is not permitted due to charge type of the instance.', + 'description' => 'The operation is not permitted due to charge type of the instance.', + ], + [ + 'errorCode' => 'MissingDBInstanceId', + 'errorMessage' => 'DBInstanceId is mandatory for this action.', + 'description' => '', + ], + ], + ], + 'title' => 'DestroyInstance', + 'summary' => 'Destroys an ApsaraDB for MongoDB instance.', + 'description' => 'Before you call this operation, make sure that the instance meets the following requirements:'."\n" + ."\n" + .'* The instance is a replica set instance or a sharded cluster instance that uses local disks.'."\n" + .'* The billing method of the instance is subscription.'."\n" + .'* The instance has expired and is in the **Locking** state.'."\n" + ."\n" + .'**'."\n" + ."\n" + .'**Warning** Data cannot be restored after the instance is destroyed. Proceed with caution.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DestroyInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721E****\\"\\n}","errorExample":""},{"type":"xml","example":"<DestroyInstanceResponse>\\n <RequestId> 65BDA532-28AF-4122-AA39-B382721E****</RequestId>\\n</DestroyInstanceResponse>","errorExample":""}]', + ], + 'EvaluateResource' => [ + 'summary' => 'Evaluates whether sufficient resources are available before you purchase a new instance or upgrade or downgrade an existing instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWP8F69', + 'FEATUREmongodbAPXG80', + 'FEATUREmongodbOM9UA4', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region. For more information, see [DescribeRegions](~~61933~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone. For more information, see [DescribeRegions](~~61933~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine. Set the value to **MongoDB**.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'default' => 'MongoDB', + 'enum' => [ + 'MongoDB', + ], + 'example' => 'MongoDB', + 'title' => '', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine version.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => [ + '3.4', + '4.0', + '4.2', + '4.4', + '5.0', + '6.0', + '7.0', + '8.0', + ], + 'example' => '4.2', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type.'."\n" + ."\n" + .'> This parameter is required when you evaluate resources for a replica set instance. For details about instance types, see [Instance types](~~57141~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.mongo.mid', + 'title' => '', + ], + ], + [ + 'name' => 'ShardsInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The shard information of the sharded cluster. This parameter is required when you evaluate resources for a sharded cluster instance.'."\n" + ."\n" + .'To evaluate resources for a new sharded cluster instance, specify the instance type for each shard in a JSON string. Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "ConfigSvrs":'."\n" + .' [{"Storage":20,"DBInstanceClass":"dds.cs.mid"}],'."\n" + .' "Mongos":'."\n" + .' [{"DBInstanceClass":"dds.mongos.standard"},{"DBInstanceClass":"dds.mongos.standard"}],'."\n" + .' "Shards":'."\n" + .' [{"Storage":50,"DBInstanceClass":"dds.shard.standard"},{"Storage":50,"DBInstanceClass":"dds.shard.standard"}, {"Storage":50,"DBInstanceClass":"dds.shard.standard"}]'."\n" + .' }'."\n" + .'```'."\n" + ."\n" + .'The parameters in the example are described as follows:'."\n" + ."\n" + .'- ConfigSvrs: The ConfigServer nodes.'."\n" + ."\n" + .'- Mongos: The Mongos nodes.'."\n" + ."\n" + .'- Shards: The shard nodes.'."\n" + ."\n" + .'- Storage: The storage space of the target shard.'."\n" + ."\n" + .'- DBInstanceClass: The instance type of the target shard. For details about instance types, see [Sharded cluster instance types](~~311414~~).'."\n" + ."\n" + .'To evaluate resources for upgrading or downgrading a sharded cluster instance, specify only the node information in a JSON string. Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"'."\n" + .'} '."\n" + .'```'."\n" + ."\n" + .'The parameters in the example are described as follows:'."\n" + ."\n" + .'- NodeId: The ID of the target node.'."\n" + ."\n" + .'- NodeClass: The instance type of the target node. For details about instance types, see [Sharded cluster instance types](~~311414~~).', + 'type' => 'string', + 'required' => false, + 'example' => '{"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"}', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID. This parameter is required when you evaluate resources for an instance upgrade or downgrade.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp14bf67a76d****', + 'title' => '', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes in the instance.'."\n" + ."\n" + .'- Set the value to **1** for a standalone instance.'."\n" + ."\n" + .'- Set the value to **2** for an instance that uses shared storage.'."\n" + ."\n" + .'- For a replica set instance, valid values are **3**, **5**, and **7**.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'> This parameter is not required for Serverless instances.'."\n" + ."\n" + .'</props>', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => [ + '1', + '3', + '5', + '7', + '2', + ], + 'required' => false, + 'example' => '3', + 'title' => '', + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of read-only nodes in the instance. Valid values: **1** to **5**.'."\n" + ."\n" + .'> This parameter is not required for standalone instances<props="china"> and Serverless instances</props>.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + ], + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'Storage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage space of the replica set. Unit: GB.'."\n" + ."\n" + .'> This parameter is required if the instance uses cloud disks.', + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceAvailable' => [ + 'description' => 'Indicates whether resources are available in the current region. Valid values:'."\n" + ."\n" + .'- **1**: Resources are sufficient.'."\n" + ."\n" + .'- **0**: Resources are insufficient.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'EngineVersion' => [ + 'description' => 'The database engine version.', + 'type' => 'string', + 'example' => '4.0', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'AE2DE465-E45F-481F-ABD8-37D64173****', + 'title' => '', + ], + 'Engine' => [ + 'description' => 'The database engine. The value is fixed to MongoDB.', + 'type' => 'string', + 'example' => 'MongoDB', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceAvailable\\": \\"1\\",\\n \\"EngineVersion\\": \\"4.0\\",\\n \\"RequestId\\": \\"AE2DE465-E45F-481F-ABD8-37D64173****\\",\\n \\"Engine\\": \\"MongoDB\\"\\n}","type":"json"}]', + 'title' => 'EvaluateResource', + 'description' => 'This operation evaluates resources for MongoDB replica set and sharded cluster instances. You can evaluate resources for scenarios such as purchasing an instance, upgrading or downgrading an instance, or adding nodes to a sharded cluster.'."\n" + ."\n" + .'> You can call this operation up to 200 times per minute. Calls that exceed this limit are subject to traffic throttling.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:EvaluateResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListTagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '8314', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWP8F69', + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the region ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to **INSTANCE**.', + 'type' => 'string', + 'required' => true, + 'example' => 'INSTANCE', + 'title' => '', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token used to start the next query to retrieve more results.'."\n" + ."\n" + .'> This parameter is not required in the first query. If not all results are returned in one query, you can pass in the **NextToken** value returned in the previous query to perform the query again.', + 'type' => 'string', + 'required' => false, + 'example' => '212db86****', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The resource IDs. You must specify this parameter or the Tag parameter.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => '开发组', + 'title' => '', + ], + 'required' => false, + 'example' => 'dds-bpxxxxxxxx', + 'maxItems' => 51, + 'title' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags that are attached to the resources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag.', + 'type' => 'string', + 'required' => false, + 'example' => '开发组', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The value of tag.', + 'type' => 'string', + 'required' => false, + 'example' => '4.0环境', + 'title' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token used to start the next query.'."\n" + ."\n" + .'> If not all results are returned in the first query, this parameter is returned. You can pass in the returned value of this parameter in the next query.', + 'type' => 'string', + 'example' => '212db86****', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '96017AF2-9AB1-4BC9-88D2-7966B3CD****', + 'title' => '', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => 'Details about the tags of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The resource type. The return value is fixed to **ALIYUN: KVSTORE: INSTANCE**, indicating an ApsaraDB for MongoDB instance.', + 'type' => 'string', + 'example' => 'ALIYUN::DDS::INSTANCE', + 'title' => '', + ], + 'TagValue' => [ + 'description' => 'The value of the tag.', + 'type' => 'string', + 'example' => '4.0环境', + 'title' => '', + ], + 'ResourceId' => [ + 'description' => 'The ID of the resource. It is the ID of the ApsaraDB for MongoDB instance.', + 'type' => 'string', + 'example' => 'dds-bp17e7a04960****', + 'title' => '', + ], + 'TagKey' => [ + 'description' => 'The key of the tag.', + 'type' => 'string', + 'example' => '开发组', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidTagValue.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Value\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceId', + 'errorMessage' => 'The specified parameter \'ResourceId.n\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'MissParameter.TagOrResourceId', + 'errorMessage' => 'The parameter \'Tag.n\'\' or \'ResourceId.n\' is needed.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.Scope', + 'errorMessage' => 'The specified parameter \'Scope\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', + 'description' => '', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed.', + 'description' => '', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' is duplicated.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The specified parameter \'ResourceType\' is not valid.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '', + ], + ], + ], + 'title' => 'ListTagResources', + 'summary' => 'Queries the relationship between ApsaraDB for MongoDB instances and tags.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"212db86****\\",\\n \\"RequestId\\": \\"96017AF2-9AB1-4BC9-88D2-7966B3CD****\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::DDS::INSTANCE\\",\\n \\"TagValue\\": \\"4.0环境\\",\\n \\"ResourceId\\": \\"dds-bp17e7a04960****\\",\\n \\"TagKey\\": \\"开发组\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'MigrateAvailableZone' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8316', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOFKSAW', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> If the instance is deployed in a VPC, you must specify the **Vswitch** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1ece71ff2f****', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination zone.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- The source zone and the destination zone belong to the same region.'."\n" + ."\n" + .'- You can call the [DescribeRegions](~~61933~~) operation to query the zone ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-b', + 'title' => '', + ], + ], + [ + 'name' => 'Vswitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch in the destination zone.'."\n" + ."\n" + .'> If the instance is deployed in a VPC, you must specify this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1buy0h9myt5i9e7****', + 'title' => '', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the instance is migrated to the destination zone. Valid values:'."\n" + ."\n" + .'- **Immediately**: The instance is immediately migrated to the destination zone.'."\n" + ."\n" + .'- **MaintainTime**: The instance is migrated to the destination zone during the maintenance window of the instance.'."\n" + ."\n" + .'Default value: **Immediately**.', + 'type' => 'string', + 'required' => false, + 'default' => 'Immediately', + 'enum' => [ + 'Immediately', + 'MaintainTime', + '0', + '1', + ], + 'example' => 'Immediately', + 'title' => '', + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination secondary zone.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + ], + [ + 'name' => 'HiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination hidden zone.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-n', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '0FDDC511-7252-4A4A-ADDA-5CB1BF63****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEffectiveTime.Malformed', + 'errorMessage' => 'Specified EffectiveTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InsType.NotSupport', + 'errorMessage' => 'Specified instance type dose not support this operation.', + 'description' => 'The specified instance type does not support this operation.', + ], + [ + 'errorCode' => 'IncorrectMasterDBInstanceState', + 'errorMessage' => 'The Master instance state does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'NetworkTypeNotSupport', + 'errorMessage' => 'The network type does not support this operation.', + 'description' => 'The network type does not support this operation.', + ], + [ + 'errorCode' => 'OperationDenied.LockMode', + 'errorMessage' => 'The operation is not permitted when the instance locked.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidIzNo.NotSupported', + 'errorMessage' => 'the Specified vpc Zone not supported.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectVswitchId', + 'errorMessage' => 'The specified parameter \'VSwitchId\' is not valid.', + 'description' => 'When the current instance is a VPC instance, the VSwitchId parameter cannot be empty.', + ], + [ + 'errorCode' => 'InvalidRegion_Zone_NotFound', + 'errorMessage' => 'Specified Region does not exist in RDS.', + 'description' => '', + ], + [ + 'errorCode' => 'VPCERROR.ALLOCATE_ERROR', + 'errorMessage' => 'Cannot Allocate the require vpcInstances.', + 'description' => '', + ], + [ + 'errorCode' => 'ProxyError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + 'description' => '', + ], + [ + 'errorCode' => 'DbInsertError', + 'errorMessage' => 'Database insert error.', + 'description' => '', + ], + [ + 'errorCode' => 'UnsupportedDBTdeStatus', + 'errorMessage' => 'Specified DB TDEStatus does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidZoneParam', + 'errorMessage' => 'The target zone and source zone cannot be the same.', + 'description' => 'The destination zone cannot be the same as the original zone.', + ], + [ + 'errorCode' => 'MigrateDBInstanceError', + 'errorMessage' => 'Error in migrating available area or changing your vpc network. Please submit the work order for processing.', + 'description' => '', + ], + [ + 'errorCode' => 'MinorVersionNotSupport', + 'errorMessage' => 'Instance\'s MinorVersion is not supported for this API.', + 'description' => 'This API does not support MinorVersion of instances.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '', + ], + ], + ], + 'title' => 'MigrateAvailableZone', + 'summary' => 'Migrates an ApsaraDB for MongoDB instance to a specific zone.', + 'description' => '- This operation is available only for replica set instances that run MongoDB 4.2 or earlier and sharded cluster instances.'."\n" + ."\n" + .'- If you have applied for a public endpoint for the ApsaraDB for MongoDB instance, you must call the [ReleasePublicNetworkAddress](~~67604~~) operation to release the public endpoint before you call the MigrateAvailableZone operation.'."\n" + ."\n" + .'- Transparent data encryption (TDE) is disabled for the ApsaraDB for MongoDB instance.'."\n" + ."\n" + .'- The source zone and the destination zone belong to the same region.'."\n" + ."\n" + .'- A vSwitch is created in the destination zone. This prerequisite must be met if the instance resides in a virtual private cloud (VPC). For more information about how to create a vSwitch, see [Work with vSwitches](~~65387~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:MigrateAvailableZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FDDC511-7252-4A4A-ADDA-5CB1BF63****\\"\\n}","type":"json"}]', + ], + 'MigrateToOtherZone' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8317', + 'abilityTreeNodes' => [ + 'FEATUREmongodb7WMH71', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> If the network type of the instance is VPC, you must specify the **Vswitch** parameter .', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2658****', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination zone to which you want to migrate the ApsaraDB for MongoDB instance.'."\n" + ."\n" + .'> - The destination and source zones must be in one region.'."\n" + .'>'."\n" + .'> - You can call [DescribeRegions](~~61933~~) to query the zone IDs.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-b', + 'title' => '', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the instance is migrated to the destination zone. Valid values:'."\n" + ."\n" + .'- **Immediately** (default): The instance is migrated immediately.'."\n" + ."\n" + .'- **MaintainTime**: The instance is migrated during its maintenance window.', + 'type' => 'string', + 'required' => false, + 'default' => 'Immediately', + 'enum' => [ + 'Immediately', + 'MaintainTime', + '0', + '1', + ], + 'example' => 'Immediately', + 'title' => '', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch in the destination zone.'."\n" + ."\n" + .'> This parameter is valid and required only when the network type of the instance is VPC.', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp67ac****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '0FDDC511-7252-4A4A-ADDA-5CB1BF63873D', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEffectiveTime.Malformed', + 'errorMessage' => 'Specified EffectiveTime is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'MigrateDBInstanceError', + 'errorMessage' => 'Error in migrating available area or changing your vpc network. Please submit the work order for processing.', + 'description' => '', + ], + ], + ], + 'title' => 'MigrateToOtherZone', + 'summary' => 'You can call this operation to migrate an ApsaraDB for MongoDB instance to another zone.', + 'description' => 'This operation is applicable only to replica set instances, but not to standalone instances or sharded cluster instances.'."\n" + ."\n" + .'> If you have applied for a public endpoint of the instance, you must first call the [ReleasePublicNetworkAddress](~~67604~~) operation to release the public endpoint.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:MigrateToOtherZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FDDC511-7252-4A4A-ADDA-5CB1BF63873D\\"\\n}","type":"json"}]', + ], + 'ModifyAccountDescription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8318', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2356****', + 'title' => '', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account whose description is to be modified.', + 'type' => 'string', + 'required' => true, + 'example' => 'root', + 'title' => '', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the account.'."\n" + ."\n" + .'- The description must start with a letter and cannot start with http\\:// or https\\://.'."\n" + ."\n" + .'- The description must be 2 to 256 characters in length, and can contain letters, digits, underscores (\\_), and hyphens (-).', + 'type' => 'string', + 'required' => true, + 'example' => 'superadmin', + 'title' => '', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the account whose description you can modify. Valid values:'."\n" + ."\n" + .'- **db**: shard account'."\n" + ."\n" + .'- **cs**: ConfigServer account'."\n" + ."\n" + .'- **normal** (default): replica set account (available)'."\n" + ."\n" + .'> You can set this parameter only to **normal**.', + 'type' => 'string', + 'default' => 'normal', + 'enum' => [ + 'db', + 'cs', + 'normal', + ], + 'required' => false, + 'example' => 'normal', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '59DE9FC2-7B40-45CF-9011-7327A8A771A2', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'Specified parameter AccountDescription is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidAccountName.NotFound', + 'errorMessage' => 'Specified account name does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'InsType.NotSupport', + 'errorMessage' => 'Specified instance type dose not support this operation.', + 'description' => 'The specified instance type does not support this operation.', + ], + ], + ], + 'title' => 'ModifyAccountDescription', + 'summary' => 'Modifies the description of the root account in an ApsaraDB for MongoDB instance.', + 'description' => '该接口暂不支持分片集群实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyAccountDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59DE9FC2-7B40-45CF-9011-7327A8A771A2\\"\\n}","type":"json"}]', + ], + 'ModifyActiveOperationMaintenanceConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '37474', + 'abilityTreeNodes' => [ + 'FEATUREmongodbKYZJ28', + ], + ], + 'parameters' => [ + [ + 'name' => 'CycleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cycle type.'."\n" + ."\n" + .'- Month: monthly'."\n" + ."\n" + .'- Week: weekly', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'Week', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The day of the cycle.'."\n" + ."\n" + .'- If CycleType is set to Month, enter a number from 1 to 28 to specify the day of the month. Use a comma (,) to separate multiple days.'."\n" + ."\n" + .'- If CycleType is set to Week, enter a number from 1 to 7 to specify the day of the week. Use a comma (,) to separate multiple days.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the O\\&M window for the instance. The time is in the HH:mmZ format and is in UTC.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '21:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the O\\&M window for the instance. The time is in the HH:mmZ format and is in UTC.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '22:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the configuration is enabled.'."\n" + ."\n" + .'- 1: enabled'."\n" + ."\n" + .'- 2: disabled', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enum' => [ + '1', + '2', + ], + 'title' => '', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'ModifyActiveOperationMaintenanceConfig', + 'summary' => 'Modifies the Operations and Maintenance (O&M) task configuration for a MongoDB instance.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8F1D721-6439-4257-A89C-F1E8E9C9****\\"\\n}","type":"json"}]', + ], + 'ModifyActiveOperationTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '37475', + 'abilityTreeNodes' => [ + 'FEATUREmongodbKYZJ28', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the O\\&M tasks. Separate multiple task IDs with commas (,).'."\n" + ."\n" + .'> You can call the DescribeActiveOperationTask operation to query the IDs of O\\&M tasks.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '11111,22222', + 'title' => '', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scheduled switching time that you want to specify. 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 time that is specified by the SwitchTime parameter cannot be later than the time that is specified by the Deadline parameter. You can call the DescribeActiveOperationTasks operation to query the latest switching time that is returned for the Deadline parameter.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-10-17T18:50:00Z', + 'title' => '', + ], + ], + [ + 'name' => 'ImmediateStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to immediately start scheduling. Valid values:'."\n" + ."\n" + .'* 0 (default): Scheduling is not started immediately.'."\n" + .'* 1: Scheduling is started immediately.'."\n" + ."\n" + .'> - If you set this parameter to 0, the SwitchTime parameter takes effect. If you set this parameter to 1, the SwitchTime parameter does not take effect. In this case, the start time of the task is the current time, and the system determines the switching time based on the start time.'."\n" + .'> - Immediate scheduling specifies that the task enters the preparing state instead of being executed immediately. After the preparation is complete, the switchover is performed. You can call the DescribeActiveOperationTasks operation to query the preparation time that is returned for the PrepareInterval parameter.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => 'The IDs of the O\\&M tasks. Multiple task IDs are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '11111,22222', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CAAE9DDA-65FD-584C-A378-F1F24676****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'ModifyActiveOperationTasks', + 'summary' => 'Modifies the switching time of scheduled O\\\\\\\\\\\\&M tasks for an ApsaraDB for MongoDB instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyActiveOperationTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"11111,22222\\",\\n \\"RequestId\\": \\"CAAE9DDA-65FD-584C-A378-F1F24676****\\"\\n}","type":"json"}]', + ], + 'ModifyAuditLogFilter' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + 'title' => '', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of logs collected by the audit log feature of the instance. Separate multiple types with commas (,). Valid values:'."\n" + ."\n" + .'- **admin**: O\\&M and management operations'."\n" + ."\n" + .'- **slow**: slow query logs'."\n" + ."\n" + .'- **query**: query operations'."\n" + ."\n" + .'- **insert**: insert operations'."\n" + ."\n" + .'- **update**: update operations'."\n" + ."\n" + .'- **delete**: delete operations'."\n" + ."\n" + .'- **command**: protocol commands such as the aggregate method', + 'type' => 'string', + 'required' => true, + 'example' => 'insert,query,update,delete', + 'title' => '', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of the node in the instance. Valid values:'."\n" + ."\n" + .'- **primary**'."\n" + ."\n" + .'- **secondary**', + 'type' => 'string', + 'required' => false, + 'example' => 'primary', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'E209BE2B-F264-4B9D-81F6-A5A5FB1FBF28', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => 'The parameter entered is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterParam', + 'errorMessage' => 'Specified filter is not valid.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyAuditLogFilter', + 'summary' => 'Queries the types of logs collected by the audit log feature of an ApsaraDB for MongoDB instance.', + 'description' => '- The instance must be in the running state when you call this operation.'."\n" + ."\n" + .'- This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.'."\n" + ."\n" + .'- You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyAuditLogFilter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E209BE2B-F264-4B9D-81F6-A5A5FB1FBF28\\"\\n}","type":"json"}]', + ], + 'ModifyAuditPolicy' => [ + 'summary' => 'Enable or disable audit logging for a MongoDB instance or set the retention period for audit logs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREmongodb42P3EC', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1785659e3f****', + 'title' => '', + ], + ], + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of audit logging. Valid values:'."\n" + ."\n" + .'- **enable**: Enable audit logging.'."\n" + ."\n" + .'- **disabled**: Disable audit logging.', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'enable', + 'disabled', + 'Enable', + 'Disabled', + ], + 'example' => 'enable', + 'title' => '', + ], + ], + [ + 'name' => 'StoragePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '- In the Standard edition, this is the retention period for audit logs. Valid values: 1 to 365 days. Default value: 30 days.'."\n" + ."\n" + .'- In the V2\\_Standard edition (DAS Enterprise Edition \\[NoSQL-compatible] audit logs), this is the cold storage duration for audit logs. Valid values: 30, 180, 365, 1095, and 1825 days.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '365', + 'minimum' => '1', + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'AuditLogSwitchSource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the audit log request. Set this parameter to **Console**.', + 'type' => 'string', + 'default' => 'Console', + 'required' => false, + 'example' => 'Console', + 'title' => '', + ], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of audit logging.'."\n" + ."\n" + .'- **Trial**: Free trial version.'."\n" + ."\n" + .'- **Standard**: Standard edition.'."\n" + .' -**V2\\_Standard**: DAS Enterprise Edition (NoSQL-compatible) audit logs.'."\n" + ."\n" + .'> * The default value is **Trial**. Starting January 6, 2022, the Standard edition becomes available in all regions. You can no longer apply for the free trial version.'."\n" + .'>'."\n" + .'> * Starting February 2026, the DAS Enterprise Edition (NoSQL-compatible) audit logs become available in all regions. You can no longer apply for the Standard edition.', + 'type' => 'string', + 'default' => 'Trial', + 'required' => false, + 'example' => 'Standard', + 'title' => '', + ], + ], + [ + 'name' => 'HotStoragePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter takes effect only in the V2\\_Standard edition (DAS Enterprise Edition \\[NoSQL-compatible] audit logs). It specifies the hot storage duration for audit logs. Valid values: 0 to 7 days.', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '7', + 'minimum' => '0', + 'required' => false, + 'example' => '7', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The request ID.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'DC04D812-F18D-4568-9B88-F260D9590116', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'EntityNotExistUser', + 'errorMessage' => 'The User does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'EntityNotExistService', + 'errorMessage' => 'The Service mongodb.aliyuncs.com does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'NoPermissionService', + 'errorMessage' => 'The Account NoPermission Error! Please Authorize The Account! Service Name: mongodb.aliyuncs.com, SLR Role:AliyunServiceRoleForMongoDB.', + 'description' => '', + ], + ], + 409 => [ + [ + 'errorCode' => 'EntityAlreadyExistsRole', + 'errorMessage' => 'The Role already exists:AliyunServiceRoleForMongoDB.', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC04D812-F18D-4568-9B88-F260D9590116\\"\\n}","type":"json"}]', + 'title' => 'ModifyAuditPolicy', + 'description' => '- This operation applies to instances with the **General-purpose Local Disk** or **Dedicated Local Disk** specification type.'."\n" + ."\n" + .'- You can call this operation up to 30 times per minute. Requests that exceed this limit are throttled. Avoid making high-frequency calls. For high-frequency use, use Logstore. For more information, see [Manage Logstore](~~48990~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyAuditPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'ModifyBackupExpireTime' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '273131', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'The instance ID.', + 'title' => '', + 'example' => 'dds-bp16cb162771****', + ], + ], + [ + 'name' => 'BackupExpireTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The time-to-live (TTL) of the backup. The time must be in the *yyyy-MM-dd*T*HH:mm:ss*Z format and in UTC.'."\n" + ."\n" + .'> - *9999-01-01*T*00:00:00*Z* indicates that the backup is retained permanently.*'."\n" + .'>'."\n" + .'> *- You can only extend the retention period. You cannot shorten it.- If you do not set the time to *9999-01-01*T*00:00:00*Z, the new expiration time must be within 730 days after the end time of the backup set.*'."\n" + .'>'."\n" + .'> **', + 'required' => false, + 'title' => '', + 'example' => '2025-03-29T03:47:12Z', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'description' => 'The backup ID.', + 'title' => '', + 'example' => '260032xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + 'description' => 'The request ID.', + 'title' => '', + 'example' => 'A0181AC4-XXXX-XXXX-87CA-100C70B86729', + ], + 'BackupExpireTime' => [ + 'type' => 'string', + 'description' => 'The time-to-live (TTL) of the backup. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is in UTC.'."\n" + ."\n" + .'> - *9999-01-01*T*00:00:00*Z* indicates that the backup is retained permanently.*'."\n" + .'>'."\n" + .'> **'."\n" + .'>'."\n" + .'> **', + 'title' => '', + 'example' => '2025-03-29T03:47:12Z', + ], + 'BackupId' => [ + 'type' => 'string', + 'description' => 'The backup ID.', + 'title' => '', + 'example' => '260032xxxx', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBackupMethod.ValueNotSupport', + 'errorMessage' => 'The specified parameter BackupMethod is not valid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.BackupJobExists', + 'errorMessage' => 'The operation is not permitted due to backup job exist.', + 'description' => 'A backup task is in progress. Try again later.', + ], + [ + 'errorCode' => 'OperationDenied.NoDatabase', + 'errorMessage' => 'The operation is not permitted due to no database.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyBackupExpireTime', + 'summary' => 'Modifies the time-to-live (TTL) of a MongoDB backup set.', + 'description' => 'You can modify the TTL only for manual backups.'."\n" + ."\n" + .'This operation is applicable only to MongoDB instances that use cloud disks.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0181AC4-XXXX-XXXX-87CA-100C70B86729\\",\\n \\"BackupExpireTime\\": \\"2025-03-29T03:47:12Z\\",\\n \\"BackupId\\": \\"260032xxxx\\"\\n}","type":"json"}]', + ], + 'ModifyBackupPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8322', + 'abilityTreeNodes' => [ + 'FEATUREmongodbPMIDED', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp16cb162771****', + 'title' => '', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time range to perform a backup. Specify the time in the *HH:mm*Z-*HH:mm*Z format. The time is displayed in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'> The time range must be 1 hour.', + 'type' => 'string', + 'required' => false, + 'example' => '03:00Z-04:00Z', + 'title' => '', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup cycle. Valid values:'."\n" + ."\n" + .'- **Monday**'."\n" + ."\n" + .'- **Tuesday**'."\n" + ."\n" + .'- **Wednesday**'."\n" + ."\n" + .'- **Thursday**'."\n" + ."\n" + .'- **Friday**'."\n" + ."\n" + .'- **Saturday**'."\n" + ."\n" + .'- **Sunday**'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'To ensure data security, back up the MongoDB instance at least twice a week.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'> To specify multiple backup cycles, separate them with commas (,).', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday,Wednesday,Friday,Sunday', + 'title' => '', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days to retain full backups.'."\n" + ."\n" + .'> - For instances that were created before September 10, 2021, the default retention period is 7 days.'."\n" + .'>'."\n" + .'> - For instances that are created after September 10, 2021, the default retention period is 30 days.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable log backup. Valid values:'."\n" + ."\n" + .'- **0**: Disable log backup. This is the default value.'."\n" + ."\n" + .'- **1**: Enable log backup.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'You cannot disable log backup for sharded cluster instances.'."\n" + ."\n" + .'></notice>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'LogBackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days to retain log backups. Default value: 7.'."\n" + ."\n" + .'Valid values: 7 to 730.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7', + 'title' => '', + ], + ], + [ + 'name' => 'SnapshotBackupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The snapshot backup type. Valid values:'."\n" + ."\n" + .'- **Flash**: second-level backup.'."\n" + ."\n" + .'- **Standard**: conventional backup. This is the default value.', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + 'title' => '', + ], + ], + [ + 'name' => 'BackupInterval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The frequency of high-frequency backups. Valid values:'."\n" + ."\n" + .'- **-1**: High-frequency backup is disabled.'."\n" + ."\n" + .'- **30**: every 30 minutes.'."\n" + ."\n" + .'- **60**: every 1 hour.'."\n" + ."\n" + .'- **120**: every 2 hours.'."\n" + ."\n" + .'- **180**: every 3 hours.'."\n" + ."\n" + .'- **240**: every 4 hours.'."\n" + ."\n" + .'- **360**: every 6 hours.'."\n" + ."\n" + .'- **480**: every 8 hours.'."\n" + ."\n" + .'- **720**: every 12 hours.'."\n" + ."\n" + .'> * If you set **SnapshotBackupType** to **Standard**, the value of this parameter is -1.'."\n" + .'>'."\n" + .'> * High-frequency backup takes effect only if you set **SnapshotBackupType** to **Flash** and set this parameter to a value greater than 0.', + 'type' => 'string', + 'example' => '-1', + 'default' => '-1', + 'required' => false, + 'title' => '', + ], + ], + [ + 'name' => 'HighFrequencyBackupRetention', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days to retain high-frequency backups. Before you specify this parameter, you must set the BackupInterval parameter. The default retention period is 1 day.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'title' => '', + 'example' => '1', + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The policy to retain backups when you release the instance.'."\n" + ."\n" + .'- 0: All backup sets of the instance are deleted when the instance is released.'."\n" + ."\n" + .'- 1: An automatic backup is performed when the instance is released, and this backup is retained for a long time.'."\n" + ."\n" + .'- 2: An automatic backup is performed when the instance is released, and all backup sets of the instance are retained for a long time.'."\n" + ."\n" + .'For more information, see [Long-term backup retention](~~2779111~~).', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => [ + '0', + '1', + '2', + ], + 'required' => false, + 'example' => '2', + 'title' => '', + ], + ], + [ + 'name' => 'CrossBackupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The policy for geo-redundant backups. Valid values:'."\n" + ."\n" + .'- update: Modify the geo-redundancy policy.'."\n" + ."\n" + .'- delete: Delete the geo-redundancy policy.'."\n" + ."\n" + .'> This parameter is required if you enable geo-redundancy.', + 'type' => 'string', + 'enum' => [ + 'update', + 'delete', + ], + 'required' => false, + 'example' => 'update', + 'title' => '', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance.'."\n" + ."\n" + .'> - This parameter is required if you restore a deleted instance.'."\n" + .'>'."\n" + .'> - This parameter is required if you enable geo-redundancy.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'title' => '', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the geo-redundant backup.'."\n" + ."\n" + .'> This parameter is required if you enable geo-redundancy.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'CrossRetentionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention policy for geo-redundant backups. Valid values:'."\n" + ."\n" + .'- delay: Retain the backup for a specified period.'."\n" + ."\n" + .'- never: Retain the backup permanently.'."\n" + ."\n" + .'> This parameter is required if you enable geo-redundancy.', + 'type' => 'string', + 'enum' => [ + 'delay', + 'never', + ], + 'required' => false, + 'example' => 'delay', + 'title' => '', + ], + ], + [ + 'name' => 'CrossRetentionValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days to retain geo-redundant backups. Valid values: 3 to 1825.'."\n" + ."\n" + .'> - This parameter is required if you enable geo-redundancy.'."\n" + .'>'."\n" + .'> - This parameter is required if you set CrossRetentionType to delay.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + 'title' => '', + ], + ], + [ + 'name' => 'CrossBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The days of the week to perform geo-redundant backups. Valid values:'."\n" + ."\n" + .'1. Monday'."\n" + ."\n" + .'2. Tuesday'."\n" + ."\n" + .'3. Wednesday'."\n" + ."\n" + .'4. Thursday'."\n" + ."\n" + .'5. Friday'."\n" + ."\n" + .'6. Saturday'."\n" + ."\n" + .'7. Sunday'."\n" + ."\n" + .'> This parameter is required if you enable geo-redundancy.'."\n" + .'>'."\n" + .'> - To specify multiple days, separate them with commas (,).'."\n" + .'>'."\n" + .'> - If you set the backup method to conventional backup, the days of the week specified by this parameter must be a subset of the days of the week specified by PreferredBackupPeriod.', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', + 'title' => '', + ], + ], + [ + 'name' => 'EnableCrossLogBackup', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable cross-region log backup. Valid values:'."\n" + ."\n" + .'> This parameter is required if you enable geo-redundancy.'."\n" + .'>'."\n" + .'> - 1: Enable cross-region log backup. This value is required for sharded cluster instances. This value is also required for replica set instances if you want to enable geo-redundant point-in-time recovery.'."\n" + .'>'."\n" + .'> - 0: Disable cross-region log backup.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'CrossLogRetentionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention policy for cross-region log backups. Valid values:'."\n" + ."\n" + .'- delay: Retain the backup for a specified period.'."\n" + ."\n" + .'- never: Retain the backup permanently.'."\n" + ."\n" + .'> This parameter is required if you enable geo-redundancy.', + 'type' => 'string', + 'enum' => [ + 'never', + 'delay', + ], + 'required' => false, + 'example' => 'delay', + 'title' => '', + ], + ], + [ + 'name' => 'CrossLogRetentionValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days to retain cross-region log backups. Valid values: 3 to 1825. The value must be less than or equal to the value of CrossRetentionValue.'."\n" + ."\n" + .'> This parameter is required if you enable geo-redundancy.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- replicate'."\n" + ."\n" + .'- sharding'."\n" + ."\n" + .'> * This parameter is required when you restore a deleted instance.'."\n" + .'>'."\n" + .'> * This parameter is required when you clone an instance from a geo-redundant backup.', + 'type' => 'string', + 'enum' => [ + 'sharding', + 'replicate', + ], + 'required' => false, + 'example' => 'replicate', + 'title' => '', + ], + ], + [ + 'name' => 'PreserveOneEachHour', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable hourly sparse backup. Valid values:'."\n" + ."\n" + .'- true: If the backup frequency is in minutes, all snapshots that are generated within the last hour are retained. For snapshots that were generated more than 1 hour ago but less than 24 hours ago, only the first snapshot that is generated after each full hour is retained.'."\n" + ."\n" + .'- false: All snapshots are retained within the high-frequency backup retention period.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '644A359C-B871-4DD3-97B5-ED91EF5809C2', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPreferredBackupPeriod.Malformed', + 'errorMessage' => 'Specified parameter PreferredBackupPeriod is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidPreferredBackupTime.Malformed', + 'errorMessage' => 'Specified parameter PreferredBackupTime is not valid.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyBackupPolicy', + 'summary' => 'Modifies the backup policy of a MongoDB instance.', + 'description' => 'Geo-redundancy is available only for replica set instances and sharded cluster instances that use cloud disks.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"644A359C-B871-4DD3-97B5-ED91EF5809C2\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceAttribute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8323', + 'abilityTreeNodes' => [ + 'FEATUREmongodbXNNG5O', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-7xv0912d85924194', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceReleaseProtection', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable instance release protection. Valid values:'."\n" + ."\n" + .'- **true**: enabled.'."\n" + ."\n" + .'- **false**: disabled.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '6826DEE3-B374-5DB7-909D-C8978827C534', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ModifyDBInstanceAttribute', + 'summary' => 'Modifies instance release protection configuration.', + 'description' => 'This operation is applicable only to pay-as-you-go instances.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6826DEE3-B374-5DB7-909D-C8978827C534\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceConfig' => [ + 'summary' => 'Modifies instance configuration', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '245140', + 'abilityTreeNodes' => [ + 'FEATUREmongodbDMJK05', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1ea17b41ab****', + 'title' => '', + ], + ], + [ + 'name' => 'ConfigName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration item name.', + 'type' => 'string', + 'required' => true, + 'example' => 'manual_check', + 'title' => '', + ], + ], + [ + 'name' => 'ConfigValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration item value', + 'type' => 'string', + 'required' => true, + 'example' => '0', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'E466EFD6-2AD2-xxxx-A1A6-C7AFA1B323E1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter %s is not valid.', + 'description' => 'The specified parameter %s is not valid.', + ], + ], + ], + 'title' => 'ModifyDBInstanceConfig', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E466EFD6-2AD2-xxxx-A1A6-C7AFA1B323E1\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceConnectionString' => [ + 'summary' => 'Modifies the endpoint and port of a MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8324', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAOTVP9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> If this parameter is set to the ID of a sharded cluster instance, the `NodeId` parameter is also required.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a Mongos node in the sharded cluster instance. You can specify only one Mongos node ID per call.'."\n" + ."\n" + .'> This parameter is available only when the `DBInstanceId` parameter is set to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 's-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'CurrentConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The current endpoint that you want to modify.', + 'type' => 'string', + 'required' => false, + 'example' => 's-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + ], + [ + 'name' => 'NewConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new endpoint prefix. The prefix must meet the following requirements:'."\n" + ."\n" + .'- Starts with a lowercase letter.'."\n" + ."\n" + .'- Ends with a lowercase letter or a digit.'."\n" + ."\n" + .'- Contains only lowercase letters, digits, and hyphens (-).'."\n" + ."\n" + .'- Is 8 to 63 characters in length.'."\n" + ."\n" + .'> Specify only the prefix of the endpoint. The domain name suffix cannot be changed.', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyuntest111', + 'title' => '', + ], + ], + [ + 'name' => 'NewPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new port. The value must be an integer from 1000 to 65535.'."\n" + ."\n" + .'> This parameter is available only when the `DBInstanceId` parameter is set to the ID of a cloud disk instance.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3310', + 'title' => '', + ], + ], + [ + 'name' => 'PortModifyOnly', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'default' => 'false', + 'title' => '', + 'description' => '', + 'example' => '', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'example' => 'vpc', + 'enum' => [ + 'vpc', + 'public', + ], + 'title' => '', + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'FF36A84C-0694-42D0-861D-C383E8E4FAAF', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NewConnectionString.NotSupport', + 'errorMessage' => 'Specified newConnectionString is not supported.', + 'description' => 'newConnectionString format', + ], + [ + 'errorCode' => 'InvalidConnectionStringOrPort.Duplicate', + 'errorMessage' => 'Specified connection string or port already exists.', + 'description' => 'The specified connection string or port information already exists, please check and resubmit.', + ], + ], + ], + 'title' => 'ModifyDBInstanceConnectionString', + 'description' => 'You can modify the endpoint and port for the following instance types:'."\n" + ."\n" + .'- You can modify the endpoints of instances that use local disks or cloud disks.'."\n" + ."\n" + .'- For sharded cluster instances, you can modify only the endpoints of Mongos nodes.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceConnectionString', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FF36A84C-0694-42D0-861D-C383E8E4FAAF\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceDescription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> To modify the name of a shard or mongos node in a sharded cluster instance, you must also specify the **NodeId** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2234****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard or mongos node in the sharded cluster instance.'."\n" + ."\n" + .'> This parameter is valid only if you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp89067****', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- The name cannot start with `http://` or `https://`.'."\n" + ."\n" + .'- It must start with a letter.'."\n" + ."\n" + .'- It must be 2 to 256 characters in length, and can contain letters, underscores (\\_), hyphens (-), and digits.', + 'type' => 'string', + 'required' => true, + 'example' => 'testdata', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '06F8F642-4009-4FFC-80C4-9D67DBF7B74E', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBInstanceDescription.Malformed', + 'errorMessage' => 'Specified parameter DBInstanceDescription is not valid.', + 'description' => 'Invalid node name.', + ], + ], + ], + 'title' => 'ModifyDBInstanceDescription', + 'summary' => 'Modifies the name of an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06F8F642-4009-4FFC-80C4-9D67DBF7B74E\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceDiskType' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '189925', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbInstanceStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The disk type after the modification. Valid value:'."\n" + ."\n" + .'- **cloud\\_auto**: ESSD AutoPL disk.', + 'type' => 'string', + 'required' => false, + 'default' => 'cloud_auto', + 'title' => '', + 'example' => 'cloud_auto', + ], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => 'The provisioned IOPS. Valid values: 0 to 50000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '50000', + 'minimum' => '0', + 'title' => '', + 'example' => '1960', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'dds-bp1fa5efaa93****', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" + ."\n" + .'- **true**: Enables automatic payment. Make sure that your account has a sufficient balance.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **false**: Disables automatic payment. To pay for the order, log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, choose **Expenses** > **Expenses and Costs**. In the navigation pane on the left, choose **Subscription Orders** > **My Orders**. On the **Product Orders** tab, find the order and complete the payment.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- **false**: Disables automatic payment. To pay for the order, log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, choose **Expenses** > **Expenses and Costs**. In the navigation pane on the left, click **Order Management**. On the **Product Orders** page, find the order and complete the payment.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'Default value: **true**.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + 'title' => '', + 'example' => 'true', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information. This is an additional parameter.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The coupon code. The default value is `youhuiquan_promotion_option_id_for_blank`.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'ExtraParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'An additional parameter.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'async', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" + ."\n" + .'- **true**: Enables auto-renewal.'."\n" + ."\n" + .'- **false**: Disables auto-renewal.'."\n" + ."\n" + .'Default value: **false**', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'false', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order type. Valid values:'."\n" + ."\n" + .'- **UPGRADE**: Upgrades the instance configuration.'."\n" + ."\n" + .'- **DOWNGRADE**: Downgrades the instance configuration.'."\n" + ."\n" + .'> This parameter is available only when the instance uses the subscription billing method.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'UPGRADE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'title' => '', + 'example' => '21012719476****', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'ModifyDBInstanceDiskType', + 'summary' => 'Modifies the disk type of an ApsaraDB for MongoDB instance.', + 'description' => '- This feature is not supported for instances with less than 40 GB of disk space.'."\n" + ."\n" + .'- You can change the disk type only to an ESSD AutoPL disk (cloud\\_auto).'."\n" + ."\n" + .'- The interval between two consecutive modifications to the provisioned input/output operations per second (IOPS) of an instance must be longer than one hour. For more information, see [Modify the performance of an ESSD AutoPL disk](~~413275~~).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceDiskType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8F1D721-6439-4257-A89C-F1E8E9C9****\\",\\n \\"OrderId\\": \\"21012719476****\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceMaintainTime' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpac2345****', + 'title' => '', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the maintenance window. Specify the time in the ISO 8601 standard in the *HH:mm*Z format. The time must be in UTC.', + 'type' => 'string', + 'required' => true, + 'example' => '01:00Z', + 'title' => '', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the maintenance window. Specify the time in the ISO 8601 standard in the *HH:mm*Z format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time of the maintenance window.', + 'type' => 'string', + 'required' => true, + 'example' => '02:00Z', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'A9310426-C763-42A2-A3AD-70A8DA204531', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'ModifyDBInstanceMaintainTime', + 'summary' => 'Modifies the maintenance window of an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceMaintainTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A9310426-C763-42A2-A3AD-70A8DA204531\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The collection frequency of monitoring data. Valid values: **1** or **300**. Unit: seconds.', + 'type' => 'string', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EFD65226-08CC-4C4D-B6A4-CB3C382F67B0', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'ModifyDBInstanceMonitor', + 'summary' => 'You can call this operation to set the monitoring granularity for an ApsaraDB for MongoDB instance.', + 'description' => '> This operation is applicable only to the ApsaraDB for MongoDB console of the previous version due to the change in the feature of adjusting collection intervals of monitoring data.'."\n" + ."\n" + .'Before you call this operation, make sure that the following requirements are met:'."\n" + ."\n" + .'- A replica set or sharded cluster instance is used.'."\n" + ."\n" + .'- MongoDB 3.4 (the latest minor version) or MongoDB 4.0 is selected.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFD65226-08CC-4C4D-B6A4-CB3C382F67B0\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceNetExpireTime' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + 'title' => '', + ], + ], + [ + 'name' => 'ClassicExpendExpiredDays', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of the classic network endpoint of the instance. Valid values: **14**, **30**, **60**, and **120**. Unit: day.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '459E7D5C-38DA-4E14-9C82-5B5AF693DBAB', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidConnectionString.NotFound', + 'errorMessage' => 'Specified connection string or net type is not found.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyDBInstanceNetExpireTime', + 'summary' => 'Extends the retention period of the classic network endpoint of an ApsaraDB for MongoDB instance.', + 'description' => 'Before you call this operation, make sure that the instance meets the following requirements:'."\n" + ."\n" + .'- The instance is in the Running state.'."\n" + ."\n" + .'- The network of the instance is in hybrid access mode.'."\n" + ."\n" + .'> This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceNetExpireTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"459E7D5C-38DA-4E14-9C82-5B5AF693DBAB\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceNetworkType' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp11483712c1****', + 'title' => '', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type to switch to. Valid value:'."\n" + ."\n" + .'- **VPC**', + 'type' => 'string', + 'required' => true, + 'example' => 'VPC', + 'title' => '', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC.'."\n" + ."\n" + .'> This parameter is required when the **NetworkType** parameter is set to **VPC**.', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1n3i15v90el48nx****', + 'title' => '', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch in the VPC.'."\n" + ."\n" + .'> This parameter is required when the **NetworkType** parameter is set to **VPC**.', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1vj604nj5a9zz74****', + 'title' => '', + ], + ], + [ + 'name' => 'RetainClassic', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to retain the original classic network address when you change the network type to VPC. Valid values:'."\n" + ."\n" + .'- **True**: retains the original classic network address.'."\n" + ."\n" + .'- **False**: does not retain the original classic network address.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- This parameter is required when the **NetworkType** parameter is set to **VPC**.'."\n" + ."\n" + .'- If you set this parameter to **True**, you must also specify the **ClassicExpiredDays** parameter.', + 'type' => 'string', + 'required' => false, + 'default' => 'False', + 'example' => 'False', + 'title' => '', + ], + ], + [ + 'name' => 'ClassicExpiredDays', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of the original classic network address when you change the network type to VPC. Valid values: **14**, **30**, **60**, and **120**. Unit: days.'."\n" + ."\n" + .'> This parameter is required when the **NetworkType** parameter is set to **VPC** and the **RetainClassic** parameter is set to **True**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区 ID，您可以通过调用 [DescribeRegions](~~61933~~) 接口查询可用区 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-b', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D0E605FD-6ECE-5FBE-84A4-99AAB1B8****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InstanceVpcAuthMode.NotSupported', + 'errorMessage' => 'Instance VpcAuthMode is NotSupported.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyDBInstanceNetworkType', + 'summary' => 'Changes the network type of an ApsaraDB for MongoDB instance.', + 'description' => 'This operation is applicable to replica set instances and sharded cluster instances, but not standalone instances. You can call this operation to change the network of an instance from a classic network to a VPC.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceNetworkType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0E605FD-6ECE-5FBE-84A4-99AAB1B8****\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceSSL' => [ + 'summary' => 'Modifies the SSL configuration of a MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8331', + 'abilityTreeNodes' => [ + 'FEATUREmongodbKJCC1K', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + 'title' => '', + ], + ], + [ + 'name' => 'SSLAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation to perform on the SSL feature. Valid values:'."\n" + ."\n" + .'- **Open**: Enable SSL encryption.'."\n" + ."\n" + .'- **Close**: Disable SSL encryption.'."\n" + ."\n" + .'- **Update**: Update the SSL certificate.', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'Open', + 'Close', + 'Update', + ], + 'example' => 'Open', + 'title' => '', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time to modify the SSL configuration of the MongoDB instance. Valid values:'."\n" + ."\n" + .'- 0: Modify immediately.'."\n" + ."\n" + .'- 1: Modify within the maintenance window.', + 'type' => 'string', + 'enum' => [ + '0', + '1', + ], + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'ForceEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to forcibly enable SSL encryption for connections. Valid values:'."\n" + ."\n" + .'- **1**: Forcibly enable SSL encryption.'."\n" + ."\n" + .'- **0**: Do not forcibly enable SSL encryption.'."\n" + ."\n" + .'> * Forced SSL encryption is supported only for MongoDB 7.0 and 8.0 instances that use cloud disks and meet the following minor engine version requirements:'."\n" + .'>'."\n" + .'> * - For version 7.0, the minor engine version must be 8.0.13 or later.'."\n" + .'>'."\n" + .'> * - For version 8.0, the minor engine version must be 9.0.5 or later.'."\n" + ."\n" + .'><warning>'."\n" + ."\n" + .'After you enable forced SSL encryption, only SSL connections to the instance are allowed.'."\n" + ."\n" + .'></warning>', + 'enumValueTitles' => [ + '0', + '1', + ], + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '6D806B11-078F-4154-BF9F-844F56D08964', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'SSLAlreadyEnabled', + 'errorMessage' => 'SSL have already been enabled.', + 'description' => '', + ], + [ + 'errorCode' => 'SSLAlreadyDisabled', + 'errorMessage' => 'SSL have already been disabled.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'SSLNotEnabled', + 'errorMessage' => 'SSL not enabled.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectCharacterType', + 'errorMessage' => 'Current DB instance CharacterType does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectEngineVersion', + 'errorMessage' => 'Current engine version does not support operations.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'Current DB instance state does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectDBInstanceLockMode', + 'errorMessage' => 'Current DB instance lock mode does not support this operation.', + 'description' => 'The current database instance locking mode does not support this operation.', + ], + ], + [ + [ + 'errorCode' => 'EnabledSSLNotSupport', + 'errorMessage' => 'Specified region does not support enable ssl.', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D806B11-078F-4154-BF9F-844F56D08964\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceSSL', + 'description' => 'Before you call the ModifyDBInstanceSSL operation, make sure that the instance meets the following requirements:'."\n" + ."\n" + .'- The instance is in the running state.'."\n" + ."\n" + .'- The instance is a replica set instance or a sharded cluster instance.'."\n" + ."\n" + .' - The replica set instance is version 3.4 or later.'."\n" + ."\n" + .' - The sharded cluster instance uses enhanced solid-state drives (ESSDs).'."\n" + ."\n" + .'> Enabling, updating, or disabling SSL restarts the instance. We recommend that you perform these operations during off-peak hours.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'ModifyDBInstanceSpec' => [ + 'summary' => 'Changes the instance type or storage capacity of an ApsaraDB for MongoDB standalone instance, replica set instance, or Serverless instance. Serverless instances are available only on the Alibaba Cloud China Website (www.aliyun.com).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '8330', + 'abilityTreeNodes' => [ + 'FEATUREmongodbX5X8MM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1ea17b41ab****', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type. <props="intl">For more information, see [Instance types](~~57141~~). You can also call the [DescribeAvailableResource](~~149719~~) operation to query instance types.</props><props="china"></props>'."\n" + ."\n" + .'- For standalone and replica set instances, this parameter specifies the instance type. For more information, see [Instance types](~~57141~~). You can also call the [DescribeAvailableResource](~~149719~~) operation to query the instance types of standalone and replica set instances.'."\n" + ."\n" + .'- For Serverless instances, this parameter specifies the computing capacity. Valid values: 100 to 8000.'."\n" + ."\n" + .'> Specify at least one of this parameter and the **DBInstanceStorage** parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.sn4.xlarge.1', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of the instance. <props="intl">The value must be in the range of 10 GB to 3,000 GB. The step size is 10 GB. The specific value is constrained by the instance type. For more information, see [Instance types](~~57141~~).</props>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- For standalone and replica set instances, the storage space must be from 10 GB to 3,000 GB. The step size is 10 GB. The maximum storage size depends on the instance type. For more information, see [Instance types](~~57141~~).'."\n" + ."\n" + .'- For Serverless instances, the storage space must be from 1 GB to 100 GB. The step size is 1 GB.'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'> - Specify at least one of this parameter and the **DBInstanceClass** parameter.'."\n" + .'>'."\n" + .'> - You cannot decrease the storage space.', + 'type' => 'string', + 'required' => false, + 'example' => '50', + 'title' => '', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of configuration change. Valid values:'."\n" + ."\n" + .'- **UPGRADE**: Upgrades the instance configurations. This is the default value.'."\n" + ."\n" + .'- **DOWNGRADE**: Downgrades the instance configurations.'."\n" + ."\n" + .'> This parameter is available only for subscription instances.', + 'type' => 'string', + 'required' => false, + 'default' => 'UPGRADE', + 'enum' => [ + 'UPGRADE', + 'DOWNGRADE', + ], + 'example' => 'UPGRADE', + 'title' => '', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-payment for the instance. Valid values:'."\n" + ."\n" + .'- **true**: Auto-payment is enabled. This is the default value. Ensure that your account has a sufficient balance.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **false**: Manual payment is required. To pay for the order, log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, choose **Expenses** > **Expenses and Costs**. In the navigation pane on the left, choose **Subscription Orders** > **My Orders**. On the **Product Orders** tab, find the order and complete the payment.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- **false**: Manual payment is required. To pay for the order, log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, choose **Expenses** > **Expenses and Costs**. In the navigation pane on the left, click **Order Management**. On the **Product Orders** page, find the order and complete the payment.'."\n" + ."\n" + .'</props>', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information.', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + 'title' => '', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes in the instance. The default value is 3.'."\n" + ."\n" + .'- For a replica set instance, valid values are **3**, **5**, and **7**.'."\n" + ."\n" + .'- For a standalone instance, the value is fixed at **1**.'."\n" + ."\n" + .'- For a replica set instance that uses shared storage (available only on the Alibaba Cloud China website (www\\.aliyun.com)), the value is fixed at **2**.'."\n" + ."\n" + .'> Do not configure this parameter for Serverless instances. Serverless instances are available only on the Alibaba Cloud China website (www\\.aliyun.com).', + 'type' => 'string', + 'required' => false, + 'default' => '3', + 'enum' => [ + '1', + '3', + '5', + '7', + '2', + ], + 'example' => '3', + 'title' => '', + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of read-only nodes. Valid values: **0** to **5**.'."\n" + ."\n" + .'If the instance is connected only using a classic network and a virtual private cloud (VPC), enable an internet endpoint or release the classic network endpoint before changing the number of read-only nodes.'."\n" + ."\n" + .'> Log on to the ApsaraDB for MongoDB console and view the enabled network types on the **Database Connection** page.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" + ."\n" + .'- **default** or **null**: Uses a coupon. This is the default value.'."\n" + ."\n" + .'- **youhuiquan\\_promotion\\_option\\_id\\_for\\_blank**: Does not use a coupon.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'title' => '', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the configuration change takes effect. Valid values:'."\n" + ."\n" + .'- **Immediately**: The change takes effect immediately. This is the default value.'."\n" + ."\n" + .'- **MaintainTime**: The change takes effect during the O\\&M window of the instance.', + 'type' => 'string', + 'required' => false, + 'default' => '0', + 'enum' => [ + 'Immediately', + 'MaintainTime', + '0', + '1', + ], + 'example' => 'Immediately', + 'title' => '', + ], + ], + [ + 'name' => 'ExtraParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'An additional parameter. Valid values:'."\n" + ."\n" + .'- **async**: The result is returned after the specification change order is created.'."\n" + ."\n" + .'- **sync**: The result is returned after the instance specifications are changed.', + 'enumValueTitles' => [ + 'async' => 'async', + 'sync' => 'sync', + ], + 'type' => 'string', + 'default' => 'async', + 'required' => false, + 'example' => 'async', + 'title' => '', + ], + ], + [ + 'name' => 'TargetZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination zone to which you want to migrate the instance. Specify this parameter when you change the instance specifications and migrate the instance across zones.'."\n" + .'><notice>This parameter is valid only for cloud disk instances.></notice>'."\n" + .'><notice>The value of this parameter cannot be the same as the value of the \\`TargetSecondaryZoneId\\` or \\`TargetHiddenZoneId\\` parameter.></notice>'."\n" + ."\n" + .'> - This parameter is required only when you change instance specifications and migrate the instance across zones.'."\n" + .'>'."\n" + .'> - The destination zone must be in the same region as the current zone of the instance.'."\n" + .'>'."\n" + .'> - Call the [DescribeRegions](~~61933~~) operation to query zone IDs.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + 'title' => '', + ], + ], + [ + 'name' => 'TargetSecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination zone of the secondary node. Specify this parameter when you change the instance specifications and migrate the instance across zones.'."\n" + .'><notice>This parameter is valid only for cloud disk instances.></notice>'."\n" + .'><notice>The value of this parameter cannot be the same as the value of the \\`TargetZoneId\\` or \\`TargetHiddenZoneId\\` parameter.></notice>'."\n" + ."\n" + .'> - This parameter is required only when you change instance specifications and migrate the instance across zones.'."\n" + .'>'."\n" + .'> - This parameter is available only for multi-zone migration.'."\n" + .'>'."\n" + .'> - The destination zone must be in the same region as the current zone of the instance.'."\n" + .'>'."\n" + .'> - Call the [DescribeRegions](~~61933~~) operation to query zone IDs.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + ], + [ + 'name' => 'TargetHiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination zone of the hidden node. Specify this parameter when you change the instance specifications and migrate the instance across zones.'."\n" + .'><notice>This parameter is valid only for cloud disk instances.></notice>'."\n" + .'><notice>The value of this parameter cannot be the same as the value of the \\`TargetZoneId\\` or \\`TargetSecondaryZoneId\\` parameter.></notice>'."\n" + ."\n" + .'> - This parameter is required only when you change instance specifications and migrate the instance across zones.'."\n" + .'>'."\n" + .'> - This parameter is available only for multi-zone migration.'."\n" + .'>'."\n" + .'> - The destination zone must be in the same region as the current zone of the instance.'."\n" + .'>'."\n" + .'> - Call the [DescribeRegions](~~61933~~) operation to query zone IDs.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + 'title' => '', + ], + ], + [ + 'name' => 'TargetVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination vSwitch. Specify this parameter when you change the instance specifications and migrate the instance across zones.'."\n" + .'><notice>This parameter is valid only for cloud disk instances.></notice>'."\n" + ."\n" + .'> - This parameter is required only when you change instance specifications and migrate the instance across zones.', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1buy0h9myt5i9e7****'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'SearchNodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the Search node.', + 'type' => 'string', + 'example' => 'mdb.shard.2x.xlarge.d', + 'title' => '', + 'required' => false, + ], + ], + [ + 'name' => 'SearchNodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of the Search node.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + 'title' => '', + 'required' => false, + ], + ], + [ + 'name' => 'SearchNodeCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of Search nodes.', + 'type' => 'integer', + 'format' => 'int64', + 'maximum' => '16', + 'minimum' => '2', + 'example' => '2', + 'title' => '', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '1E9F1104-19E7-59F0-AB7F-F4EBFDEA****', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'example' => '21012408824****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The input parameters DBInstanceClass and DBInstanceStorage all blank or no change.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidDBInstanceClass.ValueNotSupported', + 'errorMessage' => 'The specified parameter DBInstanceClass is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidDBInstanceStorage.ValueNotSupported', + 'errorMessage' => 'The specified parameter DBInstanceStorage is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'LX_REQUEST_TOKEN_CONFLICT', + 'errorMessage' => 'The request token is conflict.', + 'description' => '', + ], + [ + 'errorCode' => 'TradeConfirmPayError', + 'errorMessage' => 'BIZ_ERROR - degrade refund error', + 'description' => '', + ], + [ + 'errorCode' => 'PRICE.ORIGIN_PRICE_ERROR', + 'errorMessage' => 'Origin lingxiao price request error.', + 'description' => '', + ], + [ + 'errorCode' => 'ErrorInsufficientResource', + 'errorMessage' => 'There is not enough resource for your operation, requestId: %s.', + 'description' => 'There is not enough resource for your operation, requestId: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'The resource is out of usage.', + 'description' => '', + ], + [ + 'errorCode' => 'InvaildDBInstanceClassInRegion.NotAvailable', + 'errorMessage' => 'The DBInstanceClass in the Region is not available.', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E9F1104-19E7-59F0-AB7F-F4EBFDEA****\\",\\n \\"OrderId\\": \\"21012408824****\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceSpec', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props> of ApsaraDB for MongoDB.'."\n" + ."\n" + .'This operation applies only to ApsaraDB for MongoDB <props="china">standalone instances, replica set instances, and Serverless instances</props><props="intl">standalone instances and replica set instances</props>. To change the configuration of a sharded cluster instance, call the [ModifyNodeSpec](~~61923~~), [CreateNode](~~61911~~), [DeleteNode](~~61922~~), or [ModifyNodeSpecBatch](~~61816~~) operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceSpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + ], + 'ModifyDBInstanceTDE' => [ + 'summary' => 'Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8332', + 'abilityTreeNodes' => [ + 'FEATUREmongodbQ7EXOR', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'TDEStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The TDE status. Set the value to **enabled** to enable TDE.'."\n" + ."\n" + .'> You cannot disable TDE after you enable it. Enable this feature with caution.', + 'type' => 'string', + 'required' => true, + 'example' => 'enabled', + 'title' => '', + ], + ], + [ + 'name' => 'EncryptorName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method. Set the value to **aes-256-cbc**.'."\n" + ."\n" + .'> This parameter is available only when **TDEStatus** is set to **enabled**.', + 'type' => 'string', + 'required' => false, + 'example' => 'aes-256-cbc', + 'title' => '', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom key.'."\n" + .'Custom keys are supported only in the following regions. In other regions, the default key is used.'."\n" + ."\n" + .'- Singapore (ap-southeast-1)'."\n" + ."\n" + .'- Hangzhou (cn-hangzhou)'."\n" + ."\n" + .'- Shanghai (cn-shanghai)'."\n" + ."\n" + .'- Beijing (cn-beijing)'."\n" + ."\n" + .'- Shenzhen (cn-shenzhen)'."\n" + ."\n" + .'- Hong Kong (cn-hongkong)'."\n" + ."\n" + .'- Malaysia (ap-southeast-3)', + 'type' => 'string', + 'required' => false, + 'example' => '749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'RoleARN', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role. The format is `acs:ram::$accountID:role/$roleName `.'."\n" + ."\n" + .'> - `$accountID`: The ID of your Alibaba Cloud account. To view the ID, log on to the Alibaba Cloud Management Console, move the pointer over your profile picture in the upper-right corner, and then click Security Settings.'."\n" + .'>'."\n" + .'> - `$roleName`: The name of the RAM role. To view the name, log on to the RAM console, click RAM Role Management in the navigation pane on the left, and then view the role name in the RAM Role Name list.', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::123456789012****:role/adminrole ', + 'title' => '', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies when to enable TDE. Valid values:'."\n" + ."\n" + .'- 0: Enables TDE immediately.'."\n" + ."\n" + .'- 1: Enables TDE during the maintenance window.', + 'type' => 'string', + 'enum' => [ + '0', + '1', + ], + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '434D7127-6229-4355-BA50-7A3685A725DF', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UnsupportedDBTdeStatus', + 'errorMessage' => 'Specified DB TDEStatus does not support this operation.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'UnsupportedEngine', + 'errorMessage' => 'Current DB Instance engine does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectCharacterType', + 'errorMessage' => 'Current DB instance CharacterType does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectEngineVersion', + 'errorMessage' => 'Current engine version does not support operations.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectDBInstanceState', + 'errorMessage' => 'Current DB instance state does not support this operation.', + 'description' => '', + ], + [ + 'errorCode' => 'IncorrectDBInstanceLockMode', + 'errorMessage' => 'Current DB instance lock mode does not support this operation.', + 'description' => 'The current database instance locking mode does not support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidClusterKms', + 'errorMessage' => 'this cluster not kms service.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyDBInstanceTDE', + 'description' => 'Transparent Data Encryption (TDE) provides real-time I/O encryption and decryption for data files. Data is encrypted before it is written to a disk and decrypted when it is read from the disk into memory. For more information, see [Configure TDE](~~131048~~).'."\n" + ."\n" + .'> You cannot disable TDE after it is enabled.'."\n" + ."\n" + .'Before you call this operation, make sure that the instance meets the following requirements:'."\n" + ."\n" + .'- The instance is a replica set instance or a sharded cluster instance.'."\n" + ."\n" + .'- The instance uses the WiredTiger storage engine.'."\n" + ."\n" + .'- The instance uses local disks.'."\n" + ."\n" + .'- The instance runs MongoDB 4.0 or 4.2. If the instance runs an earlier version, you must upgrade the database version by calling the [UpgradeDBInstanceEngineVersion](~~67608~~) operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceTDE', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"434D7127-6229-4355-BA50-7A3685A725DF\\"\\n}","type":"json"}]', + ], + 'ModifyGlobalSecurityIPGroup' => [ + 'summary' => 'Modifies the global IP whitelist template associated with an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '168660', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dps', + 'maxLength' => 120, + 'minLength' => 2, + 'title' => '', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'g-fwjk62egbsrp4sftxmmr', + 'title' => '', + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP addresses in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP address whitelists.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '27.16.214.10,111.60.117.181', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A0181AC4-F186-46ED-87CA-100C70B86729', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', + 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Format', + 'errorMessage' => 'Specified security IP list format is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'ModifyGlobalSecurityIPGroup', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0181AC4-F186-46ED-87CA-100C70B86729\\"\\n}","type":"json"}]', + ], + 'ModifyGlobalSecurityIPGroupName' => [ + 'summary' => 'Modifies the name of a global IP whitelist template associated with an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '168661', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'- It can contain lowercase letters, digits, and underscores (\\_).'."\n" + ."\n" + .'- It must start with a letter and end with a letter or digit.'."\n" + ."\n" + .'- It must be 2 to 120 characters in length.', + 'type' => 'string', + 'required' => true, + 'maxLength' => 120, + 'minLength' => 2, + 'example' => 'prod_baoxian_k8s', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the IP whitelist template.', + 'type' => 'string', + 'required' => true, + 'example' => 'g-xmtncwkrzqqoe59dzljb', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'F8CA8312-530A-413A-9129-F2BB32A8D404', + 'title' => '', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'The global IP whitelist templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The global IP whitelist template.', + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the IP whitelist template.', + 'type' => 'string', + 'example' => 'g-qiawi8ec1urcx9swoy37', + 'title' => '', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the IP whitelist template.', + 'type' => 'string', + 'example' => 'def', + 'title' => '', + ], + 'GIpList' => [ + 'description' => 'The IP addresses in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP address whitelists.', + 'type' => 'string', + 'example' => '222.70.197.187', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.', + 'type' => 'string', + 'example' => 'cn-shanghai', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'ModifyGlobalSecurityIPGroupName', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroupName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8CA8312-530A-413A-9129-F2BB32A8D404\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-qiawi8ec1urcx9swoy37\\",\\n \\"GlobalIgName\\": \\"def\\",\\n \\"GIpList\\": \\"222.70.197.187\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ModifyGlobalSecurityIPGroupRelation' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze6069764423m0l', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'g-u0qdtybfvxhaxrrhk4n7', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'The specified parameters are invalid.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'ModifyGlobalSecurityIPGroupRelation', + 'summary' => 'Modifies the mapping between a global whitelist template and an ApsaraDB for MongoDB instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroupRelation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA\\"\\n}","type":"json"}]', + ], + 'ModifyInstanceAutoRenewalAttribute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8334', + 'abilityTreeNodes' => [ + 'FEATUREmongodb1FWAFI', + 'FEATUREmongodbWLAP0U', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the region ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp15da1923e3****', + 'title' => '', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The auto-renewal period. Valid values: **1** to **12**. Unit: month.'."\n" + ."\n" + .'> This parameter is valid only when **AutoRenew** is set to **true**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> If this parameter is set to **true**, you must set the **Duration** parameter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'true', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EFD65226-08CC-4C4D-B6A4-CB3C382F67B0', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => 'The instance ID does not exist.', + ], + [ + 'errorCode' => 'InvalidDbInstanceIdInvalid', + 'errorMessage' => 'Instance dbInstanceId is invalid.', + 'description' => '', + ], + [ + 'errorCode' => 'InstanceAutoRenewInvalid', + 'errorMessage' => 'Instance auto renewal is invalid.', + 'description' => '', + ], + [ + 'errorCode' => 'InstanceChargeTypeInvalid', + 'errorMessage' => 'Instance charge type is invalid.', + 'description' => 'The instance charge type is invalid.', + ], + [ + 'errorCode' => 'InvalidDuration.Invalid', + 'errorMessage' => 'Instance duration is invalid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'ClassicNetworkNotSupport', + 'errorMessage' => 'Classic network has not been supported, try to use VPC.', + 'description' => 'The current operation does not support classic network instances, please use VPC network.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ModifyInstanceAutoRenewalAttribute', + 'summary' => 'Enables or disables auto-renewal for an ApsaraDB for MongoDB instance.', + 'description' => 'Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).'."\n" + ."\n" + .'This operation is applicable to subscription instances.'."\n" + ."\n" + .'> When auto-renewal is enabled, your payment will be collected nine days before the expiration date of ApsaraDB for MongoDB. Ensure that your account has sufficient balance.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyInstanceAutoRenewalAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EFD65226-08CC-4C4D-B6A4-CB3C382F67B0\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceAutoRenewalAttributeResponse>\\n <RequestId>EFD65226-08CC-4C4D-B6A4-CB3C382F67B0</RequestId>\\n</ModifyInstanceAutoRenewalAttributeResponse>","errorExample":""}]', + ], + 'ModifyInstanceVpcAuthMode' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the mongos node in the sharded cluster instance.'."\n" + ."\n" + .'> This parameter can be used only when the instance type is sharded cluster.', + 'type' => 'string', + 'required' => false, + 'example' => 's-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'VpcAuthMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify whether to disable password-free access over VPC. Set the value to **Close**.', + 'type' => 'string', + 'required' => false, + 'example' => 'Close', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'BA51E9D9-B14A-4542-B6E6-7DE00BECCB8C', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ClassicNotSupport', + 'errorMessage' => 'Classic instance does not support this operation', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'InstanceCurrentKernelVersionNotSupport', + 'errorMessage' => 'Current DB instance CurrentKernelVersion does not support this operation.', + 'description' => 'Instance version outdated. This feature supports only instances of version 4.0 and later.', + ], + ], + ], + 'title' => 'ModifyInstanceVpcAuthMode', + 'summary' => 'Disables password-free access over Virtual Private Cloud (VPC) for an ApsaraDB for MongoDB instance.', + 'description' => 'Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:'."\n" + ."\n" + .'- The instance is a replica set or sharded cluster instance.'."\n" + ."\n" + .'- The database engine version of the instance is 4.0 (with the minor version of mongodb\\_20190408\\_3.0.11 or later) or 4.2. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine version of the instance.'."\n" + ."\n" + .'- The network type of the instance must be VPC. If the network type of the instance is classic network, you must call the [ModifyDBInstanceNetworkType](~~62138~~) operation to change the network type to VPC.'."\n" + ."\n" + .'- You can only disable but not enable password-free access over VPC.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyInstanceVpcAuthMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA51E9D9-B14A-4542-B6E6-7DE00BECCB8C\\"\\n}","type":"json"}]', + ], + 'ModifyNodeSpec' => [ + 'summary' => 'Changes the instance type and storage space of a node in a MongoDB sharded cluster instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'dds-bp1c0b990184****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard or Mongos node in the sharded cluster instance. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the node ID.'."\n" + ."\n" + .'> If you set this parameter to the ID of a shard node, you must also specify the **NodeStorage** parameter.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 's-bp143e1b1637****', + ], + ], + [ + 'name' => 'NodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the shard or Mongos node. For more information, see [Instance types](~~57141~~).', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'title' => '', + 'example' => 'dds.mongos.standard', + ], + ], + [ + 'name' => 'NodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage space of the shard node. The step size is 10. Unit: GB.'."\n" + ."\n" + .'- SSD local disk: **10** to **2000**.'."\n" + ."\n" + .'- ESSD PL1 disk: **20** to **16000**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '20', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A 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.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'FromApp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the request. Valid values:'."\n" + ."\n" + .'- **OpenApi**: The request is from OpenAPI.'."\n" + ."\n" + .'- **mongo\\_buy**: The request is from the console.', + 'type' => 'string', + 'required' => false, + 'default' => 'OpenApi', + 'title' => '', + 'example' => 'OpenApi', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" + ."\n" + .'- **true** (default): Enables automatic payment. Make sure that your account has a sufficient balance.'."\n" + ."\n" + .'- **false**: Disables automatic payment. You must manually pay for the order.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + 'title' => '', + 'example' => 'true', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The effective time of the configuration change. Valid values:'."\n" + ."\n" + .'- **Immediately** (default): The change takes effect immediately.'."\n" + ."\n" + .'- **MaintainTime**: The change takes effect during the O\\&M window of the instance.', + 'type' => 'string', + 'required' => false, + 'default' => 'Immediately', + 'enum' => [ + 'Immediately', + 'MaintainTime', + '0', + '1', + 'TimePoint', + '2', + ], + 'title' => '', + 'example' => 'Immediately', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the configuration change takes effect. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" + ."\n" + .'> This parameter is deprecated. Use the EffectiveTime parameter instead.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '2022-01-05T03:18:53Z', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order type. Valid values:'."\n" + ."\n" + .'- **UPGRADE**: upgrades the instance configuration.'."\n" + ."\n" + .'- **DOWNGRADE**: downgrades the instance configuration.', + 'type' => 'string', + 'required' => false, + 'default' => 'UPGRADE', + 'enum' => [ + 'UPGRADE', + 'DOWNGRADE', + ], + 'title' => '', + 'example' => 'UPGRADE', + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of read-only nodes in the shard node.'."\n" + ."\n" + .'Valid values: **0** to **5**. The value must be an integer.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5', + 'minimum' => '0', + 'title' => '', + 'example' => '5', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information. This is an additional parameter.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" + ."\n" + .'- **default** or **null** (default): A coupon is used.'."\n" + ."\n" + .'- **youhuiquan\\_promotion\\_option\\_id\\_for\\_blank**: A coupon is not used.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => 'default', + ], + ], + [ + 'name' => 'TargetZoneId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The primary zone to which you want to migrate the instance.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is applicable only to instances that use disks.'."\n" + ."\n" + .'></notice>', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'TargetSecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The secondary zone to which you want to migrate the instance.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is applicable only to instances that use disks.'."\n" + ."\n" + .'></notice>', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou-e', + ], + ], + [ + 'name' => 'TargetHiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The hidden zone to which you want to migrate the instance.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is applicable only to instances that use disks.'."\n" + ."\n" + .'></notice>', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'TargetVswitchId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The ID of the vSwitch in the destination zone.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is applicable only to instances that use disks.'."\n" + ."\n" + .'></notice>', + 'required' => false, + 'title' => '', + 'example' => 'vsw-xxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '61B05CCF-EBAB-4BF3-BA67-D77256A721E2', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'title' => '', + 'example' => '21084641369****', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GadInstanceNotSupport', + 'errorMessage' => 'GAD Instance doesn\'t support the operation.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyNodeSpec', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props> of MongoDB.'."\n" + ."\n" + .'> This operation is applicable only to sharded cluster instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyNodeSpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61B05CCF-EBAB-4BF3-BA67-D77256A721E2\\",\\n \\"OrderId\\": \\"21084641369****\\"\\n}","type":"json"}]', + ], + 'ModifyNodeSpecBatch' => [ + 'summary' => 'Changes the configuration of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAPXG80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~61933~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance for which you want to change configurations.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1337621e8f****', + 'title' => '', + ], + ], + [ + 'name' => 'NodesInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance types of the Mongos and shard nodes that you want to change. For more information, see [Instance types](~~57141~~).', + 'type' => 'string', + 'required' => true, + 'example' => '{"Shards":[{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp14ae4572fd****","Storage":20},{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp19f4f92dc5****","Storage":30}]}', + 'title' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A client token. It is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + 'title' => '', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" + ."\n" + .'- **true**: Automatic payment is enabled. Make sure that your account has a sufficient balance.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **false**: Manual payment is enabled. Log on to the ApsaraDB for MongoDB console. In the upper-right corner, choose **Expenses** > **Expenses and Costs**. In the navigation pane on the left, choose **Subscription Orders** > **My Orders**. On the **Product Orders** tab, find the target order and pay for it.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + ."\n" + .'- **false**: Manual payment is enabled. Log on to the ApsaraDB for MongoDB console. In the upper-right corner, choose **Expenses** > **Expenses and Costs**. In the navigation pane on the left, click **Order Management**. On the **Product Orders** page, find the target order and pay for it.'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'Default value: **true**.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The effective period of the configuration change. Valid values:'."\n" + ."\n" + .'- **Immediately**: The change takes effect immediately.'."\n" + ."\n" + .'- **MaintainTime**: The change takes effect during the maintenance window of the instance.'."\n" + ."\n" + .'> * You can call the [ModifyDBInstanceMaintainTime](~~62008~~) operation to change the maintenance window of an instance.'."\n" + .'>'."\n" + .'> * You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the maintenance window of an instance.'."\n" + ."\n" + .'Default value: **Immediately**.', + 'type' => 'string', + 'required' => false, + 'default' => 'Immediately', + 'example' => 'Immediately', + 'title' => '', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of configuration change. Valid values:'."\n" + ."\n" + .'- **UPGRADE**: Upgrades the instance configuration.'."\n" + ."\n" + .'- **DOWNGRADE**: Downgrades the instance configuration.'."\n" + ."\n" + .'> This parameter is available only when the billing method of the instance is subscription.', + 'type' => 'string', + 'required' => false, + 'default' => 'UPGRADE', + 'enum' => [ + 'UPGRADE', + 'DOWNGRADE', + ], + 'example' => 'UPGRADE', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" + ."\n" + .'- **default** or **null** (default): A coupon is used.'."\n" + ."\n" + .'- **youhuiquan\\_promotion\\_option\\_id\\_for\\_blank**: A coupon is not used.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information.', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + 'title' => '', + ], + ], + [ + 'name' => 'TargetVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination virtual switch for a configuration change that involves a zone migration.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter applies only to instances that use disks.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'> - This parameter is required only for a configuration change that involves a zone migration.', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'TargetHiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination zone of the hidden node for a configuration change that involves a zone migration.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter applies only to instances that use disks.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'The value of this parameter cannot be the same as the value of the TargetZoneId or TargetSecondaryZoneId parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'> - This parameter is required only for a configuration change that involves a zone migration.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-e', + 'title' => '', + ], + ], + [ + 'name' => 'TargetZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination zone of the primary node for a configuration change that involves a zone migration.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter applies only to instances that use disks.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'The value of this parameter cannot be the same as the value of the TargetSecondaryZoneId or TargetHiddenZoneId parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'> - This parameter is required only for a configuration change that involves a zone migration.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + ], + [ + 'name' => 'TargetSecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination zone of the secondary node for a configuration change that involves a zone migration.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter applies only to instances that use disks.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'The value of this parameter cannot be the same as the value of the TargetZoneId or TargetHiddenZoneId parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'> - This parameter is required only for a configuration change that involves a zone migration.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'example' => '21012719476****', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '0637BC25-6895-5500-871F-1127CA34****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GadInstanceNotSupport', + 'errorMessage' => 'GAD Instance doesn\'t support the operation.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyNodeSpecBatch', + 'description' => 'Before you call this operation, ensure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props> of ApsaraDB for MongoDB.'."\n" + ."\n" + .'This operation applies only to ApsaraDB for MongoDB sharded cluster instances.'."\n" + ."\n" + .'When you upgrade or downgrade multiple sharded cluster instances in a batch, the target instance types are subject to certain constraints. For example, if you expand storage capacity, the target capacity must be greater than or equal to the current capacity. If the instances have different instance types, the system randomly selects the instance type of one instance and applies its constraints to the entire batch. This may cause the upgrade or downgrade to fail. If you cannot upgrade or downgrade instances in a batch, you can use the ModifyNodeSpec operation to change the configuration of a single sharded cluster instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyNodeSpecBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"21012719476****\\",\\n \\"RequestId\\": \\"0637BC25-6895-5500-871F-1127CA34****\\"\\n}","type":"json"}]', + ], + 'ModifyParameters' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8337', + 'abilityTreeNodes' => [ + 'FEATUREmongodbDMJK05', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. To query the latest region list, call the [DescribeRegions](~~61933~~) operation.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> If this parameter is a sharded cluster instance ID, you must also specify the NodeId parameter.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'dds-bp19f409d75****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the mongos or shard node in the sharded cluster instance.'."\n" + ."\n" + .'> This parameter is active only when the DBInstanceId parameter is set to a sharded cluster instance ID.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'd-bp1b7bb3bbe****', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parameters and their new values. The value must be a JSON string. Example: {"ParameterName1":"ParameterValue1","ParameterName2":"ParameterValue2"}.'."\n" + ."\n" + .'> Call the [DescribeParameterTemplates](~~67618~~) operation to query the list of default parameter templates.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => '{"operationProfiling.mode":"all","operationProfiling.slowOpThresholdMs":"200"}', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'- **db**: shard node.'."\n" + ."\n" + .'- **cs**: Configserver node.'."\n" + ."\n" + .'- **mongos**: mongos node.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'db', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => 'The time to apply the parameter modifications. Valid values:'."\n" + ."\n" + .'- 0: Immediately.'."\n" + ."\n" + .'- 1: During the maintenance window.', + 'required' => false, + 'enumValueTitles' => [ + '0', + '1', + ], + 'title' => '', + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '36923CC2-DDAB-4B48-A144-DA92C1E19537', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => 'The parameter entered is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterForInstanceVersion', + 'errorMessage' => 'Parameter %s is not valid for instance\'s MinorVersion.', + 'description' => 'Parameter %s is not valid for the instance\'s minor version，you can try to upgrade the mini version.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter %s is not valid.', + 'description' => 'The specified parameter %s is not valid.', + ], + [ + 'errorCode' => 'OplogSizeLowerThanInstanceStorage', + 'errorMessage' => 'The oplogSizeMB parameter entered is less than 10% of the instance store size.', + 'description' => 'The oplogSizeMB parameter entered is less than 10% of the instance store size.', + ], + ], + ], + 'title' => 'ModifyParameters', + 'summary' => 'Modifies the parameters of an ApsaraDB for MongoDB instance.', + 'description' => '- When you call this operation, the instance status must be running.'."\n" + .'- If you call this operation to modify specific instance parameters that require a restart to take effect, the instance is automatically restarted after the operation is called. You can call the [DescribeParameterTemplates](~~67618~~) operation to identify which parameters require an instance restart to take effect after modification.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36923CC2-DDAB-4B48-A144-DA92C1E19537\\"\\n}","type":"json"}]', + ], + 'ModifyResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query the region ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1366caac83****', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. For more information, see [View basic information of a resource group](~~151181~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '5DD0DEC3-24A1-5268-8E0B-5B264CA1****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceGroupId.InValid', + 'errorMessage' => 'The Specified ResourceGroupId is not valid.', + 'description' => 'The specified ResourceGroupId is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidStatus.NotFound', + 'errorMessage' => 'Instance status is invalid.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifyResourceGroup', + 'summary' => 'Moves an ApsaraDB for MongoDB instance to a specified resource group.', + 'description' => 'Resource Management allows you to build an organizational structure for resources based on your business requirements. You can use resource directories, folders, accounts, and resource groups to hierarchically organize and manage resources. For more information, see [What is Resource Management?](~~94475~~)', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5DD0DEC3-24A1-5268-8E0B-5B264CA1****\\"\\n}","type":"json"}]', + ], + 'ModifySecurityGroupConfiguration' => [ + 'summary' => 'You can call this operation to modify an ECS Security group that is bound to an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREmongodb99MGX1', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ECS security group.'."\n" + ."\n" + .'> - You can bind up to 10 ECS security groups to an ApsaraDB for MongoDB instance.'."\n" + .'>'."\n" + .'> - You can call the [DescribeSecurityGroup](~~25556~~) operation of ECS to query the security groups in the specified region.', + 'type' => 'string', + 'required' => true, + 'example' => 'sg-bpxxxxxxxx', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'E062C482-1A4B-469E-938C-96D28CFAE42E', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingInstanceId', + 'errorMessage' => 'InstanceId is mandatory for this action.', + 'description' => '', + ], + [ + 'errorCode' => 'InstanceStatusInvalid', + 'errorMessage' => 'Instance status is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Specified ecs security group id is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidIzNo.NotSupported', + 'errorMessage' => 'the Specified Zone not supported.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidRegion_Zone_NotFound', + 'errorMessage' => 'Specified Region does not exist in RDS.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidVpc.NotSupported', + 'errorMessage' => 'the Different vpc not supported.', + 'description' => 'Different VPCs are not supported.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AssociatedEcsSecurityGroupId.QuotaExceed', + 'errorMessage' => 'SecurityGroupIdQuotaExceeded exceeding the allowed amount of SecurityGroupId.', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'InvalidInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidRegionZoneNotFound', + 'errorMessage' => 'Specified Region does not exist in RDS.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifySecurityGroupConfiguration', + 'description' => '> For a sharded cluster instance, the bound ECS security group takes effect only for mongos nodes.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifySecurityGroupConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E062C482-1A4B-469E-938C-96D28CFAE42E\\"\\n}","type":"json"}]', + ], + 'ModifySecurityIps' => [ + 'summary' => 'Modifies the IP address whitelist of an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '95113', + 'abilityTreeNodes' => [ + 'FEATUREmongodbMMIA04', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dds-bp*****', + 'title' => '', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP addresses in the IP address whitelist. Separate multiple IP addresses with commas (,). You can add a maximum of 1,000 different IP addresses to the IP address whitelist. The entries in the IP address whitelist must be in one of the following formats:'."\n" + ."\n" + .'- IP addresses, such as 127.0.0.1.'."\n" + ."\n" + .'- CIDR blocks, such as 127.0.0.1/24. In this example, 24 indicates that the prefix of each IP address in the IP address whitelist is 24 bits in length. You can replace 24 with a value within the range of 1 to 32.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '127.0.0.1/24,127.0.0.1', + 'title' => '', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method that is used to modify the IP address whitelist. Valid values:'."\n" + ."\n" + .'- **Cover**: overwrites the original IP address whitelist.'."\n" + ."\n" + .'- **Append**: appends data to the IP address whitelist.'."\n" + ."\n" + .'- **Delete**: deletes the IP address whitelist.'."\n" + ."\n" + .'Default value: **Cover**.', + 'type' => 'string', + 'required' => false, + 'default' => '0', + 'enum' => [ + 'Cover', + 'Append', + 'Delete', + 'Extend', + ], + 'example' => 'Append', + 'title' => '', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP address whitelist that you want to modify. Default value: **default**.', + 'type' => 'string', + 'required' => false, + 'example' => 'allowserver', + 'title' => '', + ], + ], + [ + 'name' => 'SecurityIpGroupAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => 'The attribute of the IP address whitelist. It can contain a maximum of 120 characters in length and can contain uppercase letters, lowercase letters, and digits.'."\n" + ."\n" + .'This parameter is empty by default.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '61B05CCF-EBAB-4BF3-BA67-D77256A721E2', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSecurityIps.MalFormed', + 'errorMessage' => 'The specified parameter "SecurityIps" is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidSecurityIPListLength.Malformed', + 'errorMessage' => 'The Security IP address is not in the available range or occupied.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidInstanceIp.Duplicate', + 'errorMessage' => 'The quota of security ip exceeds.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidGroupName.Format', + 'errorMessage' => 'Sepecified group name is not valid.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidSecurityIPs.NotFound', + 'errorMessage' => 'The Specified same security IP does not exist or at least one security IP need.', + 'description' => '', + ], + ], + ], + 'title' => 'ModifySecurityIps', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifySecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61B05CCF-EBAB-4BF3-BA67-D77256A721E2\\"\\n}","type":"json"}]', + ], + 'ModifySrvNetworkAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '261954', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAOTVP9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1fd530f271****', + 'title' => '', + ], + ], + [ + 'name' => 'NewConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new connection address. The address must meet the following requirements:'."\n" + ."\n" + .'- Starts with a lowercase letter.'."\n" + ."\n" + .'- Ends with a lowercase letter or a digit.'."\n" + ."\n" + .'- Contains only lowercase letters, digits, and hyphens (-).'."\n" + ."\n" + .'- Is 8 to 63 characters in length.'."\n" + ."\n" + .'> You only need to specify the prefix of the connection address. The rest of the address cannot be modified.', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyuntest111', + 'title' => '', + ], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the SRV connection address to modify. Valid values:'."\n" + ."\n" + .'- **VPC**: virtual private cloud (VPC)'."\n" + ."\n" + .'- **Public**: Internet connection', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'VPC', + 'Public', + ], + 'example' => 'VPC', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '45D2B592-DEBA-4347-BBF3-xxxxxC97DBBC', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NewConnectionString.NotSupport', + 'errorMessage' => 'Specified newConnectionString is not supported.', + 'description' => 'newConnectionString format', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'currentConnectionString is mandatory for this action.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidConnectionStringOrPort.Duplicate', + 'errorMessage' => 'Specified connection string or port already exists.', + 'description' => 'The specified connection string or port information already exists, please check and resubmit.', + ], + ], + ], + 'title' => 'ModifySrvNetworkAddress', + 'summary' => 'Modifies the SRV connection address of a MongoDB instance.', + 'description' => 'This operation applies only to replica set instances and sharded cluster instances that use disks.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifySrvNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D2B592-DEBA-4347-BBF3-xxxxxC97DBBC\\"\\n}","type":"json"}]', + ], + 'ModifyTaskInfo' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '141283', + 'abilityTreeNodes' => [ + 'FEATUREmongodbKYZJ28', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~61933~~) operation to query the region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID. Separate multiple IDs with commas (,). You can specify up to 10 task IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't-83br18hlpdrw3uxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'StepName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the step visible to the user.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exec_task'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'TaskAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action name that corresponds to the state described in the actionInfo parameter of the [DescribeHistoryTasks](~~2639186~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'modifySwitchTime', + 'title' => '', + ], + ], + [ + 'name' => 'ActionParams', + 'in' => 'query', + 'schema' => [ + 'description' => 'A action-related parameter. This parameter can be extended based on your business requirements. This parameter value varies with the value of the TaskAction parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"recoverMode\\":\\"immediate\\"}', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6163731A-XXXX-XXXX-B934-3388DE70C217', + 'title' => '', + ], + 'ErrorTaskId' => [ + 'description' => 'The ID of the failed task. The operation returns results after a task fails.'."\n", + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + 'SuccessCount' => [ + 'description' => 'The number of successful tasks.'."\n", + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'ErrorCode' => [ + 'description' => 'The error code for the failed task. It is the same as that of the ModifyTaskInfo operation.'."\n", + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'title' => 'ModifyTaskInfo', + 'summary' => 'Modifies the information of a task in the task center for an ApsaraDB for MongoDB instance.', + 'description' => 'The actions performed by this operation for a task vary based on the current state of the task. The supported actions for a task can be obtained from the value of the actionInfo parameter in the DescribeHistoryTasks operation.'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyTaskInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6163731A-XXXX-XXXX-B934-3388DE70C217\\",\\n \\"ErrorTaskId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"SuccessCount\\": \\"1\\",\\n \\"ErrorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + ], + 'ReleaseNodePrivateNetworkAddress' => [ + 'summary' => 'Releases the internal endpoint of a shard or Configserver node for a sharded cluster instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '8346', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAOTVP9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the sharded cluster instance.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'dds-bp1a7009eb24****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard or Configserver node.'."\n" + ."\n" + .'> Call the [DescribeDBInstanceAttribute](~~62010~~) API to query the ID of the shard or Configserver node.'."\n" + .'>'."\n" + .'> ><notice>'."\n" + .'>'."\n" + .'> When you release an SRV address, enter the instance ID for this parameter.'."\n" + .'>'."\n" + .'> ></notice>', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'd-bp128a003436****', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the internal endpoint for the node. Valid values:'."\n" + ."\n" + .'- **VPC**: virtual private cloud.'."\n" + ."\n" + .'- **Classic**: classic network.'."\n" + ."\n" + .'> Call the [DescribeShardingNetworkAddress](~~62135~~) API to query the network type of the internal endpoint for the node.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'VPC', + ], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The type of the public endpoint. Valid values:'."\n" + ."\n" + .'- **SRV**'."\n" + ."\n" + .'- **Normal**'."\n" + ."\n" + .'> This parameter is available only when the endpoint to be released is an SRV endpoint.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'SRV', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '0FDDC511-7252-4A4A-ADDA-5CB1BF63873D', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GadInstanceNotSupport', + 'errorMessage' => 'GAD Instance doesn\'t support the operation.', + 'description' => '', + ], + ], + ], + 'title' => 'ReleaseNodePrivateNetworkAddress', + 'description' => '- This operation releases the internal endpoint of a shard or Configserver node for a sharded cluster instance. For more information, see [Release the endpoint of a shard or Configserver node](~~134067~~).'."\n" + ."\n" + .'- To release the public endpoint of a shard or Configserver node for a sharded cluster instance, call the [ReleasePublicNetworkAddress](~~67604~~) operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ReleaseNodePrivateNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FDDC511-7252-4A4A-ADDA-5CB1BF63873D\\"\\n}","type":"json"}]', + ], + 'ReleasePublicNetworkAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8347', + 'abilityTreeNodes' => [ + 'FEATUREmongodbAOTVP9', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the mongos, shard, or Configserver node in the sharded cluster instance.'."\n" + ."\n" + .'> - This parameter is valid only if you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.'."\n" + .'>'."\n" + .'> - You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the ID of the mongos, shard, or Configserver node.', + 'type' => 'string', + 'required' => false, + 'example' => 's-bp2235****', + 'title' => '', + ], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The public endpoint type. Valid values:'."\n" + ."\n" + .'- **SRV**'."\n" + ."\n" + .'- **Normal**'."\n" + ."\n" + .'> This parameter is valid only when you want to release an SRV endpoint.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'SRV', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '1D6AFE36-1AF5-4DE4-A954-672159D4CC69', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'ReleasePublicNetworkAddress', + 'summary' => 'Releases the public endpoint of an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ReleasePublicNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1D6AFE36-1AF5-4DE4-A954-672159D4CC69\\"\\n}","type":"json"}]', + ], + 'RenewDBInstance' => [ + 'summary' => 'Manually renews an ApsaraDB for MongoDB subscription instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREmongodb1FWAFI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + '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 the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription period of the instance. Unit: month. Valid values: **1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" + ."\n" + .'- **true**: enables automatic payment. Make sure that you have sufficient balance within your account.'."\n" + ."\n" + .'- **false**: disables automatic payment. You must perform the following operations to pay for the instance: Log on to the ApsaraDB for MongoDB console. In the upper-right corner, click **Expenses** and select **User Center** from the drop-down list. The User Center page appears. In the left-side navigation pane, choose **Order Management** > Renew. On the Renewal tab, find the bill that you want to pay and then click Renew in the Actions column.'."\n" + ."\n" + .'Default value: **true**.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information.', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use coupons. Default value: null. Valid values:'."\n" + ."\n" + .'- **default** or **null**: uses coupons.'."\n" + ."\n" + .'- **youhuiquan\\_promotion\\_option\\_id\\_for\\_blank**: does not use coupons.', + 'type' => 'string', + 'required' => false, + 'default' => 'youhuiquan_promotion_option_id_for_blank', + 'example' => 'default', + 'title' => '', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**'."\n" + ."\n" + .'Default value: **false**.', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'type' => 'boolean', + 'default' => 'false', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'B118EF45-9633-4EE3-8405-42ED4373721B', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.', + 'type' => 'string', + 'example' => '203317xxxxxxxx', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TokenServiceError', + 'errorMessage' => 'Request token is duplicated.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'ClassicNetworkNotSupport', + 'errorMessage' => 'Classic network has not been supported, try to use VPC.', + 'description' => 'The current operation does not support classic network instances, please use VPC network.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'RenewDBInstance', + 'description' => 'Make sure that you fully understand the billing methods and pricing of ApsaraDB for MongoDB before you call this operation. For more information about the pricing of ApsaraDB for MongoDB, visit the [pricing tab of the product buy page](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).'."\n" + ."\n" + .'This operation is only applicable to instances that use the subscription billing method.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:RenewDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B118EF45-9633-4EE3-8405-42ED4373721B\\",\\n \\"OrderId\\": \\"203317xxxxxxxx\\"\\n}","type":"json"}]', + ], + 'ResetAccountPassword' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account whose password needs to be reset. Set the value to **root**.', + 'type' => 'string', + 'required' => true, + 'example' => 'root', + 'title' => '', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new password.'."\n" + ."\n" + .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `! # $ % ^ & * ( ) _ + - =`'."\n" + ."\n" + .'- The password must be 8 to 32 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => 'Ali!123456', + 'title' => '', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The role of the instance.'."\n" + ."\n" + .'- If the instance is a sharded cluster instance, this parameter is required. Valid values: db and cs.'."\n" + ."\n" + .'- If the instance is a replica set instance, you can leave this parameter empty or set the parameter to normal.', + 'type' => 'string', + 'enum' => [ + 'db', + 'cs', + 'normal', + ], + 'required' => false, + 'example' => 'db', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '06CBD06E-ABC9-4121-AB93-3C3820B3E7E6', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'Specified parameter AccountPassword is not valid.', + 'description' => 'The specified parameter AccountPassword is invalid.', + ], + [ + 'errorCode' => 'InvalidAccountName.NotFound', + 'errorMessage' => 'The AccountName provided does not exist in our records.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.AccountStatus', + 'errorMessage' => 'The operation is not permitted due to status of account. ', + 'description' => '', + ], + [ + 'errorCode' => 'OperationDenied.AccountType', + 'errorMessage' => 'The operation is not permitted due to type of account. ', + 'description' => '', + ], + ], + ], + 'title' => 'ResetAccountPassword', + 'summary' => 'Resets the password of the root account in an ApsaraDB for MongoDB instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ResetAccountPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06CBD06E-ABC9-4121-AB93-3C3820B3E7E6\\"\\n}","type":"json"}]', + ], + 'RestartDBInstance' => [ + 'summary' => 'Restarts an ApsaraDB for MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8351', + 'abilityTreeNodes' => [ + 'FEATUREmongodbH52V88', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a shard or Mongos node in a sharded cluster instance.'."\n" + ."\n" + .'> If you do not specify this parameter for a sharded cluster instance, the entire instance is restarted.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time to restart the instance. Valid values:'."\n" + ."\n" + .'- 0: The instance is restarted immediately.'."\n" + ."\n" + .'- 1: The instance is restarted within the maintenance window.', + 'type' => 'string', + 'enum' => [ + '0', + '1', + ], + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '149C517D-B586-47BE-A107-8673E0ED77C6', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'RestartDBInstance', + 'description' => 'You can call this operation to restart an instance. You can also restart a shard or Mongos node in a sharded cluster instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:RestartDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"149C517D-B586-47BE-A107-8673E0ED77C6\\"\\n}","type":"json"}]', + ], + 'RestartNode' => [ + 'summary' => 'Restarts a single node of a MongoDB instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '221031', + 'abilityTreeNodes' => [ + 'FEATUREmongodbH52V88', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> If the instance is a sharded cluster instance, also set the `NodeId` parameter.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Mongos, shard, or Configserver node in the sharded cluster instance. Call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the node ID.'."\n" + ."\n" + .'> This parameter is required if **DBInstanceId** is set to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp128a003436****', + 'title' => '', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role ID of the node.'."\n" + ."\n" + .'1. Call the [DescribeReplicaSetRole](~~468469~~) operation to query the role ID of a node in a replica set instance.'."\n" + ."\n" + .'2. Call the [DescribeRoleZoneInfo](~~468472~~) operation to query the role ID of a node in a sharded cluster instance.', + 'type' => 'string', + 'required' => true, + 'example' => '6025****', + 'title' => '', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time to execute the task. Valid values:'."\n" + ."\n" + .'- **0**: The task is executed immediately. This is the default value.'."\n" + ."\n" + .'- **1**: The task is executed during the maintenance window.'."\n" + ."\n" + .'> Call the [ModifyInstanceMaintainTime](~~473775~~) operation to modify the maintenance window of the instance.', + 'type' => 'string', + 'enum' => [ + '0', + '1', + ], + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'ECBCA991-XXXX-XXXX-834C-B3E8007F33AA', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'RestartNode', + 'description' => 'Limitations:'."\n" + ."\n" + .'- The instance must be in the Running state.'."\n" + ."\n" + .'- The instance must be a standard replica set instance or a sharded cluster instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:RestartNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ECBCA991-XXXX-XXXX-834C-B3E8007F33AA\\"\\n}","type":"json"}]', + ], + 'SwitchDBInstanceHA' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shard node in the sharded cluster instance.'."\n" + ."\n" + .'> You must specify this parameter if you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'RoleIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the roles who switch the primary and secondary nodes for the instance. You can call the [DescribeRoleZoneInfo](~~123802~~) operation to view the IDs and information of roles of nodes.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- Separate role IDs with commas (,). If this parameter is not specified, the primary and secondary nodes are switched.'."\n" + ."\n" + .'- If you set the **DBInstanceId** parameter to the ID of a sharded cluster instance, the roles who switch the primary and secondary nodes for the instance must belong to one shard node.', + 'type' => 'string', + 'required' => false, + 'example' => '972xxxx,972xxxx', + 'title' => '', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the primary and secondary nodes are switched. Valid values:'."\n" + ."\n" + .'- 0: The primary and secondary nodes are immediately switched.'."\n" + ."\n" + .'- 1: The primary and secondary nodes are switched during the O\\&M time period.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + 'example' => '0', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '26BD4E5F-BDB4-47BA-B232-413AA78CFA8F', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSwitchType', + 'errorMessage' => 'Specified Swtich Type is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'Specified Instance ID is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'HaStatusNotSupport', + 'errorMessage' => 'Current DB instance HA status does not support this operation.', + 'description' => '', + ], + ], + ], + 'title' => 'SwitchDBInstanceHA', + 'summary' => 'Switches the primary and secondary nodes for an ApsaraDB for MongoDB instance.', + 'description' => 'The instance must be running when you call this operation.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- This operation is applicable to replica set instances and sharded cluster instances, but cannot be performed on standalone instances.'."\n" + ."\n" + .'- On replica set instances, the switch is performed between instances. On sharded cluster instances, the switch is performed between shards.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:SwitchDBInstanceHA', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"26BD4E5F-BDB4-47BA-B232-413AA78CFA8F\\"\\n}","type":"json"}]', + ], + 'TagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8356', + 'abilityTreeNodes' => [ + 'FEATUREmongodbS7K03T', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the region ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to **INSTANCE**.', + 'type' => 'string', + 'required' => true, + 'example' => 'INSTANCE', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details of the tags bound to the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of instance.'."\n" + ."\n" + .'N specifies the serial number of the instance. The following example shows how to calculate consumption intervals:'."\n" + ."\n" + .'- **ResourceId.1** indicates the ID of the first instance.'."\n" + ."\n" + .'- **ResourceId.2** indicates the ID of the second instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp1fa5efaa93****', + 'title' => '', + ], + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'maxItems' => 51, + 'title' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags that are attached to the resources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag.'."\n" + ."\n" + .'N specifies the serial number of the tag. The following example shows how to calculate consumption intervals:'."\n" + ."\n" + .'- **Tag.1.Key** specifies the key of the first tag.'."\n" + ."\n" + .'- **Tag.2.Key** specifies the key of the second tag.', + 'type' => 'string', + 'required' => true, + 'example' => '开发组', + 'title' => '', + ], + 'Value' => [ + 'description' => 'The value of tag.'."\n" + ."\n" + .'N specifies the serial number of the tag. The following example shows how to calculate consumption intervals:'."\n" + ."\n" + .'- **Tag.1.Value** specifies the value of the first tag.'."\n" + ."\n" + .'- **Tag.2.Value** specifies the value of the second tag.', + 'type' => 'string', + 'required' => true, + 'example' => '4.0环境', + 'title' => '', + ], + ], + 'required' => false, + 'description' => 'The details of the tags bound to the instance.', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 21, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '0FDDC511-7252-4A4A-ADDA-5CB1BF63****', + 'title' => '', + ], + ], + 'description' => 'The information of parameters that is returned.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidTagValue.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Value\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceId', + 'errorMessage' => 'The specified parameter \'ResourceId.n\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'MissParameter.TagOrResourceId', + 'errorMessage' => 'The parameter \'Tag.n\'\' or \'ResourceId.n\' is needed.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.Scope', + 'errorMessage' => 'The specified parameter \'Scope\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', + 'description' => '', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed.', + 'description' => '', + ], + [ + 'errorCode' => 'NumberExceed.CustomTags', + 'errorMessage' => 'The Custom Tags parameter\'s number is exceed. Valid 20.', + 'description' => '', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' is duplicated.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The specified parameter \'ResourceType\' is not valid.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '', + ], + ], + ], + 'title' => 'TagResources', + 'summary' => 'Binds tags to ApsaraDB for MongoDB instances.', + 'description' => 'If you have a large number of instances, you can create multiple tags, bind the tags to the instances, and filter the instances by tag.'."\n" + ."\n" + .'- A tag consists of a key and a value. Each key must be unique in a region for an Alibaba Cloud account. Different keys can be mapped to the same value.'."\n" + ."\n" + .'- If the tag that you specify does not exist, this tag is automatically created and bound to the specified instance.'."\n" + ."\n" + .'- If a tag that has the same key is already bound to the instance, the new tag overwrites the existing tag.'."\n" + ."\n" + .'- You can bind up to 20 tags to each instance.'."\n" + ."\n" + .'- You can bind tags to up to 50 instances each time you call the operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FDDC511-7252-4A4A-ADDA-5CB1BF63****\\"\\n}","type":"json"}]', + ], + 'TransferClusterBackup' => [ + 'summary' => 'Switches the backup mode of an ApsaraDB for MongoDB sharded cluster instance to the cluster backup mode. After the instance is switched to the cluster backup mode, the instance supports high-frequency backup.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AlreadyDone' => [ + 'description' => 'Indicates whether the instance is switched to the cluster backup mode. If the value of this parameter is **1**, the instance is switched to the cluster backup mode.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '3C4A2494-85C4-45C5-93CF-548DB3375193', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'TransferClusterBackup', + 'description' => '- The instance is an ApsaraDB for MongoDB sharded cluster instance that runs MongoDB 4.4 or later and uses enhanced SSDs (ESSDs) to store data.'."\n" + ."\n" + .'- You can call the TransferClusterBackup operation only for instances that are created before October 19, 2023 to switch the instances to the cluster backup mode. Cloud disk-based sharded cluster instances that are created on or after October 19, 2023 are set to the cluster backup mode by default.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:TransferClusterBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlreadyDone\\": \\"1\\",\\n \\"RequestId\\": \\"3C4A2494-85C4-45C5-93CF-548DB3375193\\"\\n}","type":"json"}]', + ], + 'TransformInstanceChargeType' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWLAP0U', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze55b3ec56c****', + 'title' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the instance. Unit: months. Valid values: **1, 2, 3, 4, 5, 6, 7, 8, 9**\\*\\*\\*\\*, **12**, **24**, and **36**.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**'."\n" + ."\n" + .'> Default value: **true**.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information. This is an additional parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + 'title' => '', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**'."\n" + ."\n" + .'> Default value: **false**.', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.', + 'type' => 'string', + 'required' => false, + 'default' => 'youhuiquan_promotion_option_id_for_blank', + 'example' => 'default', + 'title' => '', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PrePaid:** subscription.'."\n" + ."\n" + .'- **PostPaid:** pay-as-you-go.', + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'PrePaid', + 'PostPaid', + 'PREPAY', + 'POSTPAY', + ], + 'example' => 'PrePaid', + 'title' => '', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '实例付费时长单位'."\n" + .'取值说明：'."\n" + ."\n" + .'- **Month：** 月'."\n" + ."\n" + .'- **Year：** 年'."\n" + ."\n" + .'默认值：Month', + 'type' => 'string', + 'example' => 'Month', + 'default' => 'Month', + 'enum' => [ + 'Month', + 'Year', + ], + 'required' => false, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'string', + 'example' => '21084641369****', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Period is mandatory for this action.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Period is invalid', + 'description' => '', + ], + [ + 'errorCode' => 'ResourceNotAvailable', + 'errorMessage' => 'Resource you requested is not available for finance user.', + 'description' => '', + ], + [ + 'errorCode' => 'InsufficientBalance', + 'errorMessage' => 'Your account does not have enough balance.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'AlreadyPrePaid', + 'errorMessage' => 'This instance is already prepaid', + 'description' => 'The instance already uses the subscription billing method.', + ], + [ + 'errorCode' => 'RealNameAuthenticationError', + 'errorMessage' => 'Your account has not passed the real-name authentication yet.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'TransformInstanceChargeType', + 'summary' => 'Changes the billing method of an instance from pay-as-you-go to subscription or from subscription to pay-as-you-go.', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB'."\n" + ."\n" + .'Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:'."\n" + ."\n" + .'- The instance is in the Running state.'."\n" + ."\n" + .'- Your instance has no unpaid billing method change orders.'."\n" + ."\n" + .'- The instance type is available for purchase. For more information about unavailable instance types, see [Instance types](~~57141~~).'."\n" + ."\n" + .'> To change the billing method of an instance whose instance type is no longer available to purchase, call the [ModifyDBInstanceSpec](~~61816~~) or [ModifyNodeSpec](~~61923~~) operation to change the instance type first.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:TransformInstanceChargeType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D8F1D721-6439-4257-A89C-F1E8E9C9****\\",\\n \\"OrderId\\": \\"21084641369****\\"\\n}","type":"json"}]', + ], + 'TransformToPrePaid' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREmongodbWLAP0U', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1366caac83****', + 'title' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the instance. Unit: months. Valid values: **1**, **2**, **3**, **4**, **5**, **6**, **7**, **8**, **9**, **12**, **24**, and **36**.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" + ."\n" + .'- **true**: enables automatic payment.'."\n" + ."\n" + .'- **false**: disables automatic payment. For more information, see [Renew an ApsaraDB for MongoDB subscription instance](~~85052~~).'."\n" + ."\n" + .'> Default value: **true**.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information. This is an additional parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + 'title' => '', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**'."\n" + ."\n" + .'> Default value: **false**.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.', + 'type' => 'string', + 'required' => false, + 'default' => 'youhuiquan_promotion_option_id_for_blank', + 'example' => 'default', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '2F42BB4E-461F-5B55-A37C-53B1141C****', + 'title' => '', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.', + 'type' => 'string', + 'example' => '21022019252****', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Period is mandatory for this action.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Period is invalid', + 'description' => '', + ], + [ + 'errorCode' => 'ResourceNotAvailable', + 'errorMessage' => 'Resource you requested is not available for finance user.', + 'description' => '', + ], + [ + 'errorCode' => 'InsufficientBalance', + 'errorMessage' => 'Your account does not have enough balance.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'AlreadyPrePaid', + 'errorMessage' => 'This instance is already prepaid', + 'description' => 'The instance already uses the subscription billing method.', + ], + [ + 'errorCode' => 'RealNameAuthenticationError', + 'errorMessage' => 'Your account has not passed the real-name authentication yet.', + 'description' => '', + ], + ], + ], + 'title' => 'TransformToPrePaid', + 'summary' => 'Changes the billing method of an ApsaraDB for MongoDB instance from pay-as-you-go to subscription.', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).'."\n" + ."\n" + .'A subscription instance cannot be changed to a pay-as-you-go instance. To avoid wasting resources, proceed with caution.'."\n" + ."\n" + .'Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:'."\n" + ."\n" + .'- The instance is in the running state.'."\n" + ."\n" + .'- The billing method of the instance is pay-as-you-go.'."\n" + ."\n" + .'- The instance has no unpaid subscription orders.'."\n" + ."\n" + .'- The instance type is available for purchase. For more information about unavailable instance types, see [Instance types](~~57141~~).'."\n" + ."\n" + .'> To change the billing method of an instance whose instance type is no longer available to subscription, call the [ModifyDBInstanceSpec](~~61816~~) or [ModifyNodeSpec](~~61923~~) operation to first change the instance type.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:TransformToPrePaid', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2F42BB4E-461F-5B55-A37C-53B1141C****\\",\\n \\"OrderId\\": \\"21022019252****\\"\\n}","type":"json"}]', + ], + 'UntagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the region ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to **INSTANCE**.', + 'type' => 'string', + 'required' => true, + 'example' => 'INSTANCE', + 'title' => '', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove all tags from the instances. Valid values:'."\n" + ."\n" + .'- **true**: removes all tags from the instances.'."\n" + ."\n" + .'- **false**: does not remove all tags from the instances.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- Default value: **false**.'."\n" + ."\n" + .'- If you specify the **TagKey** parameter together with this parameter, this parameter does not take effect.', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bpxxxxxxxxxxxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The resource IDs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource.', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'maxItems' => 51, + 'title' => '', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tag keys of the resource.', + 'type' => 'array', + 'items' => [ + 'description' => 'The key of the tag.', + 'type' => 'string', + 'required' => false, + 'example' => 'PRODUCT', + 'title' => '', + ], + 'required' => false, + 'example' => '开发组', + 'maxItems' => 21, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'FA3A7F36-DB57-4281-8935-4B9DF61554EB', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidTagValue.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Value\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceId', + 'errorMessage' => 'The specified parameter \'ResourceId.n\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'MissParameter.TagOrResourceId', + 'errorMessage' => 'The parameter \'Tag.n\'\' or \'ResourceId.n\' is needed.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.Scope', + 'errorMessage' => 'The specified parameter \'Scope\' is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', + 'description' => '', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed.', + 'description' => '', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' is duplicated.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The specified parameter \'ResourceType\' is not valid.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '', + ], + ], + ], + 'title' => 'UntagResources', + 'summary' => 'Removes a tag if the tag is not added to another instance.', + 'description' => '>'."\n" + ."\n" + .'- You can remove up to 20 tags at a time.'."\n" + ."\n" + .'- If you remove a tag from all instances, the tag is automatically deleted.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA3A7F36-DB57-4281-8935-4B9DF61554EB\\"\\n}","type":"json"}]', + ], + 'UpgradeDBInstanceEngineVersion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8360', + 'abilityTreeNodes' => [ + 'FEATUREmongodbB76JNZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database version to which you want to upgrade. Valid values: **3.4**, **4.0**, and **4.2**.'."\n" + ."\n" + .'> This database version must be later than the current database version of the instance.', + 'enumValueTitles' => [ + '4.0' => '4.0', + '5.0' => '5.0', + '4.2' => '4.2', + '6.0' => '6.0', + '7.0' => '7.0', + '4.4' => '4.4', + '8.0' => '8.0', + ], + 'type' => 'string', + 'required' => true, + 'enum' => [ + '3.4', + '4.0', + '4.2', + '4.4', + '5.0', + '6.0', + '7.0', + '8.0', + ], + 'example' => '4.0', + 'title' => '', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when to perform the upgrade. Valid values:'."\n" + ."\n" + .'- **0**: immediately performs the upgrade.'."\n" + ."\n" + .'- **1**: performs the upgrade during the maintenance window.', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1', + 'minimum' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'C4907B00-A208-4E0C-A636-AA85140E406C', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineVersion.ERROR', + 'errorMessage' => 'Target engineVersion must be greater than the current one.', + 'description' => '', + ], + ], + ], + 'title' => 'UpgradeDBInstanceEngineVersion', + 'summary' => 'Upgrades the database version of an ApsaraDB for MongoDB instance.', + 'description' => 'The instance must be in the running state when you call this operation.'."\n" + ."\n" + .'> - The available database versions depend on the storage engine used by the instance. For more information, see [Upgrades of MongoDB major versions](~~398673~~). You can also call the [DescribeAvailableEngineVersion](~~141355~~) operation to query the available database versions.'."\n" + .'>'."\n" + .'> - You cannot downgrade the MongoDB version of an instance after you upgrade it.'."\n" + .'>'."\n" + .'> - The instance is automatically restarted for two to three times during the upgrade process. Make sure that you upgrade the instance during off-peak hours.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:UpgradeDBInstanceEngineVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C4907B00-A208-4E0C-A636-AA85140E406C\\"\\n}","type":"json"}]', + ], + 'UpgradeDBInstanceKernelVersion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8361', + 'abilityTreeNodes' => [ + 'FEATUREmongodbB76JNZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + 'title' => '', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when to perform the upgrade. Valid values:'."\n" + ."\n" + .'* **0**: immediately performs the upgrade.'."\n" + .'* **1**: performs the upgrade during the maintenance window.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'maxLength' => 1, + 'minLength' => 0, + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '27B9A130-7C4B-40D9-84E8-2FC081097AAC', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'UpgradeDBInstanceKernelVersion', + 'summary' => 'Upgrades the minor version of an ApsaraDB for MongoDB instance.', + 'description' => 'When you call the UpgradeDBInstanceKernelVersion operation, the instance must be in the Running state.'."\n" + ."\n" + .'> * The UpgradeDBInstanceKernelVersion operation is applicable to replica set and sharded cluster instances, but not to standalone instances.'."\n" + .'> * The instance will be restarted once during the upgrade. Call this operation during off-peak hours.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:UpgradeDBInstanceKernelVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"27B9A130-7C4B-40D9-84E8-2FC081097AAC\\"\\n}","errorExample":""},{"type":"xml","example":"<UpgradeDBInstanceKernelVersionResponse>\\n <RequestId>27B9A130-7C4B-40D9-84E8-2FC081097AAC</RequestId>\\n</UpgradeDBInstanceKernelVersionResponse>","errorExample":""}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-heyuan', + 'regionName' => 'China (Heyuan)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'regionName' => 'China (Ulanqab)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-beijing', + 'regionName' => 'China (Beijing)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-zhengzhou-jva.aliyuncs.com', + 'endpoint' => 'mongodb.cn-zhengzhou-jva.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'regionName' => 'China (Qingdao)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-qingdao.aliyuncs.com', + 'endpoint' => 'mongodb.cn-qingdao.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'regionName' => 'China (Wuhan - Local Region)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-wuhan-lr.aliyuncs.com', + 'endpoint' => 'mongodb.cn-wuhan-lr.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'regionName' => 'China (Shanghai)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'regionName' => 'China (Hong Kong)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-hongkong.aliyuncs.com', + 'endpoint' => 'mongodb.cn-hongkong.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'regionName' => 'China (Zhangjiakou)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-zhangjiakou.aliyuncs.com', + 'endpoint' => 'mongodb.cn-zhangjiakou.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'regionName' => 'China (Shenzhen)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'regionName' => 'China (Nanjing - Local Region)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-nanjing.aliyuncs.com', + 'endpoint' => 'mongodb.cn-nanjing.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'regionName' => 'South Korea (Seoul)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.ap-northeast-2.aliyuncs.com', + 'endpoint' => 'mongodb.ap-northeast-2.aliyuncs.com', + 'vpc' => 'mongodb-vpc.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'regionName' => 'Japan (Tokyo)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.ap-northeast-1.aliyuncs.com', + 'endpoint' => 'mongodb.ap-northeast-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'regionName' => 'China (Fuzhou - Local Region)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-fuzhou.aliyuncs.com', + 'endpoint' => 'mongodb.cn-fuzhou.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'regionName' => 'China (Chengdu)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-chengdu.aliyuncs.com', + 'endpoint' => 'mongodb.cn-chengdu.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'regionName' => 'China (Guangzhou)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-guangzhou.aliyuncs.com', + 'endpoint' => 'mongodb.cn-guangzhou.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'regionName' => 'Singapore', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.ap-southeast-1.aliyuncs.com', + 'endpoint' => 'mongodb.ap-southeast-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'regionName' => 'Australia (Sydney) Closed', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.ap-southeast-2.aliyuncs.com', + 'endpoint' => 'mongodb.ap-southeast-2.aliyuncs.com', + 'vpc' => 'mongodb-vpc.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'regionName' => 'Malaysia (Kuala Lumpur)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.ap-southeast-3.aliyuncs.com', + 'endpoint' => 'mongodb.ap-southeast-3.aliyuncs.com', + 'vpc' => 'mongodb-vpc.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'regionName' => 'China (Hohhot)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.cn-huhehaote.aliyuncs.com', + 'endpoint' => 'mongodb.cn-huhehaote.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'regionName' => 'Indonesia (Jakarta)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.ap-southeast-5.aliyuncs.com', + 'endpoint' => 'mongodb.ap-southeast-5.aliyuncs.com', + 'vpc' => 'mongodb-vpc.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'regionName' => 'Philippines (Manila)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.ap-southeast-6.aliyuncs.com', + 'endpoint' => 'mongodb.ap-southeast-6.aliyuncs.com', + 'vpc' => 'mongodb-vpc.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'regionName' => 'Thailand (Bangkok)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.ap-southeast-7.aliyuncs.com', + 'endpoint' => 'mongodb.ap-southeast-7.aliyuncs.com', + 'vpc' => 'mongodb-vpc.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'regionName' => 'China (Hangzhou)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'regionName' => 'US (Virginia)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'mongodb.us-east-1.aliyuncs.com', + 'endpoint' => 'mongodb.us-east-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'regionName' => 'UK (London)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'mongodb.eu-west-1.aliyuncs.com', + 'endpoint' => 'mongodb.eu-west-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'regionName' => 'US (Silicon Valley)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'mongodb.us-west-1.aliyuncs.com', + 'endpoint' => 'mongodb.us-west-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'regionName' => 'Germany (Frankfurt)', + 'areaId' => 'europeAmerica', + 'areaName' => 'Europe & Americas', + 'public' => 'mongodb.eu-central-1.aliyuncs.com', + 'endpoint' => 'mongodb.eu-central-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'regionName' => 'UAE (Dubai)', + 'areaId' => 'middleEast', + 'areaName' => 'Middle East', + 'public' => 'mongodb.me-east-1.aliyuncs.com', + 'endpoint' => 'mongodb.me-east-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'regionName' => 'Saudi Arabia (Riyadh)', + 'areaId' => 'middleEast', + 'areaName' => 'Middle East', + 'public' => 'mongodb.me-central-1.aliyuncs.com', + 'endpoint' => 'mongodb.me-central-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'regionName' => 'India (Mumbai) Closed', + 'areaId' => 'middleEast', + 'areaName' => 'Middle East', + 'public' => 'mongodb.ap-south-1.aliyuncs.com', + 'endpoint' => 'mongodb.ap-south-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'regionName' => 'China East 1 Finance', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'regionName' => 'China South 1 Finance', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'mongodb.cn-shenzhen-finance-1.aliyuncs.com', + 'endpoint' => 'mongodb.cn-shenzhen-finance-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'regionName' => 'China North 2 Finance (Preview)', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'mongodb.cn-beijing-finance-1.aliyuncs.com', + 'endpoint' => 'mongodb.cn-beijing-finance-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'regionName' => 'China East 2 Finance', + 'areaId' => 'industryCloud', + 'areaName' => 'Industry Cloud', + 'public' => 'mongodb.cn-shanghai-finance-1.aliyuncs.com', + 'endpoint' => 'mongodb.cn-shanghai-finance-1.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-shanghai-finance-1.aliyuncs.com', + ], + ], + 'errorCodes' => [ + [ + 'code' => 'Abs.InvalidAccount.NotFound', + 'message' => 'account is not found.', + 'http_code' => 400, + 'description' => 'The account does not exist.', + ], + [ + 'code' => 'AccountNoPermission', + 'message' => 'Account has no permission to refund.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'AccountNotExists', + 'message' => 'Account not exists.', + 'http_code' => 404, + 'description' => 'Account information does not exist.', + ], + [ + 'code' => 'ADSDiskEncryptionSLRNotExist', + 'message' => 'SLR for [diskencryption.aliyuncs.com] do not exist, please create it first.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'ALI_CROUP_2_CLOUD_USER_CANNOT_BUY_NOT_INNER_COMMODITY', + 'message' => 'Internal users of the company are not allowed to buy.', + 'http_code' => 400, + 'description' => 'Internal users of the company are not allowed to buy.', + ], + [ + 'code' => 'AlreadyPostPaid', + 'message' => 'This instance is already postpaid.', + 'http_code' => 400, + 'description' => 'the current instance is a pay-as-you-go instance.', + ], + [ + 'code' => 'AlreadyPrePaid', + 'message' => 'This instance is already prepaid', + 'http_code' => 403, + 'description' => 'The instance already uses the subscription billing method.', + ], + [ + 'code' => 'ARTICLE_NOT_FOUND', + 'message' => 'CommodityCode cannot be found.', + 'http_code' => 400, + 'description' => 'CommodityCode cannot be found.', + ], + [ + 'code' => 'BackupAttachLogStatusNotSupported', + 'message' => 'The backup\'s attachLog status is not supported for CrossBackup operation.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'BackupExpireTimeExceedLimit', + 'message' => 'The backup expiration time exceeds the backup time plus 730 days.', + 'http_code' => 400, + 'description' => 'When modifying the expiration time of backup, it cannot exceed the backup time plus 730 days.', + ], + [ + 'code' => 'BackupIntervalNotSupport', + 'message' => 'BackupInterval must be -1 when SnapshotBackupType is Standard.', + 'http_code' => 400, + 'description' => 'When SnapshotBackupType is standard, the BackupInterval must be -1.', + ], + [ + 'code' => 'BackupJobExists', + 'message' => 'A backup job already exists in the specified DB instance.', + 'http_code' => 400, + 'description' => 'The specified instance already has the same backup task.', + ], + [ + 'code' => 'BackupLogInvalid', + 'message' => 'Specified parameter EnableBackupLog or EnableCrossLogBackup is invalid.', + 'http_code' => 400, + 'description' => 'The specified parameter EnableBackupLog or EnableCrossLogBackup is invalid.', + ], + [ + 'code' => 'CAN_NOT_FIND_SUBSCRIPTION', + 'message' => 'No ordering information found.', + 'http_code' => 400, + 'description' => 'No ordering information found.', + ], + [ + 'code' => 'ChargeTypeViolation', + 'message' => 'The operation is not permitted due to charge type of the instance.', + 'http_code' => 400, + 'description' => 'The operation is not permitted due to charge type of the instance.', + ], + [ + 'code' => 'ClassicNetWorkExistFault', + 'message' => 'The classic network you are trying to switch already exists.', + 'http_code' => 400, + 'description' => 'The classic network you are trying to switch to already exists.', + ], + [ + 'code' => 'ClassicNetworkNotSupport', + 'message' => 'Classic network has not been supported, try to use VPC.', + 'http_code' => 403, + 'description' => 'The current operation does not support classic network instances, please use VPC network.', + ], + [ + 'code' => 'ClassicNotSupport', + 'message' => 'Classic instance does not support this operation.', + 'http_code' => 400, + 'description' => 'Classic instances do not support this operation', + ], + [ + 'code' => 'Config.Error', + 'message' => 'Config error.', + 'http_code' => 400, + 'description' => 'Configuration error.', + ], + [ + 'code' => 'ConfigServer.Error', + 'message' => 'ConfigServer error.', + 'http_code' => 400, + 'description' => 'ConfigServer error.', + ], + [ + 'code' => 'CrossBackupPeriodInvalid', + 'message' => 'CrossBackupPeriod must be a subset of PreferredBackupPeriod.', + 'http_code' => 400, + 'description' => 'CrossBackupPeriod must be a subset of the PreferredBackup Period', + ], + [ + 'code' => 'CrossRegionTransNotAllowed', + 'message' => 'Cross region instance trans is not supported.', + 'http_code' => 404, + 'description' => 'Cross-region instance conversion is not supported', + ], + [ + 'code' => 'DataBasesNotExist', + 'message' => 'The DataBase info used for flashback does not exist.', + 'http_code' => 400, + 'description' => 'The database information used for flashback does not exist.', + ], + [ + 'code' => 'DataList.Limit', + 'message' => 'The items of Datalist cannot exceed 1000.', + 'http_code' => 400, + 'description' => 'The data list cannot have more than 1000 items.', + ], + [ + 'code' => 'DbDeleteError', + 'message' => 'Database delete error.', + 'http_code' => 400, + 'description' => 'The number of VPC cloud instance IDs obtained is incorrect.', + ], + [ + 'code' => 'DbInsertError', + 'message' => 'Database insert error.', + 'http_code' => 404, + 'description' => 'Insert database exception.', + ], + [ + 'code' => 'DbUpdateError', + 'message' => 'Database update error.', + 'http_code' => 404, + 'description' => '', + ], + [ + 'code' => 'DescribeKMSException', + 'message' => 'The request processing has failed due to some unknown error, exception or failure.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'DowngradeStorageNotSupported', + 'message' => 'The downgrading dbInstance storage does not supported.', + 'http_code' => 400, + 'description' => 'You cannot downgrade the disk capacity for the instance.', + ], + [ + 'code' => 'DryRunOperation', + 'message' => 'Request validation has been passed with DryRun flag set.', + 'http_code' => 400, + 'description' => 'The request was validated and the DryRun flag was set.', + ], + [ + 'code' => 'DynamodbNotSupport', + 'message' => 'Dynamodb Instance not support this operation.', + 'http_code' => 400, + 'description' => 'DynamoDB-compatible instances do not support this operation.', + ], + [ + 'code' => 'Ecs_Transform_Forbidden_On_Instance_Clone', + 'message' => 'Ecs/No-Ecs instance can\'t transform to No-Ecs/Ecs one on cloning.', + 'http_code' => 400, + 'description' => 'Non-single-node and single-node instances do not allow conversion', + ], + [ + 'code' => 'EngineVersion.ERROR', + 'message' => 'Target engineVersion must be greater than the current one.', + 'http_code' => 400, + 'description' => 'The target engine version must be greater than the current version.', + ], + [ + 'code' => 'EngineVersionNotSupport', + 'message' => 'Specified EngineVersion not support this operation.', + 'http_code' => 400, + 'description' => 'The specified EngineVersion does not support this operation.', + ], + [ + 'code' => 'EOFSNotSupport', + 'message' => 'The instance is at the End of Full Support (EOFS) stage.', + 'http_code' => 403, + 'description' => 'EOFS is turned off and cannot be supported.', + ], + [ + 'code' => 'ErrorInsufficientResource', + 'message' => 'There is not enough resource for your operation, requestId: %s.', + 'http_code' => 400, + 'description' => 'There is not enough resource for your operation, requestId: %s.', + ], + [ + 'code' => 'ExpireDays.Invalid', + 'message' => 'Specified expire days is not valid.', + 'http_code' => 400, + 'description' => 'The specified expiration date is invalid.', + ], + [ + 'code' => 'Forbidden', + 'message' => 'User not authorized to operate on the specified resource.', + 'http_code' => 403, + 'description' => '', + ], + [ + 'code' => 'Forbidden.RegionNotFound', + 'message' => 'Specified region is not found during access authentication.', + 'http_code' => 403, + 'description' => 'There is no access authentication in the current zone.', + ], + [ + 'code' => 'Forbidden.ZoneIdNotFound', + 'message' => 'Specified zoneId is not found during access authentication.', + 'http_code' => 404, + 'description' => '', + ], + [ + 'code' => 'Frequency.limit', + 'message' => 'The current interface has exceeded the access limit.', + 'http_code' => 400, + 'description' => 'The current interface has exceeded the access limit!', + ], + [ + 'code' => 'GranularityParamNotMatch', + 'message' => 'The granularity param not match.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'HiddenZone.Closed', + 'message' => 'Specified HiddenZone is closed.', + 'http_code' => 400, + 'description' => 'The selected hidden zone is closed.', + ], + [ + 'code' => 'IncorrectBackupSetMethod', + 'message' => 'Current backup set method does not support operations.', + 'http_code' => 403, + 'description' => 'The current Backup Set method does not support the operation.', + ], + [ + 'code' => 'IncorrectCharacterType', + 'message' => 'Current DB instance CharacterType does not support this operation.', + 'http_code' => 400, + 'description' => 'The character type of the current instance does not allow the current operation.', + ], + [ + 'code' => 'IncorrectDBInstanceLockMode', + 'message' => 'Current DB instance lock mode does not support this operation.', + 'http_code' => 403, + 'description' => 'The current database instance locking mode does not support this operation.', + ], + [ + 'code' => 'IncorrectDBInstanceState', + 'message' => 'Current DB instance state does not support this operation.', + 'http_code' => 403, + 'description' => '', + ], + [ + 'code' => 'IncorrectMasterDBInstanceState', + 'message' => 'The Master instance state does not support this operation.', + 'http_code' => 404, + 'description' => 'This operation is not supported in the master instance state.', + ], + [ + 'code' => 'IncorrectVswitchId', + 'message' => 'The specified parameter \'VSwitchId\' is not valid.', + 'http_code' => 400, + 'description' => 'When the current instance is a VPC instance, the VSwitchId parameter cannot be empty.', + ], + [ + 'code' => 'InstanceAutoRenewInvalid', + 'message' => 'Instance auto ApiRenewal is invalid.', + 'http_code' => 400, + 'description' => 'autoRenew parameter cannot be empty.', + ], + [ + 'code' => 'InstanceChargeTypeInvalid', + 'message' => 'Instance charge type is invalid.', + 'http_code' => 400, + 'description' => 'The instance charge type is invalid.', + ], + [ + 'code' => 'InstanceChargeTypeNotSupport', + 'message' => 'Instance charge type does not support this operation.', + 'http_code' => 400, + 'description' => 'The instance charge type does not support this operation.', + ], + [ + 'code' => 'InstanceClassNotSupport', + 'message' => 'The input ConfigServer class Mongo class and shard class not support .', + 'http_code' => 400, + 'description' => 'The input ConfigServer class, mongo class, and shard class are not supported.', + ], + [ + 'code' => 'InstanceCurrentKernelVersionNotSupport', + 'message' => 'Current DB instance CurrentKernelVersion does not support this operation.', + 'http_code' => 403, + 'description' => 'Instance version outdated. This feature supports only instances of version 4.0 and later.', + ], + [ + 'code' => 'InstanceReleaseProtection', + 'message' => 'The operation is not permitted due to instance release protection.', + 'http_code' => 400, + 'description' => 'The operation cannot be performed because release protection is enabled for the instance. To release the instance, disable release protection for the instance first.', + ], + [ + 'code' => 'InstanceSpecInvalid', + 'message' => 'The input parameters DBInstanceClass and DBInstanceStorage no change.', + 'http_code' => 400, + 'description' => 'The input parameters DBInstanceClass and DBInstanceStorage are unchanged.', + ], + [ + 'code' => 'InstanceStatusInvalid', + 'message' => 'Instance status is invalid.', + 'http_code' => 404, + 'description' => 'The instance is not in the running state.', + ], + [ + 'code' => 'InstanceTypeNotMatch', + 'message' => 'Specified instance\'s type does not matched.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'InstanceTypeNotSupport', + 'message' => 'Instance type does not support this operator.', + 'http_code' => 400, + 'description' => 'The instance type does not allow the current operation.', + ], + [ + 'code' => 'InstanceVpcAuthMode.NotSupported', + 'message' => 'Instance VpcAuthMode is NotSupported.', + 'http_code' => 400, + 'description' => 'This operation is not supported for a VPC password-free logon instance.', + ], + [ + 'code' => 'InsType.NotSupport', + 'message' => 'Specified instance type dose not support this operation.', + 'http_code' => 400, + 'description' => 'The specified instance type does not support this operation.', + ], + [ + 'code' => 'InsufficientResourceCapacity', + 'message' => 'There is insufficient capacity available for the requested instance.', + 'http_code' => 400, + 'description' => 'Insufficient resources in the specified region or zone. Specify another zone or submit a ticket.', + ], + [ + 'code' => 'InternalError', + 'message' => 'The request processing has failed due to some unknown error, exception or failure.', + 'http_code' => 400, + 'description' => 'An internal error occurred. Please try again later.', + ], + [ + 'code' => 'InternalFailure', + 'message' => 'The request processing has failed due to some unknown error, exception or failure.', + 'http_code' => 500, + 'description' => 'Service exception.', + ], + [ + 'code' => 'InvalidAccount.NotFound', + 'message' => 'account is not found.', + 'http_code' => 400, + 'description' => 'The account does not exist.', + ], + [ + 'code' => 'InvalidAccountDescription.Malformed', + 'message' => 'Specified parameter AccountDescription is not valid.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'InvalidAccountName.Forbid', + 'message' => 'Specified account name is a keyword.', + 'http_code' => 400, + 'description' => 'The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.', + ], + [ + 'code' => 'InvalidAccountName.Malformed', + 'message' => 'Specified parameter AccountName is not valid.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'InvalidAccountName.NotFound', + 'message' => 'Specified account name does not exist.', + 'http_code' => 404, + 'description' => 'AccountName not entered or entered incorrectly.', + ], + [ + 'code' => 'InvalidAccountPassword.Format', + 'message' => 'Specified account password is not valid.', + 'http_code' => 400, + 'description' => 'The specified account password is invalid.', + ], + [ + 'code' => 'InvalidAccountPassword.Malformed', + 'message' => 'Specified parameter AccountPassword is not valid.', + 'http_code' => 400, + 'description' => 'The specified parameter AccountPassword is invalid.', + ], + [ + 'code' => 'InvalidAction', + 'message' => 'Specified action is not valid.', + 'http_code' => 400, + 'description' => 'Service exception.', + ], + [ + 'code' => 'InvalidBackup.NotFound', + 'message' => 'Theavailable backup does not exist in recovery time.', + 'http_code' => 404, + 'description' => 'No backup set is available during the specified recovery period.', + ], + [ + 'code' => 'InvalidBackupLogStatus', + 'message' => 'Current backup log enable status does not support this operation.', + 'http_code' => 403, + 'description' => 'The operation is not supported when log backup is enabled.', + ], + [ + 'code' => 'InvalidBackupSet.NotMatched', + 'message' => 'Specified backup set does not match instance.', + 'http_code' => 400, + 'description' => 'Unmatched backup set ID.', + ], + [ + 'code' => 'InvalidCertExpiredTime', + 'message' => 'The provided SSL certificate is expired or not yet valid.', + 'http_code' => 400, + 'description' => 'The ssl certificate provided has expired or is invalid.', + ], + [ + 'code' => 'InvalidCharacterType', + 'message' => 'Specified characterType is not valid.', + 'http_code' => 400, + 'description' => 'The specified character type is invalid.', + ], + [ + 'code' => 'InvalidCommodityCode.Forbid', + 'message' => 'The specified parameter CommodityCode is not valid.', + 'http_code' => 400, + 'description' => 'The specified CommodityCode parameter is invalid. Specify a valid commodity code.', + ], + [ + 'code' => 'InvalidConnectionStringOrPort.Duplicate', + 'message' => 'Specified connection string or port already exists.', + 'http_code' => 400, + 'description' => 'The specified connection string or port information already exists, please check and resubmit.', + ], + [ + 'code' => 'InvalidDbInstance.isFound', + 'message' => 'The current instance already exists.', + 'http_code' => 400, + 'description' => 'The current instance already exists. Do not re-create it.', + ], + [ + 'code' => 'InvalidDBInstanceClass.NotFound', + 'message' => 'The specified DB instance type is not found.', + 'http_code' => 404, + 'description' => 'Invalid instance type. Specify another instance type.', + ], + [ + 'code' => 'InvalidDBInstanceDescription.Malformed', + 'message' => 'Specified parameter DBInstanceDescription is not valid.', + 'http_code' => 400, + 'description' => 'Invalid node name.', + ], + [ + 'code' => 'InvalidDBInstanceId.NotFound', + 'message' => 'Specified instance does not exist.', + 'http_code' => 400, + 'description' => 'Instance not found. Refresh the page to check whether the instance has been released.', + ], + [ + 'code' => 'InvalidDBInstanceId.NotFound', + 'message' => 'An error occurs when you query the instance information. Try again later.', + 'http_code' => 400, + 'description' => 'Failed to query the instance information. Try again later.', + ], + [ + 'code' => 'InvalidDbInstanceId.NotFound', + 'message' => 'Specified instance does not exist.', + 'http_code' => 400, + 'description' => 'The instance ID does not exist.', + ], + [ + 'code' => 'InvalidDbInstanceIdInvalid', + 'message' => 'Instance dbInstanceId is invalid.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'InvalidDBName', + 'message' => 'The specified database name is not allowed.', + 'http_code' => 403, + 'description' => 'The specified database name is invalid.', + ], + [ + 'code' => 'InvalidDuation.Invalid', + 'message' => 'Instance duation is invalid.', + 'http_code' => 400, + 'description' => 'Duration parameter is empty or invalid.', + ], + [ + 'code' => 'InvalidDuration.Invalid', + 'message' => 'Instance duration is invalid.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'InvalidEffectiveTime.Malformed', + 'message' => 'Specified EffectiveTime is not valid.', + 'http_code' => 404, + 'description' => 'The EffectiveTime parameter is empty.', + ], + [ + 'code' => 'InvalidEndTime.Malformed', + 'message' => 'The Specified parameter \\”EndTime\\” is not valid', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'InvalidInstanceId', + 'message' => 'DBInstanceIdentifier does not refer to an existing DB instance.', + 'http_code' => 400, + 'description' => 'DBInstanceIdentifier does not refer to an existing DB instance.', + ], + [ + 'code' => 'InvalidInstanceIp.Duplicate', + 'message' => 'Invalid security IP list specified, duplicated.', + 'http_code' => 400, + 'description' => 'Duplicate IP addresses in the whitelist.', + ], + [ + 'code' => 'InvalidIzNo.NotSupported', + 'message' => 'the Specified vpc Zone not supported.', + 'http_code' => 404, + 'description' => 'The specified zone is not supported.', + ], + [ + 'code' => 'InvalidKernelReleaseNotes', + 'message' => 'The format of specified KernelVersion is invalid.', + 'http_code' => 400, + 'description' => 'The specified minor version is invalid.', + ], + [ + 'code' => 'InvalidKmsKey', + 'message' => 'Kms key is disabled.', + 'http_code' => 400, + 'description' => 'The kms key is not available.', + ], + [ + 'code' => 'InvalidLogBackupRetentionPeriod.Malformed', + 'message' => 'Specified log retention period is not valid.', + 'http_code' => 400, + 'description' => 'Invalid log backup retention days.', + ], + [ + 'code' => 'InvalidMeta.TooLarge', + 'message' => 'Meta information is too large.', + 'http_code' => 403, + 'description' => 'The metadata is too large.', + ], + [ + 'code' => 'InvalidParameter', + 'message' => 'The specified parameter %s is not valid.', + 'http_code' => 400, + 'description' => 'The specified parameter %s is not valid.', + ], + [ + 'code' => 'InvalidParameter.%s', + 'message' => 'Parameter %s is not valid for instance\'s MinorVersion.', + 'http_code' => 400, + 'description' => 'Parameter %s is not valid for the instance\'s minor version，you can try to upgrade the mini version', + ], + [ + 'code' => 'InvalidParameterCombination', + 'message' => 'The end time must be greater than the start time', + 'http_code' => 400, + 'description' => 'The start time must be earlier than the end time.', + ], + [ + 'code' => 'InvalidParameterCombination', + 'message' => 'The end time must be greater than the start time.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'InvalidParameterForInstanceVersion', + 'message' => 'Parameter %s is not valid for instance\'s MinorVersion.', + 'http_code' => 400, + 'description' => 'Parameter %s is not valid for the instance\'s minor version，you can try to upgrade the mini version.', + ], + [ + 'code' => 'InvalidParameters.Format', + 'message' => 'Specified parameters is not valid.', + 'http_code' => 400, + 'description' => 'The parameter entered is invalid.', + ], + [ + 'code' => 'InvalidPerfData', + 'message' => 'The obtained instance performance data is invalid.', + 'http_code' => 403, + 'description' => 'The obtained instance performance data is invalid.', + ], + [ + 'code' => 'InvalidProvisionedIops.LimitExceed', + 'message' => 'Instance param provisionedIops non compliant.', + 'http_code' => 400, + 'description' => 'The instance parameter providizedOps does not meet the requirements.', + ], + [ + 'code' => 'InvalidRegion.Format', + 'message' => 'Specified Region is not valid.', + 'http_code' => 400, + 'description' => 'The selected region is invalid.', + ], + [ + 'code' => 'InvalidRegion_Zone_NotFound', + 'message' => 'Specified Region does not exist in RDS.', + 'http_code' => 404, + 'description' => '', + ], + [ + 'code' => 'InvalidRestoreTime', + 'message' => 'The specified parameter \'RestoreTime\' is not valid, please check Flashback RecoverTime.', + 'http_code' => 400, + 'description' => 'The specified parameter RestoreTime is invalid. Check the Flashback RecoverTime.', + ], + [ + 'code' => 'InvalidRestoreTime.Format', + 'message' => 'Specified restore time is not valid.', + 'http_code' => 400, + 'description' => 'The specified RestoreTime value is invalid.', + ], + [ + 'code' => 'InvalidSaleComponentFault', + 'message' => 'The request references an incorrect order sales component. Contact the customer support.', + 'http_code' => 400, + 'description' => 'The order information in the request is incorrect. Please submit the work order for processing.', + ], + [ + 'code' => 'InvalidSearchTimeRange', + 'message' => 'search time range cannot be longer than a day.', + 'http_code' => 400, + 'description' => 'The time range cannot exceed one day.', + ], + [ + 'code' => 'InvalidSecurityIPListGroup.QuotaExceeded', + 'message' => 'Specified security IP list group is not valid: Exceeding the allowed amount of group.', + 'http_code' => 400, + 'description' => 'The specified whitelist security group is invalid: the number of IP addresses exceeds the security group limit.', + ], + [ + 'code' => 'InvalidSecurityIpListLength.Malformed', + 'message' => 'Specified parameter SecurityIpList is not valid.', + 'http_code' => 400, + 'description' => 'The number of SecurityIpList input parameters exceeds the maximum value.', + ], + [ + 'code' => 'InvalidShardInfo.Format', + 'message' => 'Specified Shards info is not valid.', + 'http_code' => 400, + 'description' => 'The instance specification DBInstanceClass format is incorrect.', + ], + [ + 'code' => 'InvalidShardInfo.Format', + 'message' => 'Shard total number is out of range.', + 'http_code' => 400, + 'description' => 'The number of shard nodes is abnormal.', + ], + [ + 'code' => 'InvalidStartTime.Format', + 'message' => 'Specified start time is not valid.', + 'http_code' => 400, + 'description' => 'The specified start time is invalid.', + ], + [ + 'code' => 'InvalidStartTime.Malformed', + 'message' => 'The Specified parameter \\”StartTime\\” is not valid.', + 'http_code' => 400, + 'description' => 'The specified StartTime value is invalid.', + ], + [ + 'code' => 'InvalidStartTimeAndEndTime.Malformed', + 'message' => 'The end time must be greater than the start time', + 'http_code' => 400, + 'description' => 'The end time cannot be earlier than the start time.', + ], + [ + 'code' => 'InvalidStatus.NotFound', + 'message' => 'The Status provided does not exist in our records.', + 'http_code' => 404, + 'description' => 'The instance status does not exist. Check whether the entered parameters are correct.', + ], + [ + 'code' => 'InvalidStorage', + 'message' => 'Storage is mandatory for this action.', + 'http_code' => 400, + 'description' => 'This operation must be stored.', + ], + [ + 'code' => 'InvalidStorageSizeForMongos', + 'message' => 'The specified storage size is invalid for Mongos.', + 'http_code' => 400, + 'description' => 'The specified storage size is not valid for Mongos.', + ], + [ + 'code' => 'InvalidTableNameOrDBName', + 'message' => 'The specified parameter \'TableName\' or \'DBName\' is not founded.', + 'http_code' => 400, + 'description' => 'The specified parameter TableName or DBName was not found ".', + ], + [ + 'code' => 'InvalidTagKey.Malformed', + 'message' => 'The specified parameter Tag.n.Key or TagKey.n is not valid.', + 'http_code' => 400, + 'description' => 'Invalid Tag.n.Value parameter value.', + ], + [ + 'code' => 'InvalidTagKey.Malformed', + 'message' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'InvalidTagValue.Malformed', + 'message' => 'The specified parameter Tag.n.Value is not valid.', + 'http_code' => 400, + 'description' => 'Invalid Tag.n.Value parameter value.', + ], + [ + 'code' => 'InvalidTDEstatus', + 'message' => 'Specified TDEStatus is not configured on the This custins.', + 'http_code' => 400, + 'description' => 'TDE is enabled for the current instance.', + ], + [ + 'code' => 'InvalidUpgradeParams', + 'message' => 'All(replicationFactor,dbInstanceClass,dbInstanceStorage ) parameters are the same.', + 'http_code' => 400, + 'description' => 'The number of instance nodes, specification type, and storage space are not changed during the configuration change. Please modify the configuration change parameters and initiate the change again.', + ], + [ + 'code' => 'InvalidVpc.NotSupported', + 'message' => 'the Different vpc not supported.', + 'http_code' => 400, + 'description' => 'Different VPCs are not supported.', + ], + [ + 'code' => 'InvalidVpcAuthMode.Invalid', + 'message' => 'Specified VpcAuthMode is invalid.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'InvalidVpcIdRegion.NotSupported', + 'message' => 'The Specified vpcId or vSwitchId not supported.', + 'http_code' => 404, + 'description' => 'The specified vpcId or vSwitchId is not supported.', + ], + [ + 'code' => 'InvalidZoneld', + 'message' => 'The specified primary zone, secondary zone and hidden zone cannot be the same.', + 'http_code' => 400, + 'description' => 'The parameters of the primary zone, secondary zone and hidden zone cannot be the same.', + ], + [ + 'code' => 'InvalidZoneParam', + 'message' => 'The target zone and source zone cannot be the same.', + 'http_code' => 400, + 'description' => 'The destination zone cannot be the same as the original zone.', + ], + [ + 'code' => 'KeyFilter.Limit', + 'message' => 'The number of keys cannot exceed 1000 and the keyFilter JsonString length cannot exceed 48KB.', + 'http_code' => 400, + 'description' => 'The number of keys cannot exceed 1000, and the length of the keyFilter JsonString cannot exceed 48KB.', + ], + [ + 'code' => 'KeyList.Duplicate', + 'message' => 'There are duplicate keys in the keyword list.', + 'http_code' => 400, + 'description' => 'Duplicate keys in keyword list.', + ], + [ + 'code' => 'KeyList.Limit', + 'message' => 'The size of keyList cannot exceed 10 and the json string length of keyList cannot exceed 128.', + 'http_code' => 400, + 'description' => 'the size of the keyList cannot exceed 10, and the length of the keyList json string cannot exceed 128.', + ], + [ + 'code' => 'KmsAccountStatusException', + 'message' => 'KMS account status is not enabled, please enable it first.', + 'http_code' => 400, + 'description' => 'KMS account status is not enabled, please enable it first.', + ], + [ + 'code' => 'KMSIdNotValid', + 'message' => 'Specific KMS Id is not valid.', + 'http_code' => 400, + 'description' => 'The specific KMS Id is invalid.', + ], + [ + 'code' => 'LocationServiceError', + 'message' => 'Invoke location service error.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'LogApiFrequencyExceeded', + 'message' => 'Exceeding the allowed frequency of log api.', + 'http_code' => 400, + 'description' => 'Maximum number of log API operations exceeded.', + ], + [ + 'code' => 'MigrateDBInstanceError', + 'message' => 'Error in migrating available area or changing your vpc network. Please submit the work order for processing.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'MinorVersionNotSupport', + 'message' => 'Instance\'s MinorVersion is not supported for this API.', + 'http_code' => 400, + 'description' => 'This API does not support MinorVersion of instances.', + ], + [ + 'code' => 'MissingAttribute', + 'message' => 'NewPassword/InstanceName/Config at least one is mandatory for this action.', + 'http_code' => 400, + 'description' => 'At least one of NewPassword/InstanceName/Config is required.', + ], + [ + 'code' => 'MissingDBInstanceId', + 'message' => 'DBInstanceId is mandatory for this action.', + 'http_code' => 200, + 'description' => 'Invalid instance name.', + ], + [ + 'code' => 'MissingDbInstanceId', + 'message' => 'DbInstanceId is mandatory for this action.', + 'http_code' => 400, + 'description' => 'DBInstanceId is a required parameter for this operation.', + ], + [ + 'code' => 'MissingParameter', + 'message' => 'The input parameter OwnerId,OwnerAccount that is mandatory for processing this request is not supplied.', + 'http_code' => 403, + 'description' => 'You must specify at least one of OwnerId and OwnerAccount.', + ], + [ + 'code' => 'MissingParameter', + 'message' => 'The input parameter { ResourceId } that is mandatory for processing this request is not supplied.', + 'http_code' => 403, + 'description' => 'You must specify the ResourceId parameter.', + ], + [ + 'code' => 'MissingParameter', + 'message' => 'The input parameter {ResourceId} that is mandatory for processing this request is not supplied.', + 'http_code' => 403, + 'description' => 'You must specify the ResourceId parameter.', + ], + [ + 'code' => 'MissingParameter', + 'message' => '%s is mandatory for this action.', + 'http_code' => 400, + 'description' => 'The% s parameter is required.', + ], + [ + 'code' => 'MissingPeriod', + 'message' => 'Period is mandatory for this action.', + 'http_code' => 400, + 'description' => 'The Period parameter is empty, or the parameter format is abnormal.', + ], + [ + 'code' => 'MissingSpec', + 'message' => 'DBInstanceClass/DBInstanceStorage at least one is mandatory for this action.', + 'http_code' => 412, + 'description' => 'At least one of DBInstanceClass\\DBInstanceStorage is required for this operation.', + ], + [ + 'code' => 'MissingVpcId', + 'message' => 'VpcId is mandatory for this action.', + 'http_code' => 412, + 'description' => 'This operation must use VpcId.', + ], + [ + 'code' => 'MissingVswitchId', + 'message' => 'VswitchId is mandatory for this action.', + 'http_code' => 412, + 'description' => 'VswitchId is required for this operation.', + ], + [ + 'code' => 'ModifyNodeSpecBatchNotSupportCsLocalSSD', + 'message' => 'ModifyNodeSpecBatch interface not support cs for LocalSSD Instance.', + 'http_code' => 400, + 'description' => 'the ModifyNodeSpecBatch interface does not support the cs of the LocalSSD instance.', + ], + [ + 'code' => 'ModifyReadOnlyNodeInvalidMinorVersion', + 'message' => 'Modify readonly node count is not supported for instance\'s MinorVersion.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'ModifyReadOnlyNodeNotSupport', + 'message' => 'Modify readonly node count in ModifyNodeSpecBatch is not support.', + 'http_code' => 403, + 'description' => 'The ModifyNodeSpeccBatch operation cannot be used to change the number of read-only nodes.', + ], + [ + 'code' => 'Mutex.NotAcquire', + 'message' => 'Can\'t acquire mutex lock. Please try again later.', + 'http_code' => 400, + 'description' => 'Unable to acquire mutex. Please try again later', + ], + [ + 'code' => 'Namespace.Limit', + 'message' => 'The length of DBName.TableName or DBName.TempTableName cannot exceed 253.', + 'http_code' => 400, + 'description' => 'The length of the DBName. The table or database name. TempTableName cannot exceed 253.', + ], + [ + 'code' => 'NetworkType.NotSupport', + 'message' => 'Specified network type does not support this operation.', + 'http_code' => 400, + 'description' => 'The specified network type does not support this operation.', + ], + [ + 'code' => 'NetworkTypeNotMatch', + 'message' => 'Specified network type does not matched.', + 'http_code' => 400, + 'description' => 'The specified network types do not match.', + ], + [ + 'code' => 'NetworkTypeNotSupport', + 'message' => 'The network type does not support this operation.', + 'http_code' => 400, + 'description' => 'The network type does not support this operation.', + ], + [ + 'code' => 'NewConnectionString.NotSupport', + 'message' => 'Specified newConnectionString is not supported.', + 'http_code' => 400, + 'description' => 'newConnectionString format', + ], + [ + 'code' => 'Node.NotFound', + 'message' => 'Specified node is not found.', + 'http_code' => 404, + 'description' => 'The node does not exist.', + ], + [ + 'code' => 'NodeIdNotSupport', + 'message' => 'Specified NodeId not support this operation.', + 'http_code' => 400, + 'description' => 'Invalid NodeId passed in.', + ], + [ + 'code' => 'NodeNum.Config', + 'message' => 'Node number config error.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'NodeNum.Error', + 'message' => 'Node number error.', + 'http_code' => 400, + 'description' => 'The number of nodes is invalid.', + ], + [ + 'code' => 'NodeType.NotSupport', + 'message' => 'Specified node type dose not support this operation.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'NoQuota', + 'message' => 'Request zone has no quota to sell.', + 'http_code' => 403, + 'description' => '', + ], + [ + 'code' => 'OnlyVPCSupport', + 'message' => 'Only supports VPC network.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'OpenKmsServiceException', + 'message' => 'Error in opening Kms Service. Please check whether you have passed the real name authentication.', + 'http_code' => 400, + 'description' => 'Error opening Kms service. Please check whether you have passed the real name authentication.', + ], + [ + 'code' => 'Operation.NotValid', + 'message' => 'Specified operation is not valid.', + 'http_code' => 400, + 'description' => 'The specified operation is invalid.', + ], + [ + 'code' => 'OperationDenied', + 'message' => 'The resource is out of usage.', + 'http_code' => 403, + 'description' => '', + ], + [ + 'code' => 'OperationDenied.AccountStatus', + 'message' => 'The operation is not permitted due to status of account.', + 'http_code' => 403, + 'description' => 'This operation is not allowed due to the state of the account.', + ], + [ + 'code' => 'OperationDenied.BackupJobExists', + 'message' => 'The operation is not permitted due to backup job exist.', + 'http_code' => 403, + 'description' => 'A backup task is in progress. Try again later.', + ], + [ + 'code' => 'OperationDenied.DBInstance', + 'message' => 'The operation is not permitted due to type of instance.', + 'http_code' => 403, + 'description' => 'The operation is not allowed due to the type of the instance.', + ], + [ + 'code' => 'OperationDenied.DBInstanceStatus', + 'message' => 'The operation is not permitted due to status of instance.', + 'http_code' => 400, + 'description' => 'The operation is not supported while the instance is in the current state.', + ], + [ + 'code' => 'OperationDenied.KMSUnauthorized', + 'message' => 'The operation is not permitted due to KMS roleARN is not authorized to ads service account.', + 'http_code' => 400, + 'description' => 'The operation is not allowed because the KMS role ARN is not authorized to the Ad Service account', + ], + [ + 'code' => 'OperationDenied.LockMode', + 'message' => 'The operation is not permitted when the instance locked.', + 'http_code' => 403, + 'description' => 'The operation is not supported while the instance is locked.', + ], + [ + 'code' => 'OperationDenied.QuotaExceed', + 'message' => 'The maximum number of Tags is exceeded. The maximum value is 20.', + 'http_code' => 400, + 'description' => 'The number of tags cannot exceed 20. Delete the tags that are no longer needed and try again.', + ], + [ + 'code' => 'OperationDenied.SecurityIPListDuplicate', + 'message' => 'The Specified same security IP already exists.', + 'http_code' => 400, + 'description' => 'Duplicate IP addresses in the whitelist.', + ], + [ + 'code' => 'OplogSizeLowerThanInstanceStorage', + 'message' => 'Specified oplogSizeMB is lower than 5% of InstanceStorage.', + 'http_code' => 400, + 'description' => 'Specified oplogSizeMB is lower than 5% of InstanceStorage.', + ], + [ + 'code' => 'OplogSizeLowerThanInstanceStorage', + 'message' => 'The oplogSizeMB parameter entered is less than 10% of the instance store size.', + 'http_code' => 400, + 'description' => 'The oplogSizeMB parameter entered is less than 10% of the instance store size.', + ], + [ + 'code' => 'Order.BasicInfoUncompleted', + 'message' => 'Your information is incomplete. Complete your information before the operation.', + 'http_code' => 400, + 'description' => 'Your user information is incomplete. Complete the information and try again.', + ], + [ + 'code' => 'Order.CashBookInsufficent', + 'message' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', + 'http_code' => 400, + 'description' => 'The payment failed. Please add another payment method. You can also <a href=\'https://usercenter2.aliyun.com/finance/fund-management/recharge\' target=\'_blank\'>top up or add funds to your account</a>.', + ], + [ + 'code' => 'ORDER.INST_HAS_UNPAID_ORDER', + 'message' => 'Current instance has unpaid order.', + 'http_code' => 400, + 'description' => 'There are unpaid orders in the current instance.', + ], + [ + 'code' => 'Order.NeedAddPayment', + 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'http_code' => 400, + 'description' => 'No payment method is found. Please add a payment method.', + ], + [ + 'code' => 'Order.NeedMoneyOrCard', + 'message' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', + 'http_code' => 400, + 'description' => 'The payment failed. Please add another payment method. You can also <a href=\'https://usercenter2.aliyun.com/finance/fund-management/recharge\' target=\'_blank\'>top up or add funds to your account</a>.', + ], + [ + 'code' => 'Order.NoAliyunQuotaPaymentMethod', + 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'http_code' => 400, + 'description' => 'No payment method is found. Please add a payment method.', + ], + [ + 'code' => 'Order.NoAvailablePaymentMethod', + 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'http_code' => 400, + 'description' => 'No payment method is found. Please add a payment method.', + ], + [ + 'code' => 'Order.NotFound', + 'message' => 'Specified order is not found.', + 'http_code' => 404, + 'description' => '', + ], + [ + 'code' => 'Order.NotPaid', + 'message' => 'Specified order is not paid.', + 'http_code' => 400, + 'description' => 'The specified order was not paid.', + ], + [ + 'code' => 'Order.ParmentUncompleted', + 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'http_code' => 400, + 'description' => 'The specified payment method is invalid. Specify a valid payment method.', + ], + [ + 'code' => 'Order.TaxNumberRequiredUncompleted', + 'message' => 'Your tax information is incomplete. Complete your information before the operation.', + 'http_code' => 400, + 'description' => 'The tax information is incomplete. Complete the information and try again.', + ], + [ + 'code' => 'OrderTypeAutoPay', + 'message' => 'Specified order type does not support current auto pay type.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'OrderTypeNotSupport', + 'message' => 'Specified order type is not support.', + 'http_code' => 400, + 'description' => 'The specified order type is not supported.', + ], + [ + 'code' => 'ORD_S_QUERY_PROD_ERROR', + 'message' => 'Error in querying ordering information.', + 'http_code' => 400, + 'description' => 'Error in querying ordering information.', + ], + [ + 'code' => 'ProxyError', + 'message' => 'Invoke proxy error.', + 'http_code' => 400, + 'description' => 'Failed to call the proxy.', + ], + [ + 'code' => 'QuotaExceed.AfterpayInstance', + 'message' => 'The maximum number of post-paid instances has been reached.', + 'http_code' => 400, + 'description' => 'The number of postpaid instances has reached the maximum limit.', + ], + [ + 'code' => 'RandomListSize.Limit', + 'message' => 'The random list has reached the length limit.', + 'http_code' => 400, + 'description' => 'Random list has reached length limit.', + ], + [ + 'code' => 'ReduceDiskNotSupport', + 'message' => 'Reduce disk size is not supported in clone/restore.', + 'http_code' => 403, + 'description' => 'Reduce disk size is not supported in clone/restore.', + ], + [ + 'code' => 'ReduceDiskSizeNotSupport', + 'message' => 'The input disk size: "%d" is less than original max disk size: "%d".', + 'http_code' => 403, + 'description' => 'The input disk size of \'% d \\\' is less than the original maximum disk size of \'% d ".', + ], + [ + 'code' => 'ReduceStorageSizeNotSupportNodeNumChange', + 'message' => 'Reducing the instance\'s storage size does not support changing the number of nodes.', + 'http_code' => 400, + 'description' => 'Reducing the storage size of an instance does not support changing the number of nodes.', + ], + [ + 'code' => 'ReplicationFactorIsEmpty', + 'message' => 'The replicationFactor param is error.replicationFactor.', + 'http_code' => 400, + 'description' => 'The replicationFactor parameter is invalid.', + ], + [ + 'code' => 'Resource.IPAddressNotEnough', + 'message' => 'Specified vSwitch has no enough IP address.', + 'http_code' => 403, + 'description' => '', + ], + [ + 'code' => 'Resource.NotAvailable', + 'message' => 'Resource is not available.', + 'http_code' => 400, + 'description' => 'Resource not available.', + ], + [ + 'code' => 'ResourceGroupId.InValid', + 'message' => 'The Specified ResourceGroupId is not valid.', + 'http_code' => 400, + 'description' => 'The specified ResourceGroupId is invalid.', + ], + [ + 'code' => 'RestoreInstanceNotSupported', + 'message' => 'Restore instance is not supported, try to use CreateDBInstance/CreateShardingDBInstance for clone.', + 'http_code' => 400, + 'description' => 'Restoring an instance is not supported, please try cloning using CreateDBInstance/CreateShardingDBInstance', + ], + [ + 'code' => 'RestoreTypeNotSupported', + 'message' => 'The specified restoreType is not supported for the instance, check the input parameters \'RestoreType/BackupID/RestoreTime\'.', + 'http_code' => 400, + 'description' => 'The specified restoreType is not supported for the instance, check the input parameters \'RestoreType/BackupID/RestoreTime\'.', + ], + [ + 'code' => 'SaleValidateNoSpecificCodeFailed', + 'message' => 'Specified Storage or Version or InstanceClass is invalid.', + 'http_code' => 400, + 'description' => 'Storage or Version or InstanceClass is empty.', + ], + [ + 'code' => 'SameZoneId', + 'message' => 'The specified primary zone, secondary zone require two different zones.', + 'http_code' => 400, + 'description' => 'The specified primary zone, secondary zone require two different zones.', + ], + [ + 'code' => 'SecondaryZone.Closed', + 'message' => 'Specified secondaryZone is closed.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'SecurityGroupNameNotSupport', + 'message' => 'Security GroupName does not support this operation.', + 'http_code' => 400, + 'description' => 'The SecurityIpGroupName = spark_mongodb does not support this operation.', + ], + [ + 'code' => 'ServiceNotSupported', + 'message' => 'The specified service is not supported.', + 'http_code' => 400, + 'description' => 'A service error occurred. Please try again later. If this error persists, submit a ticket.', + ], + [ + 'code' => 'ServiceUnavailable', + 'message' => 'Server-Side Exception Error Please You Later Try Again, if Also Same Error Please Submitted Work Single Processing.', + 'http_code' => 503, + 'description' => 'A server error occurred. Please try again later. If this error persists, submit a ticket.', + ], + [ + 'code' => 'ServiceUnavailable', + 'message' => 'The request has failed due to a temporary failure of the server.', + 'http_code' => 503, + 'description' => 'A server error occurred. Please try again later. If this error persists, submit a ticket.', + ], + [ + 'code' => 'SimultaneousCapacityChange.Allowed', + 'message' => 'Only simultaneous capacity expansion or reduction is supported.', + 'http_code' => 400, + 'description' => 'Only simultaneous capacity expansion or reduction is supported.', + ], + [ + 'code' => 'SingleDBRestore.BackupSetNotSupport', + 'message' => 'This backup set do not support this operation.', + 'http_code' => 403, + 'description' => 'Single-database recovery is not supported for the specified time point or backup file.', + ], + [ + 'code' => 'SingleKeyFilter.limit', + 'message' => 'The single keyFilter JsonString length cannot exceed 16KB.', + 'http_code' => 400, + 'description' => 'The length of a single keyFilter JsonString cannot exceed 16KB.', + ], + [ + 'code' => 'SingleNodeNotSupport', + 'message' => 'The Single Node Instance not support this operation.', + 'http_code' => 400, + 'description' => 'This operation is not supported for single-node instances.', + ], + [ + 'code' => 'SSLNotSupportAddNode', + 'message' => 'Instance with SSL certificate can\'t add node, please contact us to solve this problem.', + 'http_code' => 400, + 'description' => 'SSL encryption instances do not allow nodes to be added. If you need to, contact us to solve the problem.', + ], + [ + 'code' => 'StorageSize.Limit', + 'message' => 'The instance storage size limit is "%d" when reducing the storage size.', + 'http_code' => 400, + 'description' => 'The instance store size limit is \'% d\' when reducing the store size ".', + ], + [ + 'code' => 'StorageTypeNotSupporteEncryption', + 'message' => 'Specified storage type does not support encryption.', + 'http_code' => 400, + 'description' => 'The specified storage type does not support encryption.', + ], + [ + 'code' => 'StorageTypeOrInstanceTypeNotSupported', + 'message' => 'Specified storage type or instance type does not support this action.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'SYSTEM.ILLEGAL_ARGUMENT', + 'message' => 'LX illegal argument.', + 'http_code' => 400, + 'description' => 'Product information error.', + ], + [ + 'code' => 'SYSTEM.SALE_VALIDATE_NO_SPECIFIC_CODE_FAILED', + 'message' => 'Failed to create the specified sharding instance.', + 'http_code' => 400, + 'description' => 'You cannot create a sharding instance of this class.', + ], + [ + 'code' => 'Task.Conflict', + 'message' => 'Current instance has unfinished task(buy or modify spec).', + 'http_code' => 400, + 'description' => 'The instance has an ongoing task. Try again later.', + ], + [ + 'code' => 'Task.Conflict', + 'message' => 'Current instance has unfinished task.', + 'http_code' => 409, + 'description' => 'The current instance has unfinished tasks. Please try again after other tasks are completed.', + ], + [ + 'code' => 'TempTableNameAlreadyExists', + 'message' => 'The TempTableName Table name already exists.', + 'http_code' => 400, + 'description' => 'TempTableName table name already exists.', + ], + [ + 'code' => 'TempTableNameNotAllowed', + 'message' => 'TempTableName is not allowed.', + 'http_code' => 400, + 'description' => 'TempTableName is not allowed.', + ], + [ + 'code' => 'TooSmallStorageSize', + 'message' => 'Specified storage size must be larger than current instance.', + 'http_code' => 403, + 'description' => 'The specified storage size must be larger than the current instance.', + ], + [ + 'code' => 'Unknown.Exception', + 'message' => 'The Request Server Is Error Or The Response Can Not Be Null.', + 'http_code' => 500, + 'description' => 'The current service is abnormal, please try again later.', + ], + [ + 'code' => 'UnSupportDbTypeReduceDiskSize', + 'message' => 'Current DB type not support reduce disk size.', + 'http_code' => 400, + 'description' => 'Current database type does not support disk size reduction', + ], + [ + 'code' => 'UnsupportedDBTdeStatus', + 'message' => 'Specified DB TDEStatus does not support this operation.', + 'http_code' => 403, + 'description' => 'TDE already enabled for the specified instance.', + ], + [ + 'code' => 'VipManagerAPICallingFailed', + 'message' => 'Vip Manager API calling failed, please check the log.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'VpcAndVSwitchNotChange', + 'message' => 'VpcId and vSwitchId not change.', + 'http_code' => 400, + 'description' => 'VpcId and vSwitchId are unchanged.', + ], + [ + 'code' => 'VpcAuthModeNotSupported', + 'message' => 'VpcAuthMode is NotSupported for Security Risk.', + 'http_code' => 400, + 'description' => 'Unable to enable the private network access function', + ], + [ + 'code' => 'VpcAuthModeNotSupported', + 'message' => 'VpcAuthMode is NotSupported for Security Risk .', + 'http_code' => 400, + 'description' => '私网免密登录功能不支持开启。', + ], + [ + 'code' => 'VPCERROR.ALLOCATE_ERROR', + 'message' => 'Cannot Allocate the require vpcInstances.', + 'http_code' => 404, + 'description' => 'Unable to allocate the required vpc resources.', + ], + [ + 'code' => 'VpcError.NotEnabled', + 'message' => 'VPC is not enabled in this zone.', + 'http_code' => 400, + 'description' => 'VPC is not enabled in this Region.', + ], + [ + 'code' => 'VPCERROR.NOT_ENABLED', + 'message' => 'VPC is not enabled in this zone.', + 'http_code' => 404, + 'description' => 'VPC is not enabled in this region.', + ], + [ + 'code' => 'VpcNetWorkExistFault', + 'message' => 'The VPC network you are trying to create already exists.', + 'http_code' => 400, + 'description' => '', + ], + [ + 'code' => 'VpcServiceError', + 'message' => 'Invoke vpc service error.', + 'http_code' => 500, + 'description' => '', + ], + [ + 'code' => 'Zone.Closed', + 'message' => 'Specified zone is closed.', + 'http_code' => 400, + 'description' => 'The specified area is closed', + ], + [ + 'code' => 'UNSUPPORTED_TDE_DELETED_INSTANCE_RESTORE', + 'message' => 'deleted TDE instance does not support restore.', + 'http_code' => 400, + 'description' => 'Recycle Bin rebuild is not supported for deleted TDE instances.', + ], + [ + 'code' => 'ErrorInsufficientResource', + 'message' => 'Insufficient resources. Please select another region or submit a ticket for further assistance.', + 'http_code' => 400, + 'description' => 'Insufficient resources. Please select another region or submit a work order.', + ], + [ + 'code' => 'InvalidModifyParams', + 'message' => 'All(replicationFactor,dbInstanceClass,dbInstanceStorage,searchNodeCount,searchNodeStorage,searchNodeClass) parameters are the same.', + 'http_code' => 400, + 'description' => 'The current configuration parameters have not changed. Please check the currently selected configuration parameters such as instance type, number of nodes, number of read-only nodes, storage size, search node type, and search node storage.', + ], + [ + 'code' => 'InvalidOthers.Timeout', + 'message' => 'Query timed out. Please try again or narrow down the query scope.', + 'http_code' => 408, + 'description' => 'The query data volume is too large, resulting in a timeout. Reduce the number of query metrics or shorten the query time range.', + ], + [ + 'code' => 'Throttling.User', + 'message' => 'Request was denied due to user flow control.', + 'http_code' => 400, + 'description' => 'The user\'s traffic during this period has exceeded the limit.', + ], + [ + 'code' => 'InstanceNotSupportSearch', + 'message' => 'The instance does not support search service.', + 'http_code' => 400, + 'description' => 'The current instance does not support enabling the Search function.', + ], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'MongoDB', + 'productName' => 'ApsaraDB for MongoDB', + 'ramCodes' => [ + 'dds', + ], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [ + [ + 'name' => 'acs:ResourceTag', + 'schema' => [ + 'type' => 'STRING', + 'description' => 'Tag authentication', + ], + ], + ], + 'ramActions' => [ + [ + 'apiName' => 'ModifyDBInstanceDescription', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeParameterModificationHistory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeParameterModificationHistory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyParameters', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ReleaseNodePrivateNetworkAddress', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ReleaseNodePrivateNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeAuditPolicy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAuditPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpgradeDBInstanceKernelVersion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:UpgradeDBInstanceKernelVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyAuditPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyAuditPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHistoryTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeHistoryTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#InstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteDBInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DeleteDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'TransferClusterBackup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:TransferClusterBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateBackup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeAvailabilityZones', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeAvailabilityZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'AllocateNodePrivateNetworkAddress', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:AllocateNodePrivateNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRestoreDBInstanceList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeRestoreDBInstanceList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSlowLogRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeSlowLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceAttribute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyGlobalSecurityIPGroupRelation', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroupRelation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'MigrateToOtherZone', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:MigrateToOtherZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceAutoRenewalAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeInstanceAutoRenewalAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'conditional', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'CheckCloudResourceAuthorized', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:CheckCloudResourceAuthorized', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeShardingNetworkAddress', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeShardingNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifySecurityGroupConfiguration', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifySecurityGroupConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateNodeBatch', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateNodeBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceNetExpireTime', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceNetExpireTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'RestartNode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:RestartNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateAccount', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyAccountDescription', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyAccountDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeAccounts', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRoleZoneInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeRoleZoneInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceSwitchLog', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceSwitchLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceSSL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceTDE', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceTDE', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'RenewDBInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:RenewDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteGlobalSecurityIPGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DeleteGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeActiveOperationTaskCount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyNodeSpecBatch', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyNodeSpecBatch', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceEncryptionKey', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceEncryptionKey', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeMongoDBLogConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeMongoDBLogConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyNodeSpec', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyNodeSpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeActiveOperationTaskRegion', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskRegion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupDBs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeBackupDBs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeActiveOperationMaintenanceConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationMaintenanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeClusterBackups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeClusterBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ReleasePublicNetworkAddress', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ReleasePublicNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceTDEInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceTDEInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'MigrateAvailableZone', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:MigrateAvailableZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceSpec', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceSpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpgradeDBInstanceEngineVersion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:UpgradeDBInstanceEngineVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeAvailableEngineVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAvailableEngineVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeActiveOperationTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DestroyInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DestroyInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeActiveOperationTaskType', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyGlobalSecurityIPGroupName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroupName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeTags', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupTasks', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:DescribeBackupTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeActiveOperationTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateGlobalSecurityIPGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceConnectionString', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceConnectionString', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'RestartDBInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:RestartDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceDiskType', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceDiskType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceSSL', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceSSL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateShardingDBInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateShardingDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + ], + ], + ], + [ + 'apiName' => 'TransformInstanceChargeType', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:TransformInstanceChargeType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeKmsKeys', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeKmsKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SwitchDBInstanceHA', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:SwitchDBInstanceHA', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstancesOverview', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstancesOverview', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateNode', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifySecurityIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifySecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'AllocatePublicNetworkAddress', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:AllocatePublicNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyAuditLogFilter', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyAuditLogFilter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifySrvNetworkAddress', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifySrvNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'EvaluateResource', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:EvaluateResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSecurityIps', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeSecurityIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeAvailableResource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAvailableResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ResetAccountPassword', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ResetAccountPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyTaskInfo', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyTaskInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceMaintainTime', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceMaintainTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeErrorLogRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeErrorLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyGlobalSecurityIPGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRenewalPrice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeRenewalPrice', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupStorage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeBackupStorage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupPolicy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeUserEncryptionKeyList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeUserEncryptionKeyList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'TransformToPrePaid', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:TransformToPrePaid', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceMonitor', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeGlobalSecurityIPGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeAuditRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAuditRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeReplicaSetRole', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeReplicaSetRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'AllocateDBInstanceSrvNetworkAddress', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:AllocateDBInstanceSrvNetworkAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRunningLogRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeRunningLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceAutoRenewalAttribute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyInstanceAutoRenewalAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBackups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyActiveOperationTasks', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyActiveOperationTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CheckRecoveryCondition', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:CheckRecoveryCondition', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribePrice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribePrice', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteNode', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DeleteNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceNetworkType', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceNetworkType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceSpecInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceSpecInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CheckServiceLinkedRole', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:CheckServiceLinkedRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeParameters', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSecurityGroupConfiguration', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeSecurityGroupConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeClusterRecoverTime', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeClusterRecoverTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstancePerformance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstancePerformance', + 'authLevel' => 'resource', + 'actionConditions' => [ + [ + 'conditionKey' => 'dds:ResourceTag', + 'validationType' => 'always', + ], + ], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeGlobalSecurityIPGroupRelation', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeGlobalSecurityIPGroupRelation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeAuditLogFilter', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAuditLogFilter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceMonitor', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceRecoverTime', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:DescribeInstanceRecoverTime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHistoryTasksStat', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeHistoryTasksStat', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#InstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateDBInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceVpcAuthMode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyInstanceVpcAuthMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyDBInstanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + ], + ], + ], + ], + 'resourceTypes' => [ + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#InstanceId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'DBInstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'dbinstance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:dbinstance/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:instance/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:dds:{#regionId}:{#accountId}:instance/{#InstanceId}', + ], + ], + ], +]; |