diff options
Diffstat (limited to 'data/zh_cn/dds/2015-12-01')
| -rw-r--r-- | data/zh_cn/dds/2015-12-01/api-docs.php | 30779 |
1 files changed, 30779 insertions, 0 deletions
diff --git a/data/zh_cn/dds/2015-12-01/api-docs.php b/data/zh_cn/dds/2015-12-01/api-docs.php new file mode 100644 index 0000000..650e3d9 --- /dev/null +++ b/data/zh_cn/dds/2015-12-01/api-docs.php @@ -0,0 +1,30779 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dds', + 'version' => '2015-12-01', + ], + 'directories' => [ + [ + 'children' => [ + 'CreateDBInstance', + 'CreateShardingDBInstance', + ], + 'type' => 'directory', + 'title' => '创建或克隆实例', + 'id' => 212272, + ], + [ + 'children' => [ + 'CreateNode', + 'CreateNodeBatch', + 'DeleteNode', + 'ModifyDBInstanceSpec', + 'ModifyNodeSpec', + 'ModifyNodeSpecBatch', + 'ModifyDBInstanceDiskType', + ], + 'type' => 'directory', + 'title' => '变更实例配置', + 'id' => 212436, + ], + [ + 'children' => [ + 'DeleteDBInstance', + 'ModifyDBInstanceMaintainTime', + 'ModifyDBInstanceDescription', + 'ModifyDBInstanceNetExpireTime', + 'UpgradeDBInstanceEngineVersion', + 'UpgradeDBInstanceKernelVersion', + 'SwitchDBInstanceHA', + 'RestartDBInstance', + 'DestroyInstance', + 'RestartNode', + ], + 'type' => 'directory', + 'title' => '实例管理', + 'id' => 211655, + ], + [ + 'children' => [ + 'ModifyInstanceAutoRenewalAttribute', + 'TransformInstanceChargeType', + 'DescribePrice', + 'DescribeRenewalPrice', + 'TransformToPrePaid', + 'RenewDBInstance', + ], + 'type' => 'directory', + 'title' => '续费管理', + 'id' => 36818, + ], + [ + 'children' => [ + 'DescribeDBInstanceSpecInfo', + 'DescribeReplicaSetRole', + 'DescribeKernelReleaseNotes', + 'DescribeAvailableEngineVersion', + 'DescribeDBInstances', + 'DescribeDBInstanceSwitchLog', + 'DescribeDBInstanceAttribute', + 'DescribeRoleZoneInfo', + 'DescribeInstanceAutoRenewalAttribute', + 'DescribeActiveOperationTaskCount', + 'DescribeActiveOperationTasks', + 'DescribeActiveOperationTaskType', + 'DescribeDBInstancesOverview', + 'DescribeHistoryTasks', + 'DescribeHistoryTasksStat', + 'ModifyTaskInfo', + 'ModifyActiveOperationTasks', + ], + 'type' => 'directory', + 'title' => '查询实例', + 'id' => 212460, + ], + [ + 'children' => [ + 'DescribeAvailableResource', + 'EvaluateResource', + 'DescribeAvailabilityZones', + 'ModifyResourceGroup', + ], + 'type' => 'directory', + 'title' => '资源管理', + 'id' => 211690, + ], + [ + 'children' => [ + 'DescribeRegions', + 'MigrateToOtherZone', + 'MigrateAvailableZone', + ], + 'type' => 'directory', + 'title' => '区域管理', + 'id' => 212482, + ], + [ + 'children' => [ + 'ModifyInstanceVpcAuthMode', + 'ModifyDBInstanceNetworkType', + 'ModifyDBInstanceConnectionString', + 'DescribeShardingNetworkAddress', + 'AllocatePublicNetworkAddress', + 'ReleasePublicNetworkAddress', + 'AllocateNodePrivateNetworkAddress', + 'ReleaseNodePrivateNetworkAddress', + ], + 'type' => 'directory', + 'title' => '连接管理', + 'id' => 36714, + ], + [ + 'children' => [ + 'ListTagResources', + 'DescribeTags', + 'TagResources', + 'UntagResources', + ], + 'type' => 'directory', + 'title' => '标签管理', + 'id' => 212333, + ], + [ + 'children' => [ + 'CreateAccount', + 'ResetAccountPassword', + 'ModifyAccountDescription', + 'DescribeAccounts', + ], + 'type' => 'directory', + 'title' => '账号管理', + 'id' => 211711, + ], + [ + 'children' => [ + 'ModifySecurityIps', + 'ModifySecurityGroupConfiguration', + 'DescribeSecurityIps', + 'DescribeSecurityGroupConfiguration', + 'ModifyGlobalSecurityIPGroup', + 'DescribeGlobalSecurityIPGroup', + 'ModifyGlobalSecurityIPGroupName', + 'DescribeGlobalSecurityIPGroupRelation', + 'CreateGlobalSecurityIPGroup', + 'ModifyGlobalSecurityIPGroupRelation', + 'DeleteGlobalSecurityIPGroup', + ], + 'type' => 'directory', + 'title' => '白名单 和安全组', + 'id' => 212713, + ], + [ + 'children' => [ + 'ModifyDBInstanceTDE', + 'CheckCloudResourceAuthorized', + 'DescribeUserEncryptionKeyList', + 'DescribeDBInstanceEncryptionKey', + 'DescribeDBInstanceTDEInfo', + 'DescribeKmsKeys', + ], + 'type' => 'directory', + 'title' => '密 钥', + 'id' => 212725, + ], + [ + 'children' => [ + 'ModifyDBInstanceSSL', + 'DescribeDBInstanceSSL', + ], + 'type' => 'directory', + 'title' => 'SSL加密', + 'id' => 24463, + ], + [ + 'children' => [ + 'ModifyAuditLogFilter', + 'ModifyAuditPolicy', + 'DescribeAuditRecords', + 'DescribeAuditPolicy', + 'DescribeAuditLogFilter', + 'DescribeMongoDBLogConfig', + ], + 'type' => 'directory', + 'title' => '审计 日志', + 'id' => 212734, + ], + [ + 'children' => [ + 'DescribeSlowLogRecords', + 'DescribeErrorLogRecords', + 'DescribeRunningLogRecords', + ], + 'type' => 'directory', + 'title' => '日志管理', + 'id' => 211742, + ], + [ + 'children' => [ + 'ModifyDBInstanceMonitor', + 'DescribeDBInstancePerformance', + 'DescribeDBInstanceMonitor', + ], + 'type' => 'directory', + 'title' => '性能监控', + 'id' => 212531, + ], + [ + 'children' => [ + 'ModifyParameters', + 'DescribeParameterModificationHistory', + 'DescribeParameterTemplates', + 'DescribeParameters', + ], + 'type' => 'directory', + 'title' => '参数管理', + 'id' => 211749, + ], + [ + 'children' => [ + 'CreateBackup', + 'ModifyBackupPolicy', + 'DescribeBackupPolicy', + 'DescribeBackups', + 'DescribeBackupDBs', + 'DescribeRestoreDBInstanceList', + 'CheckRecoveryCondition', + 'TransferClusterBackup', + 'DescribeClusterBackups', + 'DescribeClusterRecoverTime', + 'DescribeBackupStorage', + 'DescribeBackupTasks', + 'DescribeInstanceRecoverTime', + ], + 'type' => 'directory', + 'title' => '备份与恢复', + 'id' => 212379, + ], + [ + 'children' => [ + 'DescribeActiveOperationTask', + 'AllocateDBInstanceSrvNetworkAddress', + 'CancelActiveOperationTasks', + 'DescribeActiveOperationTaskRegion', + 'DescribeActiveOperationMaintenanceConfig', + 'CheckServiceLinkedRole', + 'ModifyDBInstanceConfig', + 'CreateNodeRoleTag', + 'ModifyDBInstanceAttribute', + 'ModifySrvNetworkAddress', + 'DescribeRdsVSwitchs', + 'DescribeRdsVpcs', + 'DescribeRoleTagStatus', + 'DescribeVpcsForMongoDB', + 'DeleteBackup', + 'ModifyActiveOperationMaintenanceConfig', + 'ModifyBackupExpireTime', + ], + 'type' => 'directory', + 'title' => '其他', + 'id' => 212552, + ], + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze5eb9514e31364', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID或Shard节点ID。'."\n" + ."\n" + .'> 目前无需传入该参数', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp1b7bb3bbe****', + ], + ], + [ + 'name' => 'SrvConnectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '开通srv地址类型.'."\n" + .'- **vpc** :私有网络SRV'."\n" + .'- **public** 公网SRV地址'."\n" + .'>默认私网链接地址', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + 'enum' => [ + 'vpc', + 'public', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6B82A9EF-9961-5A31-A19F-009B7098ACCA', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Forbid', + 'errorMessage' => 'Specified account name is a keyword.', + 'description' => '账户名不正确，关键字不可用于账户名。请修改账户名。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '申请Srv地址', + 'summary' => '为云数据库 MongoDB 版实例申请 Srv 地址', + 'description' => '仅适用于云盘副本集实例与云盘分片集群实例。', + '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' => '实例所属的可用区ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询实例的可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1fa5efaa93****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Shard节点ID或ConfigServer节点ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询Shard/ConfigServer节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'd-bp124beeb0ac****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账户名。'."\n" + ."\n" + .'> - 以小写字母开头，长度为4~16位，由小写字母、数字或下划线组成。'."\n" + .'> - 仅在首次申请Shard/ConfigServer地址时，需要设置账户名和账户密码。即所有Shard节点和ConfigServer节点都将使用首次申请地址时设置的账户和密码。'."\n" + .'> - 该账户的权限固定为只读权限。', + 'type' => 'string', + 'required' => false, + 'example' => 'shardcsaccount', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账户密码。'."\n" + ."\n" + .'- 密码由大写字母、小写字母、数字、特殊字符中的至少三种组成，特殊字符为`!#$%^&*()_+-=`'."\n" + .'- 密码长度为8-32位。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60EEBD77-227C-5B39-86EA-D89163C5****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Forbid', + 'errorMessage' => 'Specified account name is a keyword.', + 'description' => '账户名不正确，关键字不可用于账户名。请修改账户名。', + ], + ], + ], + 'title' => '为云数据库分片集群实例节点申请内网连接地址', + 'summary' => '为云数据库MongoDB分片集群实例的Shard节点或ConfigServer节点申请内网连接地址。', + 'description' => '本接口仅适用于分片集群实例，更多详情请参见[申请Shard/ConfigServer节点连接地址](~~134037~~)。'."\n" + .'> 申请的连接地址仅支持通过内网访问，如需通过公网访问，请调用[AllocatePublicNetworkAddress](~~67602~~)接口申请公网连接地址。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"60EEBD77-227C-5B39-86EA-D89163C5****\\"\\n}","errorExample":""},{"type":"xml","example":"<AllocateNodePrivateNetworkAddressResponse>\\n <RequestId>60EEBD77-227C-5B39-86EA-D89163C5****</RequestId>\\n</AllocateNodePrivateNetworkAddressResponse>","errorExample":""}]', + ], + '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' => '实例ID。'."\n" + ."\n" + .'> 当配置为分片集群实例ID时，还需要配置**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp11483712c1****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID、Shard节点ID或ConfigServer节点ID。您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询Mongos节点、Shard节点或ConfigServer节点的节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**配置的是分片集群实例ID时，需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 's-bp18e6d84ae3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8AA45036-497F-52E7-B951-F9C7B239****', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '为实例申请公网连接地址', + 'summary' => '分配公网地址。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8AA45036-497F-52E7-B951-F9C7B239****\\"\\n}","errorExample":""},{"type":"xml","example":"<AllocatePublicNetworkAddressResponse>\\n <RequestId>8AA45036-497F-52E7-B951-F9C7B239****</RequestId>\\n</AllocatePublicNetworkAddressResponse>","errorExample":""}]', + ], + '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' => '批量取消的运维任事件 ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1508850,1508310,1507849,1506274,1505811'."\n", + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '批量取消的运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '1508850,1508310,1507849,1506274,1505811', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '55A2504F-xxxx-xxxx-xxxx-C7C5E57350A6', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '取消运维事件', + 'summary' => '批量取消运维事件。', + 'description' => '运维事件不允许取消的场景'."\n" + .'- 事件不可取消（AllowCancel 为 0）'."\n" + .'- 当前时间大于运维事件开始时间'."\n" + .'- 运维事件状态值不为“等待执行”（Status不为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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp18f7d6b6a7****', + ], + ], + [ + 'name' => 'TargetRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属地域，您可以调用[DescribeDBInstanceAttribute](~~62010~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorizationState' => [ + 'description' => '授权状态，取值说明：'."\n" + .'- **0**：未授权。'."\n" + .'- **1**：已授权。'."\n" + .'- **2**：用户未开启KMS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A0181AC4-F186-46ED-87CA-100C70B86729', + ], + 'RoleArn' => [ + 'description' => '已授权阿里云资源的角色信息。'."\n" + .'> 当**AuthorizationState**返回值为**1**时，才会返回本参数。', + 'type' => 'string', + 'example' => 'acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询KMS密钥是否已授权给实例', + 'summary' => '查询KMS密钥是否已授权给MongoDB实例。', + 'description' => '在调用[ModifyDBInstanceTDE](~~131267~~)接口开启透明数据加密TDE前，请调用本接口查询KMS密钥是否已授权给MongoDB实例。', + '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' => '[{"type":"json","example":"{\\n \\"AuthorizationState\\": 1,\\n \\"RequestId\\": \\"A0181AC4-F186-46ED-87CA-100C70B86729\\",\\n \\"RoleArn\\": \\"acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckCloudResourceAuthorizedResponse>\\n <AuthorizationState>1</AuthorizationState>\\n <RequestId>A0181AC4-F186-46ED-87CA-100C70B86729</RequestId>\\n <RoleArn>acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole</RoleArn>\\n</CheckCloudResourceAuthorizedResponse>","errorExample":""}]', + ], + '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' => '待恢复的源实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1378****', + ], + ], + [ + 'name' => 'DatabaseNames', + 'in' => 'query', + 'schema' => [ + 'description' => '所需恢复的数据库名，格式为JSON数组。'."\n" + .'> 如果不传入本参数，默认恢复所有数据库。', + 'type' => 'string', + 'required' => false, + 'example' => '["db1","db2"]', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所需恢复的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 本参数可取值为7天内的任意时间，但是须早于当前时间，且晚于实例的创建时间。'."\n" + .'> - 本参数和**BackupId**参数两者中必须传入一项。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-08-22T08:00:00Z', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID。'."\n" + ."\n" + .'> - 您可以通过调用[DescribeBackups](~~62172~~)接口查询备份ID。'."\n" + .'> - 本参数和**RestoreTime**参数两者中必须传入一项。'."\n" + .'> - 分片集群实例不支持传入本参数。', + 'type' => 'string', + 'required' => false, + 'example' => '5664****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp179****', + ], + ], + [ + 'name' => 'SourceDBInstance', + 'in' => 'query', + 'schema' => [ + 'description' => '待恢复的源实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1378****', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '源实例所在区域。'."\n" + ."\n" + .'>- 当备份恢复类型为已删除实例重建时，需要且必填'."\n" + .'>- 当备份恢复类型为异地备份克隆时，需要且必填', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份恢复时，备份集所在区域。'."\n" + ."\n" + .'> 当备份恢复类型为异地备份克隆时，需要且必填', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => '备份恢复类型'."\n" + ."\n\n" + ."\n" + .'>- 0: 本地备份恢复'."\n" + .'>- 1: 本地时间点恢复'."\n" + .'>- 2: 已删除实例使用备份集备份恢复'."\n" + .'>- 3: 异地备份使用备份集备份恢复', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值：'."\n" + .'- replicate '."\n" + .'- sharding'."\n" + ."\n" + .'>- 当备份恢复类型为已删除实例重建时，需要且必填'."\n" + .'>- 当备份恢复类型为异地备份克隆时，需要且必填', + 'type' => 'string', + 'required' => false, + 'example' => 'replicate', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本号，取值：'."\n" + .'- **8.0**'."\n" + .'- **7.0**'."\n" + .'- **6.0**'."\n" + .'- **5.0**'."\n" + .'- **4.4**'."\n" + .'- **4.2**'."\n" + .'- **4.0**', + 'type' => 'string', + 'required' => false, + 'example' => '4.2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D563A3E7-6010-45FE-A0CD-9283414C9657', + ], + 'DBInstanceName' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp1378****', + ], + 'IsValid' => [ + 'description' => '是否满足恢复条件，取值说明：'."\n" + .'- **true**：满足条件。'."\n" + .'- **false**：不满足条件。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMeta.WrongFormat', + 'errorMessage' => 'Meta information is wrong formatter.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidRestoreTime.Format', + 'errorMessage' => 'Specified restore time is not valid.', + 'description' => '指定的参数RestoreTime不合法，请您检查输入的参数是否正确。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidDBName', + 'errorMessage' => 'The specified database name is not allowed.', + 'description' => '指定的数据库名称无效'."\n", + ], + [ + 'errorCode' => 'InvalidMeta.TooLarge', + 'errorMessage' => 'Meta information is too large.', + 'description' => '元信息太大。'."\n", + ], + [ + 'errorCode' => 'SingleDBRestore.BackupSetNotSupport', + 'errorMessage' => 'This backup set do not support this operation.', + 'description' => '所选择的时间点或备份文件尚未支持单库恢复功能。', + ], + [ + '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' => '当前备份日志启用状态不支持此操作。'."\n", + ], + [ + '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' => '恢复时间内不存在可用的备份。'."\n", + ], + ], + ], + 'title' => '检查实例是否满足数据恢复条件', + 'summary' => '检查MongoDB实例是否满足数据恢复的条件。', + 'description' => '本接口适用于副本集实例或分片集群实例。'."\n" + ."\n" + .'> 调用本接口确认满足数据恢复的条件后，您可以调用[CreateDBInstance](~~61763~~)接口，将数据恢复至新实例。', + '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' => [ + 'summary' => '查看是否已创建服务关联角色（SLR）。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '7BE0D8D2-6702-5639-A9C2-xxxxxxx', + ], + 'ServiceLinkedRoleExists' => [ + 'description' => '是否已经创建服务关联角色 [AliyunServiceRoleForMongoDB](~~384051~~)。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'title' => '查询是否已创建服务关联角色', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:CheckServiceLinkedRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-uf6e9433e955xxxx', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名。由小写字母、数字或下划线组成，以小写字母开头，长度为4~16个字符。权限为只读。', + 'type' => 'string', + 'required' => true, + 'example' => 'admin1', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账户密码。'."\n" + .'大写、小写、数字、特殊字符占三种，长度为8~32个字符；特殊字符为 ! @ # $ % ^ & * ( ) _ + - ='."\n" + ."\n" + .'> 特殊字符的处理方法，请参见[如何解决连接串中账号密码包含特殊字符导致连接失败的问题？](~~471568~~)', + 'type' => 'string', + 'required' => true, + 'example' => 'Test123456!', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => '创建账号类型。取值：'."\n" + .'- **db**: 默认值，shard账号（仅支持）'."\n" + .'- **cs**：config server账号'."\n" + .'- **normal**：副本集账号'."\n" + ."\n" + .'> 当前仅支持创建**DB**账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'db', + 'default' => 'db', + 'enum' => [ + 'db', + 'cs', + 'normal', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '7FEF1BEF-2842-5758-9126-415A297XXXXX', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'Specified parameter AccountName is not valid.', + 'description' => '指定的参数AccountName无效。', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'Specified parameter AccountPassword is not valid.', + 'description' => '指定的参数AccountPassword无效。', + ], + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'Specified parameter AccountDescription is not valid.', + 'description' => '指定的参数AccountDescription无效。', + ], + ], + 404 => [ + [ + 'errorCode' => 'AccountLimitExceeded', + 'errorMessage' => 'AccountQuotaExceeded: Exceeding the allowed amount of account.', + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建Shard账号', + 'summary' => '创建MongoDB云盘版分片集群实例的Shard只读账号。', + 'description' => '- 仅云盘版分片集群实例创建Shard账号。'."\n" + .'- Shard账号的权限固定为只读权限。', + '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' => '创建MongoDB实例备份。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd-bp2235****', + ], + ], + [ + 'name' => 'BackupMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的备份方式，取值：'."\n" + .'- **Snapshot**：快照备份。'."\n" + .'- **Logical**：逻辑备份。'."\n" + .'- **Physical**（默认值）：物理备份。'."\n" + ."\n" + .'> - 云盘版实例仅支持快照备份。'."\n" + .'> - 仅副本集和分片集群实例支持选择备份方式。单节点实例无需传入本参数，固定为快照备份。', + 'type' => 'string', + 'required' => false, + 'example' => 'Logical', + 'default' => 'Physical', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份保留天数。'."\n" + ."\n" + .'> 不传表示和默认的备份策略保持一致。传递时，可传 '."\n" + .'>- 7-730天'."\n" + .'>- -1 （长久保留）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'BackupId' => [ + 'description' => '备份ID。'."\n" + ."\n" + .'> 该参数即将下线，如需获取备份ID，请调用[DescribeBackups](~~468441~~)接口获取。', + 'type' => 'string', + 'example' => '5664****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7016B12F-7F64-40A4-BAFF-013F02AC82FC', + ], + 'BackupJobId' => [ + 'title' => '备份任务ID', + 'description' => '备份任务ID。', + 'type' => 'string', + 'example' => '775051', + ], + ], + ], + ], + ], + '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' => '当前有正在进行的备份任务，请稍后再试。', + ], + [ + 'errorCode' => 'OperationDenied.NoDatabase', + 'errorMessage' => 'The operation is not permitted due to no database.', + 'description' => '', + ], + ], + ], + 'title' => '手动备份实例', + 'description' => '调用CreateBackup接口时，实例状态必须为运行中。', + '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}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupId\\": \\"5664****\\",\\n \\"RequestId\\": \\"7016B12F-7F64-40A4-BAFF-013F02AC82FC\\",\\n \\"BackupJobId\\": \\"775051\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBackupResponse>\\n <BackupId>5664****</BackupId>\\n <RequestId>7016B12F-7F64-40A4-BAFF-013F02AC82FC</RequestId>\\n</CreateBackupResponse>","errorExample":""}]', + ], + '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' => '地域ID，您可以通过调用[DescribeRegions](~~61933~~)接口查询地域ID。'."\n" + .'> 调用本接口克隆实例或者回收站恢复实例时，该参数值需和源实例保持一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID，您可以通过调用[DescribeRegions](~~61933~~)接口查询可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本号，取值：'."\n" + .'- **8.0**'."\n" + .'- **7.0**'."\n" + .'- **6.0**'."\n" + .'- **5.0**'."\n" + .'- **4.4**'."\n" + .'- **4.2**'."\n" + .'- **4.0**'."\n" + ."\n" + .'> 调用本接口克隆实例或者回收站恢复实例时，该参数值需和源实例保持一致。'."\n" + ."\n" + .'><warning>3.4及以下版本已停售。></warning>', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => '4.4', + 'enum' => [ + '4.0', + '4.2', + '4.4', + '5.0', + '6.0', + '7.0', + '3.4', + '8.0', + ], + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格，您可以通过调用[DescribeAvailableResource](~~149719~~)接口查询实例规格。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds.mongo.standard', + ], + ], + [ + 'name' => 'DBInstanceStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '实例存储空间，单位：GB。'."\n" + ."\n" + .'具体取值受实例规格约束，详情请参见[副本集实例规格表](~~311410~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称，取值说明：'."\n" + ."\n" + .'- 以中文、英文字母开头。'."\n" + .'- 可以包含数字、中文、英文、下划线（_）、点（.）和短横线（-）。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的IP白名单，多个IP地址请用英文逗号（,）分隔，不可重复。支持如下三种格式：'."\n" + ."\n" + .'- 0.0.0.0/0'."\n" + .'- IP地址形式，例如：10.23.12.24。'."\n" + .'- CIDR形式，例如：10.23.12.0/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。'."\n" + ."\n" + .'> - 每个实例最多添加1000个IP或IP段，即所有IP白名单分组内的IP或IP段总和不能超过1000。'."\n" + .'> - 0.0.0.0/0表示任何IP地址都可以访问实例的数据库，属于高危设置，请谨慎设置。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.xx.xx,192.168.xx.xx', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'root账号的密码，取值说明：'."\n" + ."\n" + .'- 由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n" + .'- !@#$%^&*()_+-=为特殊字符。'."\n" + .'- 长度为8~32个字符。'."\n" + ."\n" + .'> 关于特殊字符导致数据库连接失败的问题请参见[如何解决连接串中账号密码包含特殊字符导致连接失败的问题？](~~471568~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的购买时长，单位为月。'."\n" + ."\n" + .'取值范围：**1**~**9**（整数）、**12**、**24**、**36**、**60**。'."\n" + ."\n" + .'> 当**ChargeType**参数值为**PrePaid**时，该参数可用且为必填参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的付费类型，取值说明：'."\n" + ."\n" + .'- **PostPaid**：默认值，后付费（按量付费）。'."\n" + .'- **PrePaid**：预付费（包年包月）。'."\n" + ."\n" + .'> 当该参数的值为**PrePaid**时，您还需要配置**Period**参数。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'PrePaid', + 'default' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的网络类型，取值说明：'."\n" + ."\n" + .'**VPC**：专有网络。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'VPC', + 'default' => 'VPC', + 'enum' => [ + 'VPC', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络（VPC）ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vpc-bp175iuvg8nxqraf2****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + ], + [ + 'name' => 'SrcDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '源实例ID。'."\n" + .'> 调用本接口克隆实例时，您需要配置该参数，同时还需要配置**BackupId**或**RestoreTime**参数。调用本接口进行回收站恢复时，只需要传入该参数，无需配置**BackupId**或**RestoreTime**。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp1ee12ad351****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份点ID，您可以通过调用[DescribeBackups](~~62172~~)接口查询备份点ID。'."\n" + .'>只有调用本接口按备份点克隆实例时，您需要配置该参数，同时还需要配置**SrcDBInstanceId**参数。', + 'type' => 'string', + 'required' => false, + 'example' => '32994****', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '选择要恢复的时间点，您可以配置7天内的任意时间点。格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> 只有调用本接口按时间点克隆实例时，您需要配置该参数，同时还需要配置**SrcDBInstanceId**参数。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-13T12:11:14Z', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '实例是否自动续费，取值说明：'."\n" + ."\n" + .'- **true**：自动续费。'."\n" + .'- **false**：默认值，不自动续费，即手动续费。'."\n" + ."\n" + .'> 当**ChargeType**参数值为**PrePaid**时，该参数可用且为可选参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DatabaseNames', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。'."\n" + .'> 调用本接口克隆实例时，您可以通过配置该参数指定需要克隆的数据库，如果不配置该参数，则克隆实例的所有数据库。', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodbtest', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'StorageEngine', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的存储引擎，取值固定为**WiredTiger**。'."\n" + .'> - 调用本接口克隆实例或回收站恢复实例时，该参数需和源实例保持一致。'."\n" + .'> - 关于存储引擎与版本的选择约束，请参见[版本与存储引擎](~~61906~~)。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'WiredTiger', + 'default' => 'WiredTiger', + 'enum' => [ + 'WiredTiger', + ], + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => '副本集实例的**主备节点数**，取值：'."\n" + ."\n" + .'- **3**（默认值）'."\n" + .'- **5**'."\n" + .'- **7**'."\n" + ."\n" + .'><notice>单节点实例可不传该参数></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '3', + 'default' => '3', + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => '副本集实例的**只读节点数**，取值范围：**0**~**5**（整数），默认值为**0**。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '专属集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dhg-2x78****', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，固定取值：**MongoDB**。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'MongoDB', + 'enum' => [ + 'MongoDB', + ], + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '存储类型，取值说明：'."\n" + .'- **cloud_essd1**：ESSD PL1云盘。'."\n" + .'- **cloud_essd2**：ESSD PL2云盘。'."\n" + .'- **cloud_essd3**：ESSD PL3云盘。'."\n" + .'- **cloud_auto**：ESSD AutoPL云盘。'."\n" + .'- **local_ssd**：SSD本地盘。'."\n" + ."\n" + .'> - 单节点实例购买传递 cloud_essd1，实际使用 cloud_essd 云盘。'."\n" + .'> - ESSD AutoPL云盘目前仅支持中国站。'."\n" + .'> - 4.4及以上版本实例默认为**cloud_essd1**。'."\n" + .'> - 4.2及以下版本实例默认为**local_ssd**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd1', + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '配置从节点（Secondary节点）所在的可用区，实现多可用区部署。取值说明：'."\n" + ."\n" + .'- **cn-hangzhou-g**：杭州可用区G。'."\n" + .'- **cn-hangzhou-h**：杭州可用区H。'."\n" + .'- **cn-hangzhou-i**：杭州可用区I。'."\n" + .'- **cn-hongkong-b**：中国香港可用区B。'."\n" + .'- **cn-hongkong-c**：中国香港可用区C。'."\n" + .'- **cn-hongkong-d**：中国香港可用区D。'."\n" + .'- **cn-wulanchabu-a**：乌兰察布可用区A。'."\n" + .'- **cn-wulanchabu-b**：乌兰察布可用区B。'."\n" + .'- **cn-wulanchabu-c**：乌兰察布可用区C。'."\n" + .'- **ap-southeast-1a**：新加坡可用区A。'."\n" + .'- **ap-southeast-1b**：新加坡可用区B。'."\n" + .'- **ap-southeast-1c**：新加坡可用区C。'."\n" + .'- **ap-southeast-5a**：雅加达可用区A。'."\n" + .'- **ap-southeast-5b**：雅加达可用区B。'."\n" + .'- **ap-southeast-5c**：雅加达可用区C。'."\n" + .'- **eu-central-1a**：法兰克福可用区A。'."\n" + .'- **eu-central-1b**：法兰克福可用区B。'."\n" + .'- **eu-central-1c**：法兰克福可用区C。'."\n" + ."\n" + .'> - 当实例为云盘类型时，该参数可用。'."\n" + .'> - 该参数取值不能与**ZoneId**和**HiddenZoneId**参数值相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'HiddenZoneId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '配置隐藏节点（Hidden节点）所在的可用区，实现多可用区部署。取值说明：'."\n" + ."\n" + .'- **cn-hangzhou-g**：杭州可用区G。'."\n" + .'- **cn-hangzhou-h**：杭州可用区H。'."\n" + .'- **cn-hangzhou-i**：杭州可用区I。'."\n" + .'- **cn-hongkong-b**：中国香港可用区B。'."\n" + .'- **cn-hongkong-c**：中国香港可用区C。'."\n" + .'- **cn-hongkong-d**：中国香港可用区D。'."\n" + .'- **cn-wulanchabu-a**：乌兰察布可用区A。'."\n" + .'- **cn-wulanchabu-b**：乌兰察布可用区B。'."\n" + .'- **cn-wulanchabu-c**：乌兰察布可用区C。'."\n" + .'- **ap-southeast-1a**：新加坡可用区A。'."\n" + .'- **ap-southeast-1b**：新加坡可用区B。'."\n" + .'- **ap-southeast-1c**：新加坡可用区C。'."\n" + .'- **ap-southeast-5a**：雅加达可用区A。'."\n" + .'- **ap-southeast-5b**：雅加达可用区B。'."\n" + .'- **ap-southeast-5c**：雅加达可用区C。'."\n" + .'- **eu-central-1a**：法兰克福可用区A。'."\n" + .'- **eu-central-1b**：法兰克福可用区B。'."\n" + .'- **eu-central-1c**：法兰克福可用区C。'."\n" + ."\n" + .'> - 当实例为云盘类型时，该参数可用。'."\n" + .'> - 该参数值不能与**ZoneId**和**SecondaryZoneId**参数值相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户自定义标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。'."\n" + .'> - **N**表示传入第几个标签的键。例如：**Tag.1.Key**表示传入第一个标签的键；**Tag.2.Key**表示传入第二个标签的键。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdatabase', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + .'> **N**表示传入第几个标签的值。例如：**Tag.1.Value**表示传入第一个标签的值；**Tag.2.Value**表示传入第二个标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'GlobalSecurityGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的全局IP白名单模板，多个IP白名单模板请用英文逗号（,）分隔，不可重复。（功能灰度中）', + 'type' => 'string', + 'required' => false, + 'example' => 'g-qxieqf40xjst1ngpr3jz ', + ], + ], + [ + 'name' => 'Encrypted', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启云盘加密', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'flase', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义密钥ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => '预配置性能（IOPS）。取值范围为0~50000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1960', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => '备份恢复实例。'."\n" + .'- 0: 恢复实例到指定备份集'."\n" + .'- 1: 恢复实例到指定时间点'."\n" + .'- 2: 恢复已释放实例到指定备份集'."\n" + .'- 3: 恢复实例到指定的异地备份集', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '源实例所在区域。'."\n" + ."\n" + .'>- 当备份恢复类型为2或3时，需要且必填', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp144a7f2db8****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21077576248****', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '节点名称不合法'."\n", + ], + [ + '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 或 Version 或 InstanceClass 为空。', + ], + [ + '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' => '选择的主可用区、备可用区1和备可用区2参数不能完全相同。', + ], + [ + 'errorCode' => 'SameZoneId', + 'errorMessage' => 'The specified primary zone, secondary zone require two different zones.', + 'description' => '选择的主可用区、备可用区参数要求不同。', + ], + ], + 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' => 'The resource is out of usage.', + ], + [ + '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' => '创建或克隆副本集实例', + 'summary' => '创建或克隆云数据库 MongoDB 版副本集实例。', + 'description' => '请确保在使用该接口前，已充分了解云数据库MongoDB产品的收费方式和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .'关于云数据库MongoDB实例的规格，请参见[实例规格表](~~57141~~)。'."\n" + ."\n" + .'如需创建分片集群实例，您可以通过调用[CreateShardingDBInstance](~~61884~~)接口进行创建。', + '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' => '创建全局IP白名单模板。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'aizy', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'required' => true, + 'example' => '27.18.86.18,183.92.40.129', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8CA8312-530A-413A-9129-F2BB32A8D404', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'IP白名单模板列表', + 'type' => 'array', + 'items' => [ + 'description' => 'IP白名单模板', + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-2ifynl1jfkdlhhxgva3q', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'example' => 'developer', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '111.207.194.217,61.149.7.154', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => '创建全局IP白名单模板', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '为云数据库MongoDB分片集群实例添加Shard节点或Mongos节点。', + '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' => '分片集群实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp11501cd7b5****', + ], + ], + [ + 'name' => 'NodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'Shard节点或Mongos节点的规格，规格详情请参见[分片集群实例规格表](~~311414~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds.shard.mid', + ], + ], + [ + 'name' => 'NodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Node的磁盘空间，单位：GB。'."\n" + ."\n" + .'不同存储类型支持的取值范围不同，具体信息，请参见[分片集群实例规格表](~~311414~~)。'."\n" + ."\n" + .'> 当节点类型为**Shard**时，需要配置该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，取值说明：'."\n" + .'- **shard**：Shard节点。'."\n" + .'- **mongos**：Mongos节点。', + 'type' => 'string', + 'required' => true, + 'example' => 'shard', + 'enum' => [ + 'mongos', + 'shard', + ], + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费，取值说明：'."\n" + .'- **true**：（默认值）自动付费，请确保账号有足够的余额。'."\n" + .'<props="china">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，选择**订购订单**>**我的订单**，在**商品订单**页签找到目标订单进行支付。</props>'."\n" + .'<props="intl">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，单击**订单管理**，在**商品订单**页面找到目标订单进行支付。</props>'."\n" + ."\n" + .'> 当付费类型为包年包月时，需要配置该参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => '设置Shard节点中只读节点的个数。'."\n" + ."\n" + .'取值范围：**0**~**5**（整数），默认值为**0**。'."\n" + .'> 当前仅中国站支持本参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5', + 'minimum' => '0', + 'example' => '5', + 'default' => '0', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'ShardDirect', + 'in' => 'query', + 'schema' => [ + 'description' => '是否申请Shard节点直连地址，取值说明：'."\n" + ."\n" + .'- **true**：申请Shard节点直连地址。'."\n" + .'- **false**：（默认值）不申请Shard节点直连地址。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名，取值说明：'."\n" + ."\n" + .'- 以小写字母开头。'."\n" + .'- 由小写字母、数字或下划线（_）组成。'."\n" + .'- 长度为4~16个字符。'."\n" + ."\n" + .'>- 云数据库MongoDB不支持使用关键字作为账号。'."\n" + .'>- 账号的权限固定为只读权限。'."\n" + .'>- 首次申请Shard节点直连地址时，需要设置账号和密码，后续申请无需再次设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'ceshi', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号密码，取值说明：'."\n" + .'- 由大写字母、小写字母、数字、特殊字符中的至少三种组成。'."\n" + .'- !@#$%^&*()_+-=为特殊字符。'."\n" + .'- 长度为8~32个字符。'."\n" + ."\n" + .'>云数据库MongoDB不支持重置Shard节点的账号密码。', + 'type' => 'string', + 'required' => false, + 'example' => '123+abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7D48FB19-20CA-4725-A870-3D8F5CE6****', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'd-bp1b234bf7a4****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '20951063702****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SSLNotSupportAddNode', + 'errorMessage' => 'Instance with SSL certificate can\'t add node, please contact us to solve this problem.', + 'description' => 'SSL加密实例不允许添加节点，如您需要，请联系我们解决该问题。', + ], + [ + 'errorCode' => 'ErrorInsufficientResource', + 'errorMessage' => 'There is not enough resource for your operation, requestId: %s.', + 'description' => '当前操作资源不足，请求id: %s。', + ], + ], + ], + 'title' => '新增Shard节点或Mongos节点', + 'description' => '请确保在使用该接口前，已充分了解MongoDB产品的收费方式和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .'该接口仅适用于分片集群实例。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7D48FB19-20CA-4725-A870-3D8F5CE6****\\",\\n \\"NodeId\\": \\"d-bp1b234bf7a4****\\",\\n \\"OrderId\\": \\"20951063702****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateNodeResponse>\\n <RequestId>7D48FB19-20CA-4725-A870-3D8F5CE6****</RequestId>\\n <NodeId>d-bp1b234bf7a4****</NodeId>\\n <OrderId>20951063702****</OrderId>\\n</CreateNodeResponse>","errorExample":""}]', + ], + 'CreateNodeBatch' => [ + 'summary' => '为云数据库MongoDB分片集群实例批量添加Mongos节点、Shard节点。', + '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' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'FromApp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源，取值说明：'."\n" + .'- **OpenApi**：请求来源为OpenAPI。'."\n" + .'- **mongo_buy**：请求来源为控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenApi', + 'default' => 'OpenApi', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费，取值说明：'."\n" + ."\n" + .'- **true**：（默认值）自动付费，请确保账号有足够的余额。'."\n" + .'- **false**：手动付费。具体操作请参见[手动续费包年包月实例](~~85052~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要添加节点的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp18b0934e70****', + ], + ], + [ + 'name' => 'NodesInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '添加Mongos节点或Shard节点的规格信息。具体规格，请参见[实例规格表](~~57141~~)。'."\n" + ."\n" + .'> 分片集群实例默认最多支持32个Mongos节点和32个Shard节点。', + 'type' => 'string', + 'required' => true, + 'example' => '{"Shards":[{"DBInstanceClass":"mdb.shard.4x.large.d","Storage":20}]}', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'ShardDirect', + 'in' => 'query', + 'schema' => [ + 'description' => '是否申请Shard节点直连地址，取值说明：'."\n" + ."\n" + .'- **true**：申请Shard节点直连地址。'."\n" + .'- **false**：（默认值）不申请Shard节点直连地址。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名，取值说明：'."\n" + ."\n" + .'- 以小写字母开头。'."\n" + .'- 由小写字母、数字或下划线（_）组成。'."\n" + .'- 长度为4~16个字符。'."\n" + ."\n" + .'> - 云数据库MongoDB不支持使用关键字作为账号。'."\n" + .'> - 账号的权限固定为只读权限。'."\n" + .'> - 首次申请Shard节点直连地址时，需要设置账号和密码，后续申请无需再次设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'ceshi', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号密码，取值说明：'."\n" + .'- 由大写字母、小写字母、数字、特殊字符中的至少三种组成。'."\n" + .'- !@#$%^&*()_+-=为特殊字符。'."\n" + .'- 长度为8~32个字符。'."\n" + ."\n" + .'>云数据库MongoDB不支持重置Shard节点的账号密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'PassWord123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '55D41A94-1ACE-55E8-8BC7-67D622E7****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '50179021707****', + ], + 'NodeId' => [ + 'description' => '新增的Mongos节点或Shard节点ID。', + 'type' => 'string', + 'example' => 'd-bp18f7d6b6a7****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SSLNotSupportAddNode', + 'errorMessage' => 'Instance with SSL certificate can\'t add node, please contact us to solve this problem.', + 'description' => 'SSL加密实例不允许添加节点，如您需要，请联系我们解决该问题。', + ], + [ + 'errorCode' => 'ErrorInsufficientResource', + 'errorMessage' => 'There is not enough resource for your operation, requestId: %s.', + 'description' => '当前操作资源不足，请求id: %s。', + ], + ], + ], + 'title' => '批量创建节点', + 'description' => '请确保在使用该接口前，已充分了解云数据库MongoDB产品的收费方式和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .'该接口仅适用于云数据库MongoDB分片集群实例。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze09d7be1fxxxxx', + ], + ], + [ + 'name' => 'ShardList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Shard节点ID。'."\n" + .'>- 当为分片集群实例Shard节点创建角色标签时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-l5xf98b78b9fxxxx,d-l5xf98b7sf9fxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B0B7DE3E-xxxx-xxxx-xxxx-0B16F8834E0B', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => '输入的参数无效。', + ], + [ + 'errorCode' => 'InvalidFilterParam', + 'errorMessage' => 'Specified filter is not valid.', + 'description' => '', + ], + ], + ], + 'title' => '创建节点角色标签', + 'summary' => '创建实例节点角色标签。', + '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' => '地域ID，您可以通过调用[DescribeRegions](~~61933~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID，您可以通过调用[DescribeRegions](~~61933~~)接口查询可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎。固定取值：**MongoDB**。', + 'type' => 'string', + 'required' => true, + 'example' => 'MongoDB', + 'enum' => [ + 'MongoDB', + ], + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本号，取值：'."\n" + .'- **8.0**'."\n" + .'- **7.0**'."\n" + .'- **6.0**'."\n" + .'- **5.0**'."\n" + .'- **4.4**'."\n" + .'- **4.2**'."\n" + .'- **4.0**'."\n" + ."\n" + .'> - 关于存储引擎与版本的选择约束，请参见[版本与存储引擎](~~61906~~)。'."\n" + .'> - 调用本接口克隆实例时，该参数值需和源实例保持一致。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => '4.4', + 'enum' => [ + '3.0', + '3.2', + '3.4', + '4.0', + '4.2', + '4.4', + '5.0', + '6.0', + '7.0', + '8.0', + ], + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称，取值说明：'."\n" + .'- 以中文、英文字母开头。'."\n" + .'- 可以包含数字、中文、英文、下划线（_）、点（.）和短横线（-）。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的IP白名单，多个IP地址请用英文逗号（,）分隔，不可重复。支持如下三种格式：'."\n" + .'- 0.0.0.0/0'."\n" + .'- IP地址形式，例如：10.23.12.24。'."\n" + .'- CIDR形式，例如：10.23.12.0/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。'."\n" + ."\n" + .'> - 每个实例最多添加1000个IP或IP段，即所有IP白名单分组内的IP或IP段总和不能超过1000。'."\n" + .'> - 0.0.0.0/0表示任何IP地址都可以访问实例的数据库，属于高危设置，请谨慎设置。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.xx.xx,192.168.xx.xx', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'root账号的密码，取值说明：'."\n" + .'- 由大写字母、小写字母、数字、特殊字符中的至少三种组成。'."\n" + .'- !@#$%^&*()_+-=为特殊字符。'."\n" + .'- 长度为8~32个字符。'."\n" + ."\n" + .'> 关于特殊字符导致数据库连接失败的问题请参见[如何解决连接串中账号密码包含特殊字符导致连接失败的问题？](~~471568~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的付费类型，取值说明：'."\n" + ."\n" + .'- **PostPaid**：默认值，后付费（按量付费）。'."\n" + .'- **PrePaid**：预付费（包年包月）。'."\n" + ."\n" + .'> 当该参数的值为**PrePaid**时，您还需要配置**Period**参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrePaid', + 'default' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的购买时长，单位为月。'."\n" + ."\n" + .'取值范围：**1**~**9**（整数）、**12**、**24**、**36**、**60**。'."\n" + .'> 当**ChargeType**参数值为**PrePaid**时，该参数可用且为必填参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的网络类型，取值说明：'."\n" + ."\n" + .'**VPC**：专有网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + 'default' => 'VPC', + 'enum' => [ + 'VPC', + 'Classic', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络（VPC）ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vpc-bp1n3i15v90el48nx****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vsw-bp1vj604nj5a9zz74****', + ], + ], + [ + 'name' => 'SrcDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '源实例ID。'."\n" + .'>只有调用本接口克隆实例时，您需要配置该参数，同时还需要配置**RestoreTime**参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp11483712c1****', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '选择要恢复的时间点，您可以配置7天内的任意时间点。格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'>只有调用本接口克隆实例时，您需要配置该参数，同时还需要配置**SrcDBInstanceId**参数。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-08T02:30:25Z', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'StorageEngine', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的存储引擎，取值固定为**WiredTiger**。'."\n" + ."\n" + .'> - 调用本接口克隆实例时，该参数需和源实例保持一致。'."\n" + .'> - 关于存储引擎与版本的选择约束，请参见[版本与存储引擎](~~61906~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'WiredTiger', + 'default' => 'WiredTiger', + 'enum' => [ + 'WiredTiger', + 'RocksDB', + ], + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '实例是否自动续费，取值说明：'."\n" + ."\n" + .'- **true**：自动续费。'."\n" + .'- **false**：默认值，不自动续费，即手动续费。'."\n" + ."\n" + .'> 当**ChargeType**参数值为**PrePaid**时，该参数可用且为可选参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问协议的类型，取值说明：'."\n" + .'- **mongodb**：MongoDB协议。'."\n" + .'- **dynamodb**：DynamoDB协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodb', + 'default' => 'mongodb', + 'enum' => [ + 'mongodb', + 'dynamodb', + ], + ], + ], + [ + 'name' => 'Mongos', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Mongos节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'Mongos节点信息。', + 'type' => 'object', + 'properties' => [ + 'Class' => [ + 'description' => 'Mongos节点的规格，取值详情请参见[分片集群实例规格表](~~311414~~)。'."\n" + ."\n" + .'> - 参数名中的**N**代表传入第几个Mongos节点的规格。例如，**Mongos.2.Class**表示传入第二个Mongos节点的规格。'."\n" + .'> - **N**的取值范围为**2**~**32**。', + 'type' => 'string', + 'required' => true, + 'example' => 'mdb.shard.2x.xlarge.d', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 32, + ], + ], + [ + 'name' => 'ReplicaSet', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Shard节点的信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'Shard节点的信息。', + 'type' => 'object', + 'properties' => [ + 'Class' => [ + 'description' => 'Shard节点的规格，取值详情请参见[分片集群实例规格表](~~311414~~)。'."\n" + ."\n" + .'> - 参数名中的**N**代表传入第几个Shard节点的规格。例如，**ReplicaSet.2.Class**表示传入第二个Shard节点的规格。'."\n" + .'> - **N**的取值范围为**2**~**32**。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds.shard.standard', + ], + 'Storage' => [ + 'description' => 'Shard节点的存储空间，单位为GB。'."\n" + ."\n" + .'> - 具体取值受实例规格约束，取值详情请参见[分片集群实例规格表](~~311414~~)。'."\n" + .'> - 参数名中的**N**代表的是传入第几个Shard节点的存储空间，例如：**ReplicaSet.2.Storage**表示传入第二个Shard节点的存储空间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + 'ReadonlyReplicas' => [ + 'description' => '设置Shard节点的只读节点个数。'."\n" + ."\n" + .'取值范围：**0**~**5**（整数），默认值为**0**。'."\n" + .'>参数名中的**N**代表设置第几个Shard节点中的只读节点个数。例如，**ReplicaSet.2.ReadonlyReplicas**表示设置第二个Shard节点的只读节点个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 32, + ], + ], + [ + 'name' => 'ConfigServer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'ConfigServer节点的信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'ConfigServer节点的信息。', + 'type' => 'object', + 'properties' => [ + 'Class' => [ + 'description' => 'ConfigServer的规格，取值说明：'."\n" + .'- **mdb.shard.2x.xlarge.d**：4核 8 GB（独享型），仅支持4.4及以上版本的实例。'."\n" + .'- **dds.cs.mid**：1核 2 GB（通用型），仅支持4.2及以下版本的实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'mdb.shard.2x.xlarge.d', + ], + 'Storage' => [ + 'description' => 'ConfigServer的存储空间，单位为GB。'."\n" + ."\n" + .'>具体取值受实例规格约束，取值详情请参见[分片集群实例规格表](~~311414~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 32, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，资源组详情请参见[查看资源组基本信息](~~151181~~)。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置备可用区1，实现多可用区部署。取值说明：'."\n" + .'- **cn-hangzhou-g**：杭州可用区G。'."\n" + .'- **cn-hangzhou-h**：杭州可用区H。'."\n" + .'- **cn-hangzhou-i**：杭州可用区I。'."\n" + .'- **cn-hongkong-b**：中国香港可用区B。'."\n" + .'- **cn-hongkong-c**：中国香港可用区C。'."\n" + .'- **cn-hongkong-d**：中国香港可用区D。'."\n" + .'- **cn-wulanchabu-a**：乌兰察布可用区A。'."\n" + .'- **cn-wulanchabu-b**：乌兰察布可用区B。'."\n" + .'- **cn-wulanchabu-c**：乌兰察布可用区C。'."\n" + .'- **ap-southeast-1a**：新加坡可用区A。'."\n" + .'- **ap-southeast-1b**：新加坡可用区B。'."\n" + .'- **ap-southeast-1c**：新加坡可用区C。'."\n" + .'- **ap-southeast-5a**：雅加达可用区A。'."\n" + .'- **ap-southeast-5b**：雅加达可用区B。'."\n" + .'- **ap-southeast-5c**：雅加达可用区C。'."\n" + .'- **eu-central-1a**：法兰克福可用区A。'."\n" + .'- **eu-central-1b**：法兰克福可用区B。'."\n" + .'- **eu-central-1c**：法兰克福可用区C。'."\n" + .'>- 当实例为云盘类型时，该参数可用。'."\n" + .'>- 该参数值不能与**ZoneId**和**HiddenZoneId**相同。'."\n" + .'>- 分片集群实例的多可用区部署策略，具体请参见[创建多可用区分片集群实例](~~117865~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'HiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置备可用区2，实现多可用区部署。取值说明：'."\n" + .'- **cn-hangzhou-g**：杭州可用区G。'."\n" + .'- **cn-hangzhou-h**：杭州可用区H。'."\n" + .'- **cn-hangzhou-i**：杭州可用区I。'."\n" + .'- **cn-hongkong-b**：中国香港可用区B。'."\n" + .'- **cn-hongkong-c**：中国香港可用区C。'."\n" + .'- **cn-hongkong-d**：中国香港可用区D。'."\n" + .'- **cn-wulanchabu-a**：乌兰察布可用区A。'."\n" + .'- **cn-wulanchabu-b**：乌兰察布可用区B。'."\n" + .'- **cn-wulanchabu-c**：乌兰察布可用区C。'."\n" + .'- **ap-southeast-1a**：新加坡可用区A。'."\n" + .'- **ap-southeast-1b**：新加坡可用区B。'."\n" + .'- **ap-southeast-1c**：新加坡可用区C。'."\n" + .'- **ap-southeast-5a**：雅加达可用区A。'."\n" + .'- **ap-southeast-5b**：雅加达可用区B。'."\n" + .'- **ap-southeast-5c**：雅加达可用区C。'."\n" + .'- **eu-central-1a**：法兰克福可用区A。'."\n" + .'- **eu-central-1b**：法兰克福可用区B。'."\n" + .'- **eu-central-1c**：法兰克福可用区C。'."\n" + ."\n" + .'> - 当实例为云盘类型时，该参数可用。'."\n" + .'> - 该参数值不能与**ZoneId**和**SecondaryZoneId**相同。'."\n" + .'> - 分片集群实例的多可用区部署策略，具体请参见[创建多可用区分片集群实例](~~117865~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '存储类型，取值说明： '."\n" + ."\n" + .'- **cloud_essd1**：ESSD PL1云盘。'."\n" + .'- **cloud_essd2**：ESSD PL2云盘。'."\n" + .'- **cloud_essd3**：ESSD PL3云盘。'."\n" + .'- **local_ssd**：SSD本地盘。'."\n" + ."\n" + .'> - 4.4及以上版本实例只支持云盘，不填写默认选择**cloud_essd1**。'."\n" + .'> - 4.2及以下版本实例只支持本地盘，不填写默认选择**local_ssd**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd1', + ], + ], + [ + 'name' => 'GlobalSecurityGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的全局IP白名单模板，多个IP白名单模板请用英文逗号（,）分隔，不可重复。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-qxieqf40xjst1ngpr3jz ', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户自定义标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。'."\n" + .'> - **N**表示传入第几个标签的键。例如：**Tag.1.Key**表示传入第一个标签的键；**Tag.2.Key**表示传入第二个标签的键。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdatabase', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + .'> **N**表示传入第几个标签的值。例如：**Tag.1.Value**表示传入第一个标签的值；**Tag.2.Value**表示传入第二个标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'Encrypted', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启云盘加密', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义密钥ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => '预配置IOPS', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1960', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '源实例所在区域。'."\n" + ."\n" + .'>- 当备份恢复类型为已删除实例重建时，需要且必填'."\n" + .'>- 当备份恢复类型为异地备份克隆时，需要且必填', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群备份ID。'."\n" + ."\n\n" + .'> - 仅当 RestoreType=2或3 时需要且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cb-xxx', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => '备份恢复实例。'."\n" + ."\n" + .'- 1: 恢复实例到指定时间点'."\n" + .'- 2: 恢复已释放实例到指定备份集'."\n" + .'- 3: 恢复实例到指定的异地备份集', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp114f14849d****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21010996721****', + ], + ], + ], + ], + ], + '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' => '输入的参数无效。', + ], + [ + 'errorCode' => 'RestoreTypeNotSupported', + 'errorMessage' => 'The specified restoreType is not supported for the instance, check the input parameters \'RestoreType/BackupID/RestoreTime\'.', + 'description' => '指明的恢复类型实例不支持，检查 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' => '实例克隆\\恢复不支持缩小磁盘空间大小。', + ], + ], + 500 => [ + [ + 'errorCode' => 'VpcServiceError', + 'errorMessage' => 'Invoke vpc service error.', + 'description' => '调用vpc服务错误。', + ], + ], + ], + 'title' => '创建或克隆分片集群实例', + 'summary' => '创建或者克隆 MongoDB 分片集群实例。', + 'description' => '- 请确保在使用该接口前，已充分了解云数据库MongoDB的收费方式和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .'- 关于云数据库MongoDB实例的规格，请参见[实例规格表](~~57141~~)。'."\n" + .'- 如果需要创建单节点实例和副本集实例，您可以通过调用[CreateDBInstance](~~61763~~)接口创建。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8F1D721-6439-4257-A89C-F1E8E9C9****\\",\\n \\"DBInstanceId\\": \\"dds-bp114f14849d****\\",\\n \\"OrderId\\": \\"21010996721****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateShardingDBInstanceResponse>\\n <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId>\\n <DBInstanceId>dds-bp114f14849d****</DBInstanceId>\\n <OrderId>21010996721****</OrderId>\\n</CreateShardingDBInstanceResponse>","errorExample":""}]', + ], + 'DeleteBackup' => [ + 'summary' => '删除MongoDB备份集', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dds-bp11483712c1****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID。', + 'type' => 'string', + 'required' => true, + 'example' => '5664****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7A9807F0-1301-4154-9849-6497E94A****', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '当前有正在进行的备份任务，请稍后再试。', + ], + [ + 'errorCode' => 'OperationDenied.NoDatabase', + 'errorMessage' => 'The operation is not permitted due to no database.', + 'description' => '', + ], + ], + ], + 'title' => '删除MongoDB备份集', + 'description' => '仅支持删除手动备份。'."\n" + ."\n" + .'仅支持云盘版MongoDB实例。', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A9807F0-1301-4154-9849-6497E94A****\\"\\n}","type":"json"}]', + ], + 'DeleteDBInstance' => [ + 'summary' => '释放MongoDB实例。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '72651AF9-7897-41A7-8B67-6C15C7F26A0A', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '删除数据库实例', + 'description' => '调用该接口时，实例必须满足以下条件。 '."\n" + ."\n" + .'- 实例状态为运行中；'."\n" + .'- 实例付费类型为按量付费。'."\n" + ."\n" + .'> 实例释放后数据将无法找回，请谨慎操作。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"72651AF9-7897-41A7-8B67-6C15C7F26A0A\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteDBInstanceResponse>\\r\\n\\t<RequestId>72651AF9-7897-41A7-8B67-6C15C7F26A0A</RequestId>\\r\\n</DeleteDBInstanceResponse>","errorExample":""}]', + ], + 'DeleteGlobalSecurityIPGroup' => [ + 'summary' => '删除全局IP白名单模板。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'corp', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-qxieqf40xjst1ngpr3jz', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求唯一ID，如果遇到问题请提供这个请求ID，由工作人员为您排查。', + 'type' => 'string', + 'example' => '2F42BB4E-461F-5B55-A37C-53B1141C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除全局IP白名单模板', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DeleteGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的Shard节点ID或Mongos节点ID，您可以通过[DescribeDBInstanceAttribute](~~61923~~)接口查询节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 's-bpxxxxxxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '111111111', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9F9BDE64-BF30-41F3-BD29-C19CE4AB3404', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '111111111111111', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除分片集群实例中的节点', + 'summary' => '删除MongoDB分片集群实例中的Shard节点或Mongos节点。', + 'description' => '调用本接口时，实例必须满足以下条件： '."\n" + .'- 实例状态为运行中。'."\n" + .'- 实例类型为分片集群实例。'."\n" + .'- 实例付费类型为按量付费。'."\n" + .'- 实例中Shard节点或Mongos节点的数量必须大于2。', + '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' => '[{"type":"json","example":"{\\n \\"TaskId\\": 111111111,\\n \\"RequestId\\": \\"9F9BDE64-BF30-41F3-BD29-C19CE4AB3404\\",\\n \\"OrderId\\": \\"111111111111111\\"\\n}","errorExample":""},{"type":"xml","example":"<TaskId>111111111</TaskId>\\n<RequestId>04BDBD93-3B59-496C-8B5E-7FF158E10C5C</RequestId>\\n<OrderId>111111111111111</OrderId>","errorExample":""}]', + ], + 'DescribeAccounts' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1fd530f271****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名。', + 'type' => 'string', + 'required' => false, + 'example' => 'root', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B562A65B-39AB-4EE8-8635-5A222054FB35', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => '账号信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CharacterType' => [ + 'description' => '账号的角色类型，取值说明：'."\n" + .'- **db**: shard角色。'."\n" + .'- **cs**：config server角色。'."\n" + .'- **mongos**：mongos角色。'."\n" + .'- **logic**：分片集群实例。'."\n" + .'- **normal**：副本集实例。', + 'type' => 'string', + 'example' => 'mongos', + ], + 'AccountStatus' => [ + 'description' => '账号的状态，取值说明：'."\n" + .'- **Unavailable**：不可用。'."\n" + .'- **Available**：可用。', + 'type' => 'string', + 'example' => 'Available', + 'default' => 'Unavailable', + ], + 'AccountDescription' => [ + 'description' => '账号备注信息。'."\n" + ."\n" + .'> 调用[ModifyAccountDescription](~~468391~~)接口设置账号备注信息后才会返回该参数。', + 'type' => 'string', + 'example' => '管理员', + ], + 'DBInstanceId' => [ + 'description' => '账号所属的实例ID。', + 'type' => 'string', + 'example' => 'dds-bp1fd530f271****', + ], + 'AccountName' => [ + 'description' => '账号名。', + 'type' => 'string', + 'example' => 'root', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ResponseEmptyError', + 'errorMessage' => 'The Response is empty, maybe server request timeout.', + 'description' => '', + ], + ], + ], + 'title' => '查询实例的数据库账号信息', + 'summary' => '查询MongoDB实例的数据库账号信息。', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeAccountsResponse>\\n <RequestId>B562A65B-39AB-4EE8-8635-5A222054FB35</RequestId>\\n <Accounts>\\n <CharacterType>mongos</CharacterType>\\n <AccountStatus>Available</AccountStatus>\\n <AccountDescription>管理员</AccountDescription>\\n <DBInstanceId>dds-bp1fd530f271****</DBInstanceId>\\n <AccountName>root</AccountName>\\n </Accounts>\\n</DescribeAccountsResponse>","errorExample":""}]', + ], + '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' => '是否已配置：'."\n" + ."\n" + .'- 1：已经配置；'."\n" + .'- 0：未配置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '72651AF9-7897-41A7-8B67-6C15C7F26A0A', + ], + 'Config' => [ + 'description' => '配置的详情信息。', + 'type' => 'object', + 'properties' => [ + 'CycleType' => [ + 'description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', + 'type' => 'string', + 'example' => 'Month', + ], + 'Status' => [ + 'description' => '配置是否生效。'."\n" + ."\n" + .'- 1 生效'."\n" + .'- 2 无效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ModifiedTime' => [ + 'description' => '修改运维任务配置的时间点，格式为<i>yyyy-mm-dd</i>T<i>hh:mm:ss</i>Z （utc时间）。', + 'type' => 'string', + 'example' => '2024-05-30T14:30:00Z', + ], + 'MaintainStartTime' => [ + 'description' => '运维时间窗口开始时间，格式为<i>hh:mm:ss</i>Z (utc时间)。', + 'type' => 'string', + 'example' => '18:00:00Z', + ], + 'MaintainEndTime' => [ + 'description' => '运维时间窗口结束时间，格式为<i>hh:mm:ss</i>Z (utc时间)。', + 'type' => 'string', + 'example' => '20:00:00Z'."\n", + ], + 'CycleTime' => [ + 'description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', + 'type' => 'string', + 'example' => '1,2,3', + ], + 'CreatedTime' => [ + 'description' => '创建运维任务配置的时间点，格式为<i>yyyy-mm-dd</i>T<i>hh:mm:ss</i>Z （utc时间）。', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询实例的运维任务配置', + 'summary' => '查询MongoDB实例的运维任务配置。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationMaintenanceConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '待处理事件所属的地域 ID，可通过[DescribeRegions](~~61933~~)查询。all代表查询该用户下所有的任务，此参数为all， taskType也必须为all。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + ."\n" + .'- rds_apsaradb_ha：主从节点切换。'."\n" + .'- rds_apsaradb_transfer：实例迁移。'."\n" + .'- rds_apsaradb_upgrade：小版本升级。'."\n" + ."\n" + .'取值来源[DescribeHistoryTasks](~~2639186~~)。'."\n" + ."\n" + .'传入all代表查询该用户下所有的任务，此参数为all时， region也必须为all。', + 'type' => 'string', + 'required' => true, + 'example' => 'rds_apsaradb_ha', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回历史任务，取值：'."\n" + ."\n" + .'- 0：默认值，返回当前任务。'."\n" + .'- 1：返回历史任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的最大记录数，取值需大于 10，默认值为 30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => '产品ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'MongoDB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FD47DC4-0750-5524-A89E-E7D559Cxxxxx', + ], + 'PageSize' => [ + 'description' => '每页记录数，默认值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态，返回值：'."\n" + .'- 2：等待用户指定时间。'."\n" + .'- 3：等待处理。'."\n" + .'- 4：处理中。进入此状态后，不可修改计划切换时间。'."\n" + .'- 5：成功。'."\n" + .'- 6：失败。'."\n" + .'- 7：已取消。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TaskParams' => [ + 'description' => '任务参数。', + 'type' => 'string', + 'example' => '""', + ], + 'PrepareInterval' => [ + 'description' => '运维任务开始时间到切换时间之间所需的准备时间，格式为HH:mm:ss。', + 'type' => 'string', + 'example' => '14:00:00', + ], + 'Deadline' => [ + 'description' => '运维任务执行时间可调整范围的最晚期时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。', + 'type' => 'string', + 'example' => '2023-03-29T13:59:59Z', + ], + 'StartTime' => [ + 'description' => '运维任务执行的时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。', + 'type' => 'string', + 'example' => '2023-03-20T02:40:00Z', + ], + 'TaskType' => [ + 'description' => '任务类型，返回值：'."\n" + ."\n" + .'- rds_apsaradb_ha：主从节点切换。'."\n" + .'- rds_apsaradb_transfer：实例迁移。'."\n" + .'- rds_apsaradb_upgrade：小版本升级。', + 'type' => 'string', + 'example' => 'rds_apsaradb_ha', + ], + 'ModifiedTime' => [ + 'description' => '运维任务修改时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。', + 'type' => 'string', + 'example' => '2023-02-24T08:18:53Z', + ], + 'InsName' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'example' => 'dds-bp12721xxxx9b914', + ], + 'DbType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'mongodb', + ], + 'Region' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ResultInfo' => [ + 'description' => '执行结果信息。', + 'type' => 'string', + 'example' => '""', + ], + 'CreatedTime' => [ + 'description' => '运维任务创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。', + 'type' => 'string', + 'example' => '2024-11-06T13:11:08Z', + ], + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50xx', + ], + 'SwitchTime' => [ + 'description' => '运维任务切换时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。', + 'type' => 'string', + 'example' => '2024-11-06T14:11:08Z'."\n", + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'title' => '查询运维任务详情', + 'summary' => '查询运维任务详情。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp5689ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '770D7F11-21A2-402B-9DF6-D1A620570EF9', + ], + 'NeedPop' => [ + 'description' => '是否有需要弹窗通知用户操作的运维任务。返回值：'."\n" + .'- **0**：无弹窗'."\n" + .'- **1**：有弹窗', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TaskCount' => [ + 'description' => '待处理的运维任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'title' => '查询MongoDB实例的运维任务数量', + 'summary' => '查询MongoDB实例的运维任务数量。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"770D7F11-21A2-402B-9DF6-D1A620570EF9\\",\\n \\"NeedPop\\": 0,\\n \\"TaskCount\\": 0\\n}","errorExample":""},{"type":"xml","example":"<DescribeActiveOperationTaskCountResponse>\\n <RequestId>770D7F11-21A2-402B-9DF6-D1A620570EF9</RequestId>\\n <NeedPop>0</NeedPop>\\n <TaskCount>0</TaskCount>\\n</DescribeActiveOperationTaskCountResponse>","errorExample":""}]', + ], + 'DescribeActiveOperationTaskRegion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '8255', + 'abilityTreeNodes' => [ + 'FEATUREmongodbOM9UA4', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + ."\n" + .'- rds_apsaradb_ha：主从节点切换。'."\n" + .'- rds_apsaradb_transfer：实例迁移。'."\n" + .'- rds_apsaradb_upgrade：小版本升级。', + 'type' => 'string', + 'required' => true, + 'example' => 'rds_apsaradb_upgrade', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回历史任务，取值：'."\n" + ."\n" + .'- 0：默认值，返回当前任务。'."\n" + .'- 1：返回历史任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C4A2494-XXXX-XXXX-93CF-548DB3375193', + ], + 'RegionList' => [ + 'description' => '地域列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'Count' => [ + 'description' => '任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'title' => '查询运维任务类型和任务数量', + 'summary' => '查询MongoDB实例的运维任务类型和任务数量。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskRegion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '是否返回历史运维任务。取值：'."\n" + .'- **0**（默认值）：仅返回当前待处理的运维任务。'."\n" + .'- **1**：返回历史运维任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。您可以调用[DescribeSecurityGroupConfiguration](~~146130~~)接口查询。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7EE83BF-7BA8-5087-BAC9-ED85ED54****', + ], + 'TypeList' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => '任务的类型。返回值：'."\n" + .'- **rds_apsaradb_transfer**：实例迁移。'."\n" + .'- **rds_apsaradb_upgrade**：小版本升级。', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'TaskTypeInfoEn' => [ + 'description' => '任务类型（英文）。', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'TaskTypeInfoZh' => [ + 'description' => '任务类型（中文）。', + 'type' => 'string', + 'example' => '小版本升级', + ], + 'Count' => [ + 'description' => '待处理的任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'title' => '查询运维任务类型和任务数量', + 'summary' => '查询实例的运维任务类型以及各类型的任务数量。', + 'description' => '该接口即将下线，后续将不再更新。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeActiveOperationTaskTypeResponse>\\n <RequestId>C7EE83BF-7BA8-5087-BAC9-ED85ED54****</RequestId>\\n <TypeList>\\n <TaskTypeInfoZh>小版本升级</TaskTypeInfoZh>\\n <TaskType>rds_apsaradb_upgrade</TaskType>\\n <Count>0</Count>\\n <TaskTypeInfoEn>Minor version update</TaskTypeInfoEn>\\n </TypeList>\\n</DescribeActiveOperationTaskTypeResponse>","errorExample":""}]', + ], + 'DescribeActiveOperationTasks' => [ + 'summary' => '查询MongoDB实例的计划内运维任务详情。', + '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' => '待处理事件所属的地域 ID，可调用 DescribeRegions 接口获取。'."\n" + .'> 取值为**all**表示所有地域 ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + ."\n" + .'- **rds_apsaradb_ha**：主从节点切换。'."\n" + .'- **rds_apsaradb_transfer**：实例迁移。'."\n" + .'- **rds_apsaradb_upgrade**：小版本升级。'."\n" + .'- **rds_apsaradb_maxscale**: 代理小版本升级。'."\n" + .'- **all**：所有任务类型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值： **30**、**50**、**100**，默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。大于**0**，默认为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名称，对于MongoDB实例可传入**MongoDB**。', + 'type' => 'string', + 'required' => false, + 'example' => 'MongoDB', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，默认为**all**。', + 'type' => 'string', + 'required' => false, + 'example' => 'mongoDb', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，用于筛选返回任务。'."\n" + ."\n" + .'- **-1**：全部任务。'."\n" + .'- **3**：待处理任务。'."\n" + .'- **4**：处理中任务。'."\n" + .'- **5**：成功结束任务。'."\n" + .'- **6**：失败结束任务。'."\n" + .'- **7**：已取消任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'InsName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的名称。可不填，填写时只允许填写至多一个实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp16aaccfe10****', + ], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许修改时间。取值如下：'."\n" + .'- **-1**（默认）：返回全部任务。'."\n" + .'- **0**：只返回不允许修改时间的任务。'."\n" + .'- **1**：只返回允许修改时间的任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许取消。取值如下：'."\n" + .'- **-1**（默认）：返回全部任务。'."\n" + .'- **0**：只返回不允许取消的任务。'."\n" + .'- **1**：只返回允许取消的任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值如下：'."\n" + .'- **all**（默认）：返回全部任务。'."\n" + .'- **S0**：返回异常修复级别的任务。'."\n" + .'- **S1**：返回系统运维级别的任务。', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '111E7B16-0A87-4CBA-B271-F34AD61E****', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalRecordCount' => [ + 'description' => '返回的任务记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '运维任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'- **3**：待处理任务。'."\n" + .'- **4**：处理中任务。'."\n" + .'- **5**：成功结束任务。'."\n" + .'- **6**：失败结束任务。'."\n" + .'- **7**：已取消任务。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ChangeLevelEn' => [ + 'description' => '事件等级（英文）。', + 'type' => 'string', + 'example' => 'System maintenance', + ], + 'TaskType' => [ + 'description' => '任务类型，取值：'."\n" + ."\n" + .'- **rds_apsaradb_ha**：主从节点切换。'."\n" + .'- **rds_apsaradb_transfer**：实例迁移。'."\n" + .'- **rds_apsaradb_upgrade**：小版本升级。'."\n" + .'- **rds_apsaradb_maxscale**: 代理小版本升级。'."\n" + .'- **all**：所有任务类型。', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'InsName' => [ + 'description' => '实例名。', + 'type' => 'string', + 'example' => 'dds-bp16aaccfe10****', + ], + 'Region' => [ + 'description' => '待处理事件所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing'."\n", + ], + 'ImpactZh' => [ + 'description' => '事件影响（中文）。', + 'type' => 'string', + 'example' => '实例闪断', + ], + 'CreatedTime' => [ + 'description' => '创建时间，格式为<i>yyyy-mm-dd</i>T<i>hh:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-05-30T14:30:00Z', + ], + 'SwitchTime' => [ + 'description' => '后台发起切换操作的时间点，格式为<i>yyyy-mm-dd</i>T<i>hh:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-05-30T14:30:00Z', + ], + 'ChangeLevelZh' => [ + 'description' => '事件等级（中文）。', + 'type' => 'string', + 'example' => '系统运维', + ], + 'Deadline' => [ + 'description' => '任务执行时间可调整范围的最晚期限，格式为<i>yyyy-mm-dd</i>T<i>hh:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-05-30T23:59:59Z', + ], + 'PrepareInterval' => [ + 'description' => '运维任务开始时间到切换时间之间所需的准备时间，格式为<i>HH:mm:ss</i>。', + 'type' => 'string', + 'example' => '04:00:00', + ], + 'TaskTypeZh' => [ + 'description' => '任务原因（中文）。', + 'type' => 'string', + 'example' => '小版本升级', + ], + 'CurrentAVZ' => [ + 'description' => '当前可用区。', + 'type' => 'string', + 'example' => 'cn-beijing-h', + ], + 'AllowChange' => [ + 'description' => '是否允许修改时间。'."\n" + .'- **1**：表示允许用户修改时间。'."\n" + .'- **0**：表示不允许用户修改时间。', + 'type' => 'string', + 'example' => '1', + ], + 'DbVersion' => [ + 'description' => '数据库引擎版本号。', + 'type' => 'string', + 'example' => '5.6', + ], + 'ImpactEn' => [ + 'description' => '事件影响（英文）。', + 'type' => 'string', + 'example' => 'Transient instance disconnection'."\n", + ], + 'InsComment' => [ + 'description' => '实例别名/实例备注。', + 'type' => 'string', + 'example' => 'test', + ], + 'StartTime' => [ + 'description' => '后台执行任务的时间点，格式为<i>yyyy-mm-dd</i>T<i>hh:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-05-30T00:00:00Z', + ], + 'ModifiedTime' => [ + 'description' => '修改时间，格式为<i>yyyy-mm-dd</i>T<i>hh:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-05-30T14:30:00Z'."\n", + ], + 'AllowCancel' => [ + 'description' => '是否允许取消。'."\n" + .'- **1**：允许用户取消任务。'."\n" + .'- **0**：表示不允许取消。', + 'type' => 'string', + 'example' => '1', + ], + 'DbType' => [ + 'description' => '数据库引擎类型。', + 'type' => 'string', + 'example' => 'mongoDb', + ], + 'ChangeLevel' => [ + 'description' => '事件等级代码。'."\n" + .'- **S1**：系统运维。'."\n" + .'- **S0**：风险修复。', + 'type' => 'string', + 'example' => 'S1', + ], + 'TaskTypeEn' => [ + 'description' => '任务原因（英文）。', + 'type' => 'string', + 'example' => 'Minor version update'."\n", + ], + 'ResultInfo' => [ + 'description' => '执行结果信息。', + 'type' => 'string', + 'example' => 'userCancel', + ], + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11111', + ], + 'SubInsNames' => [ + 'description' => '子实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子任务名称。', + 'type' => 'string', + 'example' => 'sub1369716295573-tes2cy6****.2013052818****', + ], + ], + 'TaskParams' => [ + 'description' => '任务参数。', + 'type' => 'string', + 'example' => '""', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询多个主动运维任务信息', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中节点的角色，取值：'."\n" + .'- **mongos**：mongos节点配置。'."\n" + .'- **db**：shard节点配置。'."\n" + .'- **logic**：逻辑实例配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'logic', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '实例的审计操作类型信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7BAFB0B3-2A54-5B65-B13E-3937CF08FEE6', + ], + 'Filter' => [ + 'description' => '数据库操作日志类型，有以下几种类型：'."\n" + .'- **admin**：运维管控操作。'."\n" + .'- **slow**：慢日志。'."\n" + .'- **query**：查询操作。'."\n" + .'- **insert**：插入操作。 '."\n" + .'- **update**：更新操作。 '."\n" + .'- **delete**：删除操作。 '."\n" + .'- **command**：协议命令。例如aggregate聚合方法。', + 'type' => 'string', + 'example' => 'admin,slow,insert,query,update,delete,command', + ], + 'RoleType' => [ + 'description' => '分片集群实例中节点的角色。', + 'type' => 'string', + 'example' => 'logic', + ], + ], + ], + ], + ], + 'title' => '查询审计日志采集日志类型', + 'summary' => '查询MongoDB实例审计日志采集的日志类型。', + 'description' => '- 调用本接口时，要求实例状态为运行中。'."\n" + .'- 本接口仅适用于规格类型为**通用型本地盘版**和**独享型本地盘版**实例。'."\n" + .'- 本接口限制每分钟调用30次，如超过这个限制会被限流，请勿高频调用。如需高频调用，请使用Logstore，详情请参见[管理Logstore](~~48990~~)。', + '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' => '查询MongoDB实例的审计日志是否开启。', + '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' => ' 实例ID。 ', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '111E7B16-0A87-4CBA-B271-F34AD61E099F', + ], + 'LogAuditStatus' => [ + 'description' => ' 审计日志的状态。 '."\n" + .'- Enable：开启。'."\n" + .'- Disabled：关闭。'."\n" + ."\n" + .'默认为关闭状态。', + 'type' => 'string', + 'example' => 'Enable', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBInstance.Malformed', + 'errorMessage' => 'Too many instance ids or instance id format is invalid.', + 'description' => '', + ], + ], + ], + 'title' => '查询审计日志是否开启', + 'description' => '- 调用本接口时，要求实例状态为运行中。'."\n" + .'- 本接口适用于规格类型为**通用型本地盘版**和**独享型本地盘版**实例。'."\n" + .'- 本接口限制每分钟调用30次，如超过这个限制会被限流，请勿高频调用。如需高频调用，请使用Logstore，详情请参见[管理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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"111E7B16-0A87-4CBA-B271-F34AD61E099F\\",\\n \\"LogAuditStatus\\": \\"Enable\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeAuditPolicyResponse>\\r\\n\\t<LogAuditStatus>Enable</LogAuditStatus>\\r\\n\\t<RequestId>111E7B16-0A87-4CBA-B271-F34AD61E099F</RequestId>\\r\\n</DescribeAuditPolicyResponse>","errorExample":""}]', + ], + 'DescribeAuditRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + .'> 当本参数传入的是分片集群实例ID时，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID或Shard节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp128a003436****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-03-13T12:11:14Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> 查询结束时间距查询开始时间不得超过24个小时，超过则调用失败。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-03-13T13:11:14Z', + ], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名，默认为所有数据库。', + 'type' => 'string', + 'required' => false, + 'example' => 'database****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号，默认为所有账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Form', + 'in' => 'query', + 'schema' => [ + 'description' => '审计记录返回的展示类型，取值：'."\n" + .'- **File**：触发审计日志文件的生成，若传入这个值，只返回公共参数。'."\n" + .'- **Stream**（默认值）：返回数据流。'."\n" + ."\n" + .'> **File** 参数已废弃', + 'type' => 'string', + 'required' => false, + 'example' => 'Stream', + 'default' => 'Stream', + 'enum' => [ + 'File', + 'Stream', + ], + ], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字查询。多个关键字以空格分隔，不超过10个关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'slow', + ], + ], + [ + 'name' => 'LogicalOperator', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字搜索的逻辑操作， 默认值为and。', + 'type' => 'string', + 'required' => false, + 'example' => 'and', + 'default' => 'and', + 'enum' => [ + 'and', + 'or', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。取值：**30**（默认值）、**50**、**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。大于0，且不超过Integer的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '按时间的升降序对查询到的慢日志进行排序。取值：'."\n" + .'- **asc**：按时间升序排序。'."\n" + .'- **desc**：按时间降序排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '总记录数。', + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'PageRecordCount' => [ + 'description' => '当前页最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3278BEB8-503B-4E46-8F7E-D26E040C9769', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SQLRecord' => [ + 'description' => '审计日志详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息。', + 'type' => 'object', + 'properties' => [ + 'HostAddress' => [ + 'description' => '客户端IP地址。', + 'type' => 'string', + 'example' => '11.xxx.xxx.xxx', + ], + 'TableName' => [ + 'description' => 'MongoDB的集合名称。', + 'type' => 'string', + 'example' => 'C1', + ], + 'ReturnRowCounts' => [ + 'description' => '返回记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'DBName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'test123', + ], + 'ExecuteTime' => [ + 'description' => '该语句执行的时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-03-11T03:30:27Z', + ], + 'ThreadID' => [ + 'description' => '线程ID。', + 'type' => 'string', + 'example' => '140682188297984', + ], + 'TotalExecutionTimes' => [ + 'description' => '消耗时间，单位为微秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '700', + ], + 'Syntax' => [ + 'description' => '执行语句。', + 'type' => 'string', + 'example' => '{ \\"atype\\" : \\"createCollection\\", \\"param\\" : { \\"ns\\" : \\"123.test1\\" }, \\"result\\": \\"OK\\" }', + ], + 'AccountName' => [ + 'description' => '数据库账号名。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Format', + 'errorMessage' => 'Specified start time is not valid.', + 'description' => '指定的开始时间无效。'."\n", + ], + [ + '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' => '查询实例的审计日志', + 'summary' => '查询MongoDB实例的审计日志。', + 'description' => '- 调用本接口时，实例的审计日志须处于开通状态，否则返回的审计日志内容为空。'."\n" + .'- 本接口适用于规格类型为**通用型本地盘版**和**独享型本地盘版**实例。'."\n" + .'- 本接口限制每分钟调用30次，如超过这个限制会被限流，请勿高频调用。如需高频调用，请使用Logstore，详情请参见[管理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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeAuditRecordsResponse>\\r\\n\\t<Items>\\r\\n\\t\\t<SQLRecord>\\r\\n\\t\\t\\t<TotalExecutionTimes>703</TotalExecutionTimes>\\r\\n\\t\\t\\t<Syntax>{ "atype" : "command", "param" : { "command" : "find", "ns" : "123.test1", "args" : { "find" : "test1", "filter" : { "x" : 1, "y" : 2 }, "shardVersion" : [ { "$timestamp" : { "t" : 0, "i" : 0 } }, { "$oid" : "000000000000000000000000" } ], "$clusterTime" : { "clusterTime" : { "$timestamp" : { "t" : 1552275017, "i" : 2 } }, "signature" : { "hash" : { "$binary" : "9qfygDs61fKCvdXJqjq+f0zML0E=", "$type" : "00" }, "keyId" : { "$numberLong" : "6666955498811555841" } } }, "$client" : { "application" : { "name" : "MongoDB Shell" }, "driver" : { "name" : "MongoDB Internal Client", "version" : "3.4.10" }, "os" : { "type" : "Linux", "name" : "Ubuntu", "architecture" : "x86_64", "version" : "16.04" }, "mongos" : { "host" : "rxxxxxx.cloud.cm10:3074", "client" : "47.xxx.xxx.xx:53854", "version" : "4.0.0" } }, "$configServerState" : { "opTime" : { "ts" : { "$timestamp" : { "t" : 1552275017, "i" : 2 } }, "t" : { "$numberLong" : "3" } } }, "$db" : "123" } }, "result": "OK" }</Syntax>\\r\\n\\t\\t\\t<HostAddress>11.xxx.xxx.xx</HostAddress>\\r\\n\\t\\t\\t<ExecuteTime>2019-03-11T03:30:27Z</ExecuteTime>\\r\\n\\t\\t\\t<ThreadID>139xxxxxxxx</ThreadID>\\r\\n\\t\\t\\t<AccountName>__system;</AccountName>\\r\\n\\t\\t\\t<DBName>local;</DBName>\\r\\n\\t\\t</SQLRecord>\\r\\n\\t\\t<SQLRecord>\\r\\n\\t\\t\\t<TotalExecutionTimes>0</TotalExecutionTimes>\\r\\n\\t\\t\\t<Syntax>{ "atype" : "createIndex", "param" : { "ns" : "123.test1", "indexName" : "y_1", "indexSpec" : { "v" : 2, "key" : { "y" : 1 }, "name" : "y_1", "ns" : "123.test1" } }, "result": "OK" }</Syntax>\\r\\n\\t\\t\\t<HostAddress></HostAddress>\\r\\n\\t\\t\\t<ExecuteTime>2019-03-11T03:30:06Z</ExecuteTime>\\r\\n\\t\\t\\t<ThreadID>140xxxxxxxx</ThreadID>\\r\\n\\t\\t\\t<AccountName>__system;</AccountName>\\r\\n\\t\\t\\t<DBName>local;</DBName>\\r\\n\\t\\t</SQLRecord>\\r\\n\\t</Items>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<TotalRecordCount>2</TotalRecordCount>\\r\\n\\t<RequestId>3278BEB8-503B-4E46-8F7E-D26E040C9769</RequestId>\\r\\n\\t<PageRecordCount>30</PageRecordCount>\\r\\n</DescribeAuditRecordsResponse>","errorExample":""}]', + ], + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID，您可以通过调用[DescribeRegions](~~61933~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型。取值：'."\n" + .'- **PrePaid**（默认值）：包年包月。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrePaid', + 'default' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的数据库类型。取值：'."\n" + .'- **normal**：副本集实例。'."\n" + .'- **sharding**：分片集群实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + 'default' => 'normal', + 'enum' => [ + 'normal', + 'sharding', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。资源组详情请参见[查看资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmx2m4rqu7pry', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回参数**RegionName**和**ZoneName**的语言，取值说明：'."\n" + .'- **zh**：默认值，中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + [ + 'name' => 'StorageSupport', + 'in' => 'query', + 'schema' => [ + 'title' => '当前需要展示哪些可用区，支持云盘的（cloud）,支持本地盘的（local），都支持的（default或者空）', + 'description' => '存储类型：'."\n" + ."\n" + .'- **cloud**：仅展示支持云盘版实例的可用区。'."\n" + .'- **local**：仅展示支持本地盘版实例的可用区。'."\n" + .'- **default**或空：展示本地盘和云盘版实例都支持的可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'local', + 'default' => 'default', + ], + ], + [ + 'name' => 'MongoType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '高可用版还是测试版（dbfs）', + 'description' => '高可用版还是测试版（dbfs）', + 'type' => 'string', + 'required' => false, + 'example' => 'dbfs', + 'default' => 'default', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型，取值说明： '."\n" + ."\n" + .'- **cloud_essd1**：ESSD PL1云盘。'."\n" + .'- **cloud_essd2**：ESSD PL2云盘。'."\n" + .'- **cloud_essd3**：ESSD PL3云盘。'."\n" + .'- **local_ssd**：SSD本地盘。'."\n" + ."\n" + .'>- 4.4及以上版本实例只支持云盘，不填写默认选择**cloud_essd1**。'."\n" + .'>- 4.2及以下版本实例只支持本地盘，不填写默认选择**local_ssd**。', + 'type' => 'string', + 'required' => false, + 'example' => 'local_ssd', + 'default' => 'default', + ], + ], + [ + 'name' => 'ExcludeZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '当前地域过滤此输入的可用区查询结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-g', + ], + ], + [ + 'name' => 'ExcludeSecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '当前地域过滤此输入的可用区查询结果，结合“ExcludeZoneId”实现多可用区过滤。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-b', + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.mongo.standard', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '数据库版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '5.0', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => '节点数。'."\n" + ."\n" + .'> 该参数仅支持副本集实例。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '1', + 3 => '3', + 5 => '5', + 7 => '7', + ], + 'example' => '3', + 'enum' => [], + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值： '."\n" + .'- **sharding**：分片集群实例。'."\n" + .'- **replicate**：副本集实例和单节点实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'replicate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '19A13A33-0FAD-5120-8AE1-B1636F74DD80', + ], + 'AvailableZones' => [ + 'description' => '支持购买的可用区资源详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-beijing-f', + ], + 'ZoneName' => [ + 'description' => '可用区名称。'."\n" + ."\n" + .'根据**AcceptLanguage**参数的值返回不同的语言。以**cn-hangzhou-h**可用区为例，示例如下：'."\n" + ."\n" + .'- **AcceptLanguage**为**zh**：**杭州 可用区H**'."\n" + .'- **AcceptLanguage**为**en**：**Hangzhou Zone H**', + 'type' => 'string', + 'example' => '杭州 可用区H', + ], + 'RegionId' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~61933~~)接口查询。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查看实例支持的可用区', + 'summary' => '查询MongoDB实例支持的可用区列表。', + 'description' => '查询给定购买条件下，支持的MongoDB可用区列表。购买条件中，地域ID必填。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeAvailabilityZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '52507B6B-003B-47A3-A0A3-9FE992C7A243', + ], + 'EngineVersions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EngineVersion' => [ + 'description' => '可升级的版本列表。'."\n" + ."\n" + .'> 如果当前已经是最新版本，则本参数返回为空。', + 'type' => 'array', + 'items' => [ + 'description' => '可升级的版本号。', + 'type' => 'string', + 'example' => '4.0', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询实例可升级的版本', + 'summary' => '查询MongoDB实例可升级的版本。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"52507B6B-003B-47A3-A0A3-9FE992C7A243\\",\\n \\"EngineVersions\\": {\\n \\"EngineVersion\\": [\\n \\"4.0\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeAvailableEngineVersionResponse>\\r\\n\\t<EngineVersions>\\r\\n\\t\\t<EngineVersion>4.0</EngineVersion>\\r\\n\\t</EngineVersions>\\r\\n\\t<RequestId>52507B6B-003B-47A3-A0A3-9FE992C7A243</RequestId>\\r\\n</DescribeAvailableEngineVersionResponse>","errorExample":""}]', + ], + 'DescribeAvailableResource' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~61933~~)接口进行查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。您可以通过[DescribeRegions](~~61933~~)接口查看可用的可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值说明：'."\n" + .'- **PrePaid**（默认值）：包年包月。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrePaid', + 'default' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的数据库类型，取值说明：'."\n" + .'- **normal**：副本集实例。'."\n" + .'- **sharding**：分片集群实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'sharding', + 'enum' => [ + 'normal', + 'sharding', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '存储类型，取值说明：'."\n" + .'- local_ssd：SSD本地盘。'."\n" + .'- cloud_essd1：ESSD PL1云盘。'."\n" + ."\n" + .'- cloud_essd2：ESSD PL2云盘。'."\n" + ."\n" + .'- cloud_essd3：ESSD PL3云盘。'."\n" + .'- cloud_auto：AutoPL 云盘。'."\n" + ."\n" + .'默认为空，表示查询所有存储类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'local_ssd', + 'enum' => [ + 'local_ssd', + 'cloud_essd1', + 'cloud_essd2', + 'cloud_essd3', + 'cloud_auto', + ], + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.mongo.standard', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '数据库版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '5.0', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => '节点数，只适用于副本集。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '1', + 3 => '3', + 5 => '5', + 7 => '7', + ], + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '344EE51D-8850-4935-B68B-58A8F4DCE3BD', + ], + 'SupportedDBTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedDBType' => [ + 'description' => '支持的数据库类型。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AvailableZones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableZone' => [ + 'description' => '可用区。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedEngineVersions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedEngineVersion' => [ + 'description' => '支持的存储引擎版本。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedEngines' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedEngine' => [ + 'description' => '支持的存储引擎。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedNodeTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedNodeType' => [ + 'description' => '支持的实例类型。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'description' => '实例的节点数。', + 'type' => 'string', + 'example' => '3', + ], + 'NetworkTypes' => [ + 'description' => '实例的网络类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'AvailableResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableResource' => [ + 'description' => '可用的资源详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceClassRemark' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => '4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））', + ], + 'InstanceClass' => [ + 'description' => '实例规格族。', + 'type' => 'string', + 'example' => 'mdb.shard.2x.xlarge.d', + ], + 'DBInstanceStorageRange' => [ + 'description' => '实例的存储空间范围。', + 'type' => 'object', + 'properties' => [ + 'Min' => [ + 'description' => '存储空间的最小值，单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Max' => [ + 'description' => '存储空间的最大值，单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16000', + ], + 'Step' => [ + 'description' => '调整存储空间的最小粒度，单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'Engine' => [ + 'description' => '实例的存储引擎。', + 'type' => 'string', + 'example' => 'WiredTiger', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'Version' => [ + 'description' => '实例的数据库版本。', + 'type' => 'string', + 'example' => '4.0', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'DbType' => [ + 'description' => '实例的数据库类型，取值说明：'."\n" + .'- **normal**：副本集实例。'."\n" + .'- **sharding**：分片集群实例。', + 'type' => 'string', + 'example' => 'sharding', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询指定可用区的资源信息', + 'summary' => '查询指定可用区的资源信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeAvailableResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeAvailableResourceResponse>\\n <RequestId>344EE51D-8850-4935-B68B-58A8F4DCE3BD</RequestId>\\n <SupportedDBTypes>\\n <AvailableZones>\\n <SupportedEngineVersions>\\n <SupportedEngines>\\n <SupportedNodeTypes>\\n <NodeType>3</NodeType>\\n <NetworkTypes>VPC</NetworkTypes>\\n <AvailableResources>\\n <InstanceClassRemark>4核8GB（独享型）(当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}）)</InstanceClassRemark>\\n <InstanceClass>mdb.shard.2x.xlarge.d</InstanceClass>\\n <DBInstanceStorageRange>\\n <Min>20</Min>\\n <Max>16000</Max>\\n <Step>10</Step>\\n </DBInstanceStorageRange>\\n </AvailableResources>\\n </SupportedNodeTypes>\\n <Engine>WiredTiger</Engine>\\n </SupportedEngines>\\n <Version>4.0</Version>\\n </SupportedEngineVersions>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <RegionId>cn-hangzhou</RegionId>\\n </AvailableZones>\\n <DbType>sharding</DbType>\\n </SupportedDBTypes>\\n</DescribeAvailableResourceResponse>","errorExample":""}]', + ], + 'DescribeBackupDBs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的记录数。取值： **30**（默认值）、**50**、**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'SourceDBInstance', + 'in' => 'query', + 'schema' => [ + 'description' => '待恢复数据的源实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2286****', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所需恢复的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 本参数可取值为7天内的任意时间，但是须早于当前时间，且晚于实例的创建时间。'."\n" + .'> - 本参数和**BackupId**参数两者中必须传入一项。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-08-22T12:00:00Z', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID。'."\n" + ."\n" + .'> - 您可以通过调用[DescribeBackups](~~62172~~)接口查询备份ID。'."\n" + .'> - 本参数和**RestoreTime**参数两者中必须传入一项。', + 'type' => 'string', + 'required' => false, + 'example' => '5664****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ax68****', + ], + ], + [ + 'name' => 'SourceDBInstance', + 'in' => 'query', + 'schema' => [ + 'description' => '待恢复数据的源实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2286****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询结果中数据库的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Databases' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Database' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'mongodbtest', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455', + ], + 'PageSize' => [ + 'description' => '每页可展示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMeta.WrongFormat', + 'errorMessage' => 'Meta information is wrong formatter.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidRestoreTime.Format', + 'errorMessage' => 'Specified restore time is not valid.', + 'description' => '指定的参数RestoreTime不合法，请您检查输入的参数是否正确。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidDBName', + 'errorMessage' => 'The specified database name is not allowed.', + 'description' => '指定的数据库名称无效'."\n", + ], + [ + 'errorCode' => 'InvalidMeta.TooLarge', + 'errorMessage' => 'Meta information is too large.', + 'description' => '元信息太大。'."\n", + ], + [ + 'errorCode' => 'SingleDBRestore.BackupSetNotSupport', + 'errorMessage' => 'This backup set do not support this operation.', + 'description' => '所选择的时间点或备份文件尚未支持单库恢复功能。', + ], + [ + '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' => '当前备份日志启用状态不支持此操作。'."\n", + ], + [ + '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' => '恢复时间内不存在可用的备份。'."\n", + ], + ], + ], + 'title' => '查询指定的时间点或备份集内包含的数据库', + 'summary' => '在为MongoDB实例执行单库恢复前，您可以调用本接口查询指定的时间点或备份集内包含的数据库。', + 'description' => '您可以调用[CreateDBInstance](~~61763~~)接口进行单库恢复。更多信息，请参见[MongoDB单库恢复](~~112274~~)。'."\n" + ."\n" + .'调用本接口时，实例必须满足以下条件：'."\n" + .'- 实例的创建时间晚于2019年3月26日。'."\n" + .'- 实例属于华北 1、华北 2、华北 3、华北 5、华东 1、华东 2、华南 1或亚太东南 1（新加坡）地域。'."\n" + .'- 实例类型为副本集实例。'."\n" + .'- 实例版本须为3.4、4.0、4.2 本地盘版本。'."\n" + .'- 实例存储引擎必须为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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeBackupDBsResponse>\\r\\n\\t<Databases>\\r\\n\\t\\t<Database>\\r\\n\\t\\t\\t<DBName>admin</DBName>\\r\\n\\t\\t</Database>\\r\\n\\t\\t<Database>\\r\\n\\t\\t\\t<DBName>config</DBName>\\r\\n\\t\\t</Database>\\r\\n\\t\\t<Database>\\r\\n\\t\\t\\t<DBName>mongodbtest</DBName>\\r\\n\\t\\t</Database>\\r\\n\\t\\t<Database>\\r\\n\\t\\t\\t<DBName>db1</DBName>\\r\\n\\t\\t</Database>\\r\\n\\t\\t<Database>\\r\\n\\t\\t\\t<DBName>db2</DBName>\\r\\n\\t\\t</Database>\\r\\n\\t</Databases>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<TotalCount>5</TotalCount>\\r\\n\\t<PageSize>30</PageSize>\\r\\n\\t<RequestId>1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455</RequestId>\\r\\n</DescribeBackupDBsResponse>","errorExample":""}]', + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp16cb162771****', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型。'."\n" + .'- replicate: 副本集实例'."\n" + .'- sharding: 分片集群实例', + 'type' => 'string', + 'required' => false, + 'example' => 'sharding', + 'enum' => [ + 'replicate', + 'sharding', + ], + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => '备份周期，取值说明：'."\n" + .'- **Monday**：星期一。'."\n" + .'- **Tuesday**：星期二。'."\n" + .'- **Wednesday**：星期三。'."\n" + .'- **Thursday**：星期四。'."\n" + .'- **Friday**：星期五。'."\n" + .'- **Saturday**：星期六。'."\n" + .'- **Sunday**：星期日。', + 'type' => 'string', + 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5A9464CA-F7DC-5434-90B1-DF7F197C****', + ], + 'PreferredBackupTime' => [ + 'description' => '备份时间，格式为<i>HH:mm</i>Z-<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '09:00Z-10:00Z', + ], + 'BackupRetentionPeriod' => [ + 'description' => '备份保留天数。', + 'type' => 'string', + 'example' => '30', + ], + 'PreferredNextBackupTime' => [ + 'description' => '下次常规备份时间，格式为<i>yyyy-mm-dd</i>t<i>hh:mm</i>z（utc时间）。', + 'type' => 'string', + 'example' => '2024-06-19T19:11Z', + ], + 'EnableBackupLog' => [ + 'description' => '是否打开日志备份，取值说明：'."\n" + .'- **0**：关闭（默认值）。'."\n" + .'- **1**：打开。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LogBackupRetentionPeriod' => [ + 'description' => '日志备份保留天数，取值范围：7~730。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'SnapshotBackupType' => [ + 'description' => '快照备份类型，取值说明：'."\n" + ."\n" + .'- **Flash**：秒级备份。'."\n" + .'- **Standard**：常规备份（默认值）。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'BackupInterval' => [ + 'description' => '高频备份频率，取值说明：'."\n" + ."\n" + .'- **-1**：不开启高频备份。'."\n" + .'- **15**：每15分钟。'."\n" + .'- **30**：每30分钟。'."\n" + .'- **60**：每1小时。'."\n" + .'- **120**：每2小时。'."\n" + .'- **180**：每3小时。'."\n" + .'- **240**：每4小时。'."\n" + .'- **360**：每6小时。'."\n" + .'- **480**：每8小时。'."\n" + .'- **720**：每12小时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'HighFrequencyBackupRetention' => [ + 'description' => '高频备份保留天数，单位为天。', + 'type' => 'string', + 'example' => '1', + ], + 'BackupRetentionPolicyOnClusterDeletion' => [ + 'description' => '备份保留策略。'."\n" + ."\n" + .'1. 0：实例释放时立即删除该实例的所有备份集'."\n" + .'2. 1：实例释放时会自动备份，长期保留该备份集'."\n" + .'1. 2：实例释放时会自动备份，并长期保留该集群的所有备份集'."\n" + ."\n" + .'详细信息请参见：[长期保留备份](~~2779111~~)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SrcRegion' => [ + 'description' => '源实例所在区域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DestRegion' => [ + 'description' => '异地备份所在地域。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'CrossRetentionType' => [ + 'description' => '异地备份保留类型。'."\n" + ."\n" + .'- delay: 保留一段时间'."\n" + ."\n" + .'- never: 不过期', + 'type' => 'string', + 'example' => 'delay', + ], + 'CrossRetentionValue' => [ + 'description' => '异地备份保留时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'CrossBackupPeriod' => [ + 'description' => '异地备份的保留时间。'."\n" + ."\n" + .'1. Monday：周一。'."\n" + .'2. Tuesday：周二。'."\n" + .'3. Wednesday：周三。'."\n" + .'4. Thursday：周四。'."\n" + .'5. Friday：周五。'."\n" + .'6. Saturday：周六。'."\n" + .'7. Sunday：周日。'."\n" + ."\n" + .'> 异地备份必填', + 'type' => 'string', + 'example' => 'Monday', + ], + 'EnableCrossLogBackup' => [ + 'description' => '是否开启跨地域日志备份 。'."\n" + ."\n" + .'> 异地备份必填'."\n" + .'> - 1： 打开 (分片集群必须为1)'."\n" + .'> - 0： 关闭 (副本实例必须为0)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CrossLogRetentionType' => [ + 'description' => '异地日志备份保留类型。'."\n" + ."\n" + .'- delay: 保留一段时间'."\n" + .'- never: 不过期', + 'type' => 'string', + 'example' => 'delay', + ], + 'CrossLogRetentionValue' => [ + 'description' => '异地日志备份保留时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'PreserveOneEachHour' => [ + 'description' => '是否开启小时内稀疏备份。'."\n" + ."\n" + .'- true：当备份频率为分钟级时，距离当前时间1小时内的快照全部保留。距离当前时间超过1小时且在24小时内的快照，仅保留整点后的第一个快照。'."\n" + ."\n" + .'- false：关闭小时内稀疏备份：高频备份保留天数内的快照全部保留。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'title' => '查看实例的自动备份策略', + 'summary' => '查询MongoDB实例的备份策略。', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeBackupPolicyResponse>\\n <PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>\\n <RequestId>5A9464CA-F7DC-5434-90B1-DF7F197C****</RequestId>\\n <PreferredBackupTime>09:00Z-10:00Z</PreferredBackupTime>\\n <BackupRetentionPeriod>30</BackupRetentionPeriod>\\n <EnableBackupLog>1</EnableBackupLog>\\n <LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>\\n <SnapshotBackupType>Standard</SnapshotBackupType>\\n <BackupInterval>-1</BackupInterval>\\n</DescribeBackupPolicyResponse>","errorExample":""}]', + ], + 'DescribeBackupStorage' => [ + 'summary' => '查询MongoDB云盘版副本集或分片集群的备份使用量。', + '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' => '实例所属的地域ID，您可以通过调用[DescribeDBInstanceAttribute](~~62010~~)进行查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-bejing', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2zeb2d64cb46xxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Shard节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数为必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-2zee48956b4axxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D648B367-15B6-1B42-BD4B-4XXXXXXXXX', + ], + 'FullStorageSize' => [ + 'description' => '实例全量备份数据内置存储量，单位为字节（B）。'."\n" + .'> 云盘版实例使用快照备份，当前全量的备份的大小为快照链的大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '789221621', + ], + 'LogStorageSize' => [ + 'description' => '实例日志备份数据内置存储量，单位为字节（B）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7892216', + ], + 'FreeSize' => [ + 'description' => '实例免费备份数据额度，单位为字节（B）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42949672960', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBInstance.Malformed', + 'errorMessage' => 'Too many instance ids or instance id format is invalid.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询实例的备份使用量', + 'description' => '分片集群备份用量的计费规则是每个分片单独计费，本接口只支持查询单分片的备份用量。', + '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' => '查询MongoDB云盘版副本集或分片集进行中的备份任务', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2zeb2d64cb46xxxx', + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份任务ID。'."\n" + .'> 如果您调用[CreateBackup](~~468439~~)执行了手动备份，您可以将返回的备份ID传入，用以查询备份的进度。', + 'type' => 'string', + 'required' => false, + 'example' => '170034', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D648B367-15B6-1B42-BD4B-47507C9CC****', + ], + 'BackupJobs' => [ + 'title' => '', + 'description' => '备份任务详情。', + 'type' => 'array', + 'items' => [ + 'description' => '备份任务详情。', + 'type' => 'object', + 'properties' => [ + 'BackupjobId' => [ + 'description' => '备份任务ID。', + 'type' => 'string', + 'example' => '170034'."\n", + ], + 'BackupSetStatus' => [ + 'title' => '', + 'description' => '备份任务状态。'."\n" + .'* **Scheduled**：计划中备份任务，包括未开始的常规备份任务。'."\n" + .'* **Checking**：备份前实例检查。'."\n" + .'* **Backuping**：备份中。'."\n" + .'* **Finished**：备份完成。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Scheduled', + ], + 'BackupStartTime' => [ + 'description' => '备份开始时间。', + 'type' => 'string', + 'example' => '2024-01-16T11:04:56Z', + ], + 'Progress' => [ + 'description' => '备份进度，单位为%。'."\n" + .'仅正在运行的备份才会显示进度。', + 'type' => 'string', + 'example' => '18%', + ], + 'JobMode' => [ + 'description' => '备份模式，返回值：'."\n" + .'* **Automated**：系统自动备份。'."\n" + .'* **Manual**：手动备份。', + 'type' => 'string', + 'example' => 'Manual', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => ' 查询实例进行中的备份任务', + '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}', + ], + ], + ], + ], + ], + '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"}]', + ], + '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' => '实例ID。'."\n" + .'> 当本参数传入的是分片集群实例ID时，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1a7009eb24****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Shard节点的ID。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp128a003436****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID。'."\n" + ."\n" + .'当**DBInstanceId**参数传入的是分片集群实例ID时，备份ID个数与Shard节点个数相同，中间用英文逗号（,）间隔。', + 'type' => 'string', + 'required' => false, + 'example' => '2072****,2072****,2072****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。'."\n" + ."\n\n" + .'> 当传入BackupId时，此参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-13T13:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。'."\n" + .'> 当传入BackupId时，此参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-14T13:00Z', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在地域。'."\n" + ."\n" + .'> '."\n" + .'> - 已删除实例恢复必填。'."\n" + .'> - 异地备份必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '备份所在地域。'."\n" + ."\n\n" + .'> 异地备份必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组ID', + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-xxxx', + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'title' => '备份任务ID', + 'description' => '备份任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '775051', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '实例备份信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '备份总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '275D43C3-F12F-5224-B375-************', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Backups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => '备份文件详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份文件详情列表。', + 'type' => 'object', + 'properties' => [ + 'BackupStatus' => [ + 'description' => '备份状态，取值说明：'."\n" + .'- **Success**：备份成功。'."\n" + .'- **Failed**：备份失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupType' => [ + 'description' => '备份类型，取值说明：'."\n" + .'- **FullBackup**：全量备份。'."\n" + .'- **IncrementalBackup**：增量备份。', + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupStartTime' => [ + 'description' => '本次备份开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-01-14T03:56:17Z', + ], + 'BackupIntranetDownloadURL' => [ + 'description' => '备份文件的内网下载地址。'."\n" + ."\n" + .'> 您可以通过该地址在ECS服务器（与云数据库MongoDB实例在同一网络）上下载目标备份文件。', + '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', + ], + 'BackupSize' => [ + 'description' => '备份文件大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6168576', + ], + 'BackupDownloadURL' => [ + 'description' => '备份文件的外网下载地址，若当前不可下载，则返回为空字符串。', + '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', + ], + 'BackupMode' => [ + 'description' => '备份模式，取值说明：'."\n" + .'- **Automated**：系统自动备份。'."\n" + .'- **Manual**：手动备份。', + 'type' => 'string', + 'example' => 'Automated', + ], + 'BackupEndTime' => [ + 'description' => '本次备份结束时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-01-14T03:57:34Z', + ], + 'BackupId' => [ + 'description' => '备份ID。', + 'type' => 'string', + 'example' => '32102****', + ], + 'BackupDBNames' => [ + 'description' => '备份的数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + 'BackupMethod' => [ + 'description' => '备份方式，取值说明：'."\n" + .'- **Snapshot**：快照备份。'."\n" + .'- **Physical**：物理备份。'."\n" + .'- **Logical**：逻辑备份。', + 'type' => 'string', + 'example' => 'Physical', + ], + 'BackupJobId' => [ + 'description' => '备份集任务ID。', + 'type' => 'string', + 'example' => '1123xxxx', + ], + 'BackupName' => [ + 'description' => '备份集名称(当前无效)。', + 'type' => 'string', + 'example' => '12345678.tar.gz', + ], + 'BackupScale' => [ + 'description' => '备份粒度(当前无效)。', + 'type' => 'string', + 'example' => 'DBInstance', + ], + 'IsAvail' => [ + 'description' => '备份集是否可用，取值说明：'."\n" + .'* **0**：不可用。'."\n" + .'* **1**：可用。', + 'type' => 'boolean', + 'example' => '1', + ], + 'EngineVersion' => [ + 'description' => '备份时的实例版本号，取值：'."\n" + .'- **7.0**'."\n" + .'- **6.0**'."\n" + .'- **5.0**'."\n" + .'- **4.4**'."\n" + .'- **4.2**'."\n" + .'- **4.0**'."\n" + .'- **3.4**', + 'type' => 'string', + 'example' => '4.2', + ], + 'BackupExpireTime' => [ + 'description' => '备份过期时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n\n" + .'><notice>"9999-01-01T00:00:00Z"表示长期保留。></notice>', + 'type' => 'string', + 'example' => '2025-08-30T09:49:11Z', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + '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' => '查询实例的备份列表', + 'summary' => '查询MongoDB实例的备份列表。', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeBackupsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>275D43C3-F12F-5224-B375-0C6BF453BD56</RequestId>\\n <PageSize>30</PageSize>\\n <PageNumber>1</PageNumber>\\n <Backups>\\n <BackupStatus>Success</BackupStatus>\\n <BackupType>FullBackup</BackupType>\\n <BackupStartTime>2022-01-14T03:56:17Z</BackupStartTime>\\n <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&Region=cn-hangzhou</BackupIntranetDownloadURL>\\n <BackupSize>6168576</BackupSize>\\n <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=LTAI4G2wxd32KLGARf****&Signature=lkFPjOY%2F8adB18vnOCbtmT7****&Region=cn-hangzhou</BackupDownloadURL>\\n <BackupMode>Automated</BackupMode>\\n <BackupEndTime>2022-01-14T03:57:34Z</BackupEndTime>\\n <BackupDBNames>database</BackupDBNames>\\n <BackupMethod>Physical</BackupMethod>\\n </Backups>\\n</DescribeBackupsResponse>","errorExample":""}]', + ], + 'DescribeClusterBackups' => [ + 'summary' => '查询云数据库 MongoDB 版云盘版分片集群的集群备份集列表。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp16cb162771****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群备份ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5664****', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页号。默认值为**1**，取值范围为正整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '20', + 'enum' => [ + '30', + '50', + '100', + '10', + '20', + '5', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。'."\n" + .'> 当传入BackupId时，此参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-03-13T12:11Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。'."\n" + .'> 当传入BackupId时，此参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-03-14T13:10Z', + ], + ], + [ + 'name' => 'IsOnlyGetClusterBackUp', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '是否查询集群备份下的子节点信息。取值说明：'."\n" + .'- **true**：只返回集群备份基本信息，不返回全量的子节点的备份信息。'."\n" + .'- **false**（默认 ）：返回全量的子节点的备份信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'flase', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在地域。'."\n" + ."\n" + .'> - 查询已释放实例的备份集列表式，该参数必填。'."\n" + .'> - 查询异地备份时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份所在地域。'."\n" + ."\n" + .'> 查询异地备份时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组ID', + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-xxxx', + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'title' => '备份任务ID', + 'description' => '备份任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '775051', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2F42BB4E-461F-5B55-A37C-53B1141C****', + ], + 'MaxResults' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'title' => '第几页，同请求参数', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '一页最大多少条记录，同请求参数', + 'description' => '每页最大记录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ClusterBackups' => [ + 'title' => '集群备份集列表，一个集群备份里面包含各个节点的备份集', + 'description' => '集群备份集列表，一个集群备份里面包含各个节点的备份集。', + 'type' => 'array', + 'items' => [ + 'description' => '集群备份集列表，一个集群备份里面包含各个节点的备份集。', + 'type' => 'object', + 'properties' => [ + 'IsAvail' => [ + 'title' => '集群备份集是否有效，子节点的备份集未完成或者失败时，为0', + 'description' => '集群备份集是否有效，取值说明：'."\n" + .'- **1**：集群的备份集有效。'."\n" + .'- **0**：子节点的备份集未完成或者失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterBackupId' => [ + 'title' => '集群备份集ID', + 'description' => '集群备份集ID。', + 'type' => 'string', + 'example' => 'cb-o8c2ugnxo26kx***', + ], + 'ClusterBackupStatus' => [ + 'title' => '集群备份集状态', + 'description' => '集群备份集状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'ClusterBackupStartTime' => [ + 'description' => '集群备份开始时间。', + 'type' => 'string', + 'example' => '2023-10-16T19:33:20Z', + ], + 'ClusterBackupSize' => [ + 'title' => '集群备份集大小', + 'description' => '集群备份集大小，单位为Byte。', + 'type' => 'string', + 'example' => '107374182400', + ], + 'ClusterBackupEndTime' => [ + 'description' => '集群备份结束时间。', + 'type' => 'string', + 'example' => '2023-10-16T19:33:20Z', + ], + 'ClusterBackupMode' => [ + 'description' => '集群备份模式。', + 'type' => 'string', + 'example' => 'Automated', + ], + 'ExtraInfo' => [ + 'description' => '补充信息，为JSON格式。', + 'type' => 'object', + 'properties' => [ + 'RegistryFromHistory' => [ + 'title' => '为1表示从历史备份集中迁移过来', + 'description' => '是否来自于历史备份集，为**1**则表示是从历史备份集迁移过来的。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'Backups' => [ + 'title' => '单个集群备份集下，各个子节点的备份集集合', + 'description' => '单个集群备份集下，各个子节点的备份集集合。', + 'type' => 'array', + 'items' => [ + 'description' => '单个集群备份集下，各个子节点的备份集集合。', + 'type' => 'object', + 'properties' => [ + 'BackupId' => [ + 'description' => '备份ID。', + 'type' => 'string', + 'example' => '738025367', + ], + 'InstanceName' => [ + 'description' => 'MongoDB分片名称。', + 'type' => 'string', + 'example' => 'd-bp16cb162771****'."\n", + ], + 'BackupDownloadURL' => [ + 'description' => '备份文件的外网下载地址，若当前不可下载，则返回为空字符串。', + 'type' => 'string', + 'example' => 'http://oss.com/xxx', + ], + 'BackupIntranetDownloadURL' => [ + 'description' => '内网下载地址，若当前不可下载，则返回空值。', + 'type' => 'string', + 'example' => 'http://oss.com/xxx', + ], + 'BackupStartTime' => [ + 'description' => '本次备份开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-10-16T19:33:20Z', + ], + 'BackupEndTime' => [ + 'description' => '本次备份结束时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-10-16T19:33:20Z', + ], + 'BackupSize' => [ + 'description' => '备份文件大小，单位为Byte。', + 'type' => 'string', + 'example' => '77544597650', + ], + 'IsAvail' => [ + 'description' => '备份集是否可用，取值说明：'."\n" + .'* **0**：不可用。'."\n" + .'* **1**：可用。', + 'type' => 'string', + 'example' => '1', + ], + 'BackupStatus' => [ + 'description' => '备份状态，取值说明：'."\n" + .'- **Success**：备份成功。'."\n" + .'- **Failed**：备份失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupName' => [ + 'description' => '备份名称。', + 'type' => 'string', + 'example' => '12345678.tar.gz', + ], + 'ExtraInfo' => [ + 'description' => '备份关联的实例节点信息。', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'd-2ze75ab1fa5d****', + ], + 'StorageSize' => [ + 'description' => '节点的存储空间大小，单位为MB。', + 'type' => 'string', + 'example' => '20480', + ], + 'InstanceClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'mdb.shard.4x.large.d', + ], + 'NodeType' => [ + 'description' => '节点类型。', + 'type' => 'string', + 'example' => 'db', + ], + ], + ], + ], + ], + ], + 'Progress' => [ + 'title' => '备份进度，仅正在运行的备份才会显示进度', + 'description' => '备份进度，单位为%。'."\n" + .'仅正在运行的备份才会显示进度。', + 'type' => 'string', + 'example' => '50', + ], + 'AttachLogStatus' => [ + 'description' => '备份的状态，取值如下：'."\n" + .'- **Init**：初始化。'."\n" + .'- **No_Need**：无附加日志备份。'."\n" + .'- **Running**：附加日志备份中。'."\n" + .'- **Ready**：附加日志备份完成。'."\n" + .'- **Failed**：附加日志备份失败。'."\n" + ."\n" + .'> 当**ClusterBackupStatus**参数（集群备份集的状态）的值为OK时，仅表示全量备份阶段执行成功了，对于开启了日志备份的集群实例，想要使用按时间点恢复或满足一致性恢复的效果时，需要附加日志备份完成。', + 'type' => 'string', + 'example' => 'Ready', + ], + 'EngineVersion' => [ + 'description' => '备份时的实例版本号，取值：'."\n" + ."\n" + .'- **7.0**'."\n" + .'- **6.0**'."\n" + .'- **5.0**'."\n" + .'- **4.4**'."\n" + .'- **4.2**'."\n" + .'- **4.0**'."\n" + .'- **3.4**', + 'type' => 'string', + 'example' => '4.2', + ], + 'BackupExpireTime' => [ + 'description' => '备份过期时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n\n" + .'><notice>"9999-01-01T00:00:00Z"表示长期保留。></notice>', + 'type' => 'string', + 'example' => '2025-03-29T03:47:12Z', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'title' => '查询集群备份集列表', + 'description' => '2023年10月19日前新建的云盘版分片集群实例，在调用前本接口前，需要调用 '."\n" + .'[TransferClusterBackup](~~2587931~~) 接口，完成分片备份到集群备份的转换。'."\n" + ."\n" + .'2023年10月19日之后新建的云盘版分片集群实例，默认使用集群备份。', + '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}', + ], + ], + ], + ], + ], + '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"}]', + ], + 'DescribeClusterRecoverTime' => [ + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp18f7d6b6a7****', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份源实例所在区域。'."\n" + .'> '."\n" + .'> - 当查询的是异地备份时，需要且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份备份集所在地域。'."\n" + .'> '."\n" + .'> - 当查询的是异地备份时，需要且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组ID', + 'description' => '资源组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60EEBD77-227C-5B39-86EA-D89163C5****', + ], + 'RestoreRanges' => [ + 'title' => '', + 'description' => '集群备份集列表。集群备份里面包含每个节点的备份集。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RestoreBeginTime' => [ + 'title' => '', + 'description' => '可恢复开始时间。', + 'type' => 'string', + 'example' => '2023-10-16T19:33:20Z', + ], + 'RestoreEndTime' => [ + 'title' => '', + 'description' => '可恢复结束时间。', + 'type' => 'string', + 'example' => '2023-10-16T19:43:20Z', + ], + 'RestoreType' => [ + 'description' => '恢复方式，取值说明：'."\n" + .'* **PointInTime**（默认）：基于时间点恢复。', + 'type' => 'string', + 'example' => 'PointInTime', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询分片集群可恢复时间段', + 'summary' => '查询云数据库 MongoDB 版云盘版分片集群实例的可恢复时间。', + 'description' => '- MongoDB实例需要为分片集群实例，大版本为4.4及以上版本，存储模式为ESSD云盘版。'."\n" + .'- 仅2023年10月19日之前创建的实例需要调用TransferClusterBackup接口切换至集群备份模式。已切换集群备份模式或2023年10月19日及以后新建的MongoDB云盘版分片集群实例可以直接调用该接口。', + '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}', + ], + ], + ], + ], + ], + '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"}]', + ], + 'DescribeDBInstanceAttribute' => [ + 'summary' => '查询云数据库 MongoDB 实例的信息。', + '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' => '数据库引擎，固定取值：**MongoDB**。', + 'type' => 'string', + 'required' => false, + 'example' => 'MongoDB', + 'enum' => [ + 'MongoDB', + ], + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp11483712c1****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。资源组详情请参见[查看资源组基本信息](~~151181~~)。'."\n" + .'>目前仅中国站支持配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'IsDelete', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '实例是否已删除，取值说明： '."\n" + .'- **false**：实例正常运行，查询运行中实例信息。'."\n" + .'- **true**：实例已删除，查询被删除实例的信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '实例详细信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A935A8EE-A6CC-53DE-98BA-20ABAA7E632B', + ], + 'DBInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => '实例详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例详细信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '实例的创建时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-01-02T07:43:59Z', + ], + 'ReplicaSets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReplicaSet' => [ + 'description' => '副本集实例信息。'."\n" + .'> 当实例类型为副本集实例时，返回该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '副本集实例信息。'."\n" + .'> 当实例类型为副本集实例时，返回该参数。', + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '交换机ID。'."\n" + ."\n" + .'> 当实例的网络类型为专有网络时，返回该参数。', + 'type' => 'string', + 'example' => 'vpc-bp1jk5vwkcri27qme****', + ], + 'ConnectionPort' => [ + 'description' => '节点的连接端口。', + 'type' => 'string', + 'example' => '3717', + ], + 'ReplicaSetRole' => [ + 'description' => '节点的角色，取值说明：'."\n" + .'- **Primary**：主节点。'."\n" + .'- **Secondary**：从节点。', + 'type' => 'string', + 'example' => 'Primary', + ], + 'ConnectionDomain' => [ + 'description' => '节点的连接地址。', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****.mongodb.rds.aliyuncs.com', + ], + 'VPCCloudInstanceId' => [ + 'description' => '副本集节点的vpc实例ID。'."\n" + .'> 当实例的网络类型为专有网络时，返回该参数。', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****', + ], + 'NetworkType' => [ + 'description' => '网络类型，取值说明： '."\n" + .'- **Classic**：经典网络。'."\n" + .'- **VPC**：专有网络。'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'VPCId' => [ + 'description' => '专有网络ID。'."\n" + .'> 当实例的网络类型为专有网络时，返回该参数。', + 'type' => 'string', + 'example' => 'vpc-bp1jk5vwkcri27qme****', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'ReplacateId' => [ + 'description' => '全球多活实例的逻辑ID。'."\n" + ."\n" + .'> MongoDB当前不支持新购该类型实例，该参数仅适用于老版本全球多活实例。', + 'type' => 'string', + 'example' => 'bls-m****', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '实例的标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的标签信息列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '实例的标签键。', + 'type' => 'string', + 'example' => 'test', + ], + 'Value' => [ + 'description' => '实例的标签值。', + 'type' => 'string', + 'example' => 'api', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'VpcAuthMode' => [ + 'description' => '私网免密访问模式，取值说明：'."\n" + .'- **Open**：开启私网免密访问。'."\n" + .'- **Close**：关闭私网免密访问，需要使用密码访问。'."\n" + .'- **NotSupport**：不支持该功能。', + 'type' => 'string', + 'example' => 'Open', + ], + 'NetworkType' => [ + 'description' => '实例的网络类型，取值说明：'."\n" + .'- **Classic**：经典网络。'."\n" + .'- **VPC**：专有网络。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'LockMode' => [ + 'description' => '实例的锁定状态，取值说明：'."\n" + .'* **Unlock**：正常，没有被锁定。'."\n" + .'* **ManualLock**：手动触发锁定。'."\n" + .'* **LockByExpiration**：实例过期自动锁定。'."\n" + .'* **LockByRestoration**：实例回滚前自动锁定。'."\n" + .'* **LockByDiskQuota**：实例空间满自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'EngineVersion' => [ + 'description' => '数据库大版本。', + 'type' => 'string', + 'example' => '4.4', + ], + 'MaxIOPS' => [ + 'description' => '实例最大IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'MaxMBPS' => [ + 'description' => '实例的最大云盘吞吐量，单位MB/s。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '350', + ], + 'VPCCloudInstanceIds' => [ + 'description' => 'vpc 实例的ID。 '."\n" + .'> 当实例的网络类型为专有网络时，返回该参数。'."\n" + .'><notice>参数已废弃></notice>', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****', + ], + 'MongosList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MongosAttribute' => [ + 'description' => 'Mongos节点信息列表。'."\n" + ."\n" + .'> 当实例类型为分片集群实例时，返回该参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'Mongos节点信息列表。'."\n" + ."\n" + .'> 当实例类型为分片集群实例时，返回该参数。', + 'type' => 'object', + 'properties' => [ + 'VpcCloudInstanceId' => [ + 'description' => 'Mongos节点的vpc实例ID。', + 'type' => 'string', + 'example' => 's-bp1d8c262a158****', + ], + 'LockMode' => [ + 'description' => '实例的锁定状态，取值说明：'."\n" + .'* **Unlock**：正常。'."\n" + .'* **ManualLock**：手动触发锁定。'."\n" + .'* **LockByExpiration**：实例过期自动锁定。'."\n" + .'* **LockByRestoration**：实例回滚前自动锁定。'."\n" + .'* **LockByDiskQuota**：实例空间满自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'MaxIOPS' => [ + 'description' => 'Mongos节点的最大IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '800', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。'."\n" + .'> 当实例的网络类型为专有网络时，返回该参数。', + 'type' => 'string', + 'example' => 'vsw-bp1vj604nj5a9zz74****', + ], + 'NodeClass' => [ + 'description' => 'Mongos节点的规格。', + 'type' => 'string', + 'example' => 'dds.mongos.mid', + ], + 'MaxConnections' => [ + 'description' => 'Mongos节点的最大连接数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'Port' => [ + 'description' => 'Mongos节点的连接端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3717', + ], + 'VPCId' => [ + 'description' => '专有网络ID。'."\n" + .'> 当实例的网络类型为专有网络时，返回该参数。', + 'type' => 'string', + 'example' => 'vpc-bp1n3i15v90el48nx****', + ], + 'ConnectSting' => [ + 'description' => 'Mongos节点的连接地址。'."\n" + .'><warning>此参数即将下线，请替换使用ConnectString参数></warning>', + 'type' => 'string', + 'example' => 's-bp1d8c262a15****.mongodb.rds.aliyuncs.com', + ], + 'NodeDescription' => [ + 'description' => 'Mongos节点的名称。', + 'type' => 'string', + 'example' => 'mongos1', + ], + 'NodeId' => [ + 'description' => 'Mongos节点的ID。', + 'type' => 'string', + 'example' => 's-bp1d8c262a15****', + ], + 'Status' => [ + 'description' => 'Mongos节点的状态。具体请参见[实例状态表](~~63870~~)。 ', + 'type' => 'string', + 'example' => 'Running', + ], + 'CurrentKernelVersion' => [ + 'description' => 'MongoDB 节点当前内核小版本号。', + 'type' => 'string', + 'example' => 'mongodb_20220518_4.0.21', + ], + 'ConnectString' => [ + 'description' => 'Mongos节点的连接地址。', + 'type' => 'string', + 'example' => 's-bp1d8c262a15****.mongodb.rds.aliyuncs.com', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'ProtocolType' => [ + 'description' => '实例的访问协议类型，取值说明：'."\n" + ."\n" + .'- **mongodb**：MongoDB协议。'."\n" + .'- **dynamodb**：DynamoDB协议。'."\n" + ."\n" + .'> 当实例类型为分片集群实例时，返回该参数。', + 'type' => 'string', + 'example' => 'mongodb', + ], + 'DBInstanceDescription' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => '测试数据库', + ], + 'CurrentKernelVersion' => [ + 'description' => '实例当前数据库的小版本号。', + 'type' => 'string', + 'example' => '5.0.5-20220721143518_0', + ], + 'DBInstanceReleaseProtection' => [ + 'description' => '是否开启实例释放保护，取值说明：'."\n" + .'- **true**：已开启。'."\n" + .'- **false**：未开启。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExpireTime' => [ + 'description' => '包年包月实例的到期时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。'."\n" + .'> 当实例的付费类型为包年包月时返回该参数。', + 'type' => 'string', + 'example' => '2022-02-05T16:00Z', + ], + 'MaintainStartTime' => [ + 'description' => '实例可维护时间段的开始时间，格式为<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '18:00Z', + ], + 'DBInstanceType' => [ + 'description' => '实例类型，取值说明：'."\n" + .'- **replicate**：副本集实例。'."\n" + .'- **sharding**：分片集群实例。'."\n" + .'<props="china">'."\n" + .'- **serverless**：Serverless实例。'."\n" + .'</props>', + 'type' => 'string', + 'example' => 'replicate', + ], + 'LastDowngradeTime' => [ + 'description' => '实例最近一次降配时间。', + 'type' => 'string', + 'example' => '2022-01-08', + ], + 'ShardList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ShardAttribute' => [ + 'description' => 'Shard节点信息列表。'."\n" + .'> 当实例类型为分片集群实例时返回该参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'Shard节点信息列表。'."\n" + .'> 当实例类型为分片集群实例时返回该参数。', + 'type' => 'object', + 'properties' => [ + 'LockMode' => [ + 'description' => '集群的锁定模式，取值说明：'."\n" + .'- **Unlock**：正常。'."\n" + .'- **ManualLock**：手动触发锁定。'."\n" + .'- **LockByExpiration**：集群过期自动锁定。 '."\n" + .'- **LockByRestoration**：集群回滚前的自动锁定。'."\n" + .'- **LockByDiskQuota**：集群空间满自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'MaxIOPS' => [ + 'description' => 'Shard节点的最大IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + ], + 'ConnectString' => [ + 'description' => 'Shard节点的连接地址。', + 'type' => 'string', + 'example' => 'd-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****', + ], + 'NodeClass' => [ + 'description' => 'Shard节点的规格。', + 'type' => 'string', + 'example' => 'dds.shard.mid', + ], + 'MaxConnections' => [ + 'description' => 'Shard节点的最大连接数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + ], + 'Port' => [ + 'description' => 'Shard节点的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3717', + ], + 'NodeDescription' => [ + 'description' => 'Shard节点的名称。', + 'type' => 'string', + 'example' => 'testshard', + ], + 'NodeId' => [ + 'description' => 'Shard节点的ID。', + 'type' => 'string', + 'example' => 'd-bp16e09d9c5d****', + ], + 'NodeStorage' => [ + 'description' => 'Shard节点的存储空间，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ReadonlyReplicas' => [ + 'description' => 'Shard节点中只读节点的个数，取值范围为**0**~**5**（整数）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Status' => [ + 'description' => 'Shard节点的状态，具体请参见[实例状态表](~~63870~~)。 ', + 'type' => 'string', + 'example' => 'Running', + ], + 'MaxDiskMbps' => [ + 'description' => 'shard节点的最大云盘吞吐量。', + 'type' => 'string', + 'example' => '350', + ], + 'CurrentKernelVersion' => [ + 'description' => 'MongoDB 节点当前内核小版本号。', + 'type' => 'string', + 'example' => 'mongodb_20220518_4.0.21', + ], + 'ReplicaSetName' => [ + 'description' => 'Shard节点的名称。', + 'type' => 'string', + 'example' => 'mgset-xxxx', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'MaintainEndTime' => [ + 'description' => '实例可维护时间段的结束时间，格式为<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '03:00Z', + ], + 'DBInstanceStatus' => [ + 'description' => '实例状态，具体请参见[实例状态表](~~63870~~)。 ', + 'type' => 'string', + 'example' => 'Running', + ], + 'VPCId' => [ + 'description' => '专有网络ID。'."\n" + .'> 当实例的网络类型为专有网络时，返回该参数。', + 'type' => 'string', + 'example' => 'vpc-bp1n3i15v90el48nx****', + ], + 'RegionId' => [ + 'description' => '实例所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstanceStorage' => [ + 'description' => '实例存储空间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ReplicaSetName' => [ + 'description' => '副本集实例的名称。'."\n" + ."\n" + .'> 当实例类型为副本集实例时，返回该参数。', + 'type' => 'string', + 'example' => 'mgset-10ace****', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。'."\n" + .'> 当实例的网络类型为专有网络时，返回该参数。', + 'type' => 'string', + 'example' => 'vsw-bp1oo2a7isyrb8igf****', + ], + 'StorageEngine' => [ + 'description' => '实例的存储引擎类型。', + 'type' => 'string', + 'example' => 'WiredTiger', + ], + 'ConfigserverList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConfigserverAttribute' => [ + 'description' => 'Configserver节点信息列表。'."\n" + ."\n" + .'> 当实例类型为分片集群实例时，返回该参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'Configserver节点的信息列表。'."\n" + ."\n" + .'> 当实例类型为分片集群实例时，返回该参数。', + 'type' => 'object', + 'properties' => [ + 'MaxIOPS' => [ + 'description' => 'Configserver节点的最大IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'LockMode' => [ + 'description' => '实例的锁定状态，取值说明：'."\n" + .'* **Unlock**：正常。'."\n" + .'* **ManualLock**：手动触发锁定。'."\n" + .'* **LockByExpiration**：实例过期自动锁定。'."\n" + .'* **LockByRestoration**：实例回滚前自动锁定。'."\n" + .'* **LockByDiskQuota**：实例空间满自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'ConnectString' => [ + 'description' => 'Configserver节点的连接地址。', + 'type' => 'string', + 'example' => 'dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com', + ], + 'NodeClass' => [ + 'description' => 'Configserver节点的规格。', + 'type' => 'string', + 'example' => 'dds.cs.mid', + ], + 'MaxConnections' => [ + 'description' => 'Configserver节点的最大连接数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'Port' => [ + 'description' => 'Configserver节点的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3717', + ], + 'NodeDescription' => [ + 'description' => 'Configserver节点的名称。', + 'type' => 'string', + 'example' => 'testConfigserver', + ], + 'NodeId' => [ + 'description' => 'Configserver节点ID。', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****-cs', + ], + 'NodeStorage' => [ + 'description' => 'Configserver节点的存储空间，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Status' => [ + 'description' => 'ConfigServer节点的状态。具体请参见[实例状态表](~~63870~~)。 ', + 'type' => 'string', + 'example' => 'Running', + ], + 'CurrentKernelVersion' => [ + 'description' => 'MongoDB 节点当前内核小版本号。', + 'type' => 'string', + 'example' => 'mongodb_20220518_4.0.21', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'ResourceGroupId' => [ + 'description' => '实例所属资源组ID。'."\n" + .'>目前仅中国站支持返回该参数。', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + ], + 'ZoneId' => [ + 'description' => '实例所属可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'MaxConnections' => [ + 'description' => '实例最大连接数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp11483712c1****', + ], + 'DBInstanceClass' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'dds.mongo.mid', + ], + 'Engine' => [ + 'description' => '数据库引擎。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + 'ReadonlyReplicas' => [ + 'description' => '实例的只读节点个数。', + 'type' => 'string', + 'example' => '1', + ], + 'ReplicationFactor' => [ + 'description' => '实例节点数量。 '."\n" + .'> 实例类型为副本集实例时，返回该参数。', + 'type' => 'string', + 'example' => '3', + ], + 'KindCode' => [ + 'description' => '实例的类型，取值说明：'."\n" + .'- **0**：本地盘版实例。'."\n" + .'- **3**：单节点实例。'."\n" + .'- **18**：云盘版实例。', + 'type' => 'string', + 'example' => '18', + ], + 'CapacityUnit' => [ + 'description' => '实例消耗的读写吞吐量。', + 'type' => 'string', + 'example' => '100', + ], + 'ChargeType' => [ + 'description' => '实例的付费类型，取值说明：'."\n" + .'- **PrePaid**：预付费，包年包月。'."\n" + .'- **PostPaid**：后付费，按量付费。', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'StorageType' => [ + 'description' => '存储类型，取值说明： '."\n" + ."\n" + .'**cloud\\_essd1**：ESSD PL1云盘。'."\n" + .'**cloud\\_essd2**：ESSD PL2云盘。'."\n" + .'**cloud\\_essd3**：ESSD PL3云盘。'."\n" + .'**local\\_ssd**：SSD本地盘。'."\n" + .'**cloud\\_essd\\_dbfs\\_s**：DBFS共享存储云盘。', + 'type' => 'string', + 'example' => 'cloud_essd1', + ], + 'SecondaryZoneId' => [ + 'description' => '实现多可用区部署时，实例的备可用区1，取值说明：'."\n" + .'- **cn-hangzhou-g**：杭州可用区G。'."\n" + .'- **cn-hangzhou-h**：杭州可用区H。'."\n" + .'- **cn-hangzhou-i**：杭州可用区I。'."\n" + .'- **cn-hongkong-b**：香港可用区B。'."\n" + .'- **cn-hongkong-c**：香港可用区C。'."\n" + .'- **cn-hongkong-d**：香港可用区D。'."\n" + .'- **cn-wulanchabu-a**：乌兰察布可用区A。'."\n" + .'- **cn-wulanchabu-b**：乌兰察布可用区B。'."\n" + .'- **cn-wulanchabu-c**：乌兰察布可用区C。'."\n" + .'- **ap-southeast-1a**：新加坡可用区A。'."\n" + .'- **ap-southeast-1b**：新加坡可用区B。'."\n" + .'- **ap-southeast-1c**：新加坡可用区C。'."\n" + .'- **ap-southeast-5a**：雅加达可用区A。'."\n" + .'- **ap-southeast-5b**：雅加达可用区B。'."\n" + .'- **ap-southeast-5c**：雅加达可用区C。'."\n" + .'- **eu-central-1a**：法兰克福可用区A。'."\n" + .'- **eu-central-1b**：法兰克福可用区B。'."\n" + .'- **eu-central-1c**：法兰克福可用区C。'."\n" + ."\n" + .'>- 当实例为4.4或5.0版本的多可用区副本集实例或分片集群实例时，返回该参数。'."\n" + .'- 目前仅中国站支持返回该参数。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'HiddenZoneId' => [ + 'description' => '实现多可用区部署时，实例的备可用区2，取值说明：'."\n" + .'- **cn-hangzhou-g**：杭州可用区G。'."\n" + .'- **cn-hangzhou-h**：杭州可用区H。'."\n" + .'- **cn-hangzhou-i**：杭州可用区I。'."\n" + .'- **cn-hongkong-b**：香港可用区B。'."\n" + .'- **cn-hongkong-c**：香港可用区C。'."\n" + .'- **cn-hongkong-d**：香港可用区D。'."\n" + .'- **cn-wulanchabu-a**：乌兰察布可用区A。'."\n" + .'- **cn-wulanchabu-b**：乌兰察布可用区B。'."\n" + .'- **cn-wulanchabu-c**：乌兰察布可用区C。'."\n" + .'- **ap-southeast-1a**：新加坡可用区A。'."\n" + .'- **ap-southeast-1b**：新加坡可用区B。'."\n" + .'- **ap-southeast-1c**：新加坡可用区C。'."\n" + .'- **ap-southeast-5a**：雅加达可用区A。'."\n" + .'- **ap-southeast-5b**：雅加达可用区B。'."\n" + .'- **ap-southeast-5c**：雅加达可用区C。'."\n" + .'- **eu-central-1a**：法兰克福可用区A。'."\n" + .'- **eu-central-1b**：法兰克福可用区B。'."\n" + .'- **eu-central-1c**：法兰克福可用区C。'."\n" + ."\n" + .'>- 当实例为4.4或5.0版本的多可用区副本集实例或分片集群实例时，返回该参数。'."\n" + .'- 目前仅中国站支持返回该参数。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'DestroyTime' => [ + 'description' => '实例数据销毁时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-12-10T16:00:00Z', + ], + 'DBInstanceOrderStatus' => [ + 'description' => '当前该实例已生成的订单状态，取值说明： '."\n" + ."\n" + .'- **all\\_completed**：所有订单均处于生产中或已经生产完成。'."\n" + .'- **order\\_unpaid**：当前有未支付的订单。'."\n" + .'- **order\\_wait\\_for_produce**：当前有正在下发生产的订单。'."\n" + ."\n" + .'>订单生产流程依次为用户下单、支付订单、订单下发生产、进行生产和完成生产。'."\n" + .'- 如果订单状态长时间处于**order\\_wait\\_for_produce**，说明下发生产流程遇到了问题，系统会自动重试。'."\n" + .'- 订单在进行生产和完成生产时，实例状态才会发生变化，例如变配中和运行中。', + 'type' => 'string', + 'example' => 'all_completed', + ], + 'Encrypted' => [ + 'title' => '是否开启云盘加密', + 'description' => '是否开启云盘加密', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EncryptionKey' => [ + 'title' => '云盘加密对应的kms-key', + 'description' => '云盘加密对应的kms-key', + 'type' => 'string', + 'example' => '07609cc3-3109-408f-a35e-c548e776da0b', + ], + 'SyncPercent' => [ + 'description' => '数据同步进度百分比。当实例处在变配中时，需要进行数据同步等操作，可以通过该字段判断同步进度。', + 'type' => 'string', + 'example' => '0.8', + ], + 'UseClusterBackup' => [ + 'description' => '是否使用集群备份模式。取值说明：'."\n" + ."\n" + .'- **true**：启用集群备份模式。'."\n" + .'- **false**未启用集群备份模式。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'false', + ], + 'BurstingEnabled' => [ + 'description' => '是否已开启突发', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProvisionedIops' => [ + 'description' => '预配置性能', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1960', + ], + 'DisasterRecoveryInfo' => [ + 'description' => '全球多活的源实例与目标实例信息', + 'type' => 'string', + 'example' => '{"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]}', + ], + 'SearchNodeClass' => [ + 'title' => '变配的Search节点规格', + 'description' => '变配的Search节点规格', + 'type' => 'string', + 'example' => 'mdb.shard.2x.xlarge.d', + ], + 'SearchNodeStorage' => [ + 'title' => '变配的Search节点容量', + 'description' => '变配的Search节点容量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SearchNodeCount' => [ + 'title' => '变配的Search节点数', + 'description' => '变配的Search节点数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'VpcCloudInstanceIdNumError', + 'errorMessage' => 'Get vpcCloudInstanceId number error.', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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 \\"SecondaryZoneId\\": \\"cn-hangzhou-i\\",\\n \\"HiddenZoneId\\": \\"cn-hangzhou-h\\",\\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}","errorExample":""},{"type":"xml","example":"<DescribeDBInstanceAttributeResponse>\\n <RequestId>A935A8EE-A6CC-53DE-98BA-20ABAA7E632B</RequestId>\\n <DBInstances>\\n <CreationTime>2022-01-02T07:43:59Z</CreationTime>\\n <ReplicaSets>\\n <VSwitchId>vpc-bp1jk5vwkcri27qme****</VSwitchId>\\n <ConnectionPort>3717</ConnectionPort>\\n <ReplicaSetRole>Primary</ReplicaSetRole>\\n <ConnectionDomain>dds-bp11483712c1****.mongodb.rds.aliyuncs.com</ConnectionDomain>\\n <VPCCloudInstanceId>dds-bp11483712c1****</VPCCloudInstanceId>\\n <NetworkType>VPC</NetworkType>\\n <VPCId>vpc-bp1jk5vwkcri27qme****</VPCId>\\n </ReplicaSets>\\n <ReplacateId>bls-m****</ReplacateId>\\n <Tags>\\n <Key>test</Key>\\n <Value>api</Value>\\n </Tags>\\n <VpcAuthMode>Open</VpcAuthMode>\\n <NetworkType>VPC</NetworkType>\\n <LockMode>Unlock</LockMode>\\n <EngineVersion>4.4</EngineVersion>\\n <MaxIOPS>1000</MaxIOPS>\\n <VPCCloudInstanceIds>dds-bp11483712c1****</VPCCloudInstanceIds>\\n <MongosList>\\n <VpcCloudInstanceId>s-bp1d8c262a158****</VpcCloudInstanceId>\\n <MaxIOPS>800</MaxIOPS>\\n <VSwitchId>vsw-bp1vj604nj5a9zz74****</VSwitchId>\\n <NodeClass>dds.mongos.mid</NodeClass>\\n <MaxConnections>1000</MaxConnections>\\n <Port>3717</Port>\\n <VPCId>vpc-bp1n3i15v90el48nx****</VPCId>\\n <ConnectSting>s-bp1d8c262a15****.mongodb.rds.aliyuncs.com</ConnectSting>\\n <NodeDescription>mongos1</NodeDescription>\\n <NodeId>s-bp1d8c262a15****</NodeId>\\n <Status>Running</Status>\\n </MongosList>\\n <ProtocolType>mongodb</ProtocolType>\\n <DBInstanceDescription>测试数据库</DBInstanceDescription>\\n <CurrentKernelVersion>5.0.5-20220721143518_0</CurrentKernelVersion>\\n <DBInstanceReleaseProtection>false</DBInstanceReleaseProtection>\\n <ExpireTime>2022-02-05T16:00Z</ExpireTime>\\n <MaintainStartTime>18:00Z</MaintainStartTime>\\n <DBInstanceType>replicate</DBInstanceType>\\n <LastDowngradeTime>2022-01-08</LastDowngradeTime>\\n <ShardList>\\n <MaxIOPS>8000</MaxIOPS>\\n <ConnectString>d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****</ConnectString>\\n <NodeClass>dds.shard.mid</NodeClass>\\n <MaxConnections>8000</MaxConnections>\\n <Port>3717</Port>\\n <NodeDescription>testshard</NodeDescription>\\n <NodeId>d-bp16e09d9c5d****</NodeId>\\n <NodeStorage>10</NodeStorage>\\n <ReadonlyReplicas>0</ReadonlyReplicas>\\n <Status>Running</Status>\\n </ShardList>\\n <MaintainEndTime>03:00Z</MaintainEndTime>\\n <DBInstanceStatus>Running</DBInstanceStatus>\\n <VPCId>vpc-bp1n3i15v90el48nx****</VPCId>\\n <RegionId>cn-hangzhou</RegionId>\\n <DBInstanceStorage>10</DBInstanceStorage>\\n <ReplicaSetName>mgset-10ace****</ReplicaSetName>\\n <VSwitchId>vsw-bp1oo2a7isyrb8igf****</VSwitchId>\\n <StorageEngine>WiredTiger</StorageEngine>\\n <ConfigserverList>\\n <MaxIOPS>1000</MaxIOPS>\\n <ConnectString>dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com</ConnectString>\\n <NodeClass>dds.cs.mid</NodeClass>\\n <MaxConnections>1000</MaxConnections>\\n <Port>3717</Port>\\n <NodeDescription>testConfigserver</NodeDescription>\\n <NodeId>dds-bp11483712c1****-cs</NodeId>\\n <NodeStorage>20</NodeStorage>\\n <Status>Running</Status>\\n </ConfigserverList>\\n <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>\\n <ZoneId>cn-hangzhou-b</ZoneId>\\n <MaxConnections>500</MaxConnections>\\n <DBInstanceId>dds-bp11483712c1****</DBInstanceId>\\n <DBInstanceClass>dds.mongo.mid</DBInstanceClass>\\n <Engine>MongoDB</Engine>\\n <ReadonlyReplicas>1</ReadonlyReplicas>\\n <ReplicationFactor>3</ReplicationFactor>\\n <KindCode>1</KindCode>\\n <CapacityUnit>100</CapacityUnit>\\n <ChargeType>PostPaid</ChargeType>\\n <SecondaryZoneId>cn-hangzhou-i</SecondaryZoneId>\\n <HiddenZoneId>cn-hangzhou-h</HiddenZoneId>\\n </DBInstances>\\n</DescribeDBInstanceAttributeResponse>","errorExample":""}]', + 'title' => '查询云数据库MongoDB实例的信息', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '可以输入一个实例自定义密钥。您可以调用[DescribeUserEncryptionKeyList](~~151729~~)查询实例的自定义密钥列表。', + 'type' => 'string', + 'required' => false, + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Origin' => [ + 'description' => '实例密钥的来源。', + 'type' => 'string', + 'example' => 'Aliyun_KMS', + ], + 'Description' => [ + 'description' => '实例密钥的描述。', + 'type' => 'string', + 'example' => 'key description example', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '783C2062-A2D3-4EA8-88AD-E43F990C23BB', + ], + 'EncryptionKeyStatus' => [ + 'description' => '实例密钥状态。'."\n" + ."\n" + .'- **Enabled**：实例密钥可用。'."\n" + .'- **Disabled**：实例密钥不可用。'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + 'MaterialExpireTime' => [ + 'description' => '密钥的过期时间（UTC）。当该值为空时，表示密钥不会过期。'."\n" + ."\n", + 'type' => 'string', + 'example' => '2020-07-06T18:22:03Z', + ], + 'KeyUsage' => [ + 'description' => '实例密钥的用途。', + 'type' => 'string', + 'example' => 'ENCRYPT/DECRYPT', + ], + 'EncryptionKey' => [ + 'description' => '实例密钥。', + 'type' => 'string', + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + ], + 'Creator' => [ + 'description' => '密钥创建者UID。', + 'type' => 'string', + 'example' => '123456', + ], + 'DeleteDate' => [ + 'description' => '实例密钥的预计删除时间。当该值为空时，表示密钥不会被自动删除。', + 'type' => 'string', + 'example' => '2020-07-06T18:22:03Z', + ], + ], + ], + ], + ], + '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' => '查询MongoDB实例的某个密钥的详情', + 'summary' => '查询MongoDB实例的某个密钥的详情。', + 'description' => '调用DescribeDBInstanceEncryptionKey接口时，实例必须以BYOK的方式开启了透明数据加密TDE。您可以调用[ModifyDBInstanceTDE](~~131267~~)来开启TDE。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1143f90ff3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EFD65226-08CC-4C4D-B6A4-CB3C382F67B0', + ], + 'Granularity' => [ + 'description' => '监控采集粒度。返回值为**5**，单位为秒。', + 'type' => 'string', + 'example' => '5', + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询MongoDB实例的监控采集粒度', + 'summary' => '查询MongoDB实例的监控采集粒度。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EFD65226-08CC-4C4D-B6A4-CB3C382F67B0\\",\\n \\"Granularity\\": \\"5\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBInstanceMonitorResponse>\\n <RequestId>FA79CCB2-6541-5304-BA35-05A7A1BC****</RequestId>\\n <Granularity>5</Granularity>\\n</DescribeDBInstanceMonitorResponse>","errorExample":""}]', + ], + 'DescribeDBInstancePerformance' => [ + 'summary' => '查询MongoDB实例性能数据。', + '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' => '实例ID。'."\n" + .'> 当本参数传入的是分片集群实例ID时，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2635****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID或Shard节点ID，可用于查询单个节点的性能情况。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp2287****', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '性能指标，取值详情请参见[监控项说明](~~216973~~)。'."\n" + ."\n" + .'>如需传入多个指标请用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'CpuUsage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-06-13T10:58Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-06-13T11:58Z', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => [ + 'description' => '单节点实例或副本集实例的节点角色ID。您可以通过调用[DescribeReplicaSetRole](~~62134~~)接口查询。'."\n" + .'> 当**DBInstanceId**参数传入的是单节点实例ID或副本集实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => '6025****', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '性能数据粒度(5,30,60,600,1800,3600,86400)', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'ReplicaSetRole', + 'in' => 'query', + 'schema' => [ + 'description' => '单节点实例或副本集实例的节点角色，取值说明：'."\n" + .'- **Primary**：主节点。'."\n" + .'- **Secondary**：从节点。'."\n" + ."\n" + .'> - 当**DBInstanceId**参数传入的是单节点实例ID或副本集实例ID时，本参数才可用。'."\n" + .'> - 当**DBInstanceId**参数传入的是单节点实例时，本参数的取值仅支持**Primary**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Primary', + 'default' => 'Primary', + 'enum' => [ + 'Primary', + 'Secondary', + 'Readonly', + ], + ], + ], + [ + 'name' => 'SearchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Search节点ID。'."\n" + .'> - 当实例开通Search功能后，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-2zec12675c9e****-search', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceKey' => [ + 'description' => '性能指标信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '性能指标。', + 'type' => 'string', + 'example' => 'CpuUsage', + ], + 'Unit' => [ + 'description' => '性能指标的单位。', + 'type' => 'string', + 'example' => '%', + ], + 'ValueFormat' => [ + 'description' => '性能指标值的格式。如果该性能指标包含多个字段，通常以&分隔。'."\n" + ."\n" + .'例如查询磁盘空间使用量，返回的**ValueFormat**即为**ins_size&data_size&log_size**。', + 'type' => 'string', + 'example' => 'cpu_usage', + ], + 'PerformanceValues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceValue' => [ + 'description' => '性能指标值列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '性能指标值。', + 'type' => 'string', + 'example' => '0.23', + ], + 'Date' => [ + 'description' => '性能指标值产生的日期。', + 'type' => 'string', + 'example' => '2022-06-13T10:58:00Z', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'EndTime' => [ + 'description' => '查询结束时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-06-13T11:58Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4A300BC7-6D8F-527F-A2DB-A7768D26E9AC', + ], + 'StartTime' => [ + 'description' => '查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-06-13T10:58Z', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '结束时间不能小于开始时间', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeDBInstancePerformanceResponse>\\n <PerformanceKeys>\\n <PerformanceKey>\\n <ValueFormat>cpu_usage</ValueFormat>\\n <PerformanceValues>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T10:58:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T10:59:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.22</Value>\\n <Date>2022-06-13T11:00:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:01:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:02:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:03:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:04:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:05:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:06:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:07:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:08:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:09:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:10:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:11:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:12:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:13:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:14:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:15:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:16:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:17:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:18:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.22</Value>\\n <Date>2022-06-13T11:19:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.22</Value>\\n <Date>2022-06-13T11:20:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:21:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:22:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:23:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:24:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:25:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:26:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:27:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:28:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:29:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:30:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:31:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:32:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:33:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:34:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:35:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:36:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:37:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:38:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:39:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:40:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:41:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:42:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:43:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:44:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:45:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:46:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:47:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:48:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:49:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:50:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.24</Value>\\n <Date>2022-06-13T11:51:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:52:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:53:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:54:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:55:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:56:00Z</Date>\\n </PerformanceValue>\\n <PerformanceValue>\\n <Value>0.23</Value>\\n <Date>2022-06-13T11:57:00Z</Date>\\n </PerformanceValue>\\n </PerformanceValues>\\n <Unit>%</Unit>\\n <Key>CpuUsage</Key>\\n </PerformanceKey>\\n </PerformanceKeys>\\n <RequestId>4A300BC7-6D8F-527F-A2DB-A7768D26E9AC</RequestId>\\n <EndTime>2022-06-13T11:58Z</EndTime>\\n <StartTime>2022-06-13T10:58Z</StartTime>\\n</DescribeDBInstancePerformanceResponse>","errorExample":""}]', + 'title' => '查询实例性能数据', + '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' => '查询MongoDB实例的SSL设置详情。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SSLExpiredTime' => [ + 'description' => 'SSL证书的过期时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2020-03-11T02:28:25Z', + ], + 'SSLStatus' => [ + 'description' => 'SSL功能的状态。'."\n" + .'- **Open**：SSL功能已开启。'."\n" + .'- **Closed**：SSL功能已关闭。 ', + 'type' => 'string', + 'example' => 'Open', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36BB1BC2-789C-4BBA-A519-C5B388E4B0D4', + ], + 'CertCommonName' => [ + 'description' => 'SSL证书名称。', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + ], + 'ForceEncryption' => [ + 'title' => '连接是否强制开启SSL加密，1：强制开启SSL加密；0:不强制开启SSL加密。', + 'description' => '连接是否强制开启SSL加密，取值说明：'."\n" + .'- **1**：强制开启SSL加密.'."\n" + .'- **0**：不强制开启SSL加密。', + 'type' => 'string', + 'enumValueTitles' => [ + '0', + '1', + ], + 'example' => '0', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询MongoDB实例的SSL设置详情', + 'description' => '调用该接口时，实例必须满足以下条件：'."\n" + .'- 实例状态为运行中。'."\n" + .'- 实例类型为副本集或分片集群实例。'."\n" + .' - 副本集实例的版本需为3.4及以上版本。'."\n" + .' - 分片集群实例的存储模式需要为ESSD云盘版。', + '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}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeDBInstanceSSLResponse>\\r\\n\\t<SSLExpiredTime>2020-03-11T02:28:25Z</SSLExpiredTime>\\r\\n\\t<RequestId>36BB1BC2-789C-4BBA-A519-C5B388E4B0D4</RequestId>\\r\\n\\t<SSLStatus>Open</SSLStatus>\\r\\n\\t<CertCommonName>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</CertCommonName>\\r\\n</DescribeDBInstanceSSLResponse>","errorExample":""}]', + ], + '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' => '实例规格。可通过接口 [DescribeDBInstanceAttribute](https://next.api.aliyun.com/api/Dds/2015-12-01/DescribeDBInstanceAttribute) 查询得到。'."\n" + ."\n" + .'不同类型实例的规格分别请参见：'."\n" + ."\n" + .'- [单节点实例规格表](~~311407~~)'."\n" + .'- [副本集实例规格表](~~311410~~)'."\n" + .'- [分片集群实例规格表](~~311414~~)', + 'type' => 'string', + 'required' => true, + 'example' => 'mdb.shard.4x.large.d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6B82A9EF-9961-5A31-A19F-009B709xxxxx', + ], + 'CPU' => [ + 'description' => 'CPU核数。', + 'type' => 'string', + 'example' => '2', + ], + 'Memory' => [ + 'description' => '内存大小，单位为GB。', + 'type' => 'string', + 'example' => '8', + ], + 'Description' => [ + 'description' => '规格描述。', + 'type' => 'string', + 'example' => '2核8GB（独享型）', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询实例规格的详细信息', + 'summary' => '查看实例规格信息详情', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeDBInstanceSpecInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '查询实例的主备切换日志。', + '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' => '查询开始时间，格式为<i>yyyy-mm-dd</i>T<i>hh:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-27T02:46Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，格式为<i>yyyy-mm-dd</i>T<i>hh:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-28T02:00Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：**30、50、100**，默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-uf68f1b5a57exxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ECBCA991-XXXX-XXXX-834C-B3E8007F33AA', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-uf68f1b5a57exxxx', + ], + 'TotalCount' => [ + 'description' => '查询结果中主备切换记录的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogItems' => [ + 'description' => '主备切换日志列表。', + 'type' => 'array', + 'items' => [ + 'description' => '切换记录对象。', + 'type' => 'object', + 'properties' => [ + 'SwitchStatus' => [ + 'description' => '切换状态。'."\n" + .'返回值为：'."\n" + .'- **1**：切换成功。'."\n" + .'- **0**：切换失败。', + 'type' => 'string', + 'example' => '1', + ], + 'SwitchTime' => [ + 'description' => '切换时间，格式为<i>yyyy-mm-dd</i>T<i>hh:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-02-07T18:00:00Z', + ], + 'SwitchCode' => [ + 'description' => '切换原因代码：'."\n" + .'- USER_CONSOLE_OPERATION：人工操作'."\n" + .'- OPERATION_AND_MAINTENANCE：风险隐患'."\n" + .'- MACHINE_DOWNTIME：宿主机下线'."\n" + .'- PRIMARY_UNHEALTHY：实例异常'."\n" + .'- SECONDARY_UNHEALTHY：实例异常'."\n" + .'- MULTIPLE_NODE_FAILURES：实例异常', + 'type' => 'string', + 'example' => 'USER_CONSOLE_OPERATION', + ], + 'NodeId' => [ + 'description' => '当实例为副本集实例，展示实例ID；当实例为分片集实例，展示切换的节点ID。', + 'type' => 'string', + 'example' => '当实例为副本集实例：dds-uf68f1b5a57exxxx。'."\n" + .'当实例为分片集实例：d-uf652b73f554xxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time', + 'description' => '开始时间不能大于结束时间。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询实例的主备切换日志信息', + 'description' => '调用本接口时，实例必须满足以下条件：'."\n" + ."\n" + .'- 实例的类型为副本集实例或分片集群实例。'."\n" + ."\n" + .'- 实例的规格类型为本地物理盘。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TDEStatus' => [ + 'description' => 'TDE状态，返回值为：'."\n" + .'- **enabled**：开启状态。'."\n" + .'- **disabled**：关闭状态。'."\n" + ."\n" + .'> 当TDK状态为关闭时，不会返回**RoleARN**、**EncryptionKey**和**EncryptorName**参数。', + 'type' => 'string', + 'example' => 'enabled', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F4DD0E29-361B-42F2-9301-B0048CCCE5D6', + ], + 'RoleARN' => [ + 'description' => '指定待授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息。', + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole', + ], + 'EncryptionKey' => [ + 'description' => '实例的自定义密钥。'."\n" + ."\n" + .'目前仅以下地域支持BYOK（Bring Your Own Key，用户可以自行管理和拥有加密密钥）：'."\n" + .'- 华东1（杭州）'."\n" + .'- 华东2（上海）'."\n" + .'- 华北2（北京）'."\n" + .'- 华南1（深圳）'."\n" + .'- 中国（香港）'."\n" + .'- 新加坡'."\n" + .'- 马来西亚（吉隆坡）'."\n" + ."\n" + .'> 支持BYOK，用户可以管理且拥有密钥，系统将返回用户的自定义密钥；不支持BYOK，用户不可管理密钥，系统将返回字符串`NoActiveBYOK`。', + 'type' => 'string', + 'example' => '2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + ], + 'EncryptorName' => [ + 'description' => '加密算法。', + 'type' => 'string', + 'example' => 'aes-256-cbc', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询MongoDB实例的透明数据加密TDE是否开启', + 'summary' => '查询MongoDB实例的透明数据加密TDE（Transparent Data Encryption）是否开启。', + 'description' => '> 关于该功能的详细介绍，请参见[设置透明数据加密TDE](~~131048~~)。'."\n" + ."\n" + .'调用本接口时，实例必须满足以下条件：'."\n" + .'- 实例为副本集实例或分片集群实例。'."\n" + .'- 实例的存储引擎为WiredTiger。'."\n" + .'- 实例的数据库版本为4.0或4.2版本，如果实例数据库版本过低，您可以调用[UpgradeDBInstanceEngineVersion](~~67608~~)接口升级数据库版本。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp199659b178****', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => '副本集实例的节点数量，取值：'."\n" + ."\n" + .'- **3**'."\n" + .'- **5**'."\n" + .'- **7**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称，取值说明：'."\n" + ."\n" + .'- 以中文、英文字母开头。'."\n" + .'- 可以包含数字、中文、英文、下划线（_）和短横线（-）。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '测试数据库', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的到期时间,格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'用于筛选到期时间小于等于该时间的实例。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-26T16:00:00Z', + 'enum' => [], + ], + ], + [ + 'name' => 'DBInstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的状态信息，取值详情请参见[实例状态表](~~63870~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + 'enum' => [], + ], + ], + [ + 'name' => 'DBInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值说明： '."\n" + .'- **sharding**：分片集群实例。'."\n" + .'- **replicate**：默认值，副本集实例和单节点实例。'."\n" + .' <props="china">'."\n" + .'- **serverless**：Serverless实例。'."\n" + .'</props>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sharding', + 'default' => 'replicate', + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格，取值详情请参见[实例规格表](~~57141~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.mongo.mid', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值为**MongoDB**。', + 'type' => 'string', + 'required' => false, + 'example' => 'MongoDB', + 'enum' => [ + 'MongoDB', + ], + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本号，取值：'."\n" + .'- **7.0**'."\n" + .'- **6.0**'."\n" + .'- **5.0**'."\n" + .'- **4.4**'."\n" + .'- **4.2**'."\n" + .'- **4.0**'."\n" + .'- **3.4**', + 'type' => 'string', + 'required' => false, + 'example' => '4.0', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例网络类型，取值说明：'."\n" + .'- **Classic**：经典网络。'."\n" + .'- **VPC**：VPC网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1n3i15v90el48nx****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络的交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1vj604nj5a9zz74****', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例付费类型，取值说明：'."\n" + .'- **PrePaid**：预付费，包年包月。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrePaid', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID，您可以通过调用[DescribeRegions](~~61933~~)接口查询可用区ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => [ + 'description' => '实例过期状态，取值说明：'."\n" + .'- **true**：已过期。'."\n" + .'- **false**：未过期。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConnectionDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '节点的连接地址，您可以通过调用[DescribeDBInstanceAttribute](~~62010~~)接口查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签管理。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '实例的标签键。N的取值范围为**1**~**20**。'."\n" + ."\n" + .'- 不能以`aliyun`、`acs:`、`http://`或`https://`开头。'."\n" + .'- 最多支持64个字符。'."\n" + .'- 不允许传入空字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdatabase', + ], + 'Value' => [ + 'description' => '实例的标签值。N的取值范围为**1**~**20**。'."\n" + ."\n" + .'- 不能以`aliyun`、`acs`:、`http://`或`https://`开头。'."\n" + .'- 最多支持128个字符。'."\n" + .'- TagValue可以为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DBNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '用于筛选标准实例还是测试实例'."\n" + ."\n" + .'1. 单节点实例和dbfs实例：customized'."\n" + .'2. 标准实例（副本集和分片集群）：standard'."\n" + .'3. 默认（展示全部实例）：default', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询结果中实例的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0E4FE33F-5510-5758-8FA7-A6672CDE****', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => '实例信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '实例创建的时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2021-03-25T02:18:00Z', + ], + 'ChargeType' => [ + 'description' => '实例付费类型，取值说明：'."\n" + .'- **PrePaid**：预付费，包年包月。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'example' => 'PrePaid', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '资源标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签信息列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。', + 'type' => 'string', + 'example' => 'test', + ], + 'Value' => [ + 'description' => '资源的标签值。', + 'type' => 'string', + 'example' => 'api', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'VpcAuthMode' => [ + 'description' => '是否开启了专有网络免密访问功能，取值说明：'."\n" + .'- **Open**：开启。'."\n" + .'- **Close**：关闭。', + 'type' => 'string', + 'example' => 'Close', + ], + 'NetworkType' => [ + 'description' => '实例网络类型，取值说明：'."\n" + .'* **Classic**：经典网络。'."\n" + .'* **VPC**：专有网络。', + 'type' => 'string', + 'example' => 'Classic', + ], + 'LockMode' => [ + 'description' => '实例的锁定状态，取值说明：'."\n" + .'* **Unlock**：正常。'."\n" + .'* **ManualLock**：手动触发锁定。'."\n" + .'* **LockByExpiration**：实例过期自动锁定。'."\n" + .'* **LockByRestoration**：实例回滚前自动锁定。'."\n" + .'* **LockByDiskQuota**：实例空间满自动锁定。'."\n" + .'* **Released**：实例已释放。此时实例无法进行解锁，只能使用备份数据重新创建新实例，重建时间较长，请耐心等待。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'EngineVersion' => [ + 'description' => '数据库版本号，取值：'."\n" + ."\n" + .'- **7.0**'."\n" + .'- **6.0**'."\n" + .'- **5.0**'."\n" + .'- **4.4**'."\n" + .'- **4.2**'."\n" + .'- **4.0**'."\n" + .'- **3.4**', + 'type' => 'string', + 'example' => '4.2', + ], + 'MongosList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MongosAttribute' => [ + 'description' => 'Mongos节点信息列表。'."\n" + ."\n" + .'> 实例类型为分片集群实例时，返回该参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'Mongos节点信息列表。'."\n" + ."\n" + .'> 实例类型为分片集群实例时，返回该参数。', + 'type' => 'object', + 'properties' => [ + 'NodeClass' => [ + 'description' => 'Mongos节点规格。', + 'type' => 'string', + 'example' => 'dds.mongos.standard', + ], + 'NodeDescription' => [ + 'description' => 'Mongos节点描述。', + 'type' => 'string', + 'example' => '测试mongos节点', + ], + 'NodeId' => [ + 'description' => 'Mongos节点ID。', + 'type' => 'string', + 'example' => 's-bp10e3b0d02f****', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'DBInstanceDescription' => [ + 'description' => '实例的描述或备注信息。', + 'type' => 'string', + 'example' => '测试数据库', + ], + 'ExpireTime' => [ + 'description' => '实例到期时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-25T16:00Z', + ], + 'DBInstanceType' => [ + 'description' => '实例类型，取值说明： '."\n" + .'- **sharding**：分片集群实例。'."\n" + .'- **replicate**：副本集实例和单节点实例。'."\n" + .'<props="china">'."\n" + .'- **serverless**：Serverless实例。'."\n" + .'</props>'."\n", + 'type' => 'string', + 'example' => 'sharding', + ], + 'LastDowngradeTime' => [ + 'description' => '实例最后一次降配时间。', + 'type' => 'string', + 'example' => '2021-05-08', + ], + 'ShardList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ShardAttribute' => [ + 'description' => 'Shard节点信息列表。'."\n" + .'> 实例类型为分片集群实例时返回该参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'Shard节点信息列表。'."\n" + .'> 实例类型为分片集群实例时返回该参数。', + 'type' => 'object', + 'properties' => [ + 'NodeClass' => [ + 'description' => 'Shard节点的实例规格。', + 'type' => 'string', + 'example' => 'dds.shard.mid', + ], + 'NodeDescription' => [ + 'description' => 'Shard节点描述。', + 'type' => 'string', + 'example' => '测试shard节点', + ], + 'NodeStorage' => [ + 'description' => 'Shard节点的存储空间，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NodeId' => [ + 'description' => 'Shard节点ID。', + 'type' => 'string', + 'example' => 'd-bp1cac6f2083****', + ], + 'ReadonlyReplicas' => [ + 'description' => 'Shard节点中只读节点的个数。返回值范围：**0**~**5**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'DestroyTime' => [ + 'description' => '实例数据销毁时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> - 包年包月实例，到期后第16天计算资源会被释放，数据继续保留7天，到期后第23天，数据会被删除且无法恢复。'."\n" + .'> - 按量付费实例，欠费后第16天计算资源会被释放，数据继续保留7天，欠费后第23天，数据会被删除且无法恢复。', + 'type' => 'string', + 'example' => '2021-12-10T16:00:00Z', + ], + 'DBInstanceStatus' => [ + 'description' => '实例状态，详情请参见[实例状态表](~~63870~~)。', + 'type' => 'string', + 'example' => 'Running', + ], + 'RegionId' => [ + 'description' => '实例所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstanceStorage' => [ + 'description' => '实例存储空间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + ], + 'ZoneId' => [ + 'description' => '实例所属可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp18b0934e70****', + ], + 'DBInstanceClass' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'dds.mongo.mid', + ], + 'Engine' => [ + 'description' => '数据库引擎。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + 'ReplicationFactor' => [ + 'description' => '实例中节点的个数。'."\n" + ."\n" + .'> 实例类型为副本集实例时返回该参数。', + 'type' => 'string', + 'example' => '3', + ], + 'KindCode' => [ + 'description' => '实例的类型，取值说明：'."\n" + .'- **0**：物理机。'."\n" + .'- **1**：ECS。'."\n" + .'- **2**：DOCKER。'."\n" + .'- **18**：k8s新架构实例。', + 'type' => 'string', + 'example' => '1', + ], + 'CapacityUnit' => [ + 'description' => '实例消耗的读写吞吐量。'."\n" + ."\n" + .'> 当实例类型为Serverless实例时返回该参数。', + 'type' => 'string', + 'example' => '100', + ], + 'StorageType' => [ + 'description' => '存储类型，取值说明： '."\n" + ."\n" + .'- **cloud_essd**：ESSD云盘。'."\n" + .'- **local_ssd**：SSD本地盘。', + 'type' => 'string', + 'example' => 'local_ssd', + ], + 'SecondaryZoneId' => [ + 'description' => '实现多可用区部署时，实例的备可用区1，取值说明：'."\n" + .'- **cn-hangzhou-g**：杭州可用区G。'."\n" + .'- **cn-hangzhou-h**：杭州可用区H。'."\n" + .'- **cn-hangzhou-i**：杭州可用区I。'."\n" + .'- **cn-hongkong-b**：香港可用区B。'."\n" + .'- **cn-hongkong-c**：香港可用区C。'."\n" + .'- **cn-hongkong-d**：香港可用区D。'."\n" + .'- **cn-wulanchabu-a**：乌兰察布可用区A。'."\n" + .'- **cn-wulanchabu-b**：乌兰察布可用区B。'."\n" + .'- **cn-wulanchabu-c**：乌兰察布可用区C。'."\n" + .'- **ap-southeast-1a**：新加坡可用区A。'."\n" + .'- **ap-southeast-1b**：新加坡可用区B。'."\n" + .'- **ap-southeast-1c**：新加坡可用区C。'."\n" + .'- **ap-southeast-5a**：雅加达可用区A。'."\n" + .'- **ap-southeast-5b**：雅加达可用区B。'."\n" + .'- **ap-southeast-5c**：雅加达可用区C。'."\n" + .'- **eu-central-1a**：法兰克福可用区A。'."\n" + .'- **eu-central-1b**：法兰克福可用区B。'."\n" + .'- **eu-central-1c**：法兰克福可用区C。'."\n" + ."\n" + .'> - 当实例为4.4或5.0版本的多可用区副本集实例或分片集群实例时，返回该参数。'."\n" + .'> - 目前仅中国站支持返回该参数。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'HiddenZoneId' => [ + 'description' => '实现多可用区部署时，实例的备可用区2，取值说明：'."\n" + .'- **cn-hangzhou-g**：杭州可用区G。'."\n" + .'- **cn-hangzhou-h**：杭州可用区H。'."\n" + .'- **cn-hangzhou-i**：杭州可用区I。'."\n" + .'- **cn-hongkong-b**：香港可用区B。'."\n" + .'- **cn-hongkong-c**：香港可用区C。'."\n" + .'- **cn-hongkong-d**：香港可用区D。'."\n" + .'- **cn-wulanchabu-a**：乌兰察布可用区A。'."\n" + .'- **cn-wulanchabu-b**：乌兰察布可用区B。'."\n" + .'- **cn-wulanchabu-c**：乌兰察布可用区C。'."\n" + .'- **ap-southeast-1a**：新加坡可用区A。'."\n" + .'- **ap-southeast-1b**：新加坡可用区B。'."\n" + .'- **ap-southeast-1c**：新加坡可用区C。'."\n" + .'- **ap-southeast-5a**：雅加达可用区A。'."\n" + .'- **ap-southeast-5b**：雅加达可用区B。'."\n" + .'- **ap-southeast-5c**：雅加达可用区C。'."\n" + .'- **eu-central-1a**：法兰克福可用区A。'."\n" + .'- **eu-central-1b**：法兰克福可用区B。'."\n" + .'- **eu-central-1c**：法兰克福可用区C。'."\n" + ."\n" + .'> - 当实例为4.4或5.0版本的多可用区副本集实例或分片集群实例时，返回该参数。'."\n" + .'> - 目前仅中国站支持返回该参数。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'BackupRetentionPolicy' => [ + 'description' => '备份保留策略，取值如下：'."\n" + ."\n" + .'- **0**：实例释放时立即删除该实例的所有备份集。'."\n" + .'- **1**：实例释放时会自动备份，长期保留该备份集。'."\n" + .'- **2**：实例释放时会自动备份，并长期保留该集群的所有备份集。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ReleaseTime' => [ + 'description' => '实例释放时间。', + 'type' => 'string', + 'example' => '2024-06-17T07:01Z', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询MongoDB实例列表', + 'summary' => '查询MongoDB实例列表。', + 'description' => '<props="china">该接口默认查询副本集实例（包含单节点实例）列表，即未配置请求参数**DBInstanceType**时，该参数的默认值为**replicate**。如果您需要查询分片集群实例列表，请配置**DBInstanceType**的值为**sharding**；如果您需要查询Serverless实例列表，请配置**DBInstanceType**的值为**serverless**。</props>'."\n" + .'<props="intl">该接口默认查询副本集实例（包含单节点实例）列表，即未配置请求参数**DBInstanceType**时，该参数的默认值为**replicate**。如果您需要查询分片集群实例列表，请配置**DBInstanceType**的值为**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 \\"SecondaryZoneId\\": \\"cn-hangzhou-i\\",\\n \\"HiddenZoneId\\": \\"cn-hangzhou-h\\",\\n \\"BackupRetentionPolicy\\": 1,\\n \\"ReleaseTime\\": \\"2024-06-17T07:01Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstancesOverview' => [ + 'summary' => '查询一个或多个云数据库MongoDB实例的概览信息。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询概览的实例ID。'."\n" + ."\n" + .'> - 如果不传入该参数，默认查询当前阿里云账号下的所有实例。'."\n" + .'> - 支持传入多个实例ID，实例ID之间以英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp12c5b040dc****', + ], + ], + [ + 'name' => 'InstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的状态信息，取值详情请参见[实例状态表](~~63870~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的付费类型，取值：'."\n" + .'- **PrePaid**：预付费，包年包月。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的网络类型，取值：'."\n" + .'- **Classic**：经典网络。'."\n" + .'- **VPC**：VPC网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'Classic', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的引擎版本，取值为 **5.0**、**4.4**、 **4.2**、**4.0**或 **3.4**。', + 'type' => 'string', + 'required' => false, + 'example' => '4.0', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格。不同类型实例的规格分别请参见：'."\n" + ."\n" + .'- [单节点实例规格表](~~311407~~)'."\n" + .'- [副本集实例规格表](~~311410~~)'."\n" + .'- [分片集群实例规格表](~~311414~~)'."\n" + ."\n" + .'<props="china">'."\n" + .'> Serverless实例不需要传入该参数。</props>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dds.mongo.2xlarge', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值： '."\n" + .'- **sharding**：分片集群实例。'."\n" + .'- **replicate**：副本集实例和单节点实例。'."\n" + .'<props="china">'."\n" + .'- **serverless**：Serverless实例。'."\n" + .'</props>'."\n" + ."\n" + .'> - 请根据实际需求配置，例如您需要查询分片集群实例的概览，则配置该参数的值为**sharding**。'."\n" + .'> - 不配置该参数时，默认查询所有实例的概览。', + 'type' => 'string', + 'required' => false, + 'example' => 'replicate', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。资源组详情请参见[查看资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'ShowTags', + 'in' => 'query', + 'schema' => [ + 'description' => '是否展示实例标签，默认值 false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '实例概览信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询结果中实例的数量。', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA', + ], + 'DBInstances' => [ + 'description' => '实例信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息列表。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '实例创建的时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-01-05T03:18:53Z', + ], + 'ExpireTime' => [ + 'description' => '实例到期时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-02-05T16:00Z', + ], + 'Tags' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '实例的标签键。N的取值范围为**1**~**20**。'."\n" + ."\n" + .'- 不能以`aliyun`、`acs:`、`http://`或`https://`开头。'."\n" + .'- 最多支持64个字符。'."\n" + .'- 不允许传入空字符串。', + 'type' => 'string', + 'example' => 'testdatabase', + ], + 'Value' => [ + 'description' => '实例的标签值。N的取值范围为**1**~**20**。'."\n" + ."\n" + .'- 不能以`aliyun`、`acs`:、`http://`或`https://`开头。'."\n" + .'- 最多支持128个字符。'."\n" + .'- TagValue可以为空。', + 'type' => 'string', + 'example' => 'apitest', + ], + ], + ], + ], + 'LastDowngradeTime' => [ + 'description' => '实例最后一次降配时间。', + 'type' => 'string', + 'example' => '2021-05-08', + ], + 'ShardList' => [ + 'description' => 'Shard节点信息列表。'."\n" + .'> 实例类型为分片集群实例时返回该参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'Shard节点信息列表。'."\n" + .'> 实例类型为分片集群实例时返回该参数。', + 'type' => 'object', + 'properties' => [ + 'NodeClass' => [ + 'description' => 'Shard节点的规格。', + 'type' => 'string', + 'example' => 'dds.shard.mid', + ], + 'NodeDescription' => [ + 'description' => 'Shard节点的描述信息。', + 'type' => 'string', + 'example' => '测试shard节点', + ], + 'NodeStorage' => [ + 'description' => 'Shard节点的存储空间，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NodeId' => [ + 'description' => 'Shard节点的ID。', + 'type' => 'string', + 'example' => 'd-bp1cac6f2083****', + ], + 'ReadonlyReplicas' => [ + 'description' => 'Shard节点中只读节点的个数。返回值范围：**0**~**5**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'DBInstanceType' => [ + 'description' => '实例类型，取值： '."\n" + .'- **sharding**：分片集群实例。'."\n" + .'- **replicate**：副本集实例和单节点实例。'."\n" + .'<props="china">'."\n" + .'- **serverless**：Serverless实例。'."\n" + .'</props>', + 'type' => 'string', + 'example' => 'replicate', + ], + 'DestroyTime' => [ + 'description' => '实例数据销毁时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-12-10T16:00:00Z', + ], + 'ChargeType' => [ + 'description' => '实例付费类型，取值：'."\n" + .'- **PrePaid**：预付费，包年包月。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'example' => 'PrePaid', + ], + 'CapacityUnit' => [ + 'description' => '实例消耗的读写吞吐量。'."\n" + ."\n" + .'> - 当实例类型为Serverless实例时返回该参数。'."\n" + .'> - 仅中国站支持Serverless实例。', + 'type' => 'string', + 'example' => '100', + ], + 'VpcAuthMode' => [ + 'description' => '是否开启了专有网络免密访问功能。取值：'."\n" + ."\n" + .'- **Open**：开启。'."\n" + .'- **Close**：关闭。', + 'type' => 'string', + 'example' => 'Open', + ], + 'DBInstanceStatus' => [ + 'description' => '实例的状态信息，取值详情请参见[实例状态表](~~63870~~)。', + 'type' => 'string', + 'example' => 'Running', + ], + 'NetworkType' => [ + 'description' => '实例网络类型，取值：'."\n" + .'- **Classic**：经典网络。'."\n" + .'- **VPC**：VPC网络。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'LockMode' => [ + 'description' => '实例的锁定状态。'."\n" + .'* **Unlock**：正常。'."\n" + .'* **ManualLock**：手动触发锁定。'."\n" + .'* **LockByExpiration**：实例过期自动锁定。'."\n" + .'* **LockByRestoration**：实例回滚前自动锁定。'."\n" + .'* **LockByDiskQuota**：实例空间满自动锁定。'."\n" + .'* **Released**：实例已释放。此时实例无法进行解锁，只能使用备份数据重新创建新实例，重建时间较长，请耐心等待。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'EngineVersion' => [ + 'description' => '实例的数据库版本。', + 'type' => 'string', + 'example' => '4.2', + ], + 'MongosList' => [ + 'description' => 'Mongos节点信息列表。'."\n" + ."\n" + .'> 实例类型为分片集群实例时返回该参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'Mongos节点信息列表。'."\n" + ."\n" + .'> 实例类型为分片集群实例时返回该参数。', + 'type' => 'object', + 'properties' => [ + 'NodeClass' => [ + 'description' => 'Mongos节点规格。', + 'type' => 'string', + 'example' => 'dds.mongos.standard', + ], + 'NodeDescription' => [ + 'description' => 'Mongos节点描述。', + 'type' => 'string', + 'example' => '测试mongos节点', + ], + 'NodeId' => [ + 'description' => 'Mongos节点ID。', + 'type' => 'string', + 'example' => 's-bp10e3b0d02f****', + ], + ], + ], + ], + 'RegionId' => [ + 'description' => '实例所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstanceStorage' => [ + 'description' => '实例的存储空间大小，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ResourceGroupId' => [ + 'description' => '实例所属资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfm22cdcgc****', + ], + 'ZoneId' => [ + 'description' => '实例所属可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp12c5b040dc****', + ], + 'DBInstanceClass' => [ + 'description' => '实例规格。不同类型实例的规格分别请参见：'."\n" + ."\n" + .'- [单节点实例规格表](~~311407~~)'."\n" + .'- [副本集实例规格表](~~311410~~)'."\n" + .'- [分片集群实例规格表](~~311414~~)'."\n" + ."\n" + .'<props="china">'."\n" + .'> Serverless实例不需要传入该参数。</props>', + 'type' => 'string', + 'example' => 'dds.mongo.mid', + ], + 'Engine' => [ + 'description' => '数据库引擎，取值为**MongoDB**。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + 'ReplicationFactor' => [ + 'description' => '实例中节点的个数。'."\n" + ."\n" + .'> 实例类型为副本集实例时返回该参数。', + 'type' => 'string', + 'example' => '3', + ], + 'DBInstanceDescription' => [ + 'description' => '实例的描述或备注信息。', + 'type' => 'string', + 'example' => '测试数据库', + ], + 'KindCode' => [ + 'description' => '表示实例的类型。取值：'."\n" + .'- **0**：物理机'."\n" + .'- **1**：ECS'."\n" + .'- **2**：DOCKER'."\n" + .'- **18**：k8s新架构实例', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'title' => '查询实例的概览信息', + 'description' => '- 如果您未指定实例的具体信息，则返回当前账号的目标地域下所有实例的概览信息。'."\n" + ."\n" + .'- 该接口返回结果不进行分页。', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeDBInstancesOverviewResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA</RequestId>\\n <DBInstances>\\n <EngineVersion>4.2</EngineVersion>\\n <DBInstanceStatus>Running</DBInstanceStatus>\\n <ResourceGroupId>rg-acfm22cdcgc****</ResourceGroupId>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n <ReplicationFactor>3</ReplicationFactor>\\n <CapacityUnit/>\\n <DBInstanceClass>dds.mongo.mid</DBInstanceClass>\\n <DBInstanceType>replicate</DBInstanceType>\\n <LockMode>Unlock</LockMode>\\n <DBInstanceId>dds-bp12c5b040dc****</DBInstanceId>\\n <ChargeType>PrePaid</ChargeType>\\n <NetworkType>VPC</NetworkType>\\n <DBInstanceStorage>20</DBInstanceStorage>\\n <CreationTime>2022-01-05T03:18:53Z</CreationTime>\\n <RegionId>cn-hangzhou</RegionId>\\n <ExpireTime>2022-02-05T16:00Z</ExpireTime>\\n <KindCode>0</KindCode>\\n <Engine>MongoDB</Engine>\\n <DBInstanceDescription>测试数据库</DBInstanceDescription>\\n </DBInstances>\\n</DescribeDBInstancesOverviewResponse>","errorExample":""}]', + ], + 'DescribeErrorLogRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + .'> 当本参数传入的是分片集群实例ID时，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID或Shard节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp128a003436****', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例中节点的角色。取值：'."\n" + .'- **primary**：主节点。'."\n" + .'- **secondary**：从节点。'."\n" + ."\n" + .'> 当**NodeId**参数传入的是Mongos节点ID时，本参数取值只能为**primary**。', + 'type' => 'string', + 'required' => false, + 'example' => 'primary', + 'default' => 'primary', + 'enum' => [ + 'primary', + 'secondary', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => ' 查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-01T12:10Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => ' 查询结束时间，必须晚于查询开始时间，且与查询开始时间间隔时长不能大于一天。格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-02T12:10Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodbtest', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => ' 每页记录数，取值范围：**30**~**100**。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。资源组详情请参见[查看资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，多个关键字以空格分隔，不超过10个关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'test test1', + ], + ], + [ + 'name' => 'LogicalOperator', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字搜索的逻辑操作， 默认值为and。', + 'type' => 'string', + 'required' => false, + 'example' => 'and', + 'default' => 'and', + 'enum' => [ + 'and', + 'or', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => ' 总记录数。 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '68BCBEC2-1E66-471F-A1A8-E3C60C0A80B0', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogRecords' => [ + 'description' => '错误日志明细列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnInfo' => [ + 'description' => '日志连接信息。', + 'type' => 'string', + 'example' => 'conn18xxxxxx', + ], + 'CreateTime' => [ + 'description' => '日志生成时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:</i><i>ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-02-26T12:09:34Z', + ], + 'Category' => [ + 'description' => '日志类别。返回值：'."\n" + .'- NETWORK：网络连接日志。'."\n" + .'- ACCESS：访问控制日志。'."\n" + .'- -：普通日志。'."\n" + .'- COMMAND：慢日志。'."\n" + .'- SHARDING：集群日志。'."\n" + .'- STORAGE：存储引擎日志。'."\n" + .'- CONNPOOL：连接池日志。'."\n" + .'- ASIO：异步IO日志。'."\n" + .'- WRITE：慢更新日志。', + 'type' => 'string', + 'example' => 'NETWORK', + ], + 'Content' => [ + 'description' => '日志信息。', + 'type' => 'string', + 'example' => 'xxxxxxxx', + ], + 'Id' => [ + 'description' => '日志ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1111111111', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'Engine' => [ + 'description' => '当前数据库的引擎类型。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time', + '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' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'LogApiFrequencyExceeded', + 'errorMessage' => 'Exceeding the allowed frequency of log api.', + 'description' => '', + ], + ], + ], + 'title' => '查询实例的错误日志', + 'summary' => '查询MongoDB实例的错误日志。', + 'description' => '- 本接口适用于规格类型为**通用型本地盘版**和**独享型本地盘版**实例。'."\n" + .'- 本接口限制每分钟调用30次，如超过这个限制会被限流，请勿高频调用。如需高频调用，请使用Logstore，详情请参见[管理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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeErrorLogRecordsResponse>\\r\\n\\t<Items>\\r\\n\\t\\t<LogRecords>\\r\\n\\t\\t\\t<Category>NETWORK</Category>\\r\\n\\t\\t\\t<CreateTime>2019-02-26T12:09:34Z</CreateTime>\\r\\n\\t\\t\\t<ConnInfo>conn18xxxxxx</ConnInfo>\\r\\n\\t\\t\\t<Content>xxxxxxxx</Content>\\r\\n\\t\\t</LogRecords>\\r\\n\\t</Items>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<TotalRecordCount>2</TotalRecordCount>\\r\\n\\t<RequestId>68BCBEC2-1E66-471F-A1A8-E3C60C0A80B0</RequestId>\\r\\n</DescribeErrorLogRecordsResponse>","errorExample":""}]', + ], + 'DescribeGlobalSecurityIPGroup' => [ + 'summary' => '查询全局IP白名单模板。', + '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' => '实例所属的地域ID，您可以通过调用[DescribeDBInstanceAttribute](~~62010~~)进行查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-hedmu8kg9nsabw6u42rv', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求唯一ID，如果遇到问题请提供这个请求ID，由工作人员为您排查。', + 'type' => 'string', + 'example' => '72651AF9-7897-41A7-8B67-6C15C7F26A0A', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '全局IP白名单模板。', + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-sdgwqyp4f5j1x3qk7yvm', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。', + 'type' => 'string', + 'example' => 'dev_baoxian_k8s_bj', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '117.12.202.19', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstances' => [ + 'description' => '全局IP白名单模板绑定的实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'MongoDB实例Id。', + 'type' => 'string', + 'example' => '[dds-asdxxxx,dds-afrexxxxxx]', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidAction', + 'errorMessage' => 'Specified action is not valid.', + 'description' => '服务异常。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'Specified user does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询全局IP白名单模板', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例Id', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze6069764423m0l', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '实例Id', + 'type' => 'string', + 'example' => 'dds-2ze6069764423m0l', + ], + 'RequestId' => [ + 'description' => '请求唯一ID，如果遇到问题请提供这个请求ID，由工作人员为您排查。', + 'type' => 'string', + 'example' => 'F8CA8312-530A-413A-9129-F2BB32A8D404', + ], + 'GlobalSecurityIPGroupRel' => [ + 'description' => '全局IP白名单模板映射关系。', + 'type' => 'array', + 'items' => [ + 'description' => '全局IP白名单模板映射关系。', + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-gfurfpsh4ycbrm2avst7', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '27.16.214.10,111.60.117.181', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hongkong', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。', + 'type' => 'string', + 'example' => 'dev_baoxian_k8s_bj', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询实例与全局IP白名单模板关系映射', + 'summary' => '查询实例与全局IP白名单模板关系映射。', + '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' => '查看任务中心的任务列表。', + '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' => '待处理事件所属的地域ID，您可以通过调用[DescribeRegions](~~61933~~)接口进行查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：10~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的页码。取值范围：正整数。 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '当前固定为Instance。', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，用于选择对应状态的任务：'."\n" + ."\n" + .'- Scheduled：等待执行'."\n" + ."\n" + .'- Running：执行中'."\n" + ."\n" + .'- Succeed：执行成功'."\n" + ."\n" + .'- Failed：执行失败'."\n" + ."\n" + .'- Cancelling：正在终止'."\n" + ."\n" + .'- Canceled：已终止'."\n" + ."\n" + .'- Waiting：等待预设时间'."\n" + ."\n" + .'默认为空，表示全选，如需选择多个状态请用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeed,Running,Waiting', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，用于查询对应实例的任务，默认为空，表示不限制。如需查询多个实例请用英文逗号（,）分隔，最多支持30个。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-8vb38f0e7933xxxx', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID，用于查询已知ID的任务。默认为空，表示不限制。如需查询多个请用英文逗号（,）分隔，最多支持30个。', + 'type' => 'string', + 'required' => false, + 'example' => 't-0mq1yyhm3ffl2bxxxx', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，用于查询特定类型任务情况，默认为空，表示不限制，取值如下：'."\n" + .'- CreateIns：创建实例'."\n" + .'- DeleteIns：删除实例'."\n" + .'- ChangeVariable：参数调整'."\n" + .'- ModifyInsConfig：配置变更'."\n" + .'- RestartIns：重启实例'."\n" + .'- HaSwitch：实例主备切换'."\n" + .'- CloneIns：克隆实例'."\n" + .'- KernelVersionUpgrade：内核版本升级'."\n" + .'- ProxyVersionUpgrade：代理版本升级'."\n" + .'- ModifyAccount：账号变更'."\n" + .'- ModifyInsSpec：规格变更或迁移'."\n" + .'- CreateReadIns：创建只读实例'."\n" + .'- StartIns：启动实例'."\n" + .'- StopIns：暂停实例'."\n" + .'- ModifyNetwork：网络变更'."\n" + .'- LockIns： 锁定实例'."\n" + .'- UnlockIns：解锁实例'."\n" + .'- DiskOnlineExpansion：磁盘在线扩容'."\n" + .'- StorageOnlineExpansion：存储在线扩容'."\n" + .'- AddInsNode：增加节点'."\n" + .'- DeleteInsNode：删除节点'."\n" + .'- ManualBackupIns：手动备份实例'."\n" + .'- ModifyInsStorageType：修改存储类型', + 'type' => 'string', + 'required' => false, + 'example' => 'DeleteInsNode', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '运维任务开始的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），最早支持查询30天前的数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-03-15T03:41:26Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '运维任务结束的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），最早支持查询30天前的数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-03-16T07:21:31Z', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2inrfrnw3xby', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前显示的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C4A2494-XXXX-XXXX-93CF-548DB3375193', + ], + 'PageSize' => [ + 'description' => '每页显示的最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '不考虑分页因素，满足查询条件的总任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Items' => [ + 'description' => '任务对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务对象，格式是词典。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + .'- Scheduled：等待执行'."\n" + .'- Running：执行中'."\n" + .'- Succeed：执行成功'."\n" + .'- Failed：执行失败'."\n" + .'- Cancelling：正在终止'."\n" + .'- Canceled：已终止'."\n" + .'- Waiting：等待预设时间', + 'type' => 'string', + 'example' => 'Succeed', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-0mq1yyhm3ffl2bxxxx', + ], + 'CurrentStepName' => [ + 'description' => '当前执行的步骤名，如果为空代表任务未开始。', + 'type' => 'string', + 'example' => 'exec_task', + ], + 'StartTime' => [ + 'description' => '任务开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-02-11T02:33Z', + ], + 'EndTime' => [ + 'description' => '任务结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-03-16T02:59Z', + ], + 'TaskType' => [ + 'description' => '任务类型。'."\n" + .'- CreateIns：创建实例'."\n" + .'- DeleteIns：删除实例'."\n" + .'- ChangeVariable：参数调整'."\n" + .'- ModifyInsConfig：配置变更'."\n" + .'- RestartIns：重启实例'."\n" + .'- HaSwitch：实例主备切换'."\n" + .'- CloneIns：克隆实例'."\n" + .'- KernelVersionUpgrade：内核版本升级'."\n" + .'- ProxyVersionUpgrade：代理版本升级'."\n" + .'- ModifyAccount：账号变更'."\n" + .'- ModifyInsSpec：规格变更或迁移'."\n" + .'- CreateReadIns：创建只读实例'."\n" + .'- StartIns：启动实例'."\n" + .'- StopIns：暂停实例'."\n" + .'- ModifyNetwork：网络变更'."\n" + .'- LockIns： 锁定实例'."\n" + .'- UnlockIns：解锁实例'."\n" + .'- DiskOnlineExpansion：磁盘在线扩容'."\n" + .'- StorageOnlineExpansion：存储在线扩容'."\n" + .'- AddInsNode：增加节点'."\n" + .'- DeleteInsNode：删除节点'."\n" + .'- ManualBackupIns：手动备份实例'."\n" + .'- ModifyInsStorageType：修改存储类型', + 'type' => 'string', + 'example' => 'CreateIns', + ], + 'RemainTime' => [ + 'description' => '预估剩余执行时间，单位秒，0表示已执行完成。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000'."\n", + ], + 'Progress' => [ + 'description' => '当前进度，范围为[0,100]。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100.0', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceType' => [ + 'description' => '实例类型，固定为Instance。', + 'type' => 'string', + 'example' => 'Instance', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-t4n18194768fxxxx', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test-dds', + ], + 'DbType' => [ + 'description' => 'DB类型，固定为mongodb。', + 'type' => 'string', + 'example' => 'mongodb', + ], + 'Product' => [ + 'description' => '产品，固定为dds。', + 'type' => 'string', + 'example' => 'dds', + ], + 'TaskDetail' => [ + 'description' => '任务详情，不同taskType对应不同的输出。', + 'type' => 'string', + 'example' => '{\\"callerUid\\":\\"test\\"}', + ], + 'ReasonCode' => [ + 'description' => '当前任务发起的原因。', + 'type' => 'string', + 'example' => '小版本升级', + ], + 'ActionInfo' => [ + 'description' => '允许的操作信息，具体使用时是根据currentStepName+status在此信息中匹配操作Action，如果未匹配到Action，代表任务当前状态不支持操作，示例：'."\n" + .'```'."\n" + .' "steps": ['."\n" + .' {'."\n" + .' "step_name": "exec_task", // 步骤名, 与currentStepName匹配'."\n" + .' "action_info": { // 步骤支持的操作'."\n" + .' "Waiting": [ // 状态，与status匹配'."\n" + .' "modifySwitchTime" // 操作Action，可能多个，即代表支持多个操作'."\n" + .' ]'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "step_name": "init_task", // 步骤名'."\n" + .' "action_info": { // 步骤支持的操作'."\n" + .' "Running": [ // 状态'."\n" + .' "cancel", // 操作'."\n" + .' "pause"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'系统可能支持的操作：'."\n" + ."\n" + .'- retry：重试'."\n" + .'- cancel：取消'."\n" + .'- modifySwitchTime：修改切换时间/恢复时间', + 'type' => 'string', + 'example' => '`{\\"steps\\":[{\\"action_info\\":{\\"Waiting\\":[\\"modifySwitchTime\\"]},\\"step_name\\":\\"exec_task\\"}]}`', + ], + 'Uid' => [ + 'description' => '资源所属的用户ID。', + 'type' => 'string', + 'example' => '141345906006****', + ], + 'CallerSource' => [ + 'description' => '请求来源 System：系统 User：用户。', + 'type' => 'string', + 'example' => 'System', + ], + 'CallerUid' => [ + 'description' => '请求用户ID，callerSource为User时代表用户UID。', + 'type' => 'string', + 'example' => '141345906006****', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Param.Invalid', + 'errorMessage' => 'Param invalid', + 'description' => '', + ], + [ + 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', + 'errorMessage' => 'Param invalid. End time before start time', + 'description' => '', + ], + ], + ], + 'title' => '查询任务中心的任务信息', + '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' => '查看任务中心任务的概览信息。', + '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' => '待处理事件所属的地域ID，您可以通过调用[DescribeRegions](~~61933~~)接口进行查询。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，用于选择对应状态的任务：'."\n" + ."\n" + .'- Scheduled：等待执行'."\n" + ."\n" + .'- Running：执行中'."\n" + ."\n" + .'- Succeed：执行成功'."\n" + ."\n" + .'- Failed：执行失败'."\n" + ."\n" + .'- Cancelling：正在终止'."\n" + ."\n" + .'- Canceled：已终止'."\n" + ."\n" + .'- Waiting：等待预设时间'."\n" + ."\n" + .'默认为空，表示全选，如需选择多个状态请用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeed', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，用于查询对应实例的任务，默认为空，表示不限制。如需查询多个实例请用英文逗号（,）分隔，最多支持30个。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-8vb38f0e7933xxxx', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID，用于查询已知ID的任务。默认为空，表示不限制。如需查询多个请用英文逗号（,）分隔，最多支持30个。', + 'type' => 'string', + 'required' => false, + 'example' => 't-0mq1yyhm3ffl2bxxxx', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，用于查询特定类型任务情况，默认为空，表示不限制，取值如下：'."\n" + .'- CreateIns：创建实例'."\n" + .'- DeleteIns：删除实例'."\n" + .'- ChangeVariable：参数调整'."\n" + .'- ModifyInsConfig：配置变更'."\n" + .'- RestartIns：重启实例'."\n" + .'- HaSwitch：实例主备切换'."\n" + .'- CloneIns：克隆实例'."\n" + .'- KernelVersionUpgrade：内核版本升级'."\n" + .'- ProxyVersionUpgrade：代理版本升级'."\n" + .'- ModifyAccount：账号变更'."\n" + .'- ModifyInsSpec：规格变更或迁移'."\n" + .'- CreateReadIns：创建只读实例'."\n" + .'- StartIns：启动实例'."\n" + .'- StopIns：暂停实例'."\n" + .'- ModifyNetwork：网络变更'."\n" + .'- LockIns： 锁定实例'."\n" + .'- UnlockIns：解锁实例'."\n" + .'- DiskOnlineExpansion：磁盘在线扩容'."\n" + .'- StorageOnlineExpansion：存储在线扩容'."\n" + .'- AddInsNode：增加节点'."\n" + .'- DeleteInsNode：删除节点'."\n" + .'- ManualBackupIns：手动备份实例'."\n" + .'- ModifyInsStorageType：修改存储类型', + 'type' => 'string', + 'required' => false, + 'example' => 'DeleteIns', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '运维任务开始的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），最早支持查询30天前的数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-16T02:46:21Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '运维任务结束的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），最早支持查询30天前的数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-05-16T02:15:52Z', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FC724D23-XXXX-XXXX-ABB1-606C935AE7FD', + ], + 'Items' => [ + 'description' => '任务对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务对象。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + .'- Scheduled：等待执行'."\n" + .'- Running：执行中'."\n" + .'- Succeed：执行成功'."\n" + .'- Failed：执行失败'."\n" + .'- Cancelling：正在终止'."\n" + .'- Canceled：已终止'."\n" + .'- Waiting：等待预设时间', + 'type' => 'string', + 'example' => 'Succeed', + ], + 'TotalCount' => [ + 'description' => '任务状态对应的任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Param.Invalid', + 'errorMessage' => 'Param invalid', + 'description' => '', + ], + [ + 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', + 'errorMessage' => 'Param invalid. End time before start time', + 'description' => '', + ], + ], + ], + 'title' => '查询任务中心任务状态的概览信息', + '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' => '实例所属的地域ID。您可以通过调用[DescribeDBInstanceAttribute](~~62010~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp567b****', + ], + ], + [ + 'name' => 'DBInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型。取值：'."\n" + .'- **replicate**（默认值）：单节点或副本集实例。'."\n" + .'- **sharding**：分片集群实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'replicate', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。取值：**30**（默认值）、**50**或**100**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ItemsNumbers' => [ + 'description' => '查询结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageRecordCount' => [ + 'description' => '当前页显示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '查询结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceType' => [ + 'description' => '实例类型，返回值为：'."\n" + .'- **replicate**：单节点或副本集实例。'."\n" + .'- **sharding**：分片集群实例。', + 'type' => 'string', + 'example' => 'replicate', + ], + 'AutoRenew' => [ + 'description' => '自动续费状态，返回值为：'."\n" + .'- **true**：已开启自动续费。'."\n" + .'- **false**：未开启自动续费。', + 'type' => 'string', + 'example' => 'true', + ], + 'Duration' => [ + 'description' => '自动续费的续费周期，单位为月。'."\n" + ."\n" + .'> - 当**AutoRenew**参数的返回值为**true**时，才会返回本参数。'."\n" + .'> - 您可以调用[ModifyInstanceAutoRenewalAttribute](~~145979~~)接口，修改自动续费的周期。', + 'type' => 'string', + 'example' => '1', + ], + 'DbInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp2568*****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + 'description' => '内部错误，请稍后重试。'."\n", + ], + ], + ], + 'title' => '查询MongoDB实例是否为自动付费', + 'summary' => '查询MongoDB实例是否为自动付费。', + 'description' => '> 本接口适用于包年包月付费类型的实例。', + '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' => '[{"type":"json","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}","errorExample":"{\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"Duration\\": 1,\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"DBInstanceId\\": \\"r-xxxxxxxxxxxxxxx\\",\\n \\"AutoRenew\\": \\"true\\"\\n }\\n ]\\n },\\n \\"TotalRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"2B17D708-1D6D-49F3-B6D7-478371DDDBE8\\",\\n \\"PageRecordCount\\": 1\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeInstanceAutoRenewalAttributeResponse>\\n\\t<Items>\\n\\t\\t<Item>\\n\\t\\t\\t<DBInstanceType>replicate</DBInstanceType>\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t\\t<DbInstanceId>dds-bpxxxxxxxx</DbInstanceId>\\n\\t\\t\\t<AutoRenew>false</AutoRenew>\\n\\t\\t</Item>\\n\\t\\t<Item>\\n\\t\\t\\t<DBInstanceType>replicate</DBInstanceType>\\n\\t\\t\\t<Duration>1</Duration>\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t\\t<DbInstanceId>dds-bpxxxxxxxx</DbInstanceId>\\n\\t\\t\\t<AutoRenew>true</AutoRenew>\\n\\t\\t</Item>\\n\\t</Items>\\n\\t<PageNumber>1</PageNumber>\\n\\t<RequestId>FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949</RequestId>\\n\\t<ItemsNumbers>2</ItemsNumbers>\\n\\t<PageRecordCount>2</PageRecordCount>\\n</DescribeInstanceAutoRenewalAttributeResponse>","errorExample":"<DescribeInstanceAutoRenewalAttributeResponse>\\n <Items>\\n <Item>\\n <Duration>1</Duration>\\n <RegionId>cn-shanghai</RegionId>\\n <DBInstanceId>r-xxxxxxxxxxxxxxx</DBInstanceId>\\n <AutoRenew>true</AutoRenew>\\n </Item>\\n </Items>\\n <TotalRecordCount>1</TotalRecordCount>\\n <PageNumber>1</PageNumber>\\n <RequestId>2B17D708-1D6D-49F3-B6D7-478371DDDBE8</RequestId>\\n <PageRecordCount>1</PageRecordCount>\\n</DescribeInstanceAutoRenewalAttributeResponse>"}]', + ], + 'DescribeInstanceRecoverTime' => [ + 'summary' => '查询云数据库 MongoDB 版云盘版副本集实例的可恢复时间', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份备份集所在地域。'."\n" + .'> '."\n" + .'> - 当查询的是异地备份时，需要且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份源实例所在区域。'."\n" + .'> '."\n" + .'> - 当查询的是异地备份时，需要且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组ID', + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8CA8312-530A-413A-9129-F2BB32A8D404', + ], + 'RestoreRanges' => [ + 'title' => '', + 'description' => '可恢复时间段列表。包含所有可用于按时间点恢复的时间段', + 'type' => 'array', + 'items' => [ + 'description' => '可恢复时间段列表。包含所有可用于按时间点恢复的时间段', + 'type' => 'object', + 'properties' => [ + 'RestoreBeginTime' => [ + 'title' => '', + 'description' => '可恢复开始时间。', + 'type' => 'string', + 'example' => '2023-10-16T19:33:20Z', + ], + 'RestoreEndTime' => [ + 'title' => '', + 'description' => '可恢复结束时间。', + 'type' => 'string', + 'example' => '2023-10-16T19:43:20Z', + ], + 'RestoreType' => [ + 'description' => '恢复方式，取值说明：'."\n" + .'* PointInTime（默认）：基于时间点恢复。', + 'type' => 'string', + 'example' => 'PointInTime', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询副本集实例的可恢复时间', + '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' => '数据库小版本号，例如：**mongodb_20180522_0.4.8**。'."\n" + ."\n" + .'您可以前往MongoDB控制台的实例**基本信息**页面，在**规格信息**区域获取**小版本**。'."\n" + .'> 该参数必传，将返回大于该版本的版本号列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodb_20180522_0.4.8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F01D4DDA-CB72-4083-B399-AF4642294FE6', + ], + 'ReleaseNotes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReleaseNote' => [ + 'description' => '版本发布日志信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseNote' => [ + 'description' => '发布日志。', + 'type' => 'string', + 'example' => '放开sharding某集合开关balancer的限制', + ], + 'KernelVersion' => [ + 'description' => '版本号。', + 'type' => 'string', + 'example' => 'mongodb_20180619_0.4.9', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidKernelReleaseNotes', + 'errorMessage' => 'The format of specified KernelVersion is invalid.', + 'description' => '', + ], + ], + ], + 'title' => '查询实例的小版本发布日志', + 'summary' => '查询MongoDB实例的小版本发布日志。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeKernelReleaseNotesResponse>\\r\\n\\t<RequestId>F01D4DDA-CB72-4083-B399-AF4642294FE6</RequestId>\\r\\n\\t<ReleaseNotes>\\r\\n\\t\\t<ReleaseNote>\\r\\n\\t\\t\\t<KernelVersion>mongodb_20180619_0.4.9</KernelVersion>\\r\\n\\t\\t\\t<ReleaseNote>放开sharding某集合开关balancer的限制</ReleaseNote>\\r\\n\\t\\t</ReleaseNote>\\r\\n\\t</ReleaseNotes>\\r\\n</DescribeKernelReleaseNotesResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + ], + 'DescribeKmsKeys' => [ + 'summary' => '查询云盘加密可选择的Kms密钥。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60EEBD77-227C-5B39-86EA-D89163C5****', + ], + 'KmsKeys' => [ + 'description' => 'KMS的密钥列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'KMS的密钥对象。', + 'type' => 'object', + 'properties' => [ + 'KeyAlias' => [ + 'description' => '密钥别名。', + 'type' => 'string', + 'example' => 'key-shh656820f4mh9qxxxxx alias/test1', + ], + 'KeyId' => [ + 'description' => '密钥ID。', + 'type' => 'string', + 'example' => '37291352-xxxx-xxxx-adbf-fd0630a95583', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => '查询云盘加密可选择的Kms密钥', + 'description' => '查询到的密钥仅适用于云盘加密。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeKmsKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '查看MongoDB日志服务的配置。', + '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' => '实例ID。您可以通过调用[DescribeDBInstances](~~61939~~)进行查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '审计日志的配置信息。', + 'type' => 'object', + 'properties' => [ + 'UserProjectName' => [ + 'description' => '审计日志的project名称。', + 'type' => 'string', + 'example' => 'nosql-176498472570****-cn-hangzhou', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '664ECE26-658A-47C5-88F6-870B0132E8D2', + ], + 'IsUserProjectLogstoreExist' => [ + 'description' => '当前地域中是否存在审计日志的project。取值：'."\n" + .'- **1**：存在。'."\n" + .'- **0**或**null**：不存在。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsEtlMetaExist' => [ + 'description' => '是否已创建将审计日志分发到Logtail的规则。关于Logtail的详细信息，请参见[Logtail简介](~~28979~~)。取值：'."\n" + .'- **1**：已创建。'."\n" + .'- **0**或**null**：未创建。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ServiceType' => [ + 'description' => '审计日志的版本类型。'."\n" + .'- **Trial**：免费试用版。'."\n" + .'- **Standard**：正式版。'."\n" + .'- **V2_Standard**： DAS企业版(NOSQL兼容)版本。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'EnableAudit' => [ + 'description' => '是否开启云数据库MongoDB审计日志功能。'."\n" + ."\n" + .'- **true**：开启。'."\n" + .'- **false**：未开启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TtlForTrail' => [ + 'description' => '免费试用版审计日志的保留时长，单位为天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'UsedStorageForTrail' => [ + 'description' => '免费试用版审计日志已使用的存储容量，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12548178759', + ], + 'PreserveStorageForTrail' => [ + 'description' => '免费试用版审计日志可使用存储容量的上限，单位为字节。可设置最高上限为107374182400字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '107374182400', + ], + 'TtlForStandard' => [ + 'description' => '正式版审计日志的保留时长，取值范围为1~365天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'UsedStorageForStandard' => [ + 'description' => '正式版审计日志已使用的存储容量，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20163', + ], + 'PreserveStorageForStandard' => [ + 'description' => '正式版审计日志可使用存储容量的上限。如果值为-1，说明未设置上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'HotTtlForV2Standard' => [ + 'description' => '在V2_Standard（DAS企业版(NOSQL兼容)审计日志）版本审计日志中表示热存储天数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'TtlForV2Standard' => [ + 'description' => '在V2_Standard（DAS企业版(NOSQL兼容)审计日志）版本审计日志中表示冷存储天数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeMongoDBLogConfigResponse>\\n <EnableAudit>true</EnableAudit>\\n <TtlForStandard>30</TtlForStandard>\\n <PreserveStorageForStandard>-1</PreserveStorageForStandard>\\n <UserProjectName>nosql-1764984725705461-cn-hangzhou</UserProjectName>\\n <RequestId>58E34DEE-EF44-5A59-B83E-A5B6F82CF5C9</RequestId>\\n <ServiceType>Standard</ServiceType>\\n <IsUserProjectLogstoreExist>1</IsUserProjectLogstoreExist>\\n <UsedStorageForTrail>12565942384</UsedStorageForTrail>\\n <PreserveStorageForTrail>107374182400</PreserveStorageForTrail>\\n <IsEtlMetaExist>1</IsEtlMetaExist>\\n <TtlForTrail>30</TtlForTrail>\\n <UsedStorageForStandard>20163</UsedStorageForStandard>\\n</DescribeMongoDBLogConfigResponse>","errorExample":""}]', + 'title' => '查看日志服务的配置', + 'description' => '本接口适用于规格类型为**通用型本地盘版**和**独享型本地盘版**实例。'."\n" + ."\n" + .'您可以根据业务需求开通云数据库MongoDB审计日志功能，开通方法请参见[开通审计日志](~~59903~~)。'."\n" + ."\n" + .'- 从2022年01月06日起，各地域将陆续上线正式版审计日志，并终止申请免费试用版审计日志。具体请参见[【通知】云数据库MongoDB上线按量收费的正式版审计日志及终止申请免费试用版](~~377480~~)。'."\n" + .'- 正式版审计日志根据审计日志的存储用量和保留时长按量收费，收费标准请参见<props="china">[云数据库MongoDB详细价格信息](https://www.aliyun.com/price/product?#/mongodb/detail/badds)</props><props="intl">[云数据库MongoDB详细价格信息](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' => '实例ID。'."\n" + .'> 当本参数传入的是分片集群实例ID时，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID或Shard节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp1158****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-01T12:10Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。必须晚于查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-02T12:10Z', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的角色类型。取值：'."\n" + .'- **db**: shard角色'."\n" + .'- **cs**：config server角色'."\n" + .'- **mongos**：mongos角色'."\n" + .'- **logic**：分片集群实例'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mongos', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B1BB6E0E-B4EF-4145-81FA-A07719860248', + ], + 'HistoricalParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'HistoricalParameter' => [ + 'description' => '参数的修改记录列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '被修改参数的名称。', + 'type' => 'string', + 'example' => 'operationProfiling.slowOpThresholdMs', + ], + 'OldParameterValue' => [ + 'description' => '修改前的参数值。', + 'type' => 'string', + 'example' => '100', + ], + 'NewParameterValue' => [ + 'description' => '修改后的参数值。', + 'type' => 'string', + 'example' => '200', + ], + 'ModifyTime' => [ + 'description' => '参数修改的时间。格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-03-12T07:58:24Z', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + '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' => '查询实例参数的修改记录', + 'summary' => '查询MongoDB实例参数的修改记录。', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeParameterModificationHistoryResponse>\\n <RequestId>B1BB6E0E-B4EF-4145-81FA-A07719860248</RequestId>\\n <HistoricalParameters>\\n <ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>\\n <OldParameterValue>100</OldParameterValue>\\n <NewParameterValue>200</NewParameterValue>\\n <ModifyTime>2019-03-12T07:58:24Z</ModifyTime>\\n </HistoricalParameters>\\n</DescribeParameterModificationHistoryResponse>","errorExample":""}]', + ], + 'DescribeParameterTemplates' => [ + 'summary' => '查询MongoDB实例默认的参数模板列表。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：**mongodb**。', + 'type' => 'string', + 'required' => true, + 'example' => 'mongodb', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本号。取值如下：'."\n" + .'- **7.0**'."\n" + .'- **6.0**'."\n" + .'- **5.0**'."\n" + .'- **4.4**'."\n" + .'- **4.2**'."\n" + .'- **4.0**'."\n" + .'- **3.4**', + 'type' => 'string', + 'required' => true, + 'example' => '5.0', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的角色类型，取值说明：'."\n" + ."\n" + .'- db：分片集群shard角色。'."\n" + .'- cs：分片集群config server角色。'."\n" + .'- mongos：分片集群mongos角色。'."\n" + .'- normal: 副本集角色。'."\n" + .'- physical：单节点角色。'."\n" + ."\n" + .'默认值为normal。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + 'default' => 'normal', + 'enum' => [ + 'normal', + 'db', + 'cs', + 'physical', + 'mongos', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterCount' => [ + 'description' => '参数个数。', + 'type' => 'string', + 'example' => '10', + ], + 'EngineVersion' => [ + 'description' => '数据库版本号。', + 'type' => 'string', + 'example' => '5.0', + ], + 'Parameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateRecord' => [ + 'description' => '参数模板列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => '可修改参数的值。', + 'type' => 'string', + 'example' => '[0-65536]', + ], + 'ParameterName' => [ + 'description' => '参数名称。'."\n" + ."\n" + .'详情请参见[MongoDB官方文档](https://www.mongodb.com/docs/manual/tutorial/manage-the-database-profiler/)', + 'type' => 'string', + 'example' => 'net.compression.compressors', + ], + 'ParameterValue' => [ + 'description' => '参数默认值。', + 'type' => 'string', + 'example' => '100', + ], + 'ForceModify' => [ + 'description' => '参数是否处于可修改的状态。'."\n" + .'- **false**：不可修改。'."\n" + .'- **true**：可修改。 ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ForceRestart' => [ + 'description' => '修改参数后是否需要重启生效。'."\n" + .'- **false**：无需重启，提交后即生效。'."\n" + .'- **true**：需要重启生效。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ParameterDescription' => [ + 'description' => '参数描述。', + 'type' => 'string', + 'example' => 'The threshold in milliseconds at which the database profiler considers a query slow, default is 100.', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BDA54203-9D61-54A3-A568-D281F785****', + ], + 'Engine' => [ + 'description' => '数据库引擎。', + 'type' => 'string', + 'example' => 'mongodb', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEngineVersion.Malformed', + 'errorMessage' => 'Specified engine version is not valid.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidEngine.Malformed', + 'errorMessage' => 'Specified engine is not valid.', + 'description' => '', + ], + ], + ], + 'title' => '查询实例默认的参数模板列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeParameterTemplatesResponse>\\n <ParameterCount>10</ParameterCount>\\n <EngineVersion>5.0</EngineVersion>\\n <Parameters>\\n <CheckingCode>[0-65536]</CheckingCode>\\n <ParameterName>net.compression.compressors</ParameterName>\\n <ParameterValue>100</ParameterValue>\\n <ForceModify>true</ForceModify>\\n <ForceRestart>false</ForceRestart>\\n <ParameterDescription>The threshold in milliseconds at which the database profiler considers a query slow, default is 100.</ParameterDescription>\\n </Parameters>\\n <RequestId>BDA54203-9D61-54A3-A568-D281F785****</RequestId>\\n <Engine>mongodb</Engine>\\n</DescribeParameterTemplatesResponse>","errorExample":""}]', + ], + 'DescribeParameters' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'> 当本参数传入的是分片集群实例ID时，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中的Mongos节点ID或Shard节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的角色类型，取值说明：'."\n" + ."\n" + .'- db：shard角色。'."\n" + .'- cs：config server角色。'."\n" + .'- mongos：mongos角色。', + 'type' => 'string', + 'required' => false, + 'example' => 'mongos', + ], + ], + [ + 'name' => 'ExtraParam', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'terrform', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RunningParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameter' => [ + 'description' => '当前运行的参数配置信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => '参数取值范围。', + 'type' => 'string', + 'example' => '[33554432-268435456]', + ], + 'ParameterName' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => 'setParameter.internalQueryExecMaxBlockingSortBytes', + ], + 'ParameterValue' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => '33554432', + ], + 'ForceRestart' => [ + 'description' => '修改参数后是否需要重启生效。'."\n" + .'- **false**：无需重启，提交后即生效。'."\n" + .'- **true**：需要重启生效。', + 'type' => 'string', + 'example' => 'false', + ], + 'ParameterDescription' => [ + 'description' => '参数描述。', + 'type' => 'string', + 'example' => 'The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)', + ], + 'ModifiableStatus' => [ + 'description' => '参数是否处于可修改的状态。'."\n" + .'- **false**：不可修改。'."\n" + .'- **true**：可修改。 ', + 'type' => 'string', + 'example' => 'true', + ], + 'CharacterType' => [ + 'description' => '实例的角色类型，取值说明：'."\n" + ."\n" + .'- **db**：shard角色。'."\n" + .'- **cs**：config server角色。'."\n" + .'- **mongos**：mongos角色。', + 'type' => 'string', + 'example' => 'db', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'EngineVersion' => [ + 'description' => '数据库版本号。', + 'type' => 'string', + 'example' => '4.0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8', + ], + 'ConfigParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameter' => [ + 'description' => '配置中的参数配置信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => '参数取值范围。', + 'type' => 'string', + 'example' => '[0-65536]', + ], + 'ParameterName' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => 'operationProfiling.slowOpThresholdMs', + ], + 'ParameterValue' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => '200', + ], + 'ForceRestart' => [ + 'description' => '修改参数后是否需要重启生效。'."\n" + .'- **false**：无需重启，提交后即生效。'."\n" + .'- **true**：需要重启生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParameterDescription' => [ + 'description' => '参数描述。', + 'type' => 'string', + 'example' => 'The threshold in milliseconds at which the database profiler considers a query slow, default is 100.', + ], + 'ModifiableStatus' => [ + 'description' => '参数是否处于可修改的状态。'."\n" + .'- **false**：不可修改。'."\n" + .'- **true**：可修改。 ', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'Engine' => [ + 'description' => '数据库引擎，默认返回**mongodb**。', + 'type' => 'string', + 'example' => 'mongodb', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '所选实例规格不存在，请重新选择。', + ], + ], + ], + 'title' => '查询实例的参数配置信息', + 'summary' => '查询MongoDB实例的参数配置信息。', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeParametersResponse>\\r\\n\\t<ConfigParameters>\\r\\n\\t\\t<Parameter>\\r\\n\\t\\t\\t<ParameterDescription>The threshold in milliseconds at which the database profiler considers a query slow, default is 100.</ParameterDescription>\\r\\n\\t\\t\\t<ParameterValue>200</ParameterValue>\\r\\n\\t\\t\\t<CheckingCode>[0-65536]</CheckingCode>\\r\\n\\t\\t\\t<ForceRestart>false</ForceRestart>\\r\\n\\t\\t\\t<ModifiableStatus>true</ModifiableStatus>\\r\\n\\t\\t\\t<ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>\\r\\n\\t\\t</Parameter>\\r\\n\\t</ConfigParameters>\\r\\n\\t<RequestId>3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8</RequestId>\\r\\n\\t<RunningParameters>\\r\\n\\t\\t<Parameter>\\r\\n\\t\\t\\t<ParameterDescription></ParameterDescription>\\r\\n\\t\\t\\t<ParameterValue>zlib</ParameterValue>\\r\\n\\t\\t\\t<CheckingCode>snappy|zlib|disabled</CheckingCode>\\r\\n\\t\\t\\t<ForceRestart>true</ForceRestart>\\r\\n\\t\\t\\t<ModifiableStatus>true</ModifiableStatus>\\r\\n\\t\\t\\t<ParameterName>net.compression.compressors</ParameterName>\\r\\n\\t\\t</Parameter>\\r\\n\\t\\t<Parameter>\\r\\n\\t\\t\\t<ParameterDescription>The level of database profiling, which inserts information about operation performance into the system.profile collection. \'off\' for no profiling, \'slowOp\' for only includes slow operations, \'all\' for includes all operations, default is \'slowOp\'.</ParameterDescription>\\r\\n\\t\\t\\t<ParameterValue>slowOp</ParameterValue>\\r\\n\\t\\t\\t<CheckingCode>off|slowOp|all</CheckingCode>\\r\\n\\t\\t\\t<ForceRestart>false</ForceRestart>\\r\\n\\t\\t\\t<ModifiableStatus>true</ModifiableStatus>\\r\\n\\t\\t\\t<ParameterName>operationProfiling.mode</ParameterName>\\r\\n\\t\\t</Parameter>\\r\\n\\t\\t<Parameter>\\r\\n\\t\\t\\t<ParameterDescription>The threshold in milliseconds at which the database profiler considers a query slow, default is 100.</ParameterDescription>\\r\\n\\t\\t\\t<ParameterValue>220</ParameterValue>\\r\\n\\t\\t\\t<CheckingCode>[0-65536]</CheckingCode>\\r\\n\\t\\t\\t<ForceRestart>false</ForceRestart>\\r\\n\\t\\t\\t<ModifiableStatus>true</ModifiableStatus>\\r\\n\\t\\t\\t<ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>\\r\\n\\t\\t</Parameter>\\r\\n\\t\\t<Parameter>\\r\\n\\t\\t\\t<ParameterDescription>The expiration threshold in milliseconds for idle cursors before MongoDB removes them; i.e. MongoDB removes cursors that have been idle for the specified cursorTimeoutMillis. default is 600000(i.e. 10 minutes)</ParameterDescription>\\r\\n\\t\\t\\t<ParameterValue>600000</ParameterValue>\\r\\n\\t\\t\\t<CheckingCode>[1-2147483647]</CheckingCode>\\r\\n\\t\\t\\t<ForceRestart>false</ForceRestart>\\r\\n\\t\\t\\t<ModifiableStatus>true</ModifiableStatus>\\r\\n\\t\\t\\t<ParameterName>setParameter.cursorTimeoutMillis</ParameterName>\\r\\n\\t\\t</Parameter>\\r\\n\\t\\t<Parameter>\\r\\n\\t\\t\\t<ParameterDescription>The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)</ParameterDescription>\\r\\n\\t\\t\\t<ParameterValue>33554432</ParameterValue>\\r\\n\\t\\t\\t<CheckingCode>[33554432-268435456]</CheckingCode>\\r\\n\\t\\t\\t<ForceRestart>false</ForceRestart>\\r\\n\\t\\t\\t<ModifiableStatus>true</ModifiableStatus>\\r\\n\\t\\t\\t<ParameterName>setParameter.internalQueryExecMaxBlockingSortBytes</ParameterName>\\r\\n\\t\\t</Parameter>\\r\\n\\t</RunningParameters>\\r\\n\\t<EngineVersion>4.0</EngineVersion>\\r\\n\\t<Engine>mongodb</Engine>\\r\\n</DescribeParametersResponse>","errorExample":""}]', + ], + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型，取值说明：'."\n" + .'- **BUY**：创建实例。'."\n" + .'- **UPGRADE**：变更配置。'."\n" + .'- **RENEW**：续费实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'BUY', + 'enum' => [ + 'BUY', + 'UPGRADE', + 'RENEW', + 'DOWNGRADE', + ], + ], + ], + [ + 'name' => 'DBInstances', + 'in' => 'query', + 'schema' => [ + 'description' => '包含实例中多个信息的JSON格式字符串。参数说明以及更多JSON格式示例，请参见[DescribePrice接口DBInstances参数说明](~~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" } ]', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '集群代码，取值说明：'."\n" + .'- **dds**：副本集版按量付费。'."\n" + .'- **badds**: 副本集版包年包月。'."\n" + .'- **dds_sharding**: 分片集群版按量付费。'."\n" + .'- **badds_sharding**： 分片集群版包年包月。'."\n" + .'- **badds_sharding_intl**： 分片集群版包年包月（国际站）。'."\n" + .'- **dds_sharding_intl**： 分片集群版按量付费（国际站）。'."\n" + .'- **badds_sharding_jp**： 分片集群版包年包月（日本站）。'."\n" + .'- **badds_intl**： 副本集版包年包月（国际站）。'."\n" + .'- **dds_intl**： 副本集版按量付费（国际站）。', + 'type' => 'string', + 'required' => false, + 'example' => 'badds', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码，默认为**dds**。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds', + 'default' => 'dds', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"AccountPassword":"Pw123456","DBInstanceDescription":"test"}', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'OrderParamOut', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回订单参数，取值说明：'."\n" + .'- **false**（默认值）：不返回。'."\n" + .'- **true**：返回。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + 'enum' => [ + 'false', + 'true', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。资源组详情请参见[查看资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '订单信息列表。', + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'description' => ' '."\n" + .'订单信息列表。', + 'type' => 'object', + 'properties' => [ + 'Coupons' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Coupon' => [ + 'description' => '优惠券信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '订单优惠券信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => 'ceshi', + ], + 'IsSelected' => [ + 'description' => '是否选中该优惠券，取值说明：'."\n" + .'- **true**：选中优惠券。'."\n" + .'- **false**：不选中优惠券。'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'CouponNo' => [ + 'description' => '优惠券编码。', + 'type' => 'string', + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + 'Name' => [ + 'description' => '优惠券名称。', + 'type' => 'string', + 'example' => 'youhuiquan111', + ], + 'PromotionRuleIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromotionRuleId' => [ + 'description' => '优惠券对应的规则ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠券对应的规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18772041****', + ], + ], + ], + 'description' => '', + ], + 'PromotionOptionCode' => [ + 'description' => '促销信息，促销选项代码。', + 'type' => 'string', + 'example' => 'youhui_quan', + ], + 'OptionCode' => [ + 'description' => '优惠券代号。', + 'type' => 'string', + 'example' => 'youhui_quan', + ], + 'ActivityCategory' => [ + 'description' => '优惠券的活动类型，取值说明：'."\n" + ."\n" + .'- **payondemand**：预付费。'."\n" + .'- **payasyougo**：后付费。', + 'type' => 'string', + 'example' => 'payondemand', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'OriginalAmount' => [ + 'description' => '订单原价。', + 'type' => 'string', + 'example' => '322.4', + ], + 'DiscountAmount' => [ + 'description' => '订单优惠金额。', + 'type' => 'string', + 'example' => '322.4', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => '订单规则信息。', + 'type' => 'array', + 'items' => [ + 'description' => '活动规则ID合集。', + 'type' => 'string', + 'example' => '{ "RuleId": [ 2075**** ] }', + ], + ], + ], + 'description' => '', + ], + 'TradeAmount' => [ + 'description' => '订单实际交易价。', + 'type' => 'string', + 'example' => '0', + ], + 'Currency' => [ + 'description' => '币种。', + 'type' => 'string', + 'example' => 'USD', + ], + 'ShowDiscountInfo' => [ + 'description' => '是否展示折扣信息。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OptionalPromotions' => [ + 'description' => '优惠活动信息列表。', + '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\\":[]}]"', + ], + 'PromDetailList' => [ + 'description' => '命中的优惠活动。', + 'type' => 'string', + 'example' => '[{\\"finalPromFee\\":90xxx,\\"optionCode\\":\\"wanhua_activity\\",\\"promType\\":\\"discount\\",\\"promotionId\\":2091xxxx,\\"promotionName\\":\\"新用户购买云数据库 MongoDB 副本集1年享*折优惠，限1台\\"}]"', + ], + 'DepreciateInfo' => [ + 'description' => '降价信息。', + 'type' => 'object', + 'properties' => [ + 'ListPrice' => [ + 'description' => '目录价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1*', + ], + 'OriginalStandAmount' => [ + 'description' => '原始官网总价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '12*', + ], + 'CheapStandAmount' => [ + 'description' => '降价后官网总价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9*', + ], + 'CheapRate' => [ + 'description' => '降价比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '30%', + ], + 'Differential' => [ + 'description' => '差价优惠（订单总价展示）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + ], + 'DifferentialName' => [ + 'description' => '差价优惠名称。', + 'type' => 'string', + 'example' => 'XXXXX', + ], + 'MonthPrice' => [ + 'description' => '折合月价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsShow' => [ + 'description' => '是否展示降价幅度。', + 'type' => 'string', + 'example' => 'true', + ], + 'ContractActivity' => [ + 'description' => '合同优惠。', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => '优惠总费用。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3621.6', + ], + 'FinalFee' => [ + 'description' => '优惠后费用。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20522.4', + ], + 'ProdFee' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '24144.0', + ], + 'ActivityId' => [ + 'description' => '活动id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41120065996xxxxx', + ], + 'OptionCode' => [ + 'description' => '优惠id。', + 'type' => 'string', + 'example' => 'wanhua_activity', + ], + 'ActivityName' => [ + 'description' => '活动名称。', + 'type' => 'string', + 'example' => '合同优惠_整单_xxx折', + ], + 'OptionIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OptionId' => [ + 'description' => '优惠id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200000614xxxx', + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'StandDiscountPrice' => [ + 'description' => '折扣价格。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'StandPrice' => [ + 'description' => '折扣价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Code' => [ + 'description' => '订单码', + 'type' => 'string', + 'example' => '""', + ], + 'Message' => [ + 'description' => '订单信息', + 'type' => 'string', + 'example' => '""', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TotalCostAmount' => [ + 'description' => '订单聚合价格', + 'type' => 'number', + 'format' => 'double', + 'example' => '483.14', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '27227A3D-6B86-56F3-9E03-9E60F001CE12', + ], + 'SubOrders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubOrder' => [ + 'description' => '优惠券对应的规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠券规则信息。', + 'type' => 'object', + 'properties' => [ + 'OriginalAmount' => [ + 'description' => '订单原价。', + 'type' => 'string', + 'example' => '322.4', + ], + 'DiscountAmount' => [ + 'description' => '订单优惠金额。', + 'type' => 'string', + 'example' => '322.4', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => '活动规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '活动规则ID合集。', + 'type' => 'string', + 'example' => '{ "RuleId": [ 2075**** ] }', + ], + ], + ], + 'description' => '', + ], + 'TradeAmount' => [ + 'description' => '订单实际交易价格。', + 'type' => 'string', + 'example' => '0', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp1b6e54e7cc****', + ], + 'DepreciateInfo' => [ + 'description' => '降价信息。', + 'type' => 'object', + 'properties' => [ + 'ListPrice' => [ + 'description' => '目录价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1*', + ], + 'OriginalStandAmount' => [ + 'description' => '原始官网总价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '12*', + ], + 'CheapStandAmount' => [ + 'description' => '降价后官网总价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9*', + ], + 'CheapRate' => [ + 'description' => '降价比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '30%', + ], + 'Differential' => [ + 'description' => '差价优惠（订单总价展示）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + ], + 'DifferentialName' => [ + 'description' => '差价优惠名称。', + 'type' => 'string', + 'example' => 'XXXXX', + ], + 'MonthPrice' => [ + 'description' => '折合月价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsShow' => [ + 'description' => '是否展示降价幅度。', + 'type' => 'string', + 'example' => 'true', + ], + 'ContractActivity' => [ + 'description' => '活动信息。', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => '优惠总费用。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3621.6', + ], + 'FinalFee' => [ + 'description' => '优惠后费用。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20522.4', + ], + 'ProdFee' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '24144.0', + ], + 'ActivityId' => [ + 'description' => '活动ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41120065996xxxxx'."\n", + ], + 'OptionCode' => [ + 'description' => '优惠ID。', + 'type' => 'string', + 'example' => 'wanhua_activity', + ], + 'ActivityName' => [ + 'description' => '活动名称。', + 'type' => 'string', + 'example' => '合同优惠_整单_xxx折', + ], + 'OptionIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OptionId' => [ + 'description' => '优惠ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2388xxxx', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'StartTime' => [ + 'description' => '活动开始时间。', + 'type' => 'string', + 'example' => '2024-02-29 10:30:00', + ], + ], + ], + 'IsNewOfficialActivity' => [ + 'description' => '命中降价优惠。', + 'type' => 'string', + 'example' => '命中降价优惠。', + ], + 'ModuleInstance' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModuleInstance' => [ + 'description' => '订单行实例配置。', + 'type' => 'array', + 'items' => [ + 'description' => '订单行实例配置子对象。', + 'type' => 'object', + 'properties' => [ + 'CycleFee' => [ + 'description' => '模块的周期费。', + 'type' => 'string', + 'example' => '0.0', + ], + 'PromDetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromDetail' => [ + 'description' => '优惠明细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠信息。', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'ActivityExtInfo' => [ + 'description' => '优惠详情额外信息。', + 'type' => 'object', + 'example' => '{'."\n" + .' "activityId": "1512010241743170"'."\n" + .'}', + ], + 'OptionCode' => [ + 'description' => '优惠券商品Code。', + 'type' => 'string', + 'example' => 'wanhua_activity', + ], + 'PromType' => [ + 'description' => '优惠子类型。', + 'type' => 'string', + 'example' => 'discount', + ], + 'PromotionId' => [ + 'description' => '优惠活动ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8105187xxxx', + ], + 'PromotionName' => [ + 'description' => '促销活动名称。', + 'type' => 'string', + 'example' => '【xxxx-x月降价项目】MongoDB全规格--xxxxx', + ], + 'PromotionCode' => [ + 'description' => '优惠码。', + 'type' => 'string', + 'example' => 'aliwood-xxx', + ], + 'DerivedPromType' => [ + 'description' => '优惠子类型。', + 'type' => 'string', + 'example' => 'subPrice', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'DepreciateInfo' => [ + 'description' => '活动信息。', + 'type' => 'object', + 'properties' => [ + 'ListPrice' => [ + 'description' => '目录价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1*', + ], + 'OriginalStandAmount' => [ + 'description' => '原始官网总价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '12*', + ], + 'CheapStandAmount' => [ + 'description' => '降价后官网总价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9*', + ], + 'CheapRate' => [ + 'description' => '降价比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '30%', + ], + 'Differential' => [ + 'description' => '差价优惠（订单总价展示）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + ], + 'DifferentialName' => [ + 'description' => '差价优惠名称。', + 'type' => 'string', + 'example' => 'XXXXX', + ], + 'MonthPrice' => [ + 'description' => '折合月价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '**', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsShow' => [ + 'description' => '是否展示降价幅度。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'DiscountFee' => [ + 'description' => '折扣费用。', + 'type' => 'string', + 'example' => '0.0', + ], + 'ModuleAttrs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'moduleAttr' => [ + 'description' => '模块属性。', + 'type' => 'array', + 'items' => [ + 'description' => '订购参数。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '属性代码。', + 'type' => 'string', + 'example' => 'dds_dbtype', + ], + 'Name' => [ + 'description' => '属性名称。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + 'Type' => [ + 'description' => '属性类型。', + 'type' => 'string', + 'example' => '3', + ], + 'Value' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'ModuleCode' => [ + 'description' => '模块code。', + 'type' => 'string', + 'example' => 'dds_dbtype', + ], + 'ModuleId' => [ + 'description' => '模块Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1017110000415xxx', + ], + 'ModuleName' => [ + 'description' => '模块名称。', + 'type' => 'string', + 'example' => '数据库类型', + ], + 'NeedOrderPay' => [ + 'description' => '在订单中是否需要支付。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PayFee' => [ + 'description' => '实付金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'PricingModule' => [ + 'description' => '是否计价项', + 'type' => 'boolean', + 'example' => 'false', + ], + 'StandPrice' => [ + 'description' => '折扣价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'TotalProductFee' => [ + 'description' => '产品原价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'ContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'StandDiscountPrice' => [ + 'description' => '优惠价格。', + 'type' => 'number', + 'format' => 'double', + 'example' => '451.00', + ], + 'priceUnit' => [ + 'description' => '价格单位。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'priceType' => [ + 'description' => '价格类型。', + 'type' => 'string', + 'example' => 'monthPrice', + ], + 'UnitPriceUnit4Buy' => [ + 'description' => '价格单位。', + 'type' => 'string', + 'example' => 'CNY/Hour', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'ContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OptionalPromotions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OptionalPromotion' => [ + 'description' => '可选择的优惠选项列表结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActivityCategory' => [ + 'description' => '活动类型。', + 'type' => 'string', + 'example' => 'discount', + ], + 'ActivityExtInfo' => [ + 'description' => '活动额外信息。', + 'type' => 'object', + 'example' => '{'."\n" + .' "activityId": "1512010241743170"'."\n" + .'}', + ], + 'CanPromFee' => [ + 'description' => '可优惠价格', + 'type' => 'number', + 'format' => 'double', + 'example' => '4560789', + ], + 'OptionCode' => [ + 'description' => '优惠类型。', + 'type' => 'string', + 'example' => 'wanhua_activity', + ], + 'PromotionName' => [ + 'description' => '优惠名称。', + 'type' => 'string', + 'example' => '【xxx月降价项目】MongoDB全规格--xxx', + ], + 'PromotionOptionNo' => [ + 'description' => '优惠号。', + 'type' => 'string', + 'example' => '1512010241xxxxx', + ], + 'Selected' => [ + 'description' => '是否外部选中。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Show' => [ + 'description' => '优惠是否展示。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TargetArticleItemCodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'targetArticleItemCode' => [ + 'description' => '目标商品规格code列表。', + 'type' => 'array', + 'items' => [ + 'description' => '目标商品规格code。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + 'description' => '', + ], + 'PromotionRuleIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'promotionRuleId' => [ + 'description' => '优惠id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠id。', + 'type' => 'string', + 'example' => '43289909', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'PromDetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromDetail' => [ + 'description' => '优惠明细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠信息。', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'ActivityExtInfo' => [ + 'description' => '活动额外信息。', + 'type' => 'object', + 'example' => '{'."\n" + .' "activityId": "1512010241743170"'."\n" + .'}', + ], + 'OptionCode' => [ + 'description' => '优惠券代号。', + 'type' => 'string', + 'example' => 'youhui_quan', + ], + 'PromType' => [ + 'description' => '优惠子类型。', + 'type' => 'string', + 'example' => 'discount', + ], + 'PromotionId' => [ + 'description' => '优惠ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '233xxxxx', + ], + 'PromotionName' => [ + 'description' => '优惠活动名称。', + 'type' => 'string', + 'example' => '【xxxx-x月降价项目】MongoDB全规格--xxxxx', + ], + 'PromotionCode' => [ + 'description' => '优惠码。', + 'type' => 'string', + 'example' => 'ali-wood', + ], + 'DerivedPromType' => [ + 'description' => '优惠子类型。', + 'type' => 'string', + 'example' => 'subPrice', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'StandDiscountPrice' => [ + 'description' => '折扣价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '8687', + ], + 'StandPrice' => [ + 'description' => '折扣价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '62982', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'TraceId' => [ + 'description' => '调用链ID。', + 'type' => 'string', + 'example' => '27227A3D-6B87-56F3-9E03-9E60F001****', + ], + 'OrderParams' => [ + 'description' => '订单参数。'."\n" + .'>仅当**OrderParamOut**参数传入**true**时，返回该参数。', + 'type' => 'string', + 'example' => '{\\"autoPay\\":false}"', + ], + 'Rules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Rule' => [ + 'description' => '活动规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '活动规则信息。', + 'type' => 'object', + 'properties' => [ + 'RuleDescId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2075****', + ], + 'Title' => [ + 'description' => '规则标题。', + 'type' => 'string', + 'example' => 'demo', + ], + 'Name' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'demoname', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + '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' => '查询费用', + 'summary' => '询价', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribePrice', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribePriceResponse>\\n <Order>\\n <Coupons>\\n <Description>ceshi</Description>\\n <IsSelected>true</IsSelected>\\n <CouponNo>youhuiquan_promotion_option_id_for_blank</CouponNo>\\n <Name>youhuiquan111</Name>\\n </Coupons>\\n <OriginalAmount>322.4</OriginalAmount>\\n <DiscountAmount>322.4</DiscountAmount>\\n <RuleIds>{ \\"RuleId\\": [ 2075**** ] }</RuleIds>\\n <TradeAmount>0</TradeAmount>\\n <Currency>USD</Currency>\\n </Order>\\n <RequestId>27227A3D-6B86-56F3-9E03-9E60F001CE12</RequestId>\\n <SubOrders>\\n <OriginalAmount>322.4</OriginalAmount>\\n <DiscountAmount>322.4</DiscountAmount>\\n <RuleIds>{ \\"RuleId\\": [ 2075**** ] }</RuleIds>\\n <TradeAmount>0</TradeAmount>\\n <InstanceId>dds-bp1b6e54e7cc****</InstanceId>\\n </SubOrders>\\n <TraceId>27227A3D-6B87-56F3-9E03-9E60F001****</TraceId>\\n <OrderParams>{\\\\\\"autoPay\\\\\\":false}\\"</OrderParams>\\n <Rules>\\n <Title>demo</Title>\\n <Name>demoname</Name>\\n </Rules>\\n</DescribePriceResponse>","errorExample":""}]', + ], + 'DescribeRdsVSwitchs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络（VPC）ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp*******************'."\n", + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm4ojaksxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60EEBD77-227C-5B39-86EA-D89163C5****', + ], + 'VSwitches' => [ + 'description' => 'VSwitch列表。', + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'description' => 'VSwith信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'VSwitch状态。**Available**表示可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'IsDefault' => [ + 'description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VSwitchId' => [ + 'description' => 'VSwitch ID。', + 'type' => 'string', + 'example' => 'vsw-bp*******************'."\n", + ], + 'CidrBlock' => [ + 'description' => 'VSwitch的网段。', + 'type' => 'string', + 'example' => '192.**.**.0/24'."\n", + ], + 'RegionNo' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'GmtCreate' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'AliUid' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'GmtModified' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'Bid' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'IzNo' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h'."\n", + ], + 'VSwitchName' => [ + 'description' => 'VSwitch名称。', + 'type' => 'string', + 'example' => 'vsw-name'."\n", + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '获取虚拟交换机列表', + 'summary' => '获取虚拟交换机（vSwitch）列表。', + 'description' => '您在新建云数据库 MongoDB 版实例时，可以通过该接口查询目标地域及可用区下可用的 vSwitch 信息。', + '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' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-l', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Vpcs' => [ + 'description' => 'VPC列表。', + 'type' => 'object', + 'properties' => [ + 'Vpc' => [ + 'description' => 'VPC信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'VPC状态。 **Available**表示可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VpcName' => [ + 'description' => 'VPC的名称。', + 'type' => 'string', + 'example' => 'vpc-name'."\n", + ], + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-bp*******************'."\n", + ], + 'IsDefault' => [ + 'description' => '是否是默认VPC。取值说明：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CidrBlock' => [ + 'description' => 'VPC的网段。', + 'type' => 'string', + 'example' => '10.**.**.0/8'."\n", + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou'."\n", + ], + 'GmtCreate' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'AliUid' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'VSwitchs' => [ + 'description' => 'VSwitch 列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'VSwitch状态。**Available**表示可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => 'VSwitch ID。', + 'type' => 'string', + 'example' => 'vsw-bp*******************'."\n", + ], + 'IsDefault' => [ + 'description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'CidrBlock' => [ + 'description' => 'VSwitch 的网段。', + 'type' => 'string', + 'example' => '10.**.**.0/24'."\n", + ], + 'GmtCreate' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null'."\n", + ], + 'GmtModified' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'IzNo' => [ + 'description' => 'VSwitch 所属的可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i'."\n", + ], + 'VSwitchName' => [ + 'description' => 'VSwitch 的名称。', + 'type' => 'string', + 'example' => 'vsw-name'."\n", + ], + ], + 'description' => '', + ], + ], + 'GmtModified' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null'."\n", + ], + 'Bid' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null'."\n", + ], + ], + 'description' => '', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '53924AF0-1628-5AA2-9C95-D4**********'."\n", + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '获取VPC列表', + 'summary' => '获取VPC列表。', + 'description' => '您在新建云数据库 MongoDB 版实例时，可以通过该接口查询目标地域及可用区下可用的 VPC 信息。', + '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' => '地域ID。'."\n" + .'>如果不填写，默认查询所有支持的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回参数**RegionName**和**ZoneName**的语言，取值说明：'."\n" + .'- **zh**：默认值，中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '地域和可用区列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4E46C22C-D3B7-4DB8-9C76-63851BE68E20', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DdsRegion' => [ + 'description' => '地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地域列表。', + 'type' => 'object', + 'properties' => [ + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区列表。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'VpcEnabled' => [ + 'description' => '是否支持VPC，取值说明：'."\n" + ."\n" + .'- **true**：支持VPC。'."\n" + .'- **false**：不支持VPC。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ZoneName' => [ + 'description' => '可用区名称。'."\n" + ."\n" + .'根据**AcceptLanguage**参数的值返回不同的语言。以**cn-hangzhou-h**可用区为例，示例如下：'."\n" + ."\n" + .'- **AcceptLanguage**为**zh**：**杭州 可用区H**'."\n" + .'- **AcceptLanguage**为**en**：**Hangzhou Zone H**', + 'type' => 'string', + 'example' => '杭州 可用区H', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionName' => [ + 'description' => '地域名称。'."\n" + ."\n" + .'根据**AcceptLanguage**参数的值返回不同的语言。以**cn-hangzhou**地域为例，示例如下：'."\n" + ."\n" + .'- **AcceptLanguage**为**zh**：**华东1（杭州）**'."\n" + .'- **AcceptLanguage**为**en**：**China (Hangzhou)**', + 'type' => 'string', + 'example' => '华东1（杭州）', + ], + 'EndPoint' => [ + 'description' => '公网接入地址。'."\n" + ."\n" + .'返回对应地域的公网接入地址，以cn-hangzhou地域为例，示例如下：'."\n" + ."\n" + .'- mongodb.aliyuncs.com', + 'type' => 'string', + 'example' => 'mongodb.aliyuncs.com', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'title' => '查询可以使用的阿里云地域', + 'summary' => '查看MongoDB实例支持的所有地域和可用区。', + 'description' => '> 如需查询创建实例可用的地域和可用区信息，请调用[DescribeAvailableResource](~~149719~~)查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>4E46C22C-D3B7-4DB8-9C76-63851BE68E20</RequestId>\\n <Regions>\\n <Zones>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneName>杭州 可用区H</ZoneName>\\n </Zones>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionName>华东1（杭州）</RegionName>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', + ], + 'DescribeRenewalPrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '订单信息列表。', + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'description' => '订单信息列表。', + 'type' => 'object', + 'properties' => [ + 'Coupons' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Coupon' => [ + 'description' => '优惠券信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠券信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'coupondemo', + ], + 'IsSelected' => [ + 'description' => '是否选中该优惠券。', + 'type' => 'string', + 'example' => 'true', + ], + 'CouponNo' => [ + 'description' => '优惠券编码。', + 'type' => 'string', + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + 'Name' => [ + 'description' => '优惠券名称。', + 'type' => 'string', + 'example' => 'youhuiquan111', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'OriginalAmount' => [ + 'description' => '订单原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1144.8', + ], + 'DiscountAmount' => [ + 'description' => '订单优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1144.8', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => '订单交易信息。', + 'type' => 'array', + 'items' => [ + 'description' => '命中的策略ID集合。', + 'type' => 'string', + 'example' => '11111111', + ], + ], + ], + 'description' => '', + ], + 'TradeAmount' => [ + 'description' => '订单实际交易价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Currency' => [ + 'description' => '币种。'."\n", + 'type' => 'string', + 'example' => 'USD', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EFD65226-08CC-4C4D-B6A4-CB3C382F67B0', + ], + 'SubOrders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubOrder' => [ + 'description' => '优惠券对应的策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '订单信息。', + 'type' => 'object', + 'properties' => [ + 'OriginalAmount' => [ + 'description' => '订单原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1144.8', + ], + 'DiscountAmount' => [ + 'description' => '订单优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1144.8', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => '订单交易信息。', + 'type' => 'array', + 'items' => [ + 'description' => '命中策略ID信息。', + 'type' => 'string', + 'example' => '{"RuleId": [11111111,11111111,11111111]}', + ], + ], + ], + 'description' => '', + ], + 'TradeAmount' => [ + 'description' => '订单实际交易价格。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp12c5b040dc****', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'Rules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Rule' => [ + 'description' => '活动规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '订单信息。', + 'type' => 'object', + 'properties' => [ + 'RuleDescId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11111111', + ], + 'Title' => [ + 'description' => '策略标题。', + 'type' => 'string', + 'example' => 'demo', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'demoname', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'DBInstanceId is mandatory for this action.', + 'description' => '', + ], + ], + ], + 'title' => '查询实例续费一个月的价格', + 'summary' => '查询指定MongoDB实例续费一个月的价格。', + 'description' => '本接口适用于包年包月付费的MongoDB实例。', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeRenewalPriceResponse>\\n <Order>\\n <Coupons>\\n <Description>coupondemo</Description>\\n <IsSelected>true</IsSelected>\\n <CouponNo>youhuiquan_promotion_option_id_for_blank</CouponNo>\\n <Name>youhuiquan111</Name>\\n </Coupons>\\n <OriginalAmount>1144.8</OriginalAmount>\\n <DiscountAmount>1144.8</DiscountAmount>\\n <RuleIds>11111111</RuleIds>\\n <TradeAmount>0</TradeAmount>\\n <Currency>USD</Currency>\\n </Order>\\n <RequestId>EFD65226-08CC-4C4D-B6A4-CB3C382F67B0</RequestId>\\n <SubOrders>\\n <OriginalAmount>1144.8</OriginalAmount>\\n <DiscountAmount>1144.8</DiscountAmount>\\n <RuleIds>{\\"RuleId\\": [11111111,11111111,11111111]}</RuleIds>\\n <TradeAmount>0</TradeAmount>\\n <InstanceId>dds-bp12c5b040dc****</InstanceId>\\n </SubOrders>\\n <Rules>\\n <RuleDescId>11111111</RuleDescId>\\n <Title>demo</Title>\\n <Name>demoname</Name>\\n </Rules>\\n</DescribeRenewalPriceResponse>","errorExample":""}]', + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DB4A0595-FCA9-437F-B2BB-25DBFC009D3E', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxx', + ], + 'ReplicaSets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReplicaSet' => [ + 'description' => '副本集角色信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionPort' => [ + 'description' => '节点的连接端口。', + 'type' => 'string', + 'example' => '3717', + ], + 'ReplicaSetRole' => [ + 'description' => '该节点在副本集中的角色。'."\n" + .'- **Primary**：主节点。'."\n" + .'- **Secondary**：从节点。', + 'type' => 'string', + 'example' => 'Primary', + ], + 'ExpiredTime' => [ + 'description' => '保留的经典网络地址剩余时长，单位为秒。', + 'type' => 'string', + 'example' => '1209582', + ], + 'ConnectionDomain' => [ + 'description' => '节点的连接地址。', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + ], + 'NetworkType' => [ + 'description' => '网络类型。'."\n" + .'- **VPC**：专有网络。'."\n" + .'- **Classic**：经典网络。'."\n" + .'- **Public**：公网。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'RoleId' => [ + 'description' => '节点的角色ID。', + 'type' => 'string', + 'example' => '651xxxxx', + ], + 'ConnectionType' => [ + 'description' => '连接类型。', + 'type' => 'string', + 'example' => 'SRV', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + 'description' => '用户未授权标签鉴权。', + ], + ], + ], + 'title' => '查询实例中的角色信息及连接信息', + 'summary' => '查询MongoDB实例中的角色信息及连接信息。', + 'description' => '本接口适用于副本集实例和单节点实例，不适用于分片集群实例。', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeReplicaSetRoleResponse>\\r\\n\\t<RequestId>7762D0FF-F34D-4DAF-9D06-6C1C28CC98CD</RequestId>\\r\\n\\t<DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>\\r\\n\\t<ReplicaSets>\\r\\n\\t\\t<ReplicaSet>\\r\\n\\t\\t\\t<NetworkType>Classic</NetworkType>\\r\\n\\t\\t\\t<ConnectionPort>3717</ConnectionPort>\\r\\n\\t\\t\\t<ReplicaSetRole>Primary</ReplicaSetRole>\\r\\n\\t\\t\\t<ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>\\r\\n\\t\\t\\t<ExpiredTime>12xxxxx</ExpiredTime>\\r\\n\\t\\t\\t<RoleId>55xxxxx</RoleId>\\r\\n\\t\\t</ReplicaSet>\\r\\n\\t\\t<ReplicaSet>\\r\\n\\t\\t\\t<NetworkType>Classic</NetworkType>\\r\\n\\t\\t\\t<ConnectionPort>3717</ConnectionPort>\\r\\n\\t\\t\\t<ReplicaSetRole>Secondary</ReplicaSetRole>\\r\\n\\t\\t\\t<ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>\\r\\n\\t\\t\\t<ExpiredTime>12xxxxx</ExpiredTime>\\r\\n\\t\\t\\t<RoleId>55xxxxx</RoleId>\\r\\n\\t\\t</ReplicaSet>\\r\\n\\t\\t<ReplicaSet>\\r\\n\\t\\t\\t<NetworkType>VPC</NetworkType>\\r\\n\\t\\t\\t<ConnectionPort>3717</ConnectionPort>\\r\\n\\t\\t\\t<ReplicaSetRole>Primary</ReplicaSetRole>\\r\\n\\t\\t\\t<ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>\\r\\n\\t\\t\\t<RoleId>55xxxxx</RoleId>\\r\\n\\t\\t</ReplicaSet>\\r\\n\\t\\t<ReplicaSet>\\r\\n\\t\\t\\t<NetworkType>VPC</NetworkType>\\r\\n\\t\\t\\t<ConnectionPort>3717</ConnectionPort>\\r\\n\\t\\t\\t<ReplicaSetRole>Secondary</ReplicaSetRole>\\r\\n\\t\\t\\t<ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>\\r\\n\\t\\t\\t<RoleId>55xxxxx</RoleId>\\r\\n\\t\\t</ReplicaSet>\\r\\n\\t</ReplicaSets>\\r\\n</DescribeReplicaSetRoleResponse>","errorExample":""}]', + ], + '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' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + '5', + ], + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp114f14849d****', + ], + ], + [ + 'name' => 'CreationTimeAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '查找实例创建时间在该时间以后的实例，格式为<i>yyyy-MM-dd</i>T<i>HH:00:00</i>Z（UTC时间）。'."\n" + ."\n" + .'> '."\n" + .'> - 时间为整点时间'."\n" + .'> - 时间不能早于当前时间-7天。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-07-24T14:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询结果中实例的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => '实例信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息列表。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '实例创建的时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-01-02T07:43:59Z', + ], + 'LockMode' => [ + 'description' => '实例的锁定状态，取值说明：'."\n" + .'* **Unlock**：正常。'."\n" + .'* **ManualLock**：手动触发锁定。'."\n" + .'* **LockByExpiration**：实例过期自动锁定。'."\n" + .'* **LockByRestoration**：实例回滚前自动锁定。'."\n" + .'* **LockByDiskQuota**：实例空间满自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'EngineVersion' => [ + 'description' => '数据库版本号，取值：'."\n" + ."\n" + .'- **7.0**'."\n" + .'- **6.0**'."\n" + .'- **5.0**'."\n" + .'- **4.4**'."\n" + .'- **4.2**'."\n" + .'- **4.0**', + 'type' => 'string', + 'example' => '4.2', + ], + 'DBInstanceDescription' => [ + 'description' => '实例的描述或备注信息。', + 'type' => 'string', + 'example' => '测试数据库', + ], + 'DBInstanceType' => [ + 'description' => '实例类型，取值说明： '."\n" + .'- **sharding**：分片集群实例。'."\n" + .'- **replicate**：副本集实例。', + 'type' => 'string', + 'example' => 'replicate', + ], + 'DBInstanceStatus' => [ + 'description' => '实例状态，详情请参见[实例状态表](~~63870~~)。', + 'type' => 'string', + 'example' => 'Running', + ], + 'RegionId' => [ + 'description' => '实例所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'description' => '实例所属可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dds-bp12c5b040dc****', + ], + 'SecondaryZoneId' => [ + 'description' => '实现多可用区部署时，实例的备可用区1。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'HiddenZoneId' => [ + 'description' => '实现多可用区部署时，实例的备可用区2。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'IsDeleted' => [ + 'description' => '是否被删除：'."\n" + .'- 1：代表已被删除。'."\n" + .'- 0：代表未被删除。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter %s is not valid.', + 'description' => '参数 %s 非有效参数。', + ], + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '该实例不存在，原因可能是该实例已经释放，请刷新页面。', + ], + ], + ], + 'title' => '查询MongoDB实例的备份恢复实例', + 'summary' => '查询MongoDB实例7天以内的备份恢复实例列表。', + '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 \\"SecondaryZoneId\\": \\"cn-hangzhou-i\\",\\n \\"HiddenZoneId\\": \\"cn-hangzhou-h\\",\\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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-wz9760547de1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '69D55DEC-B219-569F-A686-AC2F67A1****', + ], + 'RoleTagStatus' => [ + 'description' => '副本集节点Tag状态，取值说明：'."\n" + .'- **true**：节点Tag已经创建。'."\n" + .'- **false**：节点Tag未创建。'."\n" + .'>当传入的实例为分片集群类型时，该参数将返回 false。', + 'type' => 'string', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'ShardRoleTagStatus' => [ + 'description' => '分片集群各节点Tag状态，取值说明：'."\n" + ."\n" + .'- **true**：节点Tag已经创建。'."\n" + .'- **false**：节点Tag未创建。', + 'type' => 'object', + 'example' => '{'."\n" + .' "d-2ze204b4db58****": "false",'."\n" + .' "d-2zeb9716646e***": "false"'."\n" + .'}', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询节点Tag是否已创建', + 'summary' => '查询节点Tag是否已创建', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '728B9A96-E262-4AE5-915E-3A51CCE2FDA9', + ], + 'ZoneInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ZoneInfo' => [ + 'description' => '节点在可用区中的分布信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InsName' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxx', + ], + 'NodeType' => [ + 'description' => '节点类型，返回值为：'."\n" + .'- **normal**：普通节点。'."\n" + .'- **configServer**：配置服务器节点。'."\n" + .'- **shard**：Shard节点。'."\n" + .'- **mongos**：Mongos节点。'."\n" + ."\n" + .'> 当实例类型为副本集实例时，返回值为**normal**；当实例类型为分片集群实例时，返回值中包含**configServer**、**shard**和**mongos**。', + 'type' => 'string', + 'example' => 'normal', + ], + 'RoleType' => [ + 'description' => '节点的角色，返回值为：'."\n" + .'- **Primary**：主节点。'."\n" + .'- **Secondary**：从节点。'."\n" + .'- **Hidden**：隐藏节点。', + 'type' => 'string', + 'example' => 'Primary', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-e', + ], + 'RoleId' => [ + 'description' => '角色ID。', + 'type' => 'string', + 'example' => '83xxxxx', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询实例的各节点的角色和所属的可用区', + 'summary' => '查询MongoDB实例的各节点的角色和所属的可用区。', + 'description' => '> 更多详情请参见[查看节点所属的可用区](~~123825~~)。'."\n" + ."\n" + .'本接口适用于副本集实例和分片集群实例，暂不支持单节点实例。', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeRoleZoneInfoResponse>\\r\\n\\t<ZoneInfos>\\r\\n\\t\\t<ZoneInfo>\\r\\n\\t\\t\\t<RoleType>Primary</RoleType>\\r\\n\\t\\t\\t<NodeType>normal</NodeType>\\r\\n\\t\\t\\t<InsName>dds-bpxxxxxxxx</InsName>\\r\\n\\t\\t\\t<ZoneId>cn-hangzhou-e</ZoneId>\\r\\n\\t\\t\\t<RoleId>83xxxxx</RoleId>\\r\\n\\t\\t</ZoneInfo>\\r\\n\\t\\t<ZoneInfo>\\r\\n\\t\\t\\t<RoleType>Secondary</RoleType>\\r\\n\\t\\t\\t<NodeType>normal</NodeType>\\r\\n\\t\\t\\t<InsName>dds-bpxxxxxxxx</InsName>\\r\\n\\t\\t\\t<ZoneId>cn-hangzhou-f</ZoneId>\\r\\n\\t\\t\\t<RoleId>83xxxxx</RoleId>\\r\\n\\t\\t</ZoneInfo>\\r\\n\\t\\t<ZoneInfo>\\r\\n\\t\\t\\t<RoleType>Hidden</RoleType>\\r\\n\\t\\t\\t<NodeType>normal</NodeType>\\r\\n\\t\\t\\t<InsName>dds-bpxxxxxxxx</InsName>\\r\\n\\t\\t\\t<ZoneId>cn-hangzhou-b</ZoneId>\\r\\n\\t\\t\\t<RoleId>83xxxxx</RoleId>\\r\\n\\t\\t</ZoneInfo>\\r\\n\\t</ZoneInfos>\\r\\n\\t<RequestId>728B9A96-E262-4AE5-915E-3A51CCE2FDA9</RequestId>\\r\\n</DescribeRoleZoneInfoResponse>","errorExample":""}]', + ], + 'DescribeRunningLogRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + .'> 当本参数传入的是分片集群实例ID时，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID或Shard节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => ' 查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-01T12:10Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => ' 查询结束时间，必须晚于查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。'."\n" + .'> 查询结束时间距查询开始时间不得超过24个小时，超过则调用失败。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-01T13:10Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodbtest', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例中节点的角色。取值：'."\n" + .'- **primary**：主节点。'."\n" + .'- **secondary**：从节点。'."\n" + ."\n" + .'> 当**NodeId**参数传入的是Mongos节点ID时，**RoleType**取值只能为**primary**。', + 'type' => 'string', + 'required' => false, + 'example' => 'primary', + 'default' => 'primary', + 'enum' => [ + 'primary', + 'secondary', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => ' 每页记录数，取值范围为**30**~**100**。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '按时间的升降序对查询到的运行日志进行排序。取值：'."\n" + .'- asc：按时间升序排序。'."\n" + .'- desc：按时间降序排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bpxxxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => [ + 'description' => '节点的角色ID。您可以通过[DescribeReplicaSetRole](~~62134~~)进行查询。', + 'type' => 'string', + 'required' => false, + 'example' => '651xxxxx', + ], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，多个关键字以空格分隔，不超过10个关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'test test2', + ], + ], + [ + 'name' => 'LogicalOperator', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字搜索的逻辑操作，'."\n" + .'默认值为and。', + 'type' => 'string', + 'required' => false, + 'example' => 'and', + 'default' => 'and', + 'enum' => [ + 'and', + 'or', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => ' 总记录数。 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageRecordCount' => [ + 'description' => '每页的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '45D2B592-DEBA-4347-BBF3-47FF6C97DBBC', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogRecords' => [ + 'description' => '运行日志明细列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnInfo' => [ + 'description' => '日志连接信息。', + 'type' => 'string', + 'example' => 'conn18xxxxxx', + ], + 'CreateTime' => [ + 'description' => '日志生成时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-02-26T12:09:34Z', + ], + 'Category' => [ + 'description' => '日志类别。', + 'type' => 'string', + 'example' => 'NETWORK', + ], + 'Content' => [ + 'description' => '日志信息。', + 'type' => 'string', + 'example' => ' end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\\n', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'Engine' => [ + 'description' => '当前数据库的引擎类型。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time', + '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' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'LogApiFrequencyExceeded', + 'errorMessage' => 'Exceeding the allowed frequency of log api.', + 'description' => '', + ], + ], + ], + 'title' => '查询实例的运行日志', + 'summary' => '查询MongoDB实例的运行日志。', + 'description' => '- 本接口适用于规格类型为**通用型本地盘版**和**独享型本地盘版**实例。'."\n" + .'- 本接口限制每分钟调用30次，如超过这个限制会被限流，请勿高频调用。如需高频调用，请使用Logstore，详情请参见[管理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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeRunningLogRecordsResponse>\\r\\n\\t<Items>\\r\\n\\t\\t<LogRecords>\\r\\n\\t\\t\\t<Category>-</Category>\\r\\n\\t\\t\\t<CreateTime>2019-02-26T12:09:34Z</CreateTime>\\r\\n\\t\\t\\t<ConnInfo>conn18xxxxxx</ConnInfo>\\r\\n\\t\\t\\t<Content>\\r\\n\\t\\t\\t\\tend connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\\r\\n\\t\\t\\t</Content>\\r\\n\\t\\t</LogRecords>\\r\\n\\t\\t<LogRecords>\\r\\n\\t\\t\\t<Category>NETWORK</Category>\\r\\n\\t\\t\\t<CreateTime>2019-02-26T12:09:34Z</CreateTime>\\r\\n\\t\\t\\t<ConnInfo>thread1</ConnInfo>\\r\\n\\t\\t\\t<Content>connection accepted from 11.xxx.xxx.xx:3xxxx #1862051 (11 connections now open)</Content>\\r\\n\\t\\t</LogRecords>\\r\\n\\t</Items>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<TotalRecordCount>2</TotalRecordCount>\\r\\n\\t<RequestId>45D2B592-DEBA-4347-BBF3-47FF6C97DBBC</RequestId>\\r\\n</DescribeRunningLogRecordsResponse>","errorExample":""}]', + ], + 'DescribeSecurityGroupConfiguration' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C4A2494-85C4-45C5-93CF-548DB3375193', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RdsEcsSecurityGroupRel' => [ + 'description' => 'ECS安全组信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => 'ECS安全组ID。', + 'type' => 'string', + 'example' => 'sg-bpxxxxxxxx', + ], + 'NetType' => [ + 'description' => 'ECS安全组的网络类型。返回值：'."\n" + .'- **vpc**：专有网络。'."\n" + .'- **classic**：经典网络。', + 'type' => 'string', + 'example' => 'vpc', + ], + 'RegionId' => [ + 'description' => 'ECS安全组所属的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询MongoDB实例绑定的ECS安全组信息', + 'summary' => '查询MongoDB实例绑定的ECS安全组信息。', + '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' => '查询MongoDB实例的IP白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'ShowHDMIps', + 'in' => 'query', + 'schema' => [ + 'description' => '是否展示DAS白名单信息。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '展示DAS白名单信息', + 'false' => '不展示DAS白名单信息', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityIps' => [ + 'description' => '默认分组中包含的IP白名单。', + 'type' => 'string', + 'example' => '47.xxx.xxx.xx,100.xxx.xxx.0/24', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FC724D23-2962-479E-ABB1-606C935AE7FD', + ], + 'SecurityIpGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecurityIpGroup' => [ + 'description' => 'IP白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityIpGroupName' => [ + 'description' => '分组名。', + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIpGroupAttribute' => [ + 'description' => 'IP白名单分组属性，默认为空。', + 'type' => 'string', + 'example' => ' hidden', + ], + 'SecurityIpList' => [ + 'description' => '分组中包含的IP白名单列表。', + 'type' => 'string', + 'example' => '47.xxx.xxx.xx,100.xxx.xxx.0/24', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBInstance.Malformed', + 'errorMessage' => 'Too many instance ids or instance id format is invalid.', + 'description' => '', + ], + ], + ], + 'title' => '查询MongoDB实例的IP白名单', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeSecurityIpsResponse>\\r\\n\\t<SecurityIpGroups>\\r\\n\\t\\t<SecurityIpGroup>\\r\\n\\t\\t\\t<SecurityIpList>114.xxx.xxx.xx</SecurityIpList>\\r\\n\\t\\t\\t<SecurityIpGroupAttribute></SecurityIpGroupAttribute>\\r\\n\\t\\t\\t<SecurityIpGroupName>allowserver</SecurityIpGroupName>\\r\\n\\t\\t</SecurityIpGroup>\\r\\n\\t\\t<SecurityIpGroup>\\r\\n\\t\\t\\t<SecurityIpList>47.xxx.xxx.xx,100.xxx.xxx.0/24</SecurityIpList>\\r\\n\\t\\t\\t<SecurityIpGroupAttribute></SecurityIpGroupAttribute>\\r\\n\\t\\t\\t<SecurityIpGroupName>default</SecurityIpGroupName>\\r\\n\\t\\t</SecurityIpGroup>\\r\\n\\t</SecurityIpGroups>\\r\\n\\t<SecurityIps>47.xxx.xxx.xx,100.xxx.xxx.0/24</SecurityIps>\\r\\n\\t<RequestId>FC724D23-2962-479E-ABB1-606C935AE7FD</RequestId>\\r\\n</DescribeSecurityIpsResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + ], + 'DescribeShardingNetworkAddress' => [ + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID、Shard节点ID或ConfigServer节点ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询Mongos/Shard/ConfigServer节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络类型，取值：'."\n" + .'- **VPC**：专有网络。'."\n" + .'- **Classic**：经典网络。'."\n" + .'- **Public**：公网。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CompatibleConnections' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CompatibleConnection' => [ + 'description' => 'DynamoDB协议类型实例的连接地址信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VswitchId' => [ + 'description' => '专有网络中交换机ID。'."\n" + ."\n" + .'> 当网络类型为**VPC**时返回该参数。', + 'type' => 'string', + 'example' => 'vsw-bpxxxxxxxx', + ], + 'ExpiredTime' => [ + 'description' => '保留的经典网络地址剩余时长，单位为秒。', + 'type' => 'string', + 'example' => '2591963', + ], + 'NetworkType' => [ + 'description' => '网络类型。'."\n" + .'- **VPC**：专有网络。'."\n" + .'- **Classic**：经典网络。'."\n" + .'- **Public**：公网。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => '连接端口。', + 'type' => 'string', + 'example' => '3717', + ], + 'NetworkAddress' => [ + 'description' => '连接地址。', + 'type' => 'string', + 'example' => 'dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com', + ], + 'VPCId' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'> 当网络类型为**VPC**时返回该参数。', + 'type' => 'string', + 'example' => 'vpc-bpxxxxxxxx', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '10.140.xxx.xx', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '18D8AAFD-6BEB-420F-8164-810CB0C0AA39', + ], + 'NetworkAddresses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NetworkAddress' => [ + 'description' => 'MongoDB协议类型实例的连接地址信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'description' => '节点类型，返回值为'."\n" + .'- **mongos**：mongos节点。'."\n" + .'- **shard**：shard节点。'."\n" + .'- **configserver**：configserver节点。', + 'type' => 'string', + 'example' => 'mongos', + ], + 'VswitchId' => [ + 'description' => '专有网络中交换机ID。'."\n" + ."\n" + .'> 当网络类型为**VPC**时返回该参数。', + 'type' => 'string', + 'example' => 'vsw-bpxxxxxxxx', + ], + 'ExpiredTime' => [ + 'description' => '保留的经典网络地址剩余时长，单位为秒。', + 'type' => 'string', + 'example' => '2591963', + ], + 'NetworkType' => [ + 'description' => '网络类型。'."\n" + .'- **VPC**：专有网络。'."\n" + .'- **Classic**：经典网络。'."\n" + .'- **Public**：公网。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'Role' => [ + 'description' => '节点角色，返回值：'."\n" + .'- Primary：主节点。'."\n" + .'- Secondary：从节点。', + 'type' => 'string', + 'example' => 'Primary', + ], + 'Port' => [ + 'description' => '连接端口。', + 'type' => 'string', + 'example' => '3717', + ], + 'VPCId' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'> 当网络类型为**VPC**时返回该参数。', + 'type' => 'string', + 'example' => 'vpc-bpxxxxxxxx', + ], + 'NetworkAddress' => [ + 'description' => '连接地址（字符串）。', + 'type' => 'string', + 'example' => 's-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + ], + 'NodeId' => [ + 'description' => 'Mongos节点ID。', + 'type' => 'string', + 'example' => 's-bpxxxxxxxx', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '10.140.xxx.xx', + ], + 'ConnectionType' => [ + 'description' => '公网地址类型，可选值：'."\n" + .'- **SRV**'."\n" + .'- **Normal**', + 'type' => 'string', + 'example' => 'SRV', + ], + 'TxtRecord' => [ + 'description' => 'TXT 记录，用来存储 MongoDB 相关的元信息，如版本信息、配置参数等，可结合 SRV 记录等其他技术实现复杂的服务发现和配置传递等功能。', + 'type' => 'string', + 'example' => 'mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询MongoDB分片集群实例的连接信息', + 'summary' => '查询MongoDB分片集群实例的连接信息。', + 'description' => '该接口仅支持分片集群实例。', + '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}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<NetworkAddresses>\\n <NetworkAddress>\\n <NetworkType>Public</NetworkType>\\n <NodeId>s-bpxxxxxxxx</NodeId>\\n <Port>3717</Port>\\n <VPCId/>\\n <IPAddress>47.xx.xx.xxx</IPAddress>\\n <NodeType>mongos</NodeType>\\n <Role>Primary</Role>\\n <NetworkAddress>s-bpxxxxxxxx-pub.mongodb.rds.aliyuncs.com</NetworkAddress>\\n </NetworkAddress>\\n <NetworkAddress>\\n <NetworkType>VPC</NetworkType>\\n <NodeId>s-bpxxxxxxxx</NodeId>\\n <Port>3717</Port>\\n <VPCId>vpc-bpxxxxxxxx</VPCId>\\n <IPAddress>192.168.xx.xxx</IPAddress>\\n <NodeType>mongos</NodeType>\\n <Role>Primary</Role>\\n <VswitchId>vsw-bpxxxxxxxx</VswitchId>\\n <NetworkAddress>s-bpxxxxxxxx.mongodb.rds.aliyuncs.com</NetworkAddress>\\n </NetworkAddress>\\n</NetworkAddresses>\\n<RequestId>3F5DD5CD-0B93-46FF-96DD-F938B13CDE8B</RequestId>","errorExample":""}]', + ], + 'DescribeSlowLogRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => ' 实例ID。 '."\n" + .'> 如果是分片集群实例，您还需要配置`NodeId`。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1fc7e65108****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => ' Shard节点ID。 '."\n" + ."\n" + .'> 如果`DBInstanceId`配置的是分片集群实例的ID，需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp18b06ebc21****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => ' 查询开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-08-15T14:13Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm</i>Z（UTC时间）。'."\n" + ."\n" + .'> - 必须晚于查询开始时间。'."\n" + .'> - 查询结束时间距查询开始时间不得超过24个小时，超过则调用失败。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-08-16T14:13Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'mongodbtest', + ], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字，多个关键字以空格分隔，不超过10个关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'test test1', + ], + ], + [ + 'name' => 'LogicalOperator', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字搜索的逻辑操作， 默认值为and。', + 'type' => 'string', + 'required' => false, + 'example' => 'and', + 'default' => 'and', + 'enum' => [ + 'and', + 'or', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => ' 每页记录数，取值范围为**30**~**100**。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '按时间的升降序对查询到的慢日志进行排序。取值如下：'."\n" + .'- asc：按时间升序排序。'."\n" + .'- desc：按时间降序排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => ' 总记录数。 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '本页慢操作日志明细的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8076C4BA-DDBD-529C-BFF4-D8620C3F****', + ], + 'PageNumber' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogRecords' => [ + 'description' => '慢日志明细列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExecutionStartTime' => [ + 'description' => '操作执行的开始时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-02-25T 01:41:28Z', + ], + 'HostAddress' => [ + 'description' => '连接数据库的主机地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'QueryTimes' => [ + 'description' => '该语句的执行时长，单位为毫秒。', + 'type' => 'string', + 'example' => '600', + ], + 'TableName' => [ + 'description' => 'MongoDB的集合名称。', + 'type' => 'string', + 'example' => 'C1', + ], + 'SQLText' => [ + 'description' => '慢操作执行的语句。', + 'type' => 'string', + 'example' => '{\\"op\\":\\"query\\",\\"ns\\":\\"mongodbtest.customer\\",\\"query\\":{\\"find\\":\\"customer\\",\\"filter\\":{\\"name\\":\\"jack\\"}}}', + ], + 'ReturnRowCounts' => [ + 'description' => '返回行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'KeysExamined' => [ + 'description' => '索引扫描行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DBName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'mongodbtest', + ], + 'DocsExamined' => [ + 'description' => '该操作执行时扫描的文档数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000', + ], + 'AccountName' => [ + 'description' => '执行该操作的数据库用户名。', + 'type' => 'string', + 'example' => 'test', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'Engine' => [ + 'description' => '当前数据库的引擎类型。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '开始时间不能大于结束时间。', + ], + [ + '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' => '查询实例运行出现的慢操作日志明细', + 'summary' => '查询MongoDB实例运行出现的慢日志明细。', + 'description' => '- 本接口仅适用于规格类型为**通用型本地盘版**,**独享型本地盘版**和**独享型云盘版**实例。'."\n" + .'- 本接口限制每分钟调用30次，如超过这个限制会被限流，请勿高频调用。如需高频调用，请使用Logstore，详情请参见[管理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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DescribeSlowLogRecordsResponse>\\n <TotalRecordCount>1</TotalRecordCount>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>8076C4BA-DDBD-529C-BFF4-D8620C3F****</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <LogRecords>\\n <TableName>$cmd</TableName>\\n <QueryTimes>944</QueryTimes>\\n <ExecutionStartTime>2021-08-15T21:08:36Z</ExecutionStartTime>\\n <DBName>admin</DBName>\\n <HostAddress>11.61.195.204</HostAddress>\\n <SQLText>{\\"op\\":\\"command\\",\\"ns\\":\\"admin.$cmd\\",\\"command\\":{\\"isMaster\\":1,\\"client\\":{\\"driver\\":{\\"name\\":\\"mgo\\",\\"version\\":\\"vinllen\\"},\\"os\\":{\\"type\\":\\"linux\\",\\"architecture\\":\\"amd64\\"}},\\"$readPreference\\":{\\"mode\\":\\"secondaryPreferred\\"},\\"$db\\":\\"admin\\"},\\"numYield\\":0,\\"locks\\":{},\\"flowControl\\":{},\\"responseLength\\":748,\\"protocol\\":\\"op_query\\",\\"millis\\":944,\\"replRole\\":{\\"stateStr\\":\\"SECONDARY\\",\\"_id\\":1}}</SQLText>\\n </LogRecords>\\n </Items>\\n <Engine>MongoDB</Engine>\\n</DescribeSlowLogRecordsResponse>","errorExample":""}]', + ], + 'DescribeTags' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~61933~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值固定为**INSTANCE**。', + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE', + 'default' => 'INSTANCE', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp17e7a04960****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token，用来返回更多结果。'."\n" + .'>第一次查询不需要提供本参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的NextToken值以继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。'."\n" + .'>如果一次查询没有返回全部结果，则会返回本参数，您可以后续查询中传入本参数的值以继续查询。', + 'type' => 'string', + 'example' => '212db86****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEDBE38F-5CF5-4316-AAC2-35817BA60D68', + ], + 'Tags' => [ + 'description' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'TagValues' => [ + 'description' => '标签的值。', + 'type' => 'array', + 'items' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => '3.4环境', + ], + ], + 'TagKey' => [ + 'description' => '标签的键。', + 'type' => 'string', + 'example' => '测试组', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'description' => '指定的参数“Tag.n.Key”或“TagKey.n”无效。', + ], + [ + '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' => '查询已有标签列表', + 'summary' => '查询目标地域中所有的标签信息。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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":"<DescribeTagsResponse>\\n <NextToken>212db86****</NextToken>\\n <RequestId>EEDBE38F-5CF5-4316-AAC2-35817BA60D68</RequestId>\\n <Tags>\\n <TagValues>3.4环境</TagValues>\\n <TagKey>测试组</TagKey>\\n </Tags>\\n</DescribeTagsResponse>","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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'TargetRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标可用区ID，您可以通过[DescribeRegions](~~61933~~)查询可用的可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'RoleARN', + 'in' => 'query', + 'schema' => [ + 'description' => '指定角色的ARN。格式：`acs:ram::$accountID:role/$roleName `，默认值为：`acs:ram::$accountID:role/aliyunrdsinstanceencryptiondefaultrole`。'."\n" + .'> - `$accountID`：云账号ID。您可以通过登录阿里云控制台，将鼠标悬停在右上角头像的位置，单击安全设置进行查看。'."\n" + .'> - `$roleName`：RAM角色名称。您可以通过登录RAM控制台，单击左侧导航栏的RAM角色管理，在RAM角色名称列表下进行查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7CD51DA4-A499-43CE-B9B5-20CD4FDC648E', + ], + 'KeyIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'KeyId' => [ + 'description' => '实例密钥列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例密钥。', + 'type' => 'string', + 'example' => '2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'INVALID_INSNAME_REGIONID_EMPTY', + 'errorMessage' => 'The insName and regionId can\'t be all empty', + 'description' => '', + ], + ], + ], + 'title' => '查询实例的自定义密钥列表', + 'summary' => '查询实例的自定义密钥列表。', + 'description' => '使用通过DescribeUserEncryptionKeyList查询到的自定义密钥可以开启透明数据加密TDE。详细信息请参见[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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CD51DA4-A499-43CE-B9B5-20CD4FDC648E\\",\\n \\"KeyIds\\": {\\n \\"KeyId\\": [\\n \\"2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>7CD51DA4-A499-43CE-B9B5-20CD4FDC648E</RequestId>\\n<KeyIds>\\n <KeyId>2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>\\n <KeyId>578b59ad-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>\\n <KeyId>749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>\\n</KeyIds>","errorExample":""}]', + ], + 'DescribeVpcsForMongoDB' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的记录数，取值为大于0且不超过Integer数据类型的最大值，默认值为**50**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '10', + 'default' => '30', + 'enum' => [ + '30', + '50', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Vpcs' => [ + 'description' => 'VPC列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'VPC状态。 **Available**表示可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VpcName' => [ + 'description' => 'VPC的名称。', + 'type' => 'string', + 'example' => 'vpc-name', + ], + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-2zep2pepkthg5ueal****', + ], + 'IsDefault' => [ + 'description' => '是否是默认VPC。取值说明：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'CidrBlock' => [ + 'description' => 'VPC的网段。', + 'type' => 'string', + 'example' => '10.**.**.**/24', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'AliUid' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'VSwitchs' => [ + 'description' => 'VSwitch 列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'VSwitch状态。**Available**表示可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => 'VSwitch ID。', + 'type' => 'string', + 'example' => 'vsw-bp*******************', + ], + 'IsDefault' => [ + 'description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'CidrBlock' => [ + 'description' => 'VSwitch 的网段。', + 'type' => 'string', + 'example' => '10.**.**.**/28', + ], + 'GmtCreate' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'GmtModified' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'IzNo' => [ + 'description' => 'VSwitch 所属的可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'VSwitchName' => [ + 'description' => 'VSwitch 的名称。', + 'type' => 'string', + 'example' => 'vsw-name', + ], + ], + 'description' => '', + ], + ], + 'GmtModified' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + 'Bid' => [ + 'description' => '该参数已废弃，故不会返回参数值。', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'description' => '', + ], + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '53924AF0-1628-5AA2-9C95-D4**********', + ], + 'PageSize' => [ + 'description' => '每页可展示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '分页获取VPC列表', + 'summary' => '分页获取VPC列表。', + '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' => '实例ID。'."\n" + ."\n" + .'> **InstanceId**参数与**DBInstanceId**参数作用相同，只需选择一个传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp147acd4783****', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'> **InstanceId**参数与**DBInstanceId**参数作用相同，只需选择一个传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp147acd4783****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65BDA532-28AF-4122-AA39-B382721E****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ChargeTypeViolation', + 'errorMessage' => 'The operation is not permitted due to charge type of the instance.', + 'description' => '实例收费类型不允许执行当前操作。', + ], + [ + 'errorCode' => 'MissingDBInstanceId', + 'errorMessage' => 'DBInstanceId is mandatory for this action.', + 'description' => '', + ], + ], + ], + 'title' => '销毁MongoDB实例', + 'summary' => '销毁MongoDB实例。', + 'description' => '调用本接口时，实例必须满足以下条件：'."\n" + .'- 实例的付费类型为包年包月。'."\n" + .'- 实例处于**到期锁定**状态，未释放。'."\n" + ."\n" + .'> 本地盘实例调用本接口时会直接销毁实例；'."\n" + .'云盘实例调用本接口时会删除实例，并修改备份策略为 "实例释放时立即删除该实例的所有备份集"。'."\n" + ."\n\n" + .'><danger> 实例销毁后数据将无法找回，请谨慎操作。></danger>', + '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' => '在新购实例或对实例进行变配之前，评估是否有足够的资源。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID，您可以调用[DescribeRegions](~~61933~~)查询。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎，取值：**MongoDB**。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'MongoDB', + 'default' => 'MongoDB', + 'enum' => [ + 'MongoDB', + ], + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本号。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + '4.0' => '4.0', + '5.0' => '5.0', + '4.2' => '4.2', + '6.0' => '6.0', + '3.4' => '3.4', + '7.0' => '7.0', + '4.4' => '4.4', + '8.0' => '8.0', + ], + 'example' => '4.2', + 'enum' => [ + '3.4', + '4.0', + '4.2', + '4.4', + '5.0', + '6.0', + '7.0', + '8.0', + ], + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格。'."\n" + ."\n" + .'> 评估副本集资源时必须配置该参数，规格详情请参见[实例规格表](~~57141~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.mongo.mid', + ], + ], + [ + 'name' => 'ShardsInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群的分片信息，评估分片集群资源时必须配置该参数。'."\n" + ."\n" + .'评估新购分片集群资源时，需指定每个分片的规格，格式为JSON格式字符串。示例如下：'."\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" + ."\n" + .' - ConfigSvrs：ConfigServer节点。'."\n" + .' - Mongos：Mongos节点。'."\n" + .' - Shards：Shard节点。'."\n" + .' - Storage：指定目标分片的存储空间。'."\n" + .' - DBInstanceClass：指定目标分片的规格，规格详情请参见[分片集群实例规格表](~~311414~~)。'."\n" + ."\n" + .'评估分片集群变配资源时，仅需指定节点信息即可，格式为JSON格式字符串。示例如下：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"'."\n" + .'} '."\n" + .'```'."\n" + .'示例中参数说明如下：'."\n" + ."\n" + .'- NodeId：指定目标节点ID。'."\n" + .'- NodeClass：指定目标节点的规格。规格详情请参见[分片集群实例规格表](~~311414~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"}', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，评估变配资源时必须配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp14bf67a76d****', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => '设置实例的节点个数。'."\n" + ."\n" + .'- 单节点实例取值固定为**1**。'."\n" + ."\n" + .'- 共享存储版实例取值固定为**2**。'."\n" + ."\n" + .'- 副本集实例取值为**3**，**5**，**7**。'."\n" + ."\n" + .'<props="china">'."\n" + .'> Serverless实例不需要配置该参数。</props>', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '3', + 'enum' => [ + '1', + '3', + '5', + '7', + '2', + ], + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => '设置实例中只读节点的个数，取值范围为**1**~**5**。'."\n" + ."\n" + .'> 单节点实例<ph props ="china">和Serverless实例</ph>不需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '1', + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + ], + ], + ], + [ + 'name' => 'Storage', + 'in' => 'query', + 'schema' => [ + 'description' => '副本集的存储空间，单位为GB。'."\n" + .'> 实例规格为云盘型时，该参数必填。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceAvailable' => [ + 'description' => '展示当前区域是否有可用的资源。返回值：'."\n" + .'- **1**：资源足够。'."\n" + .'- **0**：资源不足。', + 'type' => 'string', + 'example' => '1', + ], + 'EngineVersion' => [ + 'description' => '数据库版本号。', + 'type' => 'string', + 'example' => '4.0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AE2DE465-E45F-481F-ABD8-37D64173****', + ], + 'Engine' => [ + 'description' => '数据库引擎，固定为MongoDB。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceAvailable\\": \\"1\\",\\n \\"EngineVersion\\": \\"4.0\\",\\n \\"RequestId\\": \\"AE2DE465-E45F-481F-ABD8-37D64173****\\",\\n \\"Engine\\": \\"MongoDB\\"\\n}","errorExample":""},{"type":"xml","example":"<EvaluateResourceResponse>\\n <DBInstanceAvailable>1</DBInstanceAvailable>\\n <EngineVersion>4.0</EngineVersion>\\n <RequestId>AE2DE465-E45F-481F-ABD8-37D64173****</RequestId>\\n <Engine>MongoDB</Engine>\\n</EvaluateResourceResponse>","errorExample":""}]', + 'title' => '评估是否有足够的资源', + 'description' => '本接口适用于MongoDB副本集、分片集群资源的评估。支持对副本集和分片集群的新购、变配，以及分片集群新增节点进行资源评估。'."\n" + ."\n" + .'> 本接口每分钟调用不得超过200次，超出会被限制流量。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dds:EvaluateResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '实例所属的地域ID，您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值固定为**INSTANCE**。', + 'type' => 'string', + 'required' => true, + 'example' => 'INSTANCE', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token，用来返回更多结果。'."\n" + .'> 第一次查询不需要提供本参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的**NextToken**值以继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例ID。'."\n" + .'> - **N**表示传入第几个实例ID。例如：**ResourceId.1**表示传入第一个实例ID；**ResourceId.2**表示传入第二个实例ID。'."\n" + .'> - 本参数和**Tag.N.Key**参数两者中必须传入一项。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。'."\n" + .'> - **N**表示传入第几个实例ID。例如：**ResourceId.1**表示传入第一个实例ID；**ResourceId.2**表示传入第二个实例ID。'."\n" + .'> - 本参数和**Tag.N.Key**参数两者中必须传入一项。', + 'type' => 'string', + 'required' => false, + 'example' => '开发组', + ], + 'required' => false, + 'example' => 'dds-bpxxxxxxxx', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。'."\n" + .'> - **N**表示传入第几个标签的键。例如：**Tag.1.Key**表示传入第一个标签的键；**Tag.2.Key**表示传入第二个标签的键。'."\n" + .'> - 本参数和**ResourceId.N**参数两者中必须传入一项。', + 'type' => 'string', + 'required' => false, + 'example' => '开发组', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + ."\n" + .'> **N**表示传入第几个标签的值。例如：**Tag.1.Value**表示传入第一个标签的值；**Tag.2.Value**表示传入第二个标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => '4.0环境', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '查询返回信息。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。'."\n" + .'> 如果一次查询没有返回全部结果，则会返回本参数，您可以后续查询中传入本参数返回的值以继续查询。', + 'type' => 'string', + 'example' => '212db86****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '96017AF2-9AB1-4BC9-88D2-7966B3CD****', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '实例和标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例和标签信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。返回值固定为**ALIYUN::KVSTORE::INSTANCE**，即MongoDB实例。', + 'type' => 'string', + 'example' => 'ALIYUN::DDS::INSTANCE', + ], + 'TagValue' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => '4.0环境', + ], + 'ResourceId' => [ + 'description' => '资源ID，此处为MongoDB实例ID。', + 'type' => 'string', + 'example' => 'dds-bp17e7a04960****', + ], + 'TagKey' => [ + 'description' => '标签的键。', + 'type' => 'string', + 'example' => '开发组', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'description' => '指定的参数“Tag.n.Key”或“TagKey.n”无效。', + ], + [ + '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' => '查询实例和标签的绑定关系', + 'summary' => '查询MongoDB实例和标签的绑定关系。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <NextToken>212db86****</NextToken>\\n <RequestId>96017AF2-9AB1-4BC9-88D2-7966B3CD****</RequestId>\\n <TagResources>\\n <ResourceType>ALIYUN::DDS::INSTANCE</ResourceType>\\n <TagValue>4.0环境</TagValue>\\n <ResourceId>dds-bp17e7a04960****</ResourceId>\\n <TagKey>开发组</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + ], + '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' => '实例ID。'."\n" + ."\n" + .'> 如果实例的网络类型为专有网络，您还需要传入**Vswitch**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1ece71ff2f****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移的目标可用区ID。'."\n" + ."\n" + .'> - 迁移的目标可用区和当前实例的可用区处于同一地域。'."\n" + .'> - 您可以通过调用[DescribeRegions](~~61933~~)接口查询可用区ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'Vswitch', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移的目标可用区虚拟交换机ID。'."\n" + ."\n" + .'> 当实例的网络类型为专有网络时，需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1buy0h9myt5i9e7****', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区的生效时间，取值：'."\n" + .'- **Immediately**：立即生效。'."\n" + .'- **MaintainTime**：在实例的可运维时间段内生效。'."\n" + ."\n" + .'默认为**Immediately**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => 'Immediately', + 'enum' => [ + 'Immediately', + 'MaintainTime', + '0', + '1', + ], + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移的目标备可用区1的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'HiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移的目标备可用区2的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-n', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0FDDC511-7252-4A4A-ADDA-5CB1BF63****', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '指定的实例类型不支持此操作。', + ], + [ + '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' => '该网络类型不支持此操作。'."\n", + ], + [ + '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' => '当前实例为VPC实例时，VSwitchId 参数不能为空。', + ], + [ + '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' => '目标可用区不可以和原可用区一致', + ], + [ + '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' => '此API不支持实例的MinorVersion。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '', + ], + ], + ], + 'title' => '迁移实例的可用区', + 'summary' => '迁移MongoDB实例的可用区。', + 'description' => '- MigrateAvailableZone接口暂不支持单节点实例，可适用于云盘实例与本地盘实例。'."\n" + .'- 实例未开启透明数据加密TDE功能。'."\n" + .'- 迁移的目标可用区和当前实例的可用区处于同一地域。'."\n" + .'- 专有网络的实例在操作迁移可用区之前，请确保目标可用区已创建相应的虚拟交换机。如需创建，请参见[创建虚拟交换机](~~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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0FDDC511-7252-4A4A-ADDA-5CB1BF63****\\"\\n}","errorExample":""},{"type":"xml","example":"<MigrateAvailableZoneResponse>\\n <RequestId>0FDDC511-7252-4A4A-ADDA-5CB1BF63****</RequestId>\\n</MigrateAvailableZoneResponse>","errorExample":""}]', + ], + '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' => '实例ID。'."\n" + ."\n" + .'> 如果实例的网络类型为专有网络，您还需要传入**VSwitchId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2658****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移的目标可用区ID。'."\n" + ."\n" + .'> - 迁移的目标可用区必须和当前实例的可用区处于同一地域。'."\n" + .'> - 您可以通过调用[DescribeRegions](~~61933~~)接口查询可用区ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区的生效时间，取值：'."\n" + .'- **Immediately**（默认值）：立即生效。'."\n" + .'- **MaintainTime**：在实例的可运维时间段内生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => 'Immediately', + 'enum' => [ + 'Immediately', + 'MaintainTime', + '0', + '1', + ], + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移的目标可用区虚拟交换机ID。'."\n" + ."\n" + .'> 当实例的网络类型为专有网络时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp67ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0FDDC511-7252-4A4A-ADDA-5CB1BF63873D', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '迁移实例到其他可用区', + 'summary' => '迁移MongoDB实例到其他可用区。', + 'description' => '- 本接口适用于副本集实例，暂不支持单节点实例和分片集群实例。'."\n" + .'- 实例未开启透明数据加密TDE功能。'."\n" + .'- 迁移的目标可用区和当前实例的可用区处于同一地域。'."\n" + .'- 专有网络的实例在操作迁移可用区之前，请确保目标可用区已创建相应的虚拟交换机，如需创建请参见[创建虚拟交换机](~~65387~~)。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0FDDC511-7252-4A4A-ADDA-5CB1BF63873D\\"\\n}","errorExample":""},{"type":"xml","example":"<MigrateToOtherZoneResponse>\\n <RequestId>0FDDC511-7252-4A4A-ADDA-5CB1BF63873D</RequestId>\\n</MigrateToOtherZoneResponse>","errorExample":""}]', + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2356****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '待修改备注信息的账号名。', + 'type' => 'string', + 'required' => true, + 'example' => 'root', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '设置账号的备注信息。'."\n" + .'- 不能以http:// 或者 https:// 开头。'."\n" + .'- 以中文、英文字母开头。'."\n" + .'- 可以包含中文、英文字符、下划线（_）、短划线（-）和数字，长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'superadmin', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => '修改账号备注信息类型。取值：'."\n" + .'- **db**: shard账号'."\n" + .'- **cs**：config server账号'."\n" + .'- **normal**：默认值，副本集账号（仅支持）'."\n" + ."\n" + .'> 当前仅支持修改**副本集**账号信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + 'default' => 'normal', + 'enum' => [ + 'db', + 'cs', + 'normal', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '59DE9FC2-7B40-45CF-9011-7327A8A771A2', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'Specified parameter AccountDescription is not valid.', + 'description' => '指定的参数AccountDescription无效。', + ], + [ + 'errorCode' => 'InvalidAccountName.NotFound', + 'errorMessage' => 'Specified account name does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'InsType.NotSupport', + 'errorMessage' => 'Specified instance type dose not support this operation.', + 'description' => '指定的实例类型不支持此操作。', + ], + ], + ], + 'title' => '修改实例中root账号的备注信息', + 'summary' => '修改MongoDB实例中root账号的备注信息。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"59DE9FC2-7B40-45CF-9011-7327A8A771A2\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAccountDescriptionResponse>\\n <RequestId>59DE9FC2-7B40-45CF-9011-7327A8A771A2</RequestId>\\n</ModifyAccountDescriptionResponse>","errorExample":""}]', + ], + 'ModifyActiveOperationMaintenanceConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '37474', + 'abilityTreeNodes' => [ + 'FEATUREmongodbKYZJ28', + ], + ], + 'parameters' => [ + [ + 'name' => 'CycleType', + 'in' => 'query', + 'schema' => [ + 'description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', + 'type' => 'string', + 'required' => false, + 'example' => 'Week', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，输入1～28的数字，表示每月几号，用","拼接。'."\n" + .'- 当CycleType为Week，输入1～7的数字，表示每周星期几，用","拼接。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '实例运维开始时间，格式为HH:mmZ，UTC时间。', + 'type' => 'string', + 'required' => false, + 'example' => '21:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '实例运维结束时间，格式为HH:mmZ，UTC时间。', + 'type' => 'string', + 'required' => false, + 'example' => '22:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '是否生效 '."\n" + .'- 1 生效 '."\n" + .'- 2 无效', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '修改实例的运维任务配置', + 'summary' => '修改mongoDb实例的运维任务配置', + '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' => '运维任务 ID，多个 ID 间使用英文逗号（,）分隔。'."\n" + ."\n" + .'> 您可以调用 DescribeActiveOperationTasks 获取运维任务 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '11111,22222', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '要设置的计划切换时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。'."\n" + ."\n" + .'> 不能晚于最晚操作时间，您可以调用DescribeActiveOperationTasks，通过返回参数Deadline的值来获取最晚操作时间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-10-17T18:50:00Z', + ], + ], + [ + 'name' => 'ImmediateStart', + 'in' => 'query', + 'schema' => [ + 'description' => '是否立即进入执行调度。'."\n" + .'- 0：否（默认）'."\n" + .'- 1：是'."\n" + .'> - 值为0时switchTime起作用；值为1时switchTime不起作用，任务开始时间将设置为当前时间，切换时间根据新的开始时间自动计算。'."\n" + .'> - 立即进入执行调度并不是立即切换，而是立即进入准备中状态，准备完成后，进行切换。您可以调用DescribeActiveOperationTasks，通过返回参数PrepareInterval的值来获取准备时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '运维任务ID，多个ID间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '11111,22222', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CAAE9DDA-65FD-584C-A378-F1F24676****', + ], + ], + ], + ], + ], + 'title' => '修改多个主动运维任务切换时间', + 'summary' => '该接口用于修改云数据库MongoDB实例计划内运维任务的切换时间。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyActiveOperationTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp12c5b040dc****', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => '设置审计日志的采集类型，多个采集类型请用英文逗号分隔。'."\n" + .'- **admin**：运维管控操作。'."\n" + .'- **slow**：慢日志。'."\n" + .'- **query**：查询操作。'."\n" + .'- **insert**：插入操作。 '."\n" + .'- **update**：更新操作。 '."\n" + .'- **delete**：删除操作。 '."\n" + .'- **command**：协议命令。例如aggregate聚合方法。 ', + 'type' => 'string', + 'required' => true, + 'example' => 'insert,query,update,delete', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例中节点的角色，取值：'."\n" + .'- **primary**：主节点。'."\n" + .'- **secondary**：从节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'primary', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E209BE2B-F264-4B9D-81F6-A5A5FB1FBF28', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => '输入的参数无效。', + ], + [ + 'errorCode' => 'InvalidFilterParam', + 'errorMessage' => 'Specified filter is not valid.', + 'description' => '', + ], + ], + ], + 'title' => '修改实例审计日志的采集类型', + 'summary' => '修改MongoDB实例审计日志的采集类型。', + 'description' => '- 调用本接口时，要求实例状态为运行中。'."\n" + .'- 本接口限制每分钟调用30次，如超过这个限制会被限流，请勿高频调用。如需高频调用，请使用Logstore，详情请参见[管理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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E209BE2B-F264-4B9D-81F6-A5A5FB1FBF28\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyAuditLogFilterResponse>\\r\\n\\t<RequestId>E209BE2B-F264-4B9D-81F6-A5A5FB1FBF28</RequestId>\\r\\n</ModifyAuditLogFilterResponse>","errorExample":""}]', + ], + 'ModifyAuditPolicy' => [ + 'summary' => '设置MongoDB实例的审计日志开关或日志存储时长。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1785659e3f****', + ], + ], + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '审计日志状态，取值：'."\n" + .'- **enable**：开启审计日志。'."\n" + .'- **disabled**：关闭审计日志。', + 'type' => 'string', + 'required' => true, + 'example' => 'enable', + 'enum' => [ + 'enable', + 'disabled', + 'Enable', + 'Disabled', + ], + ], + ], + [ + 'name' => 'StoragePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '- 在Standard（正式版）版本中，为审计日志保留时长。取值范围为1~365天，默认为30天。'."\n" + ."\n" + .'- 在V2_Standard（DAS企业版(NOSQL兼容)审计日志）版本中，为审计日志冷存储天数，取值范围为30、180、365、1095、1825，单位天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '365', + 'minimum' => '1', + 'example' => '30', + ], + ], + [ + 'name' => 'AuditLogSwitchSource', + 'in' => 'query', + 'schema' => [ + 'description' => '审计日志的请求来源，取值为**Console**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Console', + 'default' => 'Console', + ], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => [ + 'description' => '审计日志的版本类型。'."\n" + ."\n" + .'- **Trial**：免费试用版。'."\n" + .'- **Standard**：正式版。'."\n" + .'-**V2_Standard** ：DAS企业版(NOSQL兼容)审计日志。'."\n" + .'> - 该参数的默认值为**Trial**。从2022年01月06日起，各地域将陆续上线正式版审计日志，并终止申请免费试用版审计日志。'."\n" + .'> - 从2026年2月起，各地域将陆续上线DAS企业版(NOSQL兼容)审计日志，并终止申请正式版审计日志。', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + 'default' => 'Trial', + ], + ], + [ + 'name' => 'HotStoragePeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '在V2_Standard（DAS企业版(NOSQL兼容)审计日志）版本中生效，为审计日志热存储天数，取值范围为0-7，单位天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '7', + 'minimum' => '0', + 'example' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DC04D812-F18D-4568-9B88-F260D9590116', + ], + ], + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC04D812-F18D-4568-9B88-F260D9590116\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyAuditPolicyResponse>\\r\\n\\t<RequestId>DC04D812-F18D-4568-9B88-F260D9590116</RequestId>\\r\\n</ModifyAuditPolicyResponse>","errorExample":""}]', + 'title' => '设置实例的审计日志开关或日志存储时长', + 'description' => '- 本接口适用于规格类型为**通用型本地盘版**和**独享型本地盘版**实例。'."\n" + .'- 本接口限制每分钟调用30次，如超过这个限制会被限流，请勿高频调用。如需高频调用，请使用Logstore，详情请参见[管理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' => [ + 'summary' => '修改MongoDB备份集的过期时间', + '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' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dds-bp16cb162771****', + ], + ], + [ + 'name' => 'BackupExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '备份过期时间，格式为 <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n\n" + .'>- <i>9999-01-01</i>T<i>00:00:00</i>Z<i> 表示长久保留。'."\n" + .'>- 只能延长备份保留时间，不可缩短。'."\n" + .'>- 当设置的时间不是 <i>9999-01-01</i>T<i>00:00:00</i>Z 时，必须在备份集结束时间之后的 730 天范围内。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-03-29T03:47:12Z', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID。', + 'type' => 'string', + 'required' => true, + 'example' => '260032xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A0181AC4-XXXX-XXXX-87CA-100C70B86729', + ], + 'BackupExpireTime' => [ + 'description' => '备份过期时间,格式为 <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'>- <i>9999-01-01</i>T<i>00:00:00</i>Z<i> 表示长久保留。', + 'type' => 'string', + 'example' => '2025-03-29T03:47:12Z', + ], + 'BackupId' => [ + 'description' => '备份ID。', + 'type' => 'string', + 'example' => '260032xxxx', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '当前有正在进行的备份任务，请稍后再试。', + ], + [ + 'errorCode' => 'OperationDenied.NoDatabase', + 'errorMessage' => 'The operation is not permitted due to no database.', + 'description' => '', + ], + ], + ], + 'title' => '修改MongoDB备份集的过期时间', + 'description' => '仅支持修改手动备份的过期时间。'."\n" + ."\n" + .'仅支持修改云盘版MongoDB实例。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp16cb162771****', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '执行备份的时间，格式为<i>HH:mm</i>Z-<i>HH:mm</i>Z（UTC时间）。'."\n" + ."\n" + .'> 时间范围限制为1小时。', + 'type' => 'string', + 'required' => false, + 'example' => '03:00Z-04:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份周期，取值说明：'."\n" + .'- **Monday**：周一。'."\n" + .'- **Tuesday**：周二。'."\n" + .'- **Wednesday**：周三。'."\n" + .'- **Thursday**：周四。'."\n" + .'- **Friday**：周五。'."\n" + .'- **Saturday**：周六。'."\n" + .'- **Sunday**：周日。'."\n" + ."\n" + .'><notice>为了数据安全，请一周至少备份两次MongoDB></notice>'."\n" + ."\n\n" + .'> 传入多个值，请用英文逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday,Wednesday,Friday,Sunday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '全量备份保留天数。'."\n" + ."\n" + .'> - 2021年09月10日前用户默认保留天数为7天。'."\n" + .'> - 2021年09月10日后新用户默认保留天数为30天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => '是否打开日志备份，取值说明：'."\n" + .'- **0**：关闭（默认值）。'."\n" + ."\n" + .'- **1**：打开。'."\n" + .'><notice>分片集群不支持关闭日志备份></notice>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'LogBackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '日志备份保留天数，默认为7天。'."\n" + ."\n" + .'取值范围：7~730。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'SnapshotBackupType', + 'in' => 'query', + 'schema' => [ + 'description' => '快照备份类型，取值说明：'."\n" + ."\n" + .'- **Flash**：秒级备份。'."\n" + .'- **Standard**：常规备份（默认值）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'BackupInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '高频备份频率，取值说明：'."\n" + ."\n" + .'- **-1**：不开启高频备份。'."\n" + .'- **30**：每30分钟。'."\n" + .'- **60**：每1小时。'."\n" + .'- **120**：每2小时。'."\n" + .'- **180**：每3小时。'."\n" + .'- **240**：每4小时。'."\n" + .'- **360**：每6小时。'."\n" + .'- **480**：每8小时。'."\n" + .'- **720**：每12小时。'."\n" + ."\n" + .'>- 当**SnapshotBackupType**取值为**Standard**时，该参数取值固定为**-1**。'."\n" + .'>- 当**SnapshotBackupType**取值为**Flash**，且该参数取值大于0时，高频备份才生效。', + 'type' => 'string', + 'required' => false, + 'example' => '-1', + 'default' => '-1', + ], + ], + [ + 'name' => 'HighFrequencyBackupRetention', + 'in' => 'query', + 'schema' => [ + 'title' => '高频备份保留天数，使用该参数前需要先确认已经传入BackupInterval字段。默认保留时长一天。', + 'description' => '高频备份保留天数，使用该参数前需要先确认已经传入BackupInterval字段。默认保留时长一天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'description' => '备份保留策略。'."\n" + ."\n" + .'- 0：实例释放时立即删除该实例的所有备份集'."\n" + ."\n" + .'- 1：实例释放时会自动备份，长期保留该备份集'."\n" + .'- 2：实例释放时会自动备份，并长期保留该集群的所有备份集'."\n" + ."\n" + .'详细信息请参见：[长期保留备份](~~2779111~~)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'CrossBackupType', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份操作策略：'."\n" + ."\n" + .'- update: 修改异地备份策略'."\n" + .'- delete: 删除异地备份策略'."\n" + ."\n" + .'> 异地备份必填', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + 'enum' => [ + 'update', + 'delete', + ], + ], + ], + [ + 'name' => 'SrcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在地域。'."\n" + ."\n" + .'> '."\n" + .'> - 已删除实例恢复必填'."\n" + .'> - 异地备份必填', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DestRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '备份所在地域。'."\n" + ."\n\n" + .'> 异地备份必填', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CrossRetentionType', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份保留类型。'."\n" + ."\n" + .'- delay（保留一段时间）'."\n" + ."\n" + .'- never（不过期）'."\n" + ."\n" + .'> 异地备份必填', + 'type' => 'string', + 'required' => false, + 'example' => 'delay', + 'enum' => [ + 'delay', + 'never', + ], + ], + ], + [ + 'name' => 'CrossRetentionValue', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份保留时长，可设置 3-1825 天。'."\n" + ."\n" + .'> '."\n" + .'> - 异地备份必填'."\n" + .'> - 当 CrossRetentionType 为 delay 时使用且必须使用。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'CrossBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '异地备份的保留时间。'."\n" + ."\n" + .'1. Monday：周一'."\n" + .'2. Tuesday：周二'."\n" + .'3. Wednesday：周三'."\n" + .'4. Thursday：周四'."\n" + .'5. Friday：周五'."\n" + .'6. Saturday：周六'."\n" + .'7. Sunday：周日'."\n" + ."\n" + .'> 异地备份必填'."\n" + .'> - 传入多个值，请用英文逗号（,）隔开。'."\n" + .'> - 当备份设置为常规备份时，该值需要为 PreferredBackupPeriod 备份周期的子集。', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', + ], + ], + [ + 'name' => 'EnableCrossLogBackup', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启跨地域日志备份 。'."\n" + ."\n" + .'> 异地备份必填'."\n" + .'> - 1： 打开 (分片集群必须为1，副本集如果想支持异地时间点恢复必须为1)'."\n" + .'> - 0： 关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CrossLogRetentionType', + 'in' => 'query', + 'schema' => [ + 'description' => '异地日志备份保留类型。'."\n" + ."\n" + .'- delay（保留一段时间）'."\n" + .'- never（不过期）'."\n" + ."\n" + .'> 异地备份必填', + 'type' => 'string', + 'required' => false, + 'example' => 'delay', + 'enum' => [ + 'never', + 'delay', + ], + ], + ], + [ + 'name' => 'CrossLogRetentionValue', + 'in' => 'query', + 'schema' => [ + 'description' => '异地日志备份保留时长，可设置 3-1825 天，需要小于等于CrossRetentionValue的值。'."\n" + ."\n\n" + .'> 异地备份必填', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值：'."\n" + .'- replicate '."\n" + .'- sharding'."\n" + ."\n" + .'>- 当备份恢复类型为已删除实例重建时，需要且必填'."\n" + .'>- 当备份恢复类型为异地备份克隆时，需要且必填', + 'type' => 'string', + 'required' => false, + 'example' => 'replicate', + 'enum' => [ + 'sharding', + 'replicate', + ], + ], + ], + [ + 'name' => 'PreserveOneEachHour', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启按小时稀疏备份。'."\n" + ."\n" + .'- true：当备份频率为分钟级时，距离当前时间1小时内的快照全部保留。距离当前时间超过1小时且在24小时内的快照，仅保留整点后的第一个快照。'."\n" + ."\n" + .'- false：高频备份保留天数内的快照全部保留。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '644A359C-B871-4DD3-97B5-ED91EF5809C2', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '修改实例的备份策略', + 'summary' => '修改MongoDB实例的备份策略。', + 'description' => '异地备份只适用于云盘副本集、云盘分片实例。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"644A359C-B871-4DD3-97B5-ED91EF5809C2\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyBackupPolicyResponse>\\n <RequestId>657D2872-ED98-5778-A676-10132E30****</RequestId>\\n</ModifyBackupPolicyResponse>","errorExample":""}]', + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-7xv0912d85924194', + ], + ], + [ + 'name' => 'DBInstanceReleaseProtection', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启实例释放保护，取值说明：'."\n" + .'- **true**：已开启。'."\n" + .'- **false**：未开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '6826DEE3-B374-5DB7-909D-C8978827C534', + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改实例部分信息', + 'summary' => '调用该接口，可以设置实例释放保护配置。', + 'description' => '仅适用于后付费实例。', + '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' => '修改实例配置', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1ea17b41ab****', + ], + ], + [ + 'name' => 'ConfigName', + 'in' => 'query', + 'schema' => [ + 'description' => '配置项名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'manual_check', + ], + ], + [ + 'name' => 'ConfigValue', + 'in' => 'query', + 'schema' => [ + 'description' => '配置项值', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E466EFD6-2AD2-xxxx-A1A6-C7AFA1B323E1', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter %s is not valid.', + 'description' => '参数 %s 非有效参数。', + ], + ], + ], + 'title' => '修改实例的属性配置', + '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' => '修改MongoDB实例的连接地址和端口。', + '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' => '实例ID。'."\n" + ."\n" + .'> 当本参数传入的是分片集群实例ID时，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中的Mongos节点ID，每次调用仅能传入一个Mongos节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 's-bpxxxxxxxx', + ], + ], + [ + 'name' => 'CurrentConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '当前连接地址，即待修改的连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => 's-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'NewConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '新的连接地址，要求如下：'."\n" + .'- 以小写字母开头。'."\n" + .'- 以小写字母或数字结尾。'."\n" + .'- 由小写字母、数字和连字符（-） 组成。'."\n" + .'- 长度为8~63个字符。'."\n" + ."\n" + .'> 仅需传入连接地址的前缀部分，前缀以外的部分不可修改。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyuntest111', + ], + ], + [ + 'name' => 'NewPort', + 'in' => 'query', + 'schema' => [ + 'description' => '新的端口，端口范围需要在1000~65535之间。'."\n" + .'> 当**DBInstanceId**参数传入的是云盘实例ID时，本参数才可用。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3310', + ], + ], + [ + 'name' => 'PortModifyOnly', + 'in' => 'query', + 'schema' => [ + 'title' => '是否仅修改端口号，仅修改端口号的情况下支持批量修改', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'title' => '仅修改端口号时连接串网络类型。', + 'type' => 'string', + 'example' => 'vpc', + 'enum' => [ + 'vpc', + 'public', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FF36A84C-0694-42D0-861D-C383E8E4FAAF', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NewConnectionString.NotSupport', + 'errorMessage' => 'Specified newConnectionString is not supported.', + 'description' => 'newConnectionString 格式错误。', + ], + [ + 'errorCode' => 'InvalidConnectionStringOrPort.Duplicate', + 'errorMessage' => 'Specified connection string or port already exists.', + 'description' => '指明的连接串或port信息已存在，请检查后重新提交。', + ], + ], + ], + 'title' => '修改实例的连接地址和端口', + 'description' => '支持修改连接地址和端口的实例类型如下：'."\n" + .'- 支持修改本地盘和云盘版实例的连接地址。'."\n" + .'- 分片集群仅支持修改Mongos节点的连接地址。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF36A84C-0694-42D0-861D-C383E8E4FAAF\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyDBInstanceConnectionStringResponse>\\r\\n\\t<RequestId>FF36A84C-0694-42D0-861D-C383E8E4FAAF</RequestId>\\r\\n</ModifyDBInstanceConnectionStringResponse>","errorExample":""}]', + ], + 'ModifyDBInstanceDescription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + .'> 如需修改分片集群实例中的Shard节点或Mongos节点的名称，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2234****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Shard节点ID或Mongos节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**传入的是分片集群实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp89067****', + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。'."\n" + ."\n" + .'> - 不能以`http://`或`https://`开头。'."\n" + .'> - 以中文、英文字母开头。'."\n" + .'> - 可以包含中文、英文字符、下划线（_）、短划线（-）和数字，字符长度2~256个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdata', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06F8F642-4009-4FFC-80C4-9D67DBF7B74E', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBInstanceDescription.Malformed', + 'errorMessage' => 'Specified parameter DBInstanceDescription is not valid.', + 'description' => '节点名称不合法'."\n", + ], + ], + ], + 'title' => '修改实例名称', + 'summary' => '修改MongoDB实例名称。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"06F8F642-4009-4FFC-80C4-9D67DBF7B74E\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceDescriptionResponse>\\n <RequestId>06F8F642-4009-4FFC-80C4-9D67DBF7B74E</RequestId>\\n</ModifyDBInstanceDescriptionResponse>","errorExample":""}]', + ], + 'ModifyDBInstanceDiskType' => [ + 'summary' => '修改云数据库 MongoDB 版的磁盘类型。', + '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' => '修改后的磁盘类型，取值：'."\n" + .'- **cloud_auto**：ESSD AutoPL 云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_auto', + 'default' => 'cloud_auto', + ], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => '预配置性能（IOPS）。取值范围为 0~50000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '50000', + 'minimum' => '0', + 'example' => '1960', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1fa5efaa93****', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费。取值：'."\n" + .'- **true**：自动付费，请确保账号有足够的余额。'."\n" + .'<props="china">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，选择**订购订单**>**我的订单**，在**商品订单**页签找到目标订单进行支付。</props>'."\n" + .'<props="intl">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，单击**订单管理**，在**商品订单**页面找到目标订单进行支付。</props>'."\n" + ."\n" + .'默认值为：**true**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => ' 优惠码，默认为`youhuiquan_promotion_option_id_for_blank`。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'ExtraParam', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'async', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值说明：'."\n" + .'- **true**：开启自动续费。'."\n" + .'- **false**：不开启自动续费。'."\n" + ."\n" + .'默认值为 **false**', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '变配类型，取值：'."\n" + ."\n" + .'- **UPGRADE**：升级配置。'."\n" + .'- **DOWNGRADE**：降级配置。'."\n" + ."\n" + .'> 当实例付费方式为包年包月时，该参数可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'UPGRADE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21012719476****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改实例磁盘类型', + 'description' => '- 磁盘空间小于40GB，不支持此功能。'."\n" + .'- 只支持变配至cloud_auto云盘类型。'."\n" + .'- 单个实例两次修改IOPS预配置性能的时间间隔需超过一小时。更多说明，请参见[修改ESSD AutoPL云盘性能配置](~~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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpac2345****', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '实例可运维时间段的开始时间，格式为<i>HH:mm</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '01:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '实例可运维时间段的结束时间，格式为<i>HH:mm</i>Z（UTC时间）。'."\n" + ."\n" + .'> 可运维时间段的结束时间需晚于可运维时间段的开始时间。', + 'type' => 'string', + 'required' => true, + 'example' => '02:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A9310426-C763-42A2-A3AD-70A8DA204531', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '修改实例的可维护时间', + 'summary' => '修改MongoDB实例的可维护时间。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A9310426-C763-42A2-A3AD-70A8DA204531\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceMaintainTimeResponse>\\n <RequestId>A9310426-C763-42A2-A3AD-70A8DA204531</RequestId>\\n</ModifyDBInstanceMaintainTimeResponse>","errorExample":""}]', + ], + 'ModifyDBInstanceMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => '设置监控采集粒度，取值：**1**或**300**，单位为秒。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EFD65226-08CC-4C4D-B6A4-CB3C382F67B0', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '设置MongoDB实例的监控采集粒度', + 'summary' => '设置MongoDB实例的监控采集粒度。', + 'description' => '>由于监控采集粒度调整功能变更，本接口仅适用于旧版本MongoDB控制台。'."\n" + ."\n" + .'调用本接口时，实例必须满足以下条件：'."\n" + .'- 实例为副本集实例或分片集群实例。'."\n" + .'- 实例的版本为3.4（最新的小版本）或4.0。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EFD65226-08CC-4C4D-B6A4-CB3C382F67B0\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceMonitorResponse>\\r\\n\\t<RequestId>EFD65226-08CC-4C4D-B6A4-CB3C382F67B0</RequestId>\\r\\n</ModifyDBInstanceMonitorResponse>","errorExample":""}]', + ], + 'ModifyDBInstanceNetExpireTime' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'ClassicExpendExpiredDays', + 'in' => 'query', + 'schema' => [ + 'description' => '设置保留原经典网络地址的时长，取值：**14**、**30**、**60**、**120**，单位为天。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '459E7D5C-38DA-4E14-9C82-5B5AF693DBAB', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidConnectionString.NotFound', + 'errorMessage' => 'Specified connection string or net type is not found.', + 'description' => '', + ], + ], + ], + 'title' => '延长MongoDB实例的经典网络保留时长', + 'summary' => '延长MongoDB实例的经典网络保留时长。', + 'description' => '调用该接口时实例须满足以下条件：'."\n" + .'* 实例状态处于运行中。'."\n" + .'* 实例的网络处于混访模式。'."\n" + ."\n" + .'> 本接口适用于副本集实例和分片集群实例，暂不支持单节点实例。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"459E7D5C-38DA-4E14-9C82-5B5AF693DBAB\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyDBInstanceNetExpireTimeResponse>\\r\\n\\t<RequestId>459E7D5C-38DA-4E14-9C82-5B5AF693DBAB</RequestId>\\r\\n</ModifyDBInstanceNetExpireTimeResponse>","errorExample":""}]', + ], + 'ModifyDBInstanceNetworkType' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp11483712c1****', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例要切换的目标网络类型，取值说明：'."\n" + .'- **VPC**：将网络类型切换为专有网络。', + 'type' => 'string', + 'required' => true, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'> 当**NetworkType**参数配置为**VPC**时，需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1n3i15v90el48nx****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络中的交换机ID。'."\n" + .'> 当**NetworkType**参数配置为**VPC**时，需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1vj604nj5a9zz74****', + ], + ], + [ + 'name' => 'RetainClassic', + 'in' => 'query', + 'schema' => [ + 'description' => '切换网络类型为VPC时，设置是否保留原经典网络地址，取值说明：'."\n" + .'- **True**：保留原经典网络地址。'."\n" + .'- **False**：不保留原经典网络地址。'."\n" + ."\n" + .'> - 当**NetworkType**参数配置为**VPC**时，需要配置该参数。'."\n" + .'> - 当该参数配置为**True**时，还需要配置**ClassicExpiredDays**参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'False', + 'default' => 'False', + ], + ], + [ + 'name' => 'ClassicExpiredDays', + 'in' => 'query', + 'schema' => [ + 'description' => '切换网络类型为VPC时，设置保留原经典网络地址的时长。取值为**14**、**30**、**60**、**120**，单位为天。'."\n" + ."\n" + .'> 当**NetworkType**参数配置为**VPC**且**RetainClassic**参数配置为**True**时，需要配置该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID，您可以通过调用[DescribeRegions](~~61933~~)接口查询可用区ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0E605FD-6ECE-5FBE-84A4-99AAB1B8****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InstanceVpcAuthMode.NotSupported', + 'errorMessage' => 'Instance VpcAuthMode is NotSupported.', + 'description' => '', + ], + ], + ], + 'title' => '切换实例的网络类型', + 'summary' => '切换MongoDB实例的网络类型。', + 'description' => '- 该接口适用于副本集实例和分片集群实例，暂不支持单节点实例。且仅支持经典网络类型转换至VPC网络类型。'."\n" + .'- 该接口仅支持MongoDB 4.2及以下版本的本地盘版实例。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0E605FD-6ECE-5FBE-84A4-99AAB1B8****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceNetworkTypeResponse>\\n <RequestId>D0E605FD-6ECE-5FBE-84A4-99AAB1B8****</RequestId>\\n</ModifyDBInstanceNetworkTypeResponse>","errorExample":""}]', + ], + 'ModifyDBInstanceSSL' => [ + 'summary' => '修改MongoDB实例的SSL配置。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + ], + ], + [ + 'name' => 'SSLAction', + 'in' => 'query', + 'schema' => [ + 'description' => '对SSL功能执行的操作，取值说明：'."\n" + .'- **Open**：开启SSL加密。'."\n" + .'- **Close**：关闭SSL加密。'."\n" + .'- **Update**：更新SSL证书。 '."\n" + .' ', + 'type' => 'string', + 'required' => true, + 'example' => 'Open', + 'enum' => [ + 'Open', + 'Close', + 'Update', + ], + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '修改MongoDB实例SSL配置的时间点，取值：'."\n" + ."\n" + .'- 0：立刻修改。'."\n" + ."\n" + .'- 1：在可运维时间内修改。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'ForceEncryption', + 'in' => 'query', + 'schema' => [ + 'title' => '连接是否强制开启SSL加密，1：强制开启SSL加密；0:不强制开启SSL加密。', + 'description' => '连接是否强制开启SSL加密，取值说明：'."\n" + ."\n" + .'- **1**：强制开启SSL加密.'."\n" + .'- **0**：不强制开启SSL加密。'."\n" + ."\n" + .'> '."\n" + .'> - SSL强制加密仅适用于云盘版 7.0 及 8.0 实例，且需满足以下内核小版本要求：'."\n" + .'> - - 7.0 版本：内核小版本需为 8.0.13 及以上。'."\n" + .'> - - 8.0 版本：内核小版本需为 9.0.5 及以上。'."\n" + ."\n" + .'><warning>启用强制SSL加密后，将无法使用非SSL加密方式连接实例。></warning>', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '0', + '1', + ], + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6D806B11-078F-4154-BF9F-844F56D08964', + ], + ], + ], + ], + ], + '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' => '当前的数据库实例锁定模式不支持此操作。', + ], + ], + [ + [ + 'errorCode' => 'EnabledSSLNotSupport', + 'errorMessage' => 'Specified region does not support enable ssl.', + 'description' => '', + ], + ], + ], + 'title' => '修改MongoDB实例的SSL链路配置', + 'description' => '调用ModifyDBInstanceSSL接口时，实例必须满足以下条件： '."\n" + .'- 实例状态为运行中。'."\n" + .'- 实例类型为副本集或分片集群实例。'."\n" + .' - 副本集实例的版本需为3.4及以上版本。'."\n" + .' - 分片集群实例的存储模式需要为ESSD云盘版。'."\n" + ."\n" + .'> 在开通、更新和关闭SSL过程中，实例会重启一次，建议您在业务低峰期操作。', + '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}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D806B11-078F-4154-BF9F-844F56D08964\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceSSLResponse>\\n <RequestId>6D806B11-078F-4154-BF9F-844F56D08964</RequestId>\\n</ModifyDBInstanceSSLResponse>","errorExample":""}]', + ], + 'ModifyDBInstanceSpec' => [ + 'summary' => '变更云数据库MongoDB单节点实例、副本集实例和Serverless实例（仅中国站支持Serverless实例）的规格或存储空间。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1ea17b41ab****', + ], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格。<props="intl"><ph>详情请参见[实例规格表](~~57141~~)。您也可以通过调用[DescribeAvailableResource](~~149719~~)接口查看实例规格。</ph></props>'."\n" + .'<props="china">'."\n" + .'- 单节点实例和副本集实例配置为实例的规格，详情请参见[实例规格表](~~57141~~)。您也可以调用[DescribeAvailableResource](~~149719~~)接口查看单节点实例和副本集实例的实例规格。'."\n" + .'- Serverless实例配置为实例的计算规格，取值范围为100~8000。'."\n" + .'</props>'."\n" + ."\n" + .'> 该参数和**DBInstanceStorage**参数两者中至少配置一项。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds.sn4.xlarge.1', + ], + ], + [ + 'name' => 'DBInstanceStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的存储空间。<props="intl"><ph>取值范围为10~3000 GB，步长为10 GB。具体取值受实例规格约束，详情请参见[实例规格表](~~57141~~)。</ph></props>'."\n" + ."\n" + .'<props="china">'."\n" + .'- 单节点实例和副本集实例存储空间的取值范围为10~3000 GB，步长为10 GB。具体取值受实例规格约束，详情请参见[实例规格表](~~57141~~)。'."\n" + .'- Serverless实例存储空间的取值范围1~100 GB，步长为1 GB。'."\n" + .'</props>'."\n" + ."\n" + .'> - 该参数和**DBInstanceClass**参数两者中至少配置一项。'."\n" + .'> - 目前不支持降配存储空间。', + 'type' => 'string', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '变配类型，取值说明：'."\n" + .'- **UPGRADE**：默认值，升级配置。'."\n" + .'- **DOWNGRADE**：降级配置。'."\n" + ."\n" + .'> 当实例付费方式为包年包月时，可以配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'UPGRADE', + 'default' => 'UPGRADE', + 'enum' => [ + 'UPGRADE', + 'DOWNGRADE', + ], + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '实例是否自动付费，取值说明：'."\n" + .'- **true**：默认值，自动付费，请确保账号有足够的余额。'."\n" + .'<props="china">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，选择**订购订单**>**我的订单**，在**商品订单**页签找到目标订单进行支付。</props>'."\n" + .'<props="intl">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，单击**订单管理**，在**商品订单**页面找到目标订单进行支付。</props>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'ReplicationFactor', + 'in' => 'query', + 'schema' => [ + 'description' => '设置实例的节点个数，默认值为3。'."\n" + .'- 副本集实例取值为**3**，**5**，**7**。'."\n" + .'- 单节点实例取值固定为**1**。'."\n" + .'- 共享存储版副本集实例（仅支持中国站）取值固定为**2**。'."\n" + ."\n" + .'> Serverless实例（仅支持中国站）不需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + 'default' => '3', + 'enum' => [ + '1', + '3', + '5', + '7', + '2', + ], + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点的个数，取值范围为**0**~**5**。'."\n" + ."\n" + .'如果实例的网络类型只开通了**经典网络**和**专有网络**，您需要开通公网或释放经典网络，才能变更**只读节点数**。'."\n" + .'>您可以登录云数据库MongoDB控制台，在**数据库连接**页面查看已开通的网络类型。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '变更配置的生效时间，取值说明：'."\n" + .'- **Immediately**：默认值，立即生效。'."\n" + .'- **MaintainTime**：在实例的可运维时间段内生效。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => '0', + 'enum' => [ + 'Immediately', + 'MaintainTime', + '0', + '1', + ], + ], + ], + [ + 'name' => 'ExtraParam', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，取值说明：'."\n" + ."\n" + .'- **async**：变配订单创建后返回结果。'."\n" + .'- **sync**：变配订单创建后实例变配下发时返回结果。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'async' => 'async', + 'sync' => 'sync', + ], + 'example' => 'async', + 'default' => 'async', + ], + ], + [ + 'name' => 'TargetZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区同时变配时，实例迁移的目标可用区。'."\n" + .'><notice>只支持云盘实例。></notice>'."\n" + .'><notice>该参数取值不能与TargetSecondaryZoneId和TargetHiddenZoneId参数值相同。></notice>'."\n" + .'> - 只有在迁移可用区同时变配才需要传入此参数。'."\n" + .'> - 迁移的目标可用区和当前实例的可用区处于同一地域。'."\n" + .'> - 您可以通过调用[DescribeRegions](~~61933~~)接口查询可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'TargetSecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区同时变配时，从节点（Secondary节点）的目标可用区。'."\n" + .'><notice>只支持云盘实例。></notice>'."\n" + .'><notice>该参数取值不能与TargetZoneId和TargetHiddenZoneId参数值相同。></notice>'."\n" + .'> '."\n" + .'> - 只有在迁移可用区同时变配才需要传入此参数。'."\n" + .'>- 本参数仅在多可用区迁移时可用。'."\n" + .'> - 迁移的目标可用区和当前实例的可用区处于同一地域。'."\n" + .'> - 您可以通过调用[DescribeRegions](~~61933~~)接口查询可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'TargetHiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区同时变配时，隐藏节点（Hidden节点）的目标可用区。'."\n" + .'><notice>只支持云盘实例。></notice>'."\n" + .'><notice>该参数取值不能与TargetZoneId和TargetSecondaryZoneId参数值相同。></notice>'."\n" + ."\n" + .'> '."\n" + .'> - 只有在迁移可用区同时变配才需要传入此参数。'."\n" + .'>- 本参数仅在多可用区迁移时可用。'."\n" + .'> - 迁移的目标可用区和当前实例的可用区处于同一地域。'."\n" + .'> - 您可以通过调用[DescribeRegions](~~61933~~)接口查询可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'TargetVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区同时变配的目标虚拟交换机ID。'."\n" + .'><notice>只支持云盘实例。></notice>'."\n" + .'> '."\n" + .'> - 只有在迁移可用区同时变配才需要传入此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1buy0h9myt5i9e7****'."\n", + ], + ], + [ + 'name' => 'SearchNodeClass', + 'in' => 'query', + 'schema' => [ + 'title' => '变配的Search节点规格', + 'description' => '变配的Search节点规格', + 'type' => 'string', + 'required' => false, + 'example' => 'mdb.shard.2x.xlarge.d', + ], + ], + [ + 'name' => 'SearchNodeStorage', + 'in' => 'query', + 'schema' => [ + 'title' => '变配的Search节点容量', + 'description' => '变配的Search节点容量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SearchNodeCount', + 'in' => 'query', + 'schema' => [ + 'title' => '变配的Search节点数', + 'description' => '变配的Search节点数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '16', + 'minimum' => '2', + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1E9F1104-19E7-59F0-AB7F-F4EBFDEA****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21012408824****', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '当前操作资源不足，请求id: %s。', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'The resource is out of usage.', + 'description' => 'The resource is out of usage.', + ], + [ + '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' => '', + ], + ], + ], + 'title' => '变更单节点或副本集实例的规格或存储空间', + 'description' => '请确保在使用该接口前，已充分了解MongoDB产品的收费方式和和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .'该接口仅适用于云数据库MongoDB<props="china"><ph>单节点实例、副本集实例和Serverless实例</ph></props><props="intl"><ph>单节点实例和副本集实例</ph></props>。如需变更分片集群实例的配置，您可以根据需求通过调用[ModifyNodeSpec](~~61923~~)、[CreateNode](~~61911~~)、[DeleteNode](~~61922~~)或[ModifyNodeSpecBatch](~~61816~~)接口来实现。', + '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}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E9F1104-19E7-59F0-AB7F-F4EBFDEA****\\",\\n \\"OrderId\\": \\"21012408824****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBInstanceSpecResponse>\\n <RequestId>1E9F1104-19E7-59F0-AB7F-F4EBFDEA****</RequestId>\\n <OrderId>21012408824****</OrderId>\\n</ModifyDBInstanceSpecResponse>","errorExample":""}]', + ], + 'ModifyDBInstanceTDE' => [ + 'summary' => '修改MongoDB实例的透明数据加密TDE（Transparent Data Encryption）状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8332', + 'abilityTreeNodes' => [ + 'FEATUREmongodbQ7EXOR', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'TDEStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'TDE状态，取值： **enabled**，即开启TDE功能。'."\n" + .'> TDE功能开启后不支持关闭，请谨慎开启。', + 'type' => 'string', + 'required' => true, + 'example' => 'enabled', + ], + ], + [ + 'name' => 'EncryptorName', + 'in' => 'query', + 'schema' => [ + 'description' => '加密方式，取值：**aes-256-cbc**。'."\n" + ."\n" + .'> 当**TEDStatus**参数取值为**enabled**时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'aes-256-cbc', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义密钥ID。'."\n" + .'只有如下地域支持自定义密钥，其余地域会使用默认密钥加密。'."\n" + .'- 新加坡（ap-southeast-1）'."\n" + .'- 杭州（cn-hangzhou）'."\n" + .'- 上海（cn-shanghai）'."\n" + .'- 北京（cn-beijing）'."\n" + .'- 深圳（cn-shenzhen）'."\n" + .'- 香港（cn-hongkong）'."\n" + .'- 马来西亚（ap-southeast-3）', + 'type' => 'string', + 'required' => false, + 'example' => '749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'RoleARN', + 'in' => 'query', + 'schema' => [ + 'description' => '指定角色的ARN。格式：`acs:ram::$accountID:role/$roleName `。'."\n" + .'> - `$accountID`：云账号ID。您可以通过登录阿里云控制台，将鼠标悬停在右上角头像的位置，单击安全设置进行查看。'."\n" + .'> - `$roleName`：RAM角色名称。您可以通过登录RAM控制台，单击左侧导航栏的RAM角色管理，在RAM角色名称列表下进行查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::123456789012****:role/adminrole ', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '修改MongoDB实例透明数据加密（TDE）状态时间点，取值：'."\n" + ."\n" + .'- 0：立刻修改。'."\n" + ."\n" + .'- 1：在可运维时间内修改。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '434D7127-6229-4355-BA50-7A3685A725DF', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '当前的数据库实例锁定模式不支持此操作。', + ], + ], + [ + [ + 'errorCode' => 'InvalidClusterKms', + 'errorMessage' => 'this cluster not kms service.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => '', + ], + ], + ], + 'title' => '修改MongoDB实例的透明数据加密TDE状态', + 'description' => '透明数据加密TDE（Transparent Data Encryption）可对数据文件执行实时I/O加密和解密，数据在写入磁盘之前进行加密，从磁盘读入内存时进行解密，更多详情请参见[设置透明数据加密TDE](~~131048~~)。'."\n" + .'> TDE功能开通后无法关闭。'."\n" + ."\n" + .'调用本接口时，实例必须满足以下条件：'."\n" + ."\n" + .'- 实例为副本集实例或分片集群实例。'."\n" + .'- 实例的存储引擎为WiredTiger。'."\n" + .'- 实例的存储类型为本地盘版。'."\n" + .'- 实例的数据库版本为4.0或4.2版本，如果实例数据库版本过低，您可以调用[UpgradeDBInstanceEngineVersion](~~67608~~)接口升级数据库版本。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"434D7127-6229-4355-BA50-7A3685A725DF\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyDBInstanceTDEResponse>\\r\\n\\t<RequestId>434D7127-6229-4355-BA50-7A3685A725DF</RequestId>\\r\\n</ModifyDBInstanceTDEResponse>","errorExample":""}]', + ], + 'ModifyGlobalSecurityIPGroup' => [ + 'summary' => '修改云数据库 MongoDB 版的全局IP白名单模板。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'dps', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-fwjk62egbsrp4sftxmmr', + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'required' => true, + 'example' => '27.16.214.10,111.60.117.181', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A0181AC4-F186-46ED-87CA-100C70B86729', + ], + ], + ], + ], + ], + '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' => '修改全局IP白名单模板', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0181AC4-F186-46ED-87CA-100C70B86729\\"\\n}","type":"json"}]', + ], + 'ModifyGlobalSecurityIPGroupName' => [ + 'summary' => '修改全局IP白名单模板名称。', + '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' => '地域ID，您可以通过调用[DescribeRegions](~~61933~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'prod_baoxian_k8s', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-xmtncwkrzqqoe59dzljb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8CA8312-530A-413A-9129-F2BB32A8D404', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板列表', + 'type' => 'array', + 'items' => [ + 'description' => '全局IP白名单模板列表', + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-qiawi8ec1urcx9swoy37', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。', + 'type' => 'string', + 'example' => 'def', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '222.70.197.187', + ], + 'RegionId' => [ + 'description' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改全局IP白名单模板名称', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroupName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => [ + 'summary' => '修改全局白名单模板与MongoDB实例的映射关系。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze6069764423m0l', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-u0qdtybfvxhaxrrhk4n7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA', + ], + ], + ], + ], + ], + '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' => '修改全局白名单模板和实例的映射关系', + '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' => '实例所属的地域ID。您可以通过调用[DescribeDBInstanceAttribute](~~62010~~)进行查询地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp15da1923e3****', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费时长，单位：月。'."\n" + ."\n" + .'取值范围：**1**~**12**（整数）。'."\n" + ."\n" + .'> 当**AutoRenew**参数传入的值为**true**时，本参数才可用，且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值说明：'."\n" + .'- **true**：开启自动续费。'."\n" + .'- **false**：不开启自动续费。'."\n" + ."\n" + .'> 当本参数取值为**true**时，您还需要传入**Duration**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EFD65226-08CC-4C4D-B6A4-CB3C382F67B0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '实例ID不存在。', + ], + [ + 'errorCode' => 'InvalidDbInstanceIdInvalid', + 'errorMessage' => 'Instance dbInstanceId is invalid.', + 'description' => '传入的实例ID无效。', + ], + [ + 'errorCode' => 'InstanceAutoRenewInvalid', + 'errorMessage' => 'Instance auto renewal is invalid.', + 'description' => '', + ], + [ + 'errorCode' => 'InstanceChargeTypeInvalid', + 'errorMessage' => 'Instance charge type is invalid.', + 'description' => '实例收费类型无效。', + ], + [ + 'errorCode' => 'InvalidDuration.Invalid', + 'errorMessage' => 'Instance duration is invalid.', + 'description' => '续费时长无效', + ], + ], + 403 => [ + [ + 'errorCode' => 'ClassicNetworkNotSupport', + 'errorMessage' => 'Classic network has not been supported, try to use VPC.', + 'description' => '当前操作不支持经典网络实例，请使用VPC网络。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '开启或者关闭实例的到期前自动续费功能', + 'summary' => '设置MongoDB实例的自动续费功能。', + 'description' => '请确保在使用该接口前，已充分了解云数据库MongoDB产品的收费方式和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .'本接口仅适用于付费类型为包年包月的实例。'."\n" + ."\n" + .'> 自动续费将于服务到期前9天开始扣款，请保证您的账户资金充足。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例的Mongos节点ID。'."\n" + ."\n" + .'> 实例类型为分片集群实例时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 's-bpxxxxxxxx', + ], + ], + [ + 'name' => 'VpcAuthMode', + 'in' => 'query', + 'schema' => [ + 'description' => '关闭专有网络免密访问功能，取值**Close**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Close', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BA51E9D9-B14A-4542-B6E6-7DE00BECCB8C', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '该功能仅支持4.0版本的最新小版本，请先升级至对应版本再启用。', + ], + ], + ], + 'title' => '关闭实例的专有网络免密访问功能', + 'summary' => '关闭MongoDB实例的专有网络免密访问功能。', + 'description' => '调用本接口时，实例必须满足以下条件：'."\n" + .'- 实例的类型为副本集实例或分片集群实例。'."\n" + .'- 实例的数据库版本为4.0版本、（数据库小版本为mongodb_20190408_3.0.11或以上版本）4.2版本。您可以通过调用[DescribeDBInstanceAttribute](~~62010~~)接口查看版本信息。如果版本过低请调用[UpgradeDBInstanceEngineVersion](~~67608~~)接口升级数据库版本。'."\n" + .'- 实例的网络类型为专有网络。如果网络类型为经典网络，请调用[ModifyDBInstanceNetworkType](~~62138~~)接口将网络类型切换为专有网络。'."\n" + .'- 免密访问功能目前仅支持关闭，不支持开启。', + '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' => [ + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1c0b990184****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Shard节点ID或Mongos节点ID，您可以通过调用[DescribeDBInstanceAttribute](~~62010~~)接口查询。'."\n" + ."\n" + .'> 当传入的值为Shard节点ID时，还需要传入**NodeStorage**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 's-bp143e1b1637****', + ], + ], + [ + 'name' => 'NodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'Shard节点或Mongos节点的规格，规格详情请参见[实例规格表](~~57141~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'dds.mongos.standard', + ], + ], + [ + 'name' => 'NodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Shard节点的存储空间，步长为10，单位：GB。'."\n" + ."\n" + .'- SSD本地盘，取值范围：**10**~**2000**。'."\n" + .'- ESSD PL1云盘，取值范围：**20**~**16000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'FromApp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源，取值说明：'."\n" + .'- **OpenApi**：请求来源为OpenApi。'."\n" + .'- **mongo_buy**：请求来源为控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenApi', + 'default' => 'OpenApi', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费，取值说明：'."\n" + .'- **true**（默认值）：自动付费，请确保账号有足够的余额。'."\n" + .'- **false**：手动付费。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '变更配置的生效时间，取值说明： '."\n" + .'- **Immediately**（默认值）：立即生效。'."\n" + .'- **MaintainTime**：实例可运维时间段内生效。 '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => 'Immediately', + 'enum' => [ + 'Immediately', + 'MaintainTime', + '0', + '1', + 'TimePoint', + '2', + ], + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '变更配置的执行时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> 该参数已废弃，请替换使用 EffectiveTime 参数。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-05T03:18:53Z', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型，取值说明：'."\n" + .'- **UPGRADE**：升配。'."\n" + .'- **DOWNGRADE**：降配 。', + 'type' => 'string', + 'required' => false, + 'example' => 'UPGRADE', + 'default' => 'UPGRADE', + 'enum' => [ + 'UPGRADE', + 'DOWNGRADE', + ], + ], + ], + [ + 'name' => 'ReadonlyReplicas', + 'in' => 'query', + 'schema' => [ + 'description' => '调整Shard节点中只读节点的个数。'."\n" + ."\n" + .'取值范围：**0**~**5**（整数）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5', + 'minimum' => '0', + 'example' => '5', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，业务信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'TargetZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区的目标主可用区。'."\n" + .'><notice>只支持云盘实例。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'TargetSecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区的目标secondary可用区。'."\n" + .'><notice>只支持云盘实例。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-e', + ], + ], + [ + 'name' => 'TargetHiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区的目标Hidden可用区。'."\n" + .'><notice>只支持云盘实例。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'TargetVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区的目标VswitchId。'."\n" + .'><notice>只支持云盘实例。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '61B05CCF-EBAB-4BF3-BA67-D77256A721E2', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21084641369****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GadInstanceNotSupport', + 'errorMessage' => 'GAD Instance doesn\'t support the operation.', + 'description' => '', + ], + ], + ], + 'title' => '变更分片集群实例中节点的规格和存储空间', + 'summary' => '变更MongoDB分片集群实例中节点的规格和存储空间。', + 'description' => '请确保在使用该接口前，您已充分了解MongoDB产品的收费方式和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .'> 该接口仅适用于分片集群实例。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"61B05CCF-EBAB-4BF3-BA67-D77256A721E2\\",\\n \\"OrderId\\": \\"21084641369****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyNodeSpecResponse>\\n <RequestId>61B05CCF-EBAB-4BF3-BA67-D77256A721E2</RequestId>\\n <OrderId>21084641369****</OrderId>\\n</ModifyNodeSpecResponse>","errorExample":""}]', + ], + 'ModifyNodeSpecBatch' => [ + 'summary' => '变更云数据库MongoDB分片集群实例中一个或多个Mongos节点、Shard节点的配置。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要进行变更配置的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1337621e8f****', + ], + ], + [ + 'name' => 'NodesInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '需要变配的Mongos节点、Shard节点的规格信息。具体规格请参见[实例规格表](~~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}]}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费。取值：'."\n" + .'- **true**：自动付费，请确保账号有足够的余额。'."\n" + .'<props="china">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，选择**订购订单**>**我的订单**，在**商品订单**页签找到目标订单进行支付。</props>'."\n" + .'<props="intl">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，单击**订单管理**，在**商品订单**页面找到目标订单进行支付。</props>'."\n" + ."\n" + .'默认值为**true**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '变更配置的生效时间，取值：'."\n" + ."\n" + .'- **Immediately**：立即生效。'."\n" + .'- **MaintainTime**：在实例的可维护时间段内生效。'."\n" + ."\n" + .'> - 您可以调用接口[ModifyDBInstanceMaintainTime](~~62008~~)修改实例的可维护时间段。'."\n" + .'> - 您可以调用接口[DescribeDBInstanceAttribute](~~62010~~)查看实例可维护时间段时间。'."\n" + ."\n" + .'默认为**Immediately**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => 'Immediately', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '变配类型，取值：'."\n" + ."\n" + .'- **UPGRADE**：升级配置。'."\n" + .'- **DOWNGRADE**：降级配置。'."\n" + ."\n" + .'> 当实例付费方式为包年包月时，该参数可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'UPGRADE', + 'default' => 'UPGRADE', + 'enum' => [ + 'UPGRADE', + 'DOWNGRADE', + ], + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'TargetVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区同时变配的目标虚拟交换机ID。'."\n" + .'><notice>只支持云盘实例。></notice>'."\n" + .'> '."\n" + .'> - 只有在迁移可用区同时变配才需要传入此参数', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxxxxxxx', + ], + ], + [ + 'name' => 'TargetHiddenZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区同时变配时，隐藏节点（Hidden节点）的目标可用区。'."\n" + .'><notice>只支持云盘实例。></notice>'."\n" + .'><notice>该参数取值不能与TargetZoneId和TargetSecondaryZoneId参数值相同。></notice>'."\n" + ."\n" + .'> '."\n" + .'> - 只有在迁移可用区同时变配才需要传入此参数', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-e', + ], + ], + [ + 'name' => 'TargetZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区同时变配时，主节点（Primary节点）的目标可用区。'."\n" + .'><notice>只支持云盘实例。></notice>'."\n" + .'><notice>该参数取值不能与TargetSecondaryZoneId和TargetHiddenZoneId参数值相同。></notice>'."\n" + .'> '."\n" + .'> - 只有在迁移可用区同时变配才需要传入此参数', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'TargetSecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '迁移可用区同时变配时，从节点（Secondary节点）的目标可用区。'."\n" + .'><notice>只支持云盘实例。></notice>'."\n" + .'><notice>该参数取值不能与TargetZoneId和TargetHiddenZoneId参数值相同。></notice>'."\n" + .'> '."\n" + .'> - 只有在迁移可用区同时变配才需要传入此参数', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21012719476****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0637BC25-6895-5500-871F-1127CA34****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GadInstanceNotSupport', + 'errorMessage' => 'GAD Instance doesn\'t support the operation.', + 'description' => '', + ], + ], + ], + 'title' => '批量修改节点规格', + 'description' => '请确保在使用该接口前，已充分了解云数据库MongoDB产品的收费方式和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .' 该接口仅适用于云数据库MongoDB分片集群实例。'."\n" + ."\n" + .'对多个分片集群实例进行批量升降配操作时，目标规格会受到一定的约束，例如存储空间扩容，目标容量需大于等于当前容量。当多个分片集群实例规格不一致的时候，会随机选择一个分片集群实例的规格去构造约束条件，可能出现无法升降配的情况。'."\n" + .'如果遇到无法正常进行批量升降配的情况，建议选择使用ModifyNodeSpec接口对单个分片集群实例进行变配。', + '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' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"21012719476****\\",\\n \\"RequestId\\": \\"0637BC25-6895-5500-871F-1127CA34****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyNodeSpecBatchResponse>\\n <RequestId>0637BC25-6895-5500-871F-1127CA34****</RequestId>\\n <OrderId>21012719476****</OrderId>\\n</ModifyNodeSpecBatchResponse>","errorExample":""}]', + ], + 'ModifyParameters' => [ + 'summary' => '修改MongoDB实例的参数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '8337', + 'abilityTreeNodes' => [ + 'FEATUREmongodbDMJK05', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~61933~~)接口查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + .'>当本参数传入的是分片集群实例ID时，还需要传入NodeId参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp19f409d75****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中的Mongos节点ID或Shard节点ID。'."\n" + .'>当DBInstanceId参数传入的是分片集群实例ID时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp1b7bb3bbe****', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的参数及参数值，格式为JSON串，例如：{"ParameterName1":"ParameterValue1","ParameterName2":"ParameterValue2"}。'."\n" + .'>您可以通过调用[DescribeParameterTemplates](~~67618~~)接口查询默认的参数模板列表。', + 'type' => 'string', + 'required' => true, + 'example' => '{"operationProfiling.mode":"all","operationProfiling.slowOpThresholdMs":"200"}', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的角色类型，取值说明：'."\n" + ."\n" + .'- **db**：shard角色。'."\n" + .'- **cs**：config server角色。'."\n" + .'- **mongos**：mongos角色。', + 'type' => 'string', + 'required' => false, + 'example' => 'db', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '修改MongoDB实例参数的时间点，取值：'."\n" + ."\n" + .'- 0：立刻修改。'."\n" + ."\n" + .'- 1：在可运维时间内修改。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '0', + '1', + ], + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36923CC2-DDAB-4B48-A144-DA92C1E19537', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + 'description' => '输入的参数无效。', + ], + [ + 'errorCode' => 'InvalidParameterForInstanceVersion', + 'errorMessage' => 'Parameter %s is not valid for instance\'s MinorVersion.', + 'description' => '当前实例小版本不支持参数 %s，请尝试升级小版本。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter %s is not valid.', + 'description' => '参数 %s 非有效参数。', + ], + [ + 'errorCode' => 'OplogSizeLowerThanInstanceStorage', + 'errorMessage' => 'The oplogSizeMB parameter entered is less than 10% of the instance store size.', + 'description' => '输入的oplogSizeMB参数低于实例存储大小的10%。', + ], + ], + ], + 'title' => '修改MongoDB实例的参数', + 'description' => '- 调用本接口时，云数据库MongoDB实例的状态为运行中。'."\n" + .'- 如果修改的参数中包含需要重启才能生效的参数，调用本接口后实例将自动重启。您可以调用[DescribeParameterTemplates](~~67618~~)接口查询哪些参数修改后需要重启实例才能生效。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36923CC2-DDAB-4B48-A144-DA92C1E19537\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyParametersResponse>\\n <RequestId>36923CC2-DDAB-4B48-A144-DA92C1E19537</RequestId>\\n</ModifyParametersResponse>","errorExample":""}]', + ], + 'ModifyResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1366caac83****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。资源组详情请参见查看[资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5DD0DEC3-24A1-5268-8E0B-5B264CA1****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceGroupId.InValid', + 'errorMessage' => 'The Specified ResourceGroupId is not valid.', + 'description' => '指定的ResourceGroupId无效。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbInstanceId.NotFound', + 'errorMessage' => 'Specified instance does not exist.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidStatus.NotFound', + 'errorMessage' => 'Instance status is invalid.', + 'description' => '', + ], + ], + ], + 'title' => '移动到指定资源组', + 'summary' => '将MongoDB实例移动到指定资源组。', + 'description' => '通过资源管理服务，您可以按照业务需要搭建合适的资源组织关系，使用目录、资源夹、账号以及资源组，分层次地组织和管理您的云资源。详情请参见[什么是资源管理](~~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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5DD0DEC3-24A1-5268-8E0B-5B264CA1****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyResourceGroupResponse>\\n <RequestId>5DD0DEC3-24A1-5268-8E0B-5B264CA1****</RequestId>\\n</ModifyResourceGroupResponse>","errorExample":""}]', + ], + 'ModifySecurityGroupConfiguration' => [ + 'summary' => '更改MongoDB实例已绑定的ECS安全组。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS安全组ID。'."\n" + ."\n" + .'> - 1个实例最多可以绑定10个ECS安全组。'."\n" + .'> - 您可以通过调用ECS的[DescribeSecurityGroup](~~25556~~)接口查询目标地域的安全组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sg-bpxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E062C482-1A4B-469E-938C-96D28CFAE42E', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '不同的 VPC 不支持。', + ], + ], + 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' => '更改MongoDB实例已绑定的ECS安全组', + 'description' => '> 如果是分片集群实例，绑定的ECS安全组仅对Mongos节点生效。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E062C482-1A4B-469E-938C-96D28CFAE42E\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E062C482-1A4B-469E-938C-96D28CFAE42E</RequestId>","errorExample":""}]', + ], + 'ModifySecurityIps' => [ + 'summary' => '修改MongoDB实例的IP白名单。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dds-bp*****', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单分组下的IP列表，多个IP地址请以半角逗号（,）隔开，不可重复，最多1000个。支持如下两种格式：'."\n" + .'- IP地址形式，例如：127.0.0.1。'."\n" + .'- CIDR形式，例如：127.0.0.1/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '127.0.0.1/24,127.0.0.1', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => '修改方式，取值：'."\n" + .'- **Cover**：覆盖原白名单。'."\n" + .'- **Append**：追加白名单，有重复IP时报错。'."\n" + .'- **Extend**：追加白名单，有重复IP时合并。'."\n" + .'- **Delete**：删除该白名单。'."\n" + ."\n\n" + .'默认取值为**Cover**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Append', + 'default' => '0', + 'enum' => [ + 'Cover', + 'Append', + 'Delete', + 'Extend', + ], + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '进行修改的IP白名单所属分组名称，默认为**default**分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'allowserver', + ], + ], + [ + 'name' => 'SecurityIpGroupAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单分组属性。支持大写字母、小写字母、数字，长度最大为120个字符。'."\n" + ."\n" + .'默认为空字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '61B05CCF-EBAB-4BF3-BA67-D77256A721E2', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '设置可以访问实例的 IP 白名单地址', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"61B05CCF-EBAB-4BF3-BA67-D77256A721E2\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifySecurityIpsResponse>\\r\\n\\t<RequestId>61B05CCF-EBAB-4BF3-BA67-D77256A721E2</RequestId>\\r\\n</ModifySecurityIpsResponse>","errorExample":""}]', + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1fd530f271****', + ], + ], + [ + 'name' => 'NewConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '新的连接地址，要求如下：'."\n" + .'- 以小写字母开头。'."\n" + .'- 以小写字母或数字结尾。'."\n" + .'- 由小写字母、数字和连字符（-） 组成。'."\n" + .'- 长度为8~63个字符。'."\n" + ."\n" + .'> 仅需传入连接地址的前缀部分，前缀以外的部分不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyuntest111', + ], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的SRV地址类型，可选值：'."\n" + .'- **VPC**：专有网络'."\n" + .'- **Public**：公网连接', + 'type' => 'string', + 'required' => true, + 'example' => 'VPC', + 'enum' => [ + 'VPC', + 'Public', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '45D2B592-DEBA-4347-BBF3-xxxxxC97DBBC', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NewConnectionString.NotSupport', + 'errorMessage' => 'Specified newConnectionString is not supported.', + 'description' => 'newConnectionString 格式错误。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'currentConnectionString is mandatory for this action.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidConnectionStringOrPort.Duplicate', + 'errorMessage' => 'Specified connection string or port already exists.', + 'description' => '指明的连接串或port信息已存在，请检查后重新提交。', + ], + ], + ], + 'title' => '修改MongoDB实例的SRV连接地址', + 'summary' => '修改MongoDB实例的SRV连接地址', + 'description' => '仅适用于云盘副本集实例与云盘分片集群实例。', + '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' => '地域ID，您可以调用[DescribeRegions](~~61933~~)查询。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务id，多个英文逗号分隔，最多支持10个。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't-83br18hlpdrw3uxxxx', + ], + ], + [ + 'name' => 'StepName', + 'in' => 'query', + 'schema' => [ + 'description' => '当前用户可见的步骤名。', + 'type' => 'string', + 'required' => true, + 'example' => 'exec_task'."\n", + ], + ], + [ + 'name' => 'TaskAction', + 'in' => 'query', + 'schema' => [ + 'description' => '操作名，值为[DescribeHistoryTasks](~~2639186~~)得到的actionInfo内相应状态对应的操作action名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'modifySwitchTime', + ], + ], + [ + 'name' => 'ActionParams', + 'in' => 'query', + 'schema' => [ + 'description' => '动作相关的参数，根据业务需要扩展，不同的taskAction名需传不同的值。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"recoverMode\\":\\"immediate\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6163731A-XXXX-XXXX-B934-3388DE70C217', + ], + 'ErrorTaskId' => [ + 'description' => '失败的任务ID，遇到一个失败即返回。', + 'type' => 'string', + 'example' => '""', + ], + 'SuccessCount' => [ + 'description' => '成功记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'ErrorCode' => [ + 'description' => '失败错误码，同接口错误码。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'title' => '任务中心修改任务信息', + 'summary' => '任务操作，修改任务中心的任务信息。', + 'description' => '根据任务当前状态进行相关操作，支持的操作需根据 接口获得的任务actionInfo识别。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyTaskInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6163731A-XXXX-XXXX-B934-3388DE70C217\\",\\n \\"ErrorTaskId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"SuccessCount\\": \\"1\\",\\n \\"ErrorCode\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + ], + 'ReleaseNodePrivateNetworkAddress' => [ + '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' => '分片集群实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1a7009eb24****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Shard节点或ConfigServer节点的ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询Shard节点或ConfigServer节点的ID。'."\n" + .'><notice>当释放srv地址时，此处填写实例ID即可。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp128a003436****', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '该节点内网连接地址所属的网络类型，取值：'."\n" + .'- **VPC**：专有网络。'."\n" + .'- **Classic**：经典网络。'."\n" + ."\n" + .'> 您可以调用[DescribeShardingNetworkAddress](~~62135~~)接口查询该节点的内网连接地址所属的网络类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '公网地址类型，可选值：'."\n" + .'- **SRV**'."\n" + .'- **Normal**'."\n" + .'>当释放的连接地址是SRV地址时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'SRV', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0FDDC511-7252-4A4A-ADDA-5CB1BF63873D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GadInstanceNotSupport', + 'errorMessage' => 'GAD Instance doesn\'t support the operation.', + 'description' => '', + ], + ], + ], + 'title' => '释放节点或节点内网连接地址', + 'summary' => '释放分片集群实例的Shard节点或ConfigServer节点的内网连接地址。', + 'description' => '- 本接口用于释放分片集群实例中Shard节点或ConfigServer节点的内网连接地址。更多信息请参见[释放Shard或ConfigServer节点连接地址](~~134067~~)。'."\n" + .'- 如果需要释放分片集群实例中Shard节点或ConfigServer节点的公网连接地址，您可以通过调用[ReleasePublicNetworkAddress](~~67604~~)接口释放。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0FDDC511-7252-4A4A-ADDA-5CB1BF63873D\\"\\n}","errorExample":""},{"type":"xml","example":"<ReleaseNodePrivateNetworkAddressResponse>\\r\\n\\t<RequestId>EFD65226-08CC-4C4D-B6A4-CB3C382F67B0</RequestId>\\r\\n</ReleaseNodePrivateNetworkAddressResponse>","errorExample":""}]', + ], + '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' => '实例ID。'."\n" + ."\n" + .'> 当本参数传入的是分片集群实例ID时，还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID、Shard节点ID或ConfigServer节点ID。'."\n" + ."\n" + .'> - 当**DBInstanceId**传入的是分片集群实例ID时，本参数才可用。'."\n" + .'> - 您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询Mongos/Shard/ConfigServer节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 's-bp2235****', + ], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '公网地址类型，可选值：'."\n" + .'- **SRV**'."\n" + .'- **Normal**'."\n" + .'>当释放的连接地址是SRV地址时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'SRV', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1D6AFE36-1AF5-4DE4-A954-672159D4CC69', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '释放实例公网地址', + 'summary' => '释放MongoDB实例的公网连接地址。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1D6AFE36-1AF5-4DE4-A954-672159D4CC69\\"\\n}","errorExample":""},{"type":"xml","example":"<ReleasePublicNetworkAddressResponse>\\n <RequestId>1D6AFE36-1AF5-4DE4-A954-672159D4CC69</RequestId>\\n</ReleasePublicNetworkAddressResponse>","errorExample":""}]', + ], + 'RenewDBInstance' => [ + 'summary' => '手动续费包年包月的MongoDB实例。', + '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' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '实例续费时长，单位为月。取值：**1~9，12，24，36**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费。取值：'."\n" + .'- **true**：自动付费，请确保账号有足够的余额。'."\n" + .'<props="china">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，选择**订购订单**>**我的订单**，在**商品订单**页签找到目标订单进行支付。</props>'."\n" + .'<props="intl">- **false**：控制台手动付费。您可以登录云数据库MongoDB控制台，在页面右上角选择**费用** > **费用与成本**，在左侧导航栏，单击**订单管理**，在**商品订单**页面找到目标订单进行支付。</props>'."\n" + ."\n" + .'默认值为：**true**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值说明：'."\n" + .'- **true**：开启自动续费。'."\n" + .'- **false**：不开启自动续费。'."\n" + ."\n" + .'默认值为 **false**', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B118EF45-9633-4EE3-8405-42ED4373721B', + ], + 'OrderId' => [ + 'description' => '生成的订单ID。', + 'type' => 'string', + 'example' => '203317xxxxxxxx', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '当前操作不支持经典网络实例，请使用VPC网络。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '手动续费包年包月的实例', + 'description' => '<props="china">请确保在使用该接口前，已充分了解云数据库MongoDB版产品的收费方式和[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props>。'."\n" + .'<props="intl">请确保在使用该接口前，已充分了解云数据库MongoDB版产品的收费方式和[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .'该接口仅适用于付费类型为包年包月的实例。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B118EF45-9633-4EE3-8405-42ED4373721B\\",\\n \\"OrderId\\": \\"203317xxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<RenewDBInstanceResponse>\\r\\n\\t<OrderId>2033xxxxxxxx</OrderId>\\r\\n\\t<RequestId>B118EF45-9633-4EE3-8405-42ED4373721B</RequestId>\\r\\n</RenewDBInstanceResponse>","errorExample":""}]', + ], + 'ResetAccountPassword' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要重置密码的账号，取值：**root**。', + 'type' => 'string', + 'required' => true, + 'example' => 'root', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '重置后的密码，即修改后的密码。'."\n" + ."\n" + .'- 密码由大写字母、小写字母、数字、特殊字符中的任意三种组成，特殊字符为`!@#$%^&*()_+-=`'."\n" + .'- 密码长度为8-32位。'."\n" + ."\n" + .'> 特殊字符的处理方法，请参见[如何解决连接串中账号密码包含特殊字符导致连接失败的问题？](~~471568~~)', + 'type' => 'string', + 'required' => true, + 'example' => 'Ali!123456', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '实例的角色类型，取值说明'."\n" + ."\n\n" + .'- 当实例类型为分片集群时，charactertype为必选； 取值为db 和cs。'."\n" + .'- 当实例类型为副本集时，charactertype 可为空或传入normal。', + 'type' => 'string', + 'required' => false, + 'example' => 'db', + 'enum' => [ + 'db', + 'cs', + 'normal', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06CBD06E-ABC9-4121-AB93-3C3820B3E7E6', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'Specified parameter AccountPassword is not valid.', + 'description' => '指定的参数AccountPassword无效。', + ], + [ + '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' => '重置MongoDB实例中root账号的密码', + 'summary' => '重置MongoDB实例中数据库账号的密码。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"06CBD06E-ABC9-4121-AB93-3C3820B3E7E6\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ResetAccountPasswordResponse>\\r\\n\\t<RequestId>06CBD06E-ABC9-4121-AB93-3C3820B3E7E6</RequestId>\\r\\n</ResetAccountPasswordResponse>","errorExample":""}]', + ], + 'RestartDBInstance' => [ + 'summary' => '重启MongoDB实例。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Shard节点ID或Mongos节点ID。'."\n" + ."\n" + .'> 当实例类型为分片集群实例时，如不传入本参数，则重启分片集群实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '重启实例的时间点。取值：'."\n" + .'- 0：立即切换。'."\n" + .'- 1：在可运维时间段内切换。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '149C517D-B586-47BE-A107-8673E0ED77C6', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '重启MongoDB实例', + 'description' => '调用本接口可用于重启实例，也可用于重启分片集群实例中的某个Shard节点或Mongos节点。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"149C517D-B586-47BE-A107-8673E0ED77C6\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<RestartDBInstanceResponse>\\r\\n\\t<RequestId>149C517D-B586-47BE-A107-8673E0ED77C6</RequestId>\\r\\n</RestartDBInstanceResponse>\\r\\n","errorExample":""}]', + ], + 'RestartNode' => [ + 'summary' => '重启MongoDB实例的单个节点。', + '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' => ' 实例ID。 '."\n" + .'> 如果是分片集群实例，您还需要配置`NodeId`。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Mongos节点ID、Shard节点ID或ConfigServer节点ID。您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询Mongos节点、Shard节点或ConfigServer节点的节点ID。'."\n" + ."\n" + .'> 当**DBInstanceId**配置的是分片集群实例ID时，需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bp128a003436****', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => [ + 'description' => '节点的角色ID.'."\n" + ."\n" + .'1. 可以调用 [DescribeReplicaSetRole](~~468469~~) 接口查询副本集实例的节点ID。'."\n" + .'2. 可以调用 [DescribeRoleZoneInfo](~~468472~~) 接口查询分片集群实例的节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => '6025****', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '执行时间，取值：'."\n" + .'* **0**：立即执行，默认值。'."\n" + .'* **1**：在可维护时间段执行。'."\n" + ."\n" + .'> 您可以调用[ModifyInstanceMaintainTime](~~473775~~)修改实例的可维护时间段。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ECBCA991-XXXX-XXXX-834C-B3E8007F33AA', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '重启MongoDB实例的单个节点', + 'description' => '接口使用限制：'."\n" + .'* 实例在运行状态。'."\n" + ."\n" + .'* 实例为标准副本集或分片集群。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '分片集群实例中Shard节点的ID。'."\n" + ."\n" + .'> 当**DBInstanceId**参数传入的是分片集群实例ID时，本参数必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'd-bpxxxxxxxx', + ], + ], + [ + 'name' => 'RoleIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要执行切换的角色ID。您可以调用[DescribeRoleZoneInfo](~~123802~~)接口获取角色ID和节点角色信息。'."\n" + ."\n" + .'> - 角色ID以英文逗号（,）分隔，不传入本参数则切换主备节点。'."\n" + .'> - 当**DBInstanceId**参数传入的是分片集群实例ID时，执行切换的角色必须属于同一Shard节点中。', + 'type' => 'string', + 'required' => false, + 'example' => '972xxxx,972xxxx', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '切换主备节点的时间点。取值：'."\n" + .'- 0：立即切换。'."\n" + .'- 1：在可运维时间段内切换。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '26BD4E5F-BDB4-47BA-B232-413AA78CFA8F', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '切换实例中的主备节点', + 'summary' => '切换MongoDB实例中的主备节点。', + 'description' => '调用本接口时，实例状态要求为运行中。'."\n" + ."\n" + .'> - 本接口适用于副本集实例和分片集群实例，暂不支持单节点实例。'."\n" + .'> - 副本集实例以实例为单位进行切换，分片集群实例以Shard为单位进行切换。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"26BD4E5F-BDB4-47BA-B232-413AA78CFA8F\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<SwitchDBInstanceHAResponse>\\r\\n\\t<RequestId>26BD4E5F-BDB4-47BA-B232-413AA78CFA8F</RequestId>\\r\\n</SwitchDBInstanceHAResponse>","errorExample":""}]', + ], + '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' => '实例所属的地域ID，您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值固定为**INSTANCE**。', + 'type' => 'string', + 'required' => true, + 'example' => 'INSTANCE', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例和标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例列表。'."\n" + ."\n" + .'N表示传入第几个实例的ID，N的取值范围为1~50。例如：'."\n" + .'- **ResourceId.1**表示传入第一个实例ID。'."\n" + .'- **ResourceId.2**表示传入第二个实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bp1fa5efaa93****', + ], + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。'."\n" + ."\n" + .'N表示传入第几个标签的键，N的取值范围为1~20。例如：'."\n" + .'- **Tag.1.Key**表示传入第一个标签的键。'."\n" + .'- **Tag.2.Key**表示传入第二个标签的键。', + 'type' => 'string', + 'required' => true, + 'example' => '开发组', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + ."\n" + .'N表示传入第几个标签的值，N的取值范围为1~20。例如：'."\n" + .'- **Tag.1.Value**表示传入第一个标签的值。'."\n" + .'- **Tag.2.Value**表示传入第二个标签的值。', + 'type' => 'string', + 'required' => true, + 'example' => '4.0环境', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0FDDC511-7252-4A4A-ADDA-5CB1BF63****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'description' => '指定的参数“Tag.n.Key”或“TagKey.n”无效。', + ], + [ + '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' => '为一个或多个MongoDB实例绑定标签', + 'summary' => '为一个或多个MongoDB实例绑定标签。', + 'description' => '在实例数量较多的情况下，您可以创建多个标签，为实例绑定不同的标签对其进行分类，后续可通过标签筛选实例。'."\n" + .'- 标签由一对键（key）值（value）组成，键在同账号同地域下唯一，值无此限制。'."\n" + .'- 若设置的标签不存在，则自动创建该标签并绑定到目标实例。'."\n" + .'- 若实例已经绑定了有相同键的标签，则会覆盖绑定。'."\n" + .'- 每个实例最多可以绑定20个标签。'."\n" + .'- 每次调用最多可以对50个实例执行批量标签绑定。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0FDDC511-7252-4A4A-ADDA-5CB1BF63****\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>0FDDC511-7252-4A4A-ADDA-5CB1BF63****</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + ], + 'TransferClusterBackup' => [ + 'summary' => '将云数据库 MongoDB 版分片集群实例的备份模式切换为集群备份模式。切换至集群备份模式后，实例将支持高频备份。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AlreadyDone' => [ + 'description' => '是否已切换成集群备份模式。**1**表示已完成切换。', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C4A2494-85C4-45C5-93CF-548DB3375193', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '切换至集群备份模式', + 'description' => '- 云数据库 MongoDB 版实例需要为分片集群实例，且大版本为4.4及以上版本，存储模式为ESSD云盘版。'."\n" + .'- 仅2023年10月19日之前创建的实例需要执行本操作切换至集群备份模式，2023年10月19日及以后新建的MongoDB云盘版分片集群实例默认为集群备份模式。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-2ze55b3ec56c****', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费时长，取值范围为：'."\n" + ."\n" + .'- 当PricingCycle单位为Month:**1**~**9**'."\n" + ."\n" + .'- 当PricingCycle单位为Year: **1**、**2**、**3**、**5**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动支付订单，取值说明：'."\n" + ."\n" + .'- **true**：自动支付订单。'."\n" + .'- **false**：手动支付订单。'."\n" + ."\n" + .'> 默认值为**true**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '到期后是否自动续费，取值说明：'."\n" + ."\n" + .'- **true**：自动续费。'."\n" + .'- **false**：手动续费。'."\n" + ."\n" + .'> 默认值为**false**。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例付费类型，取值说明：'."\n" + .'- **PrePaid**：预付费，包年包月。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'required' => true, + 'example' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + 'PREPAY', + 'POSTPAY', + ], + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '实例付费时长单位'."\n" + .'取值说明：'."\n" + .'- **Month：** 月'."\n" + .'- **Year：** 年'."\n" + ."\n" + .'默认值：Month'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + 'default' => 'Month', + 'enum' => [ + 'Month', + 'Year', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D8F1D721-6439-4257-A89C-F1E8E9C9****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21084641369****', + ], + ], + ], + ], + ], + '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' => '该实例已经是预付费', + ], + [ + 'errorCode' => 'RealNameAuthenticationError', + 'errorMessage' => 'Your account has not passed the real-name authentication yet.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '转换云数据库MongoDB实例的付费类型', + 'summary' => '转换云数据库MongoDB实例的付费类型，将按量付费（后付费）实例转换为包年包月（预付费）实例或者包年包月实例转换为按量付费实例。', + 'description' => '请确保在使用该接口前，已充分了解MongoDB产品的收费方式和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n\n" + ."\n" + .'调用本接口时，实例必须满足以下条件：'."\n" + ."\n" + .'- 实例状态为运行中。'."\n" + .'- 实例没有未完成支付的转换付费类型订单。'."\n" + .'- 实例规格不能为历史规格（不再售卖的规格），历史规格列表请参见[实例规格表](~~57141~~)。'."\n" + ."\n" + .'> 如需转换历史规格实例的付费类型，请先调用[ModifyDBInstanceSpec](~~61816~~)或[ModifyNodeSpec](~~61923~~)接口变更实例规格。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp1366caac83****', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费时长，单位为月。取值范围为**1**~**9**、**12**、**24**、**36**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动支付订单，取值：'."\n" + ."\n" + .'- **true**：自动支付订单。'."\n" + .'- **false**：手动支付订单，详情请参见[手动续费包年包月实例](~~85052~~)。'."\n" + ."\n" + .'> 默认值为**true**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{“ActivityId":"000000000"}', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '到期后是否自动续费，取值：'."\n" + ."\n" + .'- **true**：自动续费。'."\n" + .'- **false**：手动续费。'."\n" + ."\n" + .'> 默认值为**false**。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + .'- **default**或**null**（默认）：使用优惠券。'."\n" + .'- **youhuiquan_promotion_option_id_for_blank**：不使用优惠券。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2F42BB4E-461F-5B55-A37C-53B1141C****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21022019252****', + ], + ], + 'description' => '', + ], + ], + ], + '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' => '该实例已经是预付费', + ], + [ + 'errorCode' => 'RealNameAuthenticationError', + 'errorMessage' => 'Your account has not passed the real-name authentication yet.', + 'description' => '', + ], + ], + ], + 'title' => '将按量付费实例转换为包年包月实例', + 'summary' => '将按量付费的MongoDB实例转换为包年包月（预付费）实例。', + 'description' => '请确保在使用该接口前，已充分了解MongoDB产品的收费方式和和和<props="china">[价格](https://www.aliyun.com/price/product#/mongodb/detail)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing)</props>。'."\n" + ."\n" + .'包年包月的实例无法转换为按量付费的实例，为避免浪费您的资源，请谨慎操作。'."\n" + ."\n\n" + .'调用本接口时，实例必须满足以下条件：'."\n" + ."\n" + .'- 实例状态为运行中。'."\n" + .'- 实例的计费类型为按量付费。'."\n" + .'- 实例没有未完成支付的转包年包月订单。'."\n" + .'- 实例规格不能为历史规格（不再售卖的规格），历史规格列表请参见[实例规格表](~~57141~~)。'."\n" + ."\n" + .'> 如需将历史规格实例转变为包年包月，请先调用[ModifyDBInstanceSpec](~~61816~~)或[ModifyNodeSpec](~~61923~~)接口变更实例规格。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2F42BB4E-461F-5B55-A37C-53B1141C****\\",\\n \\"OrderId\\": \\"21022019252****\\"\\n}","errorExample":""},{"type":"xml","example":"<TransformToPrePaidResponse>\\n <RequestId>2F42BB4E-461F-5B55-A37C-53B1141C****</RequestId>\\n <OrderId>21022019252****</OrderId>\\n</TransformToPrePaidResponse>","errorExample":""}]', + ], + 'UntagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属的地域ID，您可以调用[DescribeDBInstanceAttribute](~~62010~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值固定为**INSTANCE**。', + 'type' => 'string', + 'required' => true, + 'example' => 'INSTANCE', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解绑实例上的所有标签，取值：'."\n" + .'- **true**：解绑实例上的所有标签。'."\n" + .'- **false**：不解绑实例上的所有标签。'."\n" + ."\n" + .'> - 默认值为**false**。'."\n" + .'> - 如果同时传入**TagKey**和本参数，本参数不生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bpxxxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dds-bpxxxxxxxx', + ], + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源的标签键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'PRODUCT', + ], + 'required' => false, + 'example' => '开发组', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FA3A7F36-DB57-4281-8935-4B9DF61554EB', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'description' => '指定的参数“Tag.n.Key”或“TagKey.n”无效。', + ], + [ + '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' => '将标签从实例中解绑', + 'summary' => '如果该标签没有绑定到其他实例，则该标签会被删除。', + 'description' => '> - 单次解绑的标签数量不能超过20个。'."\n" + .'> - 当某个标签从所有绑定的实例中解绑后，该标签会被自动删除。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FA3A7F36-DB57-4281-8935-4B9DF61554EB\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FA3A7F36-DB57-4281-8935-4B9DF61554EB</RequestId>","errorExample":""}]', + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bpxxxxxxxx', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '升级的目标数据库版本。'."\n" + ."\n" + .'> 实例的存储引擎对数据库版本的选择有约束性，详情请参见[MongoDB数据库版本升级说明](~~398673~~)，您也可以调用[DescribeAvailableEngineVersion](~~468471~~)接口查询实例可升级的版本。', + 'type' => 'string', + 'required' => true, + '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', + ], + 'example' => '4.0', + 'enum' => [ + '3.4', + '4.0', + '4.2', + '4.4', + '5.0', + '6.0', + '7.0', + '8.0', + ], + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '实例版本升级模式。取值：'."\n" + ."\n" + .'- 0：立即升级。'."\n" + .'- 1：在可运维时间段内升级。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '1', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C4907B00-A208-4E0C-A636-AA85140E406C', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineVersion.ERROR', + 'errorMessage' => 'Target engineVersion must be greater than the current one.', + 'description' => '', + ], + ], + ], + 'title' => '升级实例的数据库版本', + 'summary' => '升级MongoDB实例的数据库版本。', + 'description' => '调用本接口时，要求实例状态为运行中。'."\n" + ."\n" + .'> - 实例的存储引擎对数据库版本的选择有约束性，详情请参见[MongoDB数据库版本升级说明](~~398673~~)，您也可以调用[DescribeAvailableEngineVersion](~~141355~~)接口查询实例可升级的版本。'."\n" + .'> - 升级数据库版本后不支持降级数据库版本。'."\n" + .'> - 升级过程中会自动对实例进行2-3次重启，请确保在业务低峰执行。', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C4907B00-A208-4E0C-A636-AA85140E406C\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UpgradeDBInstanceEngineVersionResponse>\\r\\n\\t<RequestId>C4907B00-A208-4E0C-A636-AA85140E406C</RequestId>\\r\\n</UpgradeDBInstanceEngineVersionResponse>","errorExample":""}]', + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dds-bp2235****', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '实例版本升级模式。取值：'."\n" + ."\n" + .'- 0：立即升级。'."\n" + .'- 1：在可运维时间段内升级。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'maxLength' => 1, + 'minLength' => 0, + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '27B9A130-7C4B-40D9-84E8-2FC081097AAC', + ], + ], + ], + ], + ], + 'title' => '升级实例的数据库小版本', + 'summary' => '升级MongoDB实例的数据库小版本。', + 'description' => '调用UpgradeDBInstanceKernelVersion接口时，实例状态必须为运行中。'."\n" + ."\n" + .'> - UpgradeDBInstanceKernelVersion接口适用于副本集实例和分片集群实例，暂不支持单节点实例。'."\n" + .'> - 升级过程中，实例会被重启一次，请在业务低峰期执行该操作。', + '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' => '华南2（河源）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'regionName' => '华北6（乌兰察布）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-beijing', + 'regionName' => '华北2（北京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'regionName' => '郑州（联通合营）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北1（青岛）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.cn-qingdao.aliyuncs.com', + 'endpoint' => 'mongodb.cn-qingdao.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'regionName' => '华中1（武汉-本地地域）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华东2（上海）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'regionName' => '中国香港', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.cn-hongkong.aliyuncs.com', + 'endpoint' => 'mongodb.cn-hongkong.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'regionName' => '华北3（张家口）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.cn-zhangjiakou.aliyuncs.com', + 'endpoint' => 'mongodb.cn-zhangjiakou.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'regionName' => '华南1（深圳）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'regionName' => '华东5（南京-本地地域）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.cn-nanjing.aliyuncs.com', + 'endpoint' => 'mongodb.cn-nanjing.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'regionName' => '韩国（首尔）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '日本（东京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华东6（福州-本地地域）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.cn-fuzhou.aliyuncs.com', + 'endpoint' => 'mongodb.cn-fuzhou.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'regionName' => '西南1（成都）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.cn-chengdu.aliyuncs.com', + 'endpoint' => 'mongodb.cn-chengdu.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'regionName' => '华南3（广州）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.cn-guangzhou.aliyuncs.com', + 'endpoint' => 'mongodb.cn-guangzhou.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'regionName' => '新加坡', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '澳大利亚（悉尼）已关停', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '马来西亚（吉隆坡）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北5（呼和浩特）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.cn-huhehaote.aliyuncs.com', + 'endpoint' => 'mongodb.cn-huhehaote.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'regionName' => '印度尼西亚（雅加达）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '菲律宾（马尼拉）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '泰国（曼谷）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华东1（杭州）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'regionName' => '美国（弗吉尼亚）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '英国（伦敦）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '美国（硅谷）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '德国（法兰克福）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '阿联酋（迪拜）', + 'areaId' => 'middleEast', + 'areaName' => '中东', + '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' => '沙特（利雅得）', + 'areaId' => 'middleEast', + 'areaName' => '中东', + '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' => '印度（孟买）已关停', + 'areaId' => 'middleEast', + 'areaName' => '中东', + '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' => '华东1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + 'public' => 'mongodb.aliyuncs.com', + 'endpoint' => 'mongodb.aliyuncs.com', + 'vpc' => 'mongodb-vpc.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'regionName' => '华南1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '华北2 金融云（邀测）', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '华东2 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '账户不存在。', + ], + [ + 'code' => 'AccountNoPermission', + 'message' => 'Account has no permission to refund.', + 'http_code' => 400, + 'description' => '您没有权限操作，请联系主账号前往控制台授权，需要授权的Action为： bss:RefundBatchRemainRefund', + ], + [ + 'code' => 'AccountNotExists', + 'message' => 'Account not exists.', + 'http_code' => 404, + 'description' => '账户信息不存在。', + ], + [ + 'code' => 'ADSDiskEncryptionSLRNotExist', + 'message' => 'SLR for [diskencryption.aliyuncs.com] do not exist, please create it first.', + 'http_code' => 400, + 'description' => 'KMS 服务异常。', + ], + [ + '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' => '不允许集团内部用户购买。', + ], + [ + 'code' => 'AlreadyPostPaid', + 'message' => 'This instance is already postpaid.', + 'http_code' => 400, + 'description' => '当前实例已经是后付费实例。', + ], + [ + 'code' => 'AlreadyPrePaid', + 'message' => 'This instance is already prepaid', + 'http_code' => 403, + 'description' => '该实例已经是预付费', + ], + [ + 'code' => 'ARTICLE_NOT_FOUND', + 'message' => 'CommodityCode cannot be found.', + 'http_code' => 400, + 'description' => '找不到商品Code。', + ], + [ + 'code' => 'BackupAttachLogStatusNotSupported', + 'message' => 'The backup\'s attachLog status is not supported for CrossBackup operation.', + 'http_code' => 400, + 'description' => 'CrossBackup操作不支持备份的attachLog状态。', + ], + [ + 'code' => 'BackupExpireTimeExceedLimit', + 'message' => 'The backup expiration time exceeds the backup time plus 730 days.', + 'http_code' => 400, + 'description' => '修改备份的到期时间时，不可以超过备份时间加730天。', + ], + [ + 'code' => 'BackupIntervalNotSupport', + 'message' => 'BackupInterval must be -1 when SnapshotBackupType is Standard.', + 'http_code' => 400, + 'description' => '当SnapshotBackupType为标准时，BackupInterval必须为-1。', + ], + [ + 'code' => 'BackupJobExists', + 'message' => 'A backup job already exists in the specified DB instance.', + 'http_code' => 400, + 'description' => '当前实例已存在相同的备份任务。', + ], + [ + 'code' => 'BackupLogInvalid', + 'message' => 'Specified parameter EnableBackupLog or EnableCrossLogBackup is invalid.', + 'http_code' => 400, + 'description' => '指定的参数EnableBackupLog或EnableCrossLogBackup无效。', + ], + [ + 'code' => 'CAN_NOT_FIND_SUBSCRIPTION', + 'message' => 'No ordering information found.', + 'http_code' => 400, + 'description' => '找不到订购信息。', + ], + [ + 'code' => 'ChargeTypeViolation', + 'message' => 'The operation is not permitted due to charge type of the instance.', + 'http_code' => 400, + 'description' => '实例收费类型不允许执行当前操作。', + ], + [ + 'code' => 'ClassicNetWorkExistFault', + 'message' => 'The classic network you are trying to switch already exists.', + 'http_code' => 400, + 'description' => '您尝试切换的经典网络已存在。', + ], + [ + 'code' => 'ClassicNetworkNotSupport', + 'message' => 'Classic network has not been supported, try to use VPC.', + 'http_code' => 403, + 'description' => '当前操作不支持经典网络实例，请使用VPC网络。', + ], + [ + 'code' => 'ClassicNotSupport', + 'message' => 'Classic instance does not support this operation.', + 'http_code' => 400, + 'description' => '经典实例不支持此操作', + ], + [ + 'code' => 'Config.Error', + 'message' => 'Config error.', + 'http_code' => 400, + 'description' => '配置错误。', + ], + [ + '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必须是PreferredBackup Period的子集', + ], + [ + 'code' => 'CrossRegionTransNotAllowed', + 'message' => 'Cross region instance trans is not supported.', + 'http_code' => 404, + 'description' => '不支持跨区域实例转换', + ], + [ + 'code' => 'DataBasesNotExist', + 'message' => 'The DataBase info used for flashback does not exist.', + 'http_code' => 400, + 'description' => '用于闪回的数据库信息不存在。', + ], + [ + 'code' => 'DataList.Limit', + 'message' => 'The items of Datalist cannot exceed 1000.', + 'http_code' => 400, + 'description' => '数据列表中的项目不能超过1000个.', + ], + [ + 'code' => 'DbDeleteError', + 'message' => 'Database delete error.', + 'http_code' => 400, + 'description' => '获取VPC云实例ID数量错误。', + ], + [ + 'code' => 'DbInsertError', + 'message' => 'Database insert error.', + 'http_code' => 404, + 'description' => '插入数据库异常。', + ], + [ + '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' => '实例暂时不支持降低磁盘空间配置', + ], + [ + 'code' => 'DryRunOperation', + 'message' => 'Request validation has been passed with DryRun flag set.', + 'http_code' => 400, + 'description' => '已通过请求验证，并设置了DryRun标志。', + ], + [ + 'code' => 'DynamodbNotSupport', + 'message' => 'Dynamodb Instance not support this operation.', + 'http_code' => 400, + 'description' => 'DynamoDB 实例暂不支持此操作。'."\n", + ], + [ + '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' => '非单节点实例与单节点实例不允许转换', + ], + [ + 'code' => 'EngineVersion.ERROR', + 'message' => 'Target engineVersion must be greater than the current one.', + 'http_code' => 400, + 'description' => '目标引擎版本必须大于当前版本。', + ], + [ + 'code' => 'EngineVersionNotSupport', + 'message' => 'Specified EngineVersion not support this operation.', + 'http_code' => 400, + 'description' => '指定的EngineVersion不支持此操作。', + ], + [ + 'code' => 'EOFSNotSupport', + 'message' => 'The instance is at the End of Full Support (EOFS) stage.', + 'http_code' => 403, + 'description' => 'EOFS 已关闭无法支持。', + ], + [ + 'code' => 'ErrorInsufficientResource', + 'message' => 'There is not enough resource for your operation, requestId: %s.', + 'http_code' => 400, + 'description' => '当前操作资源不足，请求id: %s。', + ], + [ + 'code' => 'ExpireDays.Invalid', + 'message' => 'Specified expire days is not valid.', + 'http_code' => 400, + 'description' => '指定的过期日期无效。', + ], + [ + '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' => '当前可用区暂无接入认证。', + ], + [ + 'code' => 'Forbidden.ZoneIdNotFound', + 'message' => 'Specified zoneId is not found during access authentication.', + 'http_code' => 404, + 'description' => '无法找到指定的zoneid。', + ], + [ + 'code' => 'Frequency.limit', + 'message' => 'The current interface has exceeded the access limit.', + 'http_code' => 400, + 'description' => '当前接口已超出访问限制！', + ], + [ + 'code' => 'GranularityParamNotMatch', + 'message' => 'The granularity param not match.', + 'http_code' => 400, + 'description' => '粒度参数不匹配', + ], + [ + 'code' => 'HiddenZone.Closed', + 'message' => 'Specified HiddenZone is closed.', + 'http_code' => 400, + 'description' => '选择的hidden可用区已关闭。', + ], + [ + 'code' => 'IncorrectBackupSetMethod', + 'message' => 'Current backup set method does not support operations.', + 'http_code' => 403, + 'description' => '当前备份集方法不支持操作。', + ], + [ + 'code' => 'IncorrectCharacterType', + 'message' => 'Current DB instance CharacterType does not support this operation.', + 'http_code' => 400, + 'description' => '当前实例的角色类型不允许执行当前操作。', + ], + [ + 'code' => 'IncorrectDBInstanceLockMode', + 'message' => 'Current DB instance lock mode does not support this operation.', + 'http_code' => 403, + 'description' => '当前的数据库实例锁定模式不支持此操作。', + ], + [ + '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' => '主实例状态不支持此操作。', + ], + [ + 'code' => 'IncorrectVswitchId', + 'message' => 'The specified parameter \'VSwitchId\' is not valid.', + 'http_code' => 400, + 'description' => '当前实例为VPC实例时，VSwitchId 参数不能为空。', + ], + [ + 'code' => 'InstanceAutoRenewInvalid', + 'message' => 'Instance auto ApiRenewal is invalid.', + 'http_code' => 400, + 'description' => 'autoRenew 参数不能为空。', + ], + [ + 'code' => 'InstanceChargeTypeInvalid', + 'message' => 'Instance charge type is invalid.', + 'http_code' => 400, + 'description' => '实例收费类型无效。', + ], + [ + 'code' => 'InstanceChargeTypeNotSupport', + 'message' => 'Instance charge type does not support this operation.', + 'http_code' => 400, + 'description' => '实例收费类型不支持此操作。', + ], + [ + 'code' => 'InstanceClassNotSupport', + 'message' => 'The input ConfigServer class Mongo class and shard class not support .', + 'http_code' => 400, + 'description' => '不支持输入ConfigServer类、Mongo类和shard类.', + ], + [ + 'code' => 'InstanceCurrentKernelVersionNotSupport', + 'message' => 'Current DB instance CurrentKernelVersion does not support this operation.', + 'http_code' => 403, + 'description' => '该功能仅支持4.0版本的最新小版本，请先升级至对应版本再启用。', + ], + [ + 'code' => 'InstanceReleaseProtection', + 'message' => 'The operation is not permitted due to instance release protection.', + 'http_code' => 400, + 'description' => '指定操作无法执行，该实例已经开始释放保护，如确定释放实例，请修改释放保护属性后重新执行。', + ], + [ + 'code' => 'InstanceSpecInvalid', + 'message' => 'The input parameters DBInstanceClass and DBInstanceStorage no change.', + 'http_code' => 400, + 'description' => '输入参数DBInstanceClass和DBInstanceStorage没有变化。', + ], + [ + 'code' => 'InstanceStatusInvalid', + 'message' => 'Instance status is invalid.', + 'http_code' => 404, + 'description' => '实例不在运行中。', + ], + [ + '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' => '该实例类型不允许进行当前操作。', + ], + [ + 'code' => 'InstanceVpcAuthMode.NotSupported', + 'message' => 'Instance VpcAuthMode is NotSupported.', + 'http_code' => 400, + 'description' => '开通VPC免密登录实例不支持此操作。', + ], + [ + 'code' => 'InsType.NotSupport', + 'message' => 'Specified instance type dose not support this operation.', + 'http_code' => 400, + 'description' => '指定的实例类型不支持此操作。', + ], + [ + 'code' => 'InsufficientResourceCapacity', + 'message' => 'There is insufficient capacity available for the requested instance.', + 'http_code' => 400, + 'description' => '选择的地域或可用区资源不足，请选择其他可用区或提交工单处理。', + ], + [ + 'code' => 'InternalError', + 'message' => 'The request processing has failed due to some unknown error, exception or failure.', + 'http_code' => 400, + 'description' => '内部错误，请稍后重试。'."\n", + ], + [ + 'code' => 'InternalFailure', + 'message' => 'The request processing has failed due to some unknown error, exception or failure.', + 'http_code' => 500, + 'description' => '服务异常。', + ], + [ + 'code' => 'InvalidAccount.NotFound', + 'message' => 'account is not found.', + 'http_code' => 400, + 'description' => '账号不存在。', + ], + [ + 'code' => 'InvalidAccountDescription.Malformed', + 'message' => 'Specified parameter AccountDescription is not valid.', + 'http_code' => 400, + 'description' => '指定的参数AccountDescription无效。', + ], + [ + 'code' => 'InvalidAccountName.Forbid', + 'message' => 'Specified account name is a keyword.', + 'http_code' => 400, + 'description' => '账户名不正确，关键字不可用于账户名。请修改账户名。', + ], + [ + 'code' => 'InvalidAccountName.Malformed', + 'message' => 'Specified parameter AccountName is not valid.', + 'http_code' => 400, + 'description' => '指定的参数AccountName无效。', + ], + [ + 'code' => 'InvalidAccountName.NotFound', + 'message' => 'Specified account name does not exist.', + 'http_code' => 404, + 'description' => 'AccountName未输入或输入错误。', + ], + [ + 'code' => 'InvalidAccountPassword.Format', + 'message' => 'Specified account password is not valid.', + 'http_code' => 400, + 'description' => '指明的账号密码无效。', + ], + [ + 'code' => 'InvalidAccountPassword.Malformed', + 'message' => 'Specified parameter AccountPassword is not valid.', + 'http_code' => 400, + 'description' => '指定的参数AccountPassword无效。', + ], + [ + 'code' => 'InvalidAction', + 'message' => 'Specified action is not valid.', + 'http_code' => 400, + 'description' => '服务异常。', + ], + [ + 'code' => 'InvalidBackup.NotFound', + 'message' => 'Theavailable backup does not exist in recovery time.', + 'http_code' => 404, + 'description' => '恢复时间内不存在可用的备份。'."\n", + ], + [ + 'code' => 'InvalidBackupLogStatus', + 'message' => 'Current backup log enable status does not support this operation.', + 'http_code' => 403, + 'description' => '当前备份日志启用状态不支持此操作。'."\n", + ], + [ + 'code' => 'InvalidBackupSet.NotMatched', + 'message' => 'Specified backup set does not match instance.', + 'http_code' => 400, + 'description' => '指定的备份集ID不匹配', + ], + [ + 'code' => 'InvalidCertExpiredTime', + 'message' => 'The provided SSL certificate is expired or not yet valid.', + 'http_code' => 400, + 'description' => '提供的ssl证书已过期或者无效。', + ], + [ + 'code' => 'InvalidCharacterType', + 'message' => 'Specified characterType is not valid.', + 'http_code' => 400, + 'description' => '指明的角色类型无效。', + ], + [ + 'code' => 'InvalidCommodityCode.Forbid', + 'message' => 'The specified parameter CommodityCode is not valid.', + 'http_code' => 400, + 'description' => '指定的参数CommodityCode 不合法，请您检查输入的参数是否正确。', + ], + [ + 'code' => 'InvalidConnectionStringOrPort.Duplicate', + 'message' => 'Specified connection string or port already exists.', + 'http_code' => 400, + 'description' => '指明的连接串或port信息已存在，请检查后重新提交。', + ], + [ + 'code' => 'InvalidDbInstance.isFound', + 'message' => 'The current instance already exists.', + 'http_code' => 400, + 'description' => '当前实例已经存在，请勿重新创建。', + ], + [ + 'code' => 'InvalidDBInstanceClass.NotFound', + 'message' => 'The specified DB instance type is not found.', + 'http_code' => 404, + 'description' => '所选实例规格不存在，请重新选择。', + ], + [ + 'code' => 'InvalidDBInstanceDescription.Malformed', + 'message' => 'Specified parameter DBInstanceDescription is not valid.', + 'http_code' => 400, + 'description' => '节点名称不合法'."\n", + ], + [ + 'code' => 'InvalidDBInstanceId.NotFound', + 'message' => 'Specified instance does not exist.', + 'http_code' => 400, + 'description' => '该实例不存在，原因可能是该实例已经释放，请刷新页面。', + ], + [ + 'code' => 'InvalidDBInstanceId.NotFound', + 'message' => 'An error occurs when you query the instance information. Try again later.', + 'http_code' => 400, + 'description' => '查询实例信息异常，请稍后再试', + ], + [ + 'code' => 'InvalidDbInstanceId.NotFound', + 'message' => 'Specified instance does not exist.', + 'http_code' => 400, + 'description' => '实例ID不存在。', + ], + [ + 'code' => 'InvalidDbInstanceIdInvalid', + 'message' => 'Instance dbInstanceId is invalid.', + 'http_code' => 400, + 'description' => '传入的实例ID无效。', + ], + [ + 'code' => 'InvalidDBName', + 'message' => 'The specified database name is not allowed.', + 'http_code' => 403, + 'description' => '指定的数据库名称无效'."\n", + ], + [ + 'code' => 'InvalidDuation.Invalid', + 'message' => 'Instance duation is invalid.', + 'http_code' => 400, + 'description' => 'Duration 参数为空或无效。', + ], + [ + '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' => 'EffectiveTime 参数为空。', + ], + [ + 'code' => 'InvalidEndTime.Malformed', + 'message' => 'The Specified parameter \\”EndTime\\” is not valid', + 'http_code' => 400, + 'description' => '指定的参数EndTime不合法，请您检查输入的参数是否正确。', + ], + [ + 'code' => 'InvalidInstanceId', + 'message' => 'DBInstanceIdentifier does not refer to an existing DB instance.', + 'http_code' => 400, + 'description' => '指定的实例ID不合法', + ], + [ + 'code' => 'InvalidInstanceIp.Duplicate', + 'message' => 'Invalid security IP list specified, duplicated.', + 'http_code' => 400, + 'description' => '白名单列表存在重复IP地址', + ], + [ + 'code' => 'InvalidIzNo.NotSupported', + 'message' => 'the Specified vpc Zone not supported.', + 'http_code' => 404, + 'description' => '指明的可用区不支持。', + ], + [ + 'code' => 'InvalidKernelReleaseNotes', + 'message' => 'The format of specified KernelVersion is invalid.', + 'http_code' => 400, + 'description' => '指明的数据库小版本号无效。', + ], + [ + 'code' => 'InvalidKmsKey', + 'message' => 'Kms key is disabled.', + 'http_code' => 400, + 'description' => 'kms 密钥不可用。', + ], + [ + 'code' => 'InvalidLogBackupRetentionPeriod.Malformed', + 'message' => 'Specified log retention period is not valid.', + 'http_code' => 400, + 'description' => '无效的日志备份保留天数。', + ], + [ + 'code' => 'InvalidMeta.TooLarge', + 'message' => 'Meta information is too large.', + 'http_code' => 403, + 'description' => '元信息太大。'."\n", + ], + [ + 'code' => 'InvalidParameter', + 'message' => 'The specified parameter %s is not valid.', + 'http_code' => 400, + 'description' => '参数 %s 非有效参数。', + ], + [ + 'code' => 'InvalidParameter.%s', + 'message' => 'Parameter %s is not valid for instance\'s MinorVersion.', + 'http_code' => 400, + 'description' => '当前实例小版本不支持参数 %s， 可尝试升级小版本。', + ], + [ + 'code' => 'InvalidParameterCombination', + 'message' => 'The end time must be greater than the start time', + 'http_code' => 400, + 'description' => '开始时间不能大于结束时间。', + ], + [ + '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' => '当前实例小版本不支持参数 %s，请尝试升级小版本。', + ], + [ + 'code' => 'InvalidParameters.Format', + 'message' => 'Specified parameters is not valid.', + 'http_code' => 400, + 'description' => '输入的参数无效。', + ], + [ + 'code' => 'InvalidPerfData', + 'message' => 'The obtained instance performance data is invalid.', + 'http_code' => 403, + 'description' => '获取的实例性能数据无效。', + ], + [ + 'code' => 'InvalidProvisionedIops.LimitExceed', + 'message' => 'Instance param provisionedIops non compliant.', + 'http_code' => 400, + 'description' => '实例参数providizedOps不符合要求。', + ], + [ + 'code' => 'InvalidRegion.Format', + 'message' => 'Specified Region is not valid.', + 'http_code' => 400, + 'description' => '选择的地域无效。', + ], + [ + 'code' => 'InvalidRegion_Zone_NotFound', + 'message' => 'Specified Region does not exist in RDS.', + 'http_code' => 404, + 'description' => '指定的区域在RDS中不存在。', + ], + [ + 'code' => 'InvalidRestoreTime', + 'message' => 'The specified parameter \'RestoreTime\' is not valid, please check Flashback RecoverTime.', + 'http_code' => 400, + 'description' => '指定的参数“RestoreTime”无效，请检查Flashback RecoverTime。', + ], + [ + 'code' => 'InvalidRestoreTime.Format', + 'message' => 'Specified restore time is not valid.', + 'http_code' => 400, + 'description' => '指定的参数RestoreTime不合法，请您检查输入的参数是否正确。', + ], + [ + 'code' => 'InvalidSaleComponentFault', + 'message' => 'The request references an incorrect order sales component. Contact the customer support.', + 'http_code' => 400, + 'description' => '请求中的订单信息错误，请提交工单处理。', + ], + [ + 'code' => 'InvalidSearchTimeRange', + 'message' => 'search time range cannot be longer than a day.', + 'http_code' => 400, + 'description' => '时间范围不能超过一天。', + ], + [ + 'code' => 'InvalidSecurityIPListGroup.QuotaExceeded', + 'message' => 'Specified security IP list group is not valid: Exceeding the allowed amount of group.', + 'http_code' => 400, + 'description' => '输入的白名单安全组无效：IP数量超过安全组限制。', + ], + [ + 'code' => 'InvalidSecurityIpListLength.Malformed', + 'message' => 'Specified parameter SecurityIpList is not valid.', + 'http_code' => 400, + 'description' => 'SecurityIpList 入参个数超过最大值。', + ], + [ + 'code' => 'InvalidShardInfo.Format', + 'message' => 'Specified Shards info is not valid.', + 'http_code' => 400, + 'description' => '实例规格 DBInstanceClass 格式错误。', + ], + [ + 'code' => 'InvalidShardInfo.Format', + 'message' => 'Shard total number is out of range.', + 'http_code' => 400, + 'description' => 'shard 节点数校验异常。', + ], + [ + 'code' => 'InvalidStartTime.Format', + 'message' => 'Specified start time is not valid.', + 'http_code' => 400, + 'description' => '指定的开始时间无效。'."\n", + ], + [ + 'code' => 'InvalidStartTime.Malformed', + 'message' => 'The Specified parameter \\”StartTime\\” is not valid.', + 'http_code' => 400, + 'description' => '指定的参数StartTime不合法，请您检查输入的参数是否正确。', + ], + [ + 'code' => 'InvalidStartTimeAndEndTime.Malformed', + 'message' => 'The end time must be greater than the start time', + 'http_code' => 400, + 'description' => '结束时间不能小于开始时间', + ], + [ + 'code' => 'InvalidStatus.NotFound', + 'message' => 'The Status provided does not exist in our records.', + 'http_code' => 404, + 'description' => '实例状态不存在，请检查输入的参数是否正确。', + ], + [ + 'code' => 'InvalidStorage', + 'message' => 'Storage is mandatory for this action.', + 'http_code' => 400, + 'description' => '此操作必须进行存储。', + ], + [ + 'code' => 'InvalidStorageSizeForMongos', + 'message' => 'The specified storage size is invalid for Mongos.', + 'http_code' => 400, + 'description' => '指定的存储大小对Mongos无效。', + ], + [ + 'code' => 'InvalidTableNameOrDBName', + 'message' => 'The specified parameter \'TableName\' or \'DBName\' is not founded.', + 'http_code' => 400, + 'description' => '未找到指定的参数“TableName”或“DBName”。', + ], + [ + 'code' => 'InvalidTagKey.Malformed', + 'message' => 'The specified parameter Tag.n.Key or TagKey.n is not valid.', + 'http_code' => 400, + 'description' => '指定的参数“Tag.n.Value”无效。'."\n", + ], + [ + 'code' => 'InvalidTagKey.Malformed', + 'message' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', + 'http_code' => 400, + 'description' => '指定的参数“Tag.n.Key”或“TagKey.n”无效。', + ], + [ + 'code' => 'InvalidTagValue.Malformed', + 'message' => 'The specified parameter Tag.n.Value is not valid.', + 'http_code' => 400, + 'description' => '指定的参数“Tag.n.Value”无效。', + ], + [ + 'code' => 'InvalidTDEstatus', + 'message' => 'Specified TDEStatus is not configured on the This custins.', + 'http_code' => 400, + 'description' => '当前实例已经开启TDE.', + ], + [ + 'code' => 'InvalidUpgradeParams', + 'message' => 'All(replicationFactor,dbInstanceClass,dbInstanceStorage ) parameters are the same.', + 'http_code' => 400, + 'description' => '变配时实例节点数、规格类型、存储空间未改变，请修改变配参数后重新发起。', + ], + [ + 'code' => 'InvalidVpc.NotSupported', + 'message' => 'the Different vpc not supported.', + 'http_code' => 400, + 'description' => '不同的 VPC 不支持。', + ], + [ + 'code' => 'InvalidVpcAuthMode.Invalid', + 'message' => 'Specified VpcAuthMode is invalid.', + 'http_code' => 400, + 'description' => '指定的VpcAuthMode无效。', + ], + [ + 'code' => 'InvalidVpcIdRegion.NotSupported', + 'message' => 'The Specified vpcId or vSwitchId not supported.', + 'http_code' => 404, + 'description' => '不支持指定的vpcId或vSwitchId。', + ], + [ + 'code' => 'InvalidZoneld', + 'message' => 'The specified primary zone, secondary zone and hidden zone cannot be the same.', + 'http_code' => 400, + 'description' => '选择的主可用区、备可用区1和备可用区2参数不能完全相同。', + ], + [ + 'code' => 'InvalidZoneParam', + 'message' => 'The target zone and source zone cannot be the same.', + 'http_code' => 400, + 'description' => '目标可用区不可以和原可用区一致', + ], + [ + 'code' => 'KeyFilter.Limit', + 'message' => 'The number of keys cannot exceed 1000 and the keyFilter JsonString length cannot exceed 48KB.', + 'http_code' => 400, + 'description' => '键的数量不能超过1000，keyFilter JsonString的长度不能超过48KB。', + ], + [ + 'code' => 'KeyList.Duplicate', + 'message' => 'There are duplicate keys in the keyword list.', + 'http_code' => 400, + 'description' => '关键字列表中有重复的键。', + ], + [ + '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' => 'keyList的大小不能超过10，keyList的json字符串长度不能超过128。', + ], + [ + 'code' => 'KmsAccountStatusException', + 'message' => 'KMS account status is not enabled, please enable it first.', + 'http_code' => 400, + 'description' => 'KMS帐户状态未启用，请先启用。', + ], + [ + 'code' => 'KMSIdNotValid', + 'message' => 'Specific KMS Id is not valid.', + 'http_code' => 400, + 'description' => '特定的KMS Id无效。', + ], + [ + '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' => '日志API访问量超过允许上限。', + ], + [ + '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' => '此API不支持实例的MinorVersion。', + ], + [ + 'code' => 'MissingAttribute', + 'message' => 'NewPassword/InstanceName/Config at least one is mandatory for this action.', + 'http_code' => 400, + 'description' => 'NewPassword/InstanceName/Config 中至少有一个是必需的。', + ], + [ + 'code' => 'MissingDBInstanceId', + 'message' => 'DBInstanceId is mandatory for this action.', + 'http_code' => 200, + 'description' => '实例名必须有效。'."\n", + ], + [ + 'code' => 'MissingDbInstanceId', + 'message' => 'DbInstanceId is mandatory for this action.', + 'http_code' => 400, + 'description' => 'DBInstanceId 是此操作的必需参数。', + ], + [ + 'code' => 'MissingParameter', + 'message' => 'The input parameter OwnerId,OwnerAccount that is mandatory for processing this request is not supplied.', + 'http_code' => 403, + 'description' => 'OwnerId和OwnerAccount参数值为空，请至少为其中一个参数设置参数值。', + ], + [ + 'code' => 'MissingParameter', + 'message' => 'The input parameter { ResourceId } that is mandatory for processing this request is not supplied.', + 'http_code' => 403, + 'description' => 'ResourceId参数值为空，请设置参数值。', + ], + [ + 'code' => 'MissingParameter', + 'message' => 'The input parameter {ResourceId} that is mandatory for processing this request is not supplied.', + 'http_code' => 403, + 'description' => 'ResourceId参数值为空，请设置参数值。', + ], + [ + 'code' => 'MissingParameter', + 'message' => '%s is mandatory for this action.', + 'http_code' => 400, + 'description' => '%s 参数必填。', + ], + [ + 'code' => 'MissingPeriod', + 'message' => 'Period is mandatory for this action.', + 'http_code' => 400, + 'description' => 'Period 参数为空，或参数格式异常。', + ], + [ + 'code' => 'MissingSpec', + 'message' => 'DBInstanceClass/DBInstanceStorage at least one is mandatory for this action.', + 'http_code' => 412, + 'description' => 'DBInstanceClass\\DBInstanceStorage至少有一个是此操作所必需的。', + ], + [ + 'code' => 'MissingVpcId', + 'message' => 'VpcId is mandatory for this action.', + 'http_code' => 412, + 'description' => '此操作必须使用VpcId。', + ], + [ + 'code' => 'MissingVswitchId', + 'message' => 'VswitchId is mandatory for this action.', + 'http_code' => 412, + 'description' => 'VswitchId对此操作是必需的。', + ], + [ + 'code' => 'ModifyNodeSpecBatchNotSupportCsLocalSSD', + 'message' => 'ModifyNodeSpecBatch interface not support cs for LocalSSD Instance.', + 'http_code' => 400, + 'description' => 'ModifyNodeSpecBatch接口不支持LocalSSD实例的cs。', + ], + [ + 'code' => 'ModifyReadOnlyNodeInvalidMinorVersion', + 'message' => 'Modify readonly node count is not supported for instance\'s MinorVersion.', + 'http_code' => 400, + 'description' => '实例的MinorVersion不支持修改只读节点计数。', + ], + [ + 'code' => 'ModifyReadOnlyNodeNotSupport', + 'message' => 'Modify readonly node count in ModifyNodeSpecBatch is not support.', + 'http_code' => 403, + 'description' => 'ModifyNodeSpeccBatch 接口不支持修改只读节点个数。'."\n", + ], + [ + 'code' => 'Mutex.NotAcquire', + 'message' => 'Can\'t acquire mutex lock. Please try again later.', + 'http_code' => 400, + 'description' => '无法获取互斥锁。请稍后再试', + ], + [ + 'code' => 'Namespace.Limit', + 'message' => 'The length of DBName.TableName or DBName.TempTableName cannot exceed 253.', + 'http_code' => 400, + 'description' => 'DBName的长度。表名或数据库名。TempTableName不能超过253。', + ], + [ + 'code' => 'NetworkType.NotSupport', + 'message' => 'Specified network type does not support this operation.', + 'http_code' => 400, + 'description' => '指定的网络类型不支持此操作。', + ], + [ + 'code' => 'NetworkTypeNotMatch', + 'message' => 'Specified network type does not matched.', + 'http_code' => 400, + 'description' => '指定的网络类型不匹配。', + ], + [ + 'code' => 'NetworkTypeNotSupport', + 'message' => 'The network type does not support this operation.', + 'http_code' => 400, + 'description' => '该网络类型不支持此操作。'."\n", + ], + [ + 'code' => 'NewConnectionString.NotSupport', + 'message' => 'Specified newConnectionString is not supported.', + 'http_code' => 400, + 'description' => 'newConnectionString 格式错误。', + ], + [ + 'code' => 'Node.NotFound', + 'message' => 'Specified node is not found.', + 'http_code' => 404, + 'description' => 'node节点不存在', + ], + [ + 'code' => 'NodeIdNotSupport', + 'message' => 'Specified NodeId not support this operation.', + 'http_code' => 400, + 'description' => '传入的NodeId无效。 ', + ], + [ + 'code' => 'NodeNum.Config', + 'message' => 'Node number config error.', + 'http_code' => 400, + 'description' => '节点数量配置错误。', + ], + [ + 'code' => 'NodeNum.Error', + 'message' => 'Node number error.', + 'http_code' => 400, + 'description' => '节点个数错误.。'."\n", + ], + [ + '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' => '仅支持VPC网络。', + ], + [ + 'code' => 'OpenKmsServiceException', + 'message' => 'Error in opening Kms Service. Please check whether you have passed the real name authentication.', + 'http_code' => 400, + 'description' => '打开Kms服务时出错。请检查您是否通过了实名认证。', + ], + [ + 'code' => 'Operation.NotValid', + 'message' => 'Specified operation is not valid.', + 'http_code' => 400, + 'description' => '指定的操作无效。', + ], + [ + 'code' => 'OperationDenied', + 'message' => 'The resource is out of usage.', + 'http_code' => 403, + 'description' => 'The resource is out of usage.', + ], + [ + 'code' => 'OperationDenied.AccountStatus', + 'message' => 'The operation is not permitted due to status of account.', + 'http_code' => 403, + 'description' => '由于账户的状态，不允许执行此操作。', + ], + [ + 'code' => 'OperationDenied.BackupJobExists', + 'message' => 'The operation is not permitted due to backup job exist.', + 'http_code' => 403, + 'description' => '当前有正在进行的备份任务，请稍后再试。', + ], + [ + 'code' => 'OperationDenied.DBInstance', + 'message' => 'The operation is not permitted due to type of instance.', + 'http_code' => 403, + 'description' => '由于实例的类型，不允许执行该操作。', + ], + [ + 'code' => 'OperationDenied.DBInstanceStatus', + 'message' => 'The operation is not permitted due to status of instance.', + 'http_code' => 400, + 'description' => '当前实例状态下无法执行该操作。', + ], + [ + 'code' => 'OperationDenied.KMSUnauthorized', + 'message' => 'The operation is not permitted due to KMS roleARN is not authorized to ads service account.', + 'http_code' => 400, + 'description' => '由于KMS角色ARN未被授权到广告服务帐户，因此不允许该操作。', + ], + [ + 'code' => 'OperationDenied.LockMode', + 'message' => 'The operation is not permitted when the instance locked.', + 'http_code' => 403, + 'description' => '当前实例已被锁定，无法执行该操作。'."\n", + ], + [ + 'code' => 'OperationDenied.QuotaExceed', + 'message' => 'The maximum number of Tags is exceeded. The maximum value is 20.', + 'http_code' => 400, + 'description' => '标签数量超过上限（上限：20条），请删除不再使用的标签后重试。', + ], + [ + 'code' => 'OperationDenied.SecurityIPListDuplicate', + 'message' => 'The Specified same security IP already exists.', + 'http_code' => 400, + 'description' => '白名单列表存在重复IP地址', + ], + [ + 'code' => 'OplogSizeLowerThanInstanceStorage', + 'message' => 'Specified oplogSizeMB is lower than 5% of InstanceStorage.', + 'http_code' => 400, + 'description' => '输入的oplogSizeMB参数低于实例存储大小的5%。', + ], + [ + 'code' => 'OplogSizeLowerThanInstanceStorage', + 'message' => 'The oplogSizeMB parameter entered is less than 10% of the instance store size.', + 'http_code' => 400, + 'description' => '输入的oplogSizeMB参数低于实例存储大小的10%。', + ], + [ + 'code' => 'Order.BasicInfoUncompleted', + 'message' => 'Your information is incomplete. Complete your information before the operation.', + 'http_code' => 400, + 'description' => '您的用户信息尚未完善，请补全后重试。', + ], + [ + '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' => '支付失败，您可以添加其他支付方式，也可以<a href=\'https://usercenter2.aliyun.com/finance/fund-management/recharge\' target=\'_blank\'>充值</a>后重试。', + ], + [ + 'code' => 'ORDER.INST_HAS_UNPAID_ORDER', + 'message' => 'Current instance has unpaid order.', + 'http_code' => 400, + 'description' => '当前实例存在未支付的订单。', + ], + [ + 'code' => 'Order.NeedAddPayment', + 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'http_code' => 400, + 'description' => '无支付方式，请添加支付方式。', + ], + [ + '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' => '支付失败，您可以添加其他支付方式，也可以<a href=\'https://usercenter2.aliyun.com/finance/fund-management/recharge\' target=\'_blank\'>充值</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' => '无支付方式，请添加支付方式。', + ], + [ + 'code' => 'Order.NoAvailablePaymentMethod', + 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'http_code' => 400, + 'description' => '无支付方式，请添加支付方式。', + ], + [ + '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' => '指定订单未付款。', + ], + [ + 'code' => 'Order.ParmentUncompleted', + 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'http_code' => 400, + 'description' => '支付方式无效，请切换至有效的支付方式进行支付。', + ], + [ + 'code' => 'Order.TaxNumberRequiredUncompleted', + 'message' => 'Your tax information is incomplete. Complete your information before the operation.', + 'http_code' => 400, + 'description' => '税务信息尚未完善，请补全后重试。', + ], + [ + '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' => '不支持指定的订单类型。', + ], + [ + 'code' => 'ORD_S_QUERY_PROD_ERROR', + 'message' => 'Error in querying ordering information.', + 'http_code' => 400, + 'description' => '查询订购信息错误。', + ], + [ + 'code' => 'ProxyError', + 'message' => 'Invoke proxy error.', + 'http_code' => 400, + 'description' => '调用代理错误。'."\n", + ], + [ + 'code' => 'QuotaExceed.AfterpayInstance', + 'message' => 'The maximum number of post-paid instances has been reached.', + 'http_code' => 400, + 'description' => '后付费实例数已达到最大限额。', + ], + [ + 'code' => 'RandomListSize.Limit', + 'message' => 'The random list has reached the length limit.', + 'http_code' => 400, + 'description' => '随机列表已达到长度限制。', + ], + [ + 'code' => 'ReduceDiskNotSupport', + 'message' => 'Reduce disk size is not supported in clone/restore.', + 'http_code' => 403, + 'description' => '实例克隆\\恢复不支持缩小磁盘空间大小。', + ], + [ + 'code' => 'ReduceDiskSizeNotSupport', + 'message' => 'The input disk size: "%d" is less than original max disk size: "%d".', + 'http_code' => 403, + 'description' => '输入磁盘大小“%d\\”小于原始最大磁盘大小“%d”。', + ], + [ + 'code' => 'ReduceStorageSizeNotSupportNodeNumChange', + 'message' => 'Reducing the instance\'s storage size does not support changing the number of nodes.', + 'http_code' => 400, + 'description' => '减小实例的存储大小不支持更改节点数量。', + ], + [ + 'code' => 'ReplicationFactorIsEmpty', + 'message' => 'The replicationFactor param is error.replicationFactor.', + 'http_code' => 400, + 'description' => 'replicationFactor 参数无效。', + ], + [ + 'code' => 'Resource.IPAddressNotEnough', + 'message' => 'Specified vSwitch has no enough IP address.', + 'http_code' => 403, + 'description' => '指定的vSwitch没有足够的IP地址。', + ], + [ + 'code' => 'Resource.NotAvailable', + 'message' => 'Resource is not available.', + 'http_code' => 400, + 'description' => '资源不可用。', + ], + [ + 'code' => 'ResourceGroupId.InValid', + 'message' => 'The Specified ResourceGroupId is not valid.', + 'http_code' => 400, + 'description' => '指定的ResourceGroupId无效。', + ], + [ + 'code' => 'RestoreInstanceNotSupported', + 'message' => 'Restore instance is not supported, try to use CreateDBInstance/CreateShardingDBInstance for clone.', + 'http_code' => 400, + 'description' => '不支持还原实例，请尝试使用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' => '指明的恢复类型实例不支持，检查 RestoreType/BackupID/RestoreTime 输入参数。', + ], + [ + 'code' => 'SaleValidateNoSpecificCodeFailed', + 'message' => 'Specified Storage or Version or InstanceClass is invalid.', + 'http_code' => 400, + 'description' => 'Storage 或 Version 或 InstanceClass 为空。', + ], + [ + 'code' => 'SameZoneId', + 'message' => 'The specified primary zone, secondary zone require two different zones.', + 'http_code' => 400, + 'description' => '选择的主可用区、备可用区参数要求不同。', + ], + [ + 'code' => 'SecondaryZone.Closed', + 'message' => 'Specified secondaryZone is closed.', + 'http_code' => 400, + 'description' => 'secondary 选择的可用区已经关闭。', + ], + [ + 'code' => 'SecurityGroupNameNotSupport', + 'message' => 'Security GroupName does not support this operation.', + 'http_code' => 400, + 'description' => 'SecurityIpGroupName = spark_mongodb 不支持此操作。', + ], + [ + 'code' => 'ServiceNotSupported', + 'message' => 'The specified service is not supported.', + 'http_code' => 400, + 'description' => '服务异常，请稍后重试。如果仍提示相同错误信息请提交工单处理。', + ], + [ + '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' => '服务器端异常错误，请您稍后再试，若还出现相同错误请提交工单处理。', + ], + [ + 'code' => 'ServiceUnavailable', + 'message' => 'The request has failed due to a temporary failure of the server.', + 'http_code' => 503, + 'description' => '服务器端异常。请稍后重试，如果仍提示相同错误信息请提交工单处理。', + ], + [ + 'code' => 'SimultaneousCapacityChange.Allowed', + 'message' => 'Only simultaneous capacity expansion or reduction is supported.', + 'http_code' => 400, + 'description' => '仅支持同时进行容量扩展或缩减。', + ], + [ + 'code' => 'SingleDBRestore.BackupSetNotSupport', + 'message' => 'This backup set do not support this operation.', + 'http_code' => 403, + 'description' => '所选择的时间点或备份文件尚未支持单库恢复功能。', + ], + [ + 'code' => 'SingleKeyFilter.limit', + 'message' => 'The single keyFilter JsonString length cannot exceed 16KB.', + 'http_code' => 400, + 'description' => '单个keyFilter JsonString长度不能超过16KB。', + ], + [ + 'code' => 'SingleNodeNotSupport', + 'message' => 'The Single Node Instance not support this operation.', + 'http_code' => 400, + 'description' => '单节点实例不支持此操作。', + ], + [ + 'code' => 'SSLNotSupportAddNode', + 'message' => 'Instance with SSL certificate can\'t add node, please contact us to solve this problem.', + 'http_code' => 400, + 'description' => 'SSL加密实例不允许添加节点，如您需要，请联系我们解决该问题。', + ], + [ + 'code' => 'StorageSize.Limit', + 'message' => 'The instance storage size limit is "%d" when reducing the storage size.', + 'http_code' => 400, + 'description' => '减小存储大小时，实例存储大小限制为“%d”。', + ], + [ + 'code' => 'StorageTypeNotSupporteEncryption', + 'message' => 'Specified storage type does not support encryption.', + 'http_code' => 400, + 'description' => '指定的存储类型不支持加密。', + ], + [ + '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' => '商品信息错误。', + ], + [ + 'code' => 'SYSTEM.SALE_VALIDATE_NO_SPECIFIC_CODE_FAILED', + 'message' => 'Failed to create the specified sharding instance.', + 'http_code' => 400, + 'description' => '不能创建该规格的分片实例。', + ], + [ + 'code' => 'Task.Conflict', + 'message' => 'Current instance has unfinished task(buy or modify spec).', + 'http_code' => 400, + 'description' => '当前实例有未完成任务，请稍后重试', + ], + [ + 'code' => 'Task.Conflict', + 'message' => 'Current instance has unfinished task.', + 'http_code' => 409, + 'description' => '当前实例存在未完成的任务。请其他任务完成后在重试。', + ], + [ + 'code' => 'TempTableNameAlreadyExists', + 'message' => 'The TempTableName Table name already exists.', + 'http_code' => 400, + 'description' => 'TempTableName表名称已存在。', + ], + [ + 'code' => 'TempTableNameNotAllowed', + 'message' => 'TempTableName is not allowed.', + 'http_code' => 400, + 'description' => '不允许使用TempTableName。', + ], + [ + 'code' => 'TooSmallStorageSize', + 'message' => 'Specified storage size must be larger than current instance.', + 'http_code' => 403, + 'description' => '指定的存储大小必须大于当前实例。', + ], + [ + 'code' => 'Unknown.Exception', + 'message' => 'The Request Server Is Error Or The Response Can Not Be Null.', + 'http_code' => 500, + 'description' => '当前服务异常，请稍后重试。', + ], + [ + 'code' => 'UnSupportDbTypeReduceDiskSize', + 'message' => 'Current DB type not support reduce disk size.', + 'http_code' => 400, + 'description' => '当前数据库类型不支持减小磁盘大小', + ], + [ + 'code' => 'UnsupportedDBTdeStatus', + 'message' => 'Specified DB TDEStatus does not support this operation.', + 'http_code' => 403, + 'description' => '指定实例已开启TDE，不支持此操作', + ], + [ + 'code' => 'VipManagerAPICallingFailed', + 'message' => 'Vip Manager API calling failed, please check the log.', + 'http_code' => 400, + 'description' => 'vip服务异常，请稍后重试或提交工单处理。', + ], + [ + 'code' => 'VpcAndVSwitchNotChange', + 'message' => 'VpcId and vSwitchId not change.', + 'http_code' => 400, + 'description' => 'VpcId和vSwitchId不变。', + ], + [ + 'code' => 'VpcAuthModeNotSupported', + 'message' => 'VpcAuthMode is NotSupported for Security Risk.', + 'http_code' => 400, + 'description' => '无法开启专有网络免密访问功能', + ], + [ + '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' => '无法分配所需的vpc资源.', + ], + [ + 'code' => 'VpcError.NotEnabled', + 'message' => 'VPC is not enabled in this zone.', + 'http_code' => 400, + 'description' => '此区域中未启用VPC.', + ], + [ + 'code' => 'VPCERROR.NOT_ENABLED', + 'message' => 'VPC is not enabled in this zone.', + 'http_code' => 404, + 'description' => '此区域中未启用VPC。', + ], + [ + 'code' => 'VpcNetWorkExistFault', + 'message' => 'The VPC network you are trying to create already exists.', + 'http_code' => 400, + 'description' => '您尝试创建的VPC网络已存在。', + ], + [ + 'code' => 'VpcServiceError', + 'message' => 'Invoke vpc service error.', + 'http_code' => 500, + 'description' => '调用vpc服务错误。', + ], + [ + 'code' => 'Zone.Closed', + 'message' => 'Specified zone is closed.', + 'http_code' => 400, + 'description' => '指定区域已关闭', + ], + [ + 'code' => 'UNSUPPORTED_TDE_DELETED_INSTANCE_RESTORE', + 'message' => 'deleted TDE instance does not support restore.', + 'http_code' => 400, + 'description' => '已删除的TDE实例不支持回收站重建。', + ], + [ + 'code' => 'ErrorInsufficientResource', + 'message' => 'Insufficient resources. Please select another region or submit a ticket for further assistance.', + 'http_code' => 400, + 'description' => '资源不足，请选择其他地域/地区，或提交工单处理。', + ], + [ + 'code' => 'InvalidModifyParams', + 'message' => 'All(replicationFactor,dbInstanceClass,dbInstanceStorage,searchNodeCount,searchNodeStorage,searchNodeClass) parameters are the same.', + 'http_code' => 400, + 'description' => '当前变配相关参数未发生变动，请检查当前选择的实例规格类型、节点数、只读节点数、存储大小、Search节点规格、Search节点存储等变配参数。', + ], + [ + 'code' => 'InvalidOthers.Timeout', + 'message' => 'Query timed out. Please try again or narrow down the query scope.', + 'http_code' => 408, + 'description' => '查询数据量过大导致超时，请减少查询指标数量或者缩短查询时间范围。', + ], + [ + 'code' => 'Throttling.User', + 'message' => 'Request was denied due to user flow control.', + 'http_code' => 400, + 'description' => '用户这个时段的流量已经超限。', + ], + [ + 'code' => 'InstanceNotSupportSearch', + 'message' => 'The instance does not support search service.', + 'http_code' => 400, + 'description' => '当前实例不支持开通Search功能。', + ], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'MongoDB', + 'productName' => '云数据库 MongoDB 版', + 'ramCodes' => [ + 'dds', + ], + 'ramLevel' => '资源级', + 'ramConditions' => [ + [ + 'name' => 'acs:ResourceTag', + 'schema' => [ + 'type' => 'STRING', + 'description' => 'Tag鉴权', + ], + ], + ], + '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' => '修改MongoDB实例的参数', + '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' => '全部资源', + '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' => '查询MongoDB实例的备份恢复实例', + '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' => '查询MongoDB实例是否为自动付费', + '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' => '查询KMS密钥是否已授权给实例', + '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' => '查询MongoDB分片集群实例的连接信息', + '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' => '更改MongoDB实例已绑定的ECS安全组', + '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' => '延长MongoDB实例的经典网络保留时长', + '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' => '重启MongoDB实例的单个节点', + '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' => '创建Shard账号', + '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' => '修改实例中root账号的备注信息', + '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' => '查询MongoDB实例的SSL设置详情', + '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' => '修改MongoDB实例的透明数据加密TDE状态', + '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' => '删除全局IP白名单模板', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dds:DeleteGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeActiveOperationTaskCount', + 'description' => '查询MongoDB实例的运维任务数量', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeActiveOperationTaskCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '查询MongoDB实例的某个密钥的详情', + '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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'TagResources', + 'description' => '为一个或多个MongoDB实例绑定标签', + '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' => '全部资源', + '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' => '查询MongoDB实例的透明数据加密TDE是否开启', + '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' => '销毁MongoDB实例', + '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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyGlobalSecurityIPGroupName', + 'description' => '修改全局IP白名单模板名称', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroupName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '全部资源', + '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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateGlobalSecurityIPGroup', + 'description' => '创建全局IP白名单模板', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dds:CreateGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '重启MongoDB实例', + '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' => '修改MongoDB实例的SSL链路配置', + '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' => '转换云数据库MongoDB实例的付费类型', + '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' => '查询云盘加密可选择的Kms密钥', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:DescribeKmsKeys', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '新增Shard节点或Mongos节点', + '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' => '设置可以访问实例的 IP 白名单地址', + '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' => '修改MongoDB实例的SRV连接地址', + '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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSecurityIps', + 'description' => '查询MongoDB实例的IP白名单', + '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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ResetAccountPassword', + 'description' => '重置MongoDB实例中root账号的密码', + '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' => '全部资源', + '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' => '修改全局IP白名单模板', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dds:ModifyGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceAttribute', + 'description' => '查询云数据库MongoDB实例的信息', + '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' => '设置MongoDB实例的监控采集粒度', + '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' => '查询全局IP白名单模板', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dds:DescribeGlobalSecurityIPGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '申请Srv地址', + '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' => '全部资源', + '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' => '全部资源', + '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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CheckServiceLinkedRole', + 'description' => '查询是否已创建服务关联角色', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dds:CheckServiceLinkedRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'MongoDB', + 'resourceType' => '全部资源', + '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' => '查询MongoDB实例绑定的ECS安全组信息', + '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' => '查询MongoDB实例列表', + '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' => '查询实例与全局IP白名单模板关系映射', + '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' => '查询MongoDB实例的监控采集粒度', + '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}', + ], + ], + ], +]; |